diff options
Diffstat (limited to 'doc/classes')
465 files changed, 64742 insertions, 0 deletions
diff --git a/doc/classes/@GDScript.xml b/doc/classes/@GDScript.xml new file mode 100644 index 0000000000..b61cf93ef7 --- /dev/null +++ b/doc/classes/@GDScript.xml @@ -0,0 +1,1078 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="@GDScript" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Built-in GDScript functions. + </brief_description> + <description> + This contains the list of built-in gdscript functions. Mostly math functions and other utilities. Everything else is expanded by objects. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="Color8"> + <return type="Color"> + </return> + <argument index="0" name="r8" type="int"> + </argument> + <argument index="1" name="g8" type="int"> + </argument> + <argument index="2" name="b8" type="int"> + </argument> + <argument index="3" name="a8" type="int"> + </argument> + <description> + Returns a 32 bit color with red, green, blue and alpha channels. Each channel has 8 bits of information ranging from 0 to 255. + [code]r8[/code] red channel + [code]g8[/code] green channel + [code]b8[/code] blue channel + [code]a8[/code] alpha channel + [codeblock] + red = Color8(255, 0, 0) + [/codeblock] + </description> + </method> + <method name="ColorN"> + <return type="Color"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="alpha" type="float"> + </argument> + <description> + Returns color [code]name[/code] with [code]alpha[/code] ranging from 0 to 1. Note: [code]name[/code] is defined in color_names.inc. + [codeblock] + red = ColorN('red') + [/codeblock] + </description> + </method> + <method name="abs"> + <return type="float"> + </return> + <argument index="0" name="s" type="float"> + </argument> + <description> + Returns the absolute value of parameter [code]s[/code] (i.e. unsigned value, works for integer and float). + [codeblock] + # a is 1 + a = abs(-1) + [/codeblock] + </description> + </method> + <method name="acos"> + <return type="float"> + </return> + <argument index="0" name="s" type="float"> + </argument> + <description> + Returns the arc cosine of [code]s[/code] in radians. Use to get the angle of cosine [code]s[/code]. + [codeblock] + # c is 0.523599 or 30 degrees if converted with rad2deg(s) + c = acos(0.866025) + [/codeblock] + </description> + </method> + <method name="asin"> + <return type="float"> + </return> + <argument index="0" name="s" type="float"> + </argument> + <description> + Returns the arc sine of [code]s[/code] in radians. Use to get the angle of sine [code]s[/code]. + [codeblock] + # s is 0.523599 or 30 degrees if converted with rad2deg(s) + s = asin(0.5) + [/codeblock] + </description> + </method> + <method name="assert"> + <return type="void"> + </return> + <argument index="0" name="condition" type="bool"> + </argument> + <description> + Assert that the [code]condition[/code] is true. If the [code]condition[/code] is false a fatal error is generated and the program is halted. Useful for debugging to make sure a value is always true. + [codeblock] + # 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 + [/codeblock] + </description> + </method> + <method name="atan"> + <return type="float"> + </return> + <argument index="0" name="s" type="float"> + </argument> + <description> + Returns the arc tangent of [code]s[/code] in radians. Use it to get the angle from an angle's tangent in trigonometry: [code]atan(tan(angle)) == angle[/code]. + The method cannot know in which quadrant the angle should fall. See [method atan2] if you always want an exact angle. + [codeblock] + a = atan(0.5) # a is 0.463648 + [/codeblock] + </description> + </method> + <method name="atan2"> + <return type="float"> + </return> + <argument index="0" name="x" type="float"> + </argument> + <argument index="1" name="y" type="float"> + </argument> + <description> + Returns the arc tangent of [code]y/x[/code] in radians. Use to get the angle of tangent [code]y/x[/code]. To compute the value, the method takes into account the sign of both arguments in order to determine the quadrant. + [codeblock] + a = atan(0,-1) # a is 3.141593 + [/codeblock] + </description> + </method> + <method name="bytes2var"> + <return type="Variant"> + </return> + <argument index="0" name="bytes" type="PoolByteArray"> + </argument> + <description> + Decodes a byte array back to a value. + </description> + </method> + <method name="ceil"> + <return type="float"> + </return> + <argument index="0" name="s" type="float"> + </argument> + <description> + Rounds [code]s[/code] upward, returning the smallest integral value that is not less than [code]s[/code]. + [codeblock] + i = ceil(1.45) # i is 2 + i = ceil(1.001) # i is 2 + [/codeblock] + </description> + </method> + <method name="char"> + <return type="String"> + </return> + <argument index="0" name="ascii" type="int"> + </argument> + <description> + Returns a character as a String of the given ASCII code. + [codeblock] + # a is 'A' + a = char(65) + # a is 'a' + a = char(65+32) + [/codeblock] + </description> + </method> + <method name="clamp"> + <return type="float"> + </return> + <argument index="0" name="val" type="float"> + </argument> + <argument index="1" name="min" type="float"> + </argument> + <argument index="2" name="max" type="float"> + </argument> + <description> + Clamps [code]val[/code] and returns a value not less than [code]min[/code] and not more than [code]max[/code]. + [codeblock] + speed = 1000 + # a is 20 + a = clamp(speed, 1, 20) + + speed = -10 + # a is 1 + a = clamp(speed, 1, 20) + [/codeblock] + </description> + </method> + <method name="convert"> + <return type="Object"> + </return> + <argument index="0" name="what" type="Variant"> + </argument> + <argument index="1" name="type" type="int"> + </argument> + <description> + Converts from a type to another in the best way possible. The [code]type[/code] parameter uses the enum TYPE_* in [@Global Scope]. + [codeblock] + a = Vector2(1, 0) + # prints 1 + print(a.length()) + a = convert(a, TYPE_STRING) + # prints 6 + # (1, 0) is 6 characters + print(a.length()) + [/codeblock] + </description> + </method> + <method name="cos"> + <return type="float"> + </return> + <argument index="0" name="s" type="float"> + </argument> + <description> + Returns the cosine of angle [code]s[/code] in radians. + [codeblock] + # prints 1 and -1 + print(cos(PI*2)) + print(cos(PI)) + [/codeblock] + </description> + </method> + <method name="cosh"> + <return type="float"> + </return> + <argument index="0" name="s" type="float"> + </argument> + <description> + Returns the hyperbolic cosine of [code]s[/code] in radians. + [codeblock] + # prints 1.543081 + print(cosh(1)) + [/codeblock] + </description> + </method> + <method name="db2linear"> + <return type="float"> + </return> + <argument index="0" name="db" type="float"> + </argument> + <description> + Converts from decibels to linear energy (audio). + </description> + </method> + <method name="decimals"> + <return type="float"> + </return> + <argument index="0" name="step" type="float"> + </argument> + <description> + Returns the position of the first non-zero digit, after the decimal point. + [codeblock] + # n is 2 + n = decimals(0.035) + [/codeblock] + </description> + </method> + <method name="dectime"> + <return type="float"> + </return> + <argument index="0" name="value" type="float"> + </argument> + <argument index="1" name="amount" type="float"> + </argument> + <argument index="2" name="step" type="float"> + </argument> + <description> + Returns the result of [code]value[/code] decreased by [code]step[/code] * [code]amount[/code]. + [codeblock] + # a = 59 + a = dectime(60, 10, 0.1)) + [/codeblock] + </description> + </method> + <method name="deg2rad"> + <return type="float"> + </return> + <argument index="0" name="deg" type="float"> + </argument> + <description> + Returns degrees converted to radians. + [codeblock] + # r is 3.141593 + r = deg2rad(180) + [/codeblock] + </description> + </method> + <method name="dict2inst"> + <return type="Object"> + </return> + <argument index="0" name="dict" type="Dictionary"> + </argument> + <description> + Converts a previously converted instance to a dictionary, back into an instance. Useful for deserializing. + </description> + </method> + <method name="ease"> + <return type="float"> + </return> + <argument index="0" name="s" type="float"> + </argument> + <argument index="1" name="curve" type="float"> + </argument> + <description> + Easing function, based on exponent. 0 is constant, 1 is linear, 0 to 1 is ease-in, 1+ is ease out. Negative values are in-out/out in. + </description> + </method> + <method name="exp"> + <return type="float"> + </return> + <argument index="0" name="s" type="float"> + </argument> + <description> + Raises the Euler's constant [b]e[/b] to the power of [code]s[/code] and returns it. [b]e[/b] has an approximate value of 2.71828. + [codeblock] + a = exp(2) # approximately 7.39 + [/codeblock] + </description> + </method> + <method name="floor"> + <return type="float"> + </return> + <argument index="0" name="s" type="float"> + </argument> + <description> + Rounds [code]s[/code] to the closest smaller integer and returns it. + [codeblock] + # a is 2 + a = floor(2.99) + # a is -3 + a = floor(-2.99) + [/codeblock] + </description> + </method> + <method name="fmod"> + <return type="float"> + </return> + <argument index="0" name="x" type="float"> + </argument> + <argument index="1" name="y" type="float"> + </argument> + <description> + Returns the floating-point remainder of [code]x/y[/code]. + [codeblock] + # remainder is 1.5 + var remainder = fmod(7, 5.5) + [/codeblock] + </description> + </method> + <method name="fposmod"> + <return type="float"> + </return> + <argument index="0" name="x" type="float"> + </argument> + <argument index="1" name="y" type="float"> + </argument> + <description> + Returns the floating-point remainder of [code]x/y[/code] that wraps equally in positive and negative. + [codeblock] + var i = -10; + while i < 0: + prints(i, fposmod(i, 10)) + i += 1 + [/codeblock] + Produces: + [codeblock] + -10 10 + -9 1 + -8 2 + -7 3 + -6 4 + -5 5 + -4 6 + -3 7 + -2 8 + -1 9 + [/codeblock] + </description> + </method> + <method name="funcref"> + <return type="Object"> + </return> + <argument index="0" name="instance" type="Object"> + </argument> + <argument index="1" name="funcname" type="String"> + </argument> + <description> + Returns a reference to the specified function [code]funcname[/code] in the [code]instance[/code] node. As functions aren't first-class objects in GDscript, use [code]funcref[/code] to store a [FuncRef] in a variable and call it later. + [codeblock] + func foo(): + return("bar") + + a = funcref(self, "foo") + print(a.call_func()) # prints bar + [/codeblock] + </description> + </method> + <method name="hash"> + <return type="int"> + </return> + <argument index="0" name="var" type="Variant"> + </argument> + <description> + Returns the integer hash of the variable passed. + [codeblock] + print(hash("a")) # prints 177670 + [/codeblock] + </description> + </method> + <method name="inst2dict"> + <return type="Dictionary"> + </return> + <argument index="0" name="inst" type="Object"> + </argument> + <description> + Returns the passed instance converted to a dictionary (useful for serializing). + [codeblock] + var foo = "bar" + func _ready(): + var d = inst2dict(self) + print(d.keys()) + print(d.values()) + [/codeblock] + Prints out: + [codeblock] + [@subpath, @path, foo] + [, res://test.gd, bar] + [/codeblock] + </description> + </method> + <method name="instance_from_id"> + <return type="Object"> + </return> + <argument index="0" name="instance_id" type="int"> + </argument> + <description> + Returns the Object that corresponds to [code]instance_id[/code]. All Objects have a unique instance ID. + [codeblock] + var foo = "bar" + func _ready(): + var id = get_instance_id() + var inst = instance_from_id(id) + print(inst.foo) # prints bar + [/codeblock] + </description> + </method> + <method name="inverse_lerp"> + <return type="float"> + </return> + <argument index="0" name="from" type="float"> + </argument> + <argument index="1" name="to" type="float"> + </argument> + <argument index="2" name="value" type="float"> + </argument> + <description> + Returns a normalized value considering the given range. + [codeblock] + inverse_lerp(3, 5, 4) # returns 0.5 + [/codeblock] + </description> + </method> + <method name="is_inf"> + <return type="bool"> + </return> + <argument index="0" name="s" type="float"> + </argument> + <description> + Returns True/False whether [code]s[/code] is an infinity value (either positive infinity or negative infinity). + </description> + </method> + <method name="is_nan"> + <return type="bool"> + </return> + <argument index="0" name="s" type="float"> + </argument> + <description> + Returns True/False whether [code]s[/code] is a NaN (Not-A-Number) value. + </description> + </method> + <method name="len"> + <return type="int"> + </return> + <argument index="0" name="var" type="Variant"> + </argument> + <description> + Returns length of Variant [code]var[/code]. 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. + [codeblock] + a = [1, 2, 3, 4] + len(a) # returns 4 + [/codeblock] + </description> + </method> + <method name="lerp"> + <return type="float"> + </return> + <argument index="0" name="from" type="float"> + </argument> + <argument index="1" name="to" type="float"> + </argument> + <argument index="2" name="weight" type="float"> + </argument> + <description> + Linearly interpolates between two values by a normalized value. + [codeblock] + lerp(1, 3, 0.5) # returns 2 + [/codeblock] + </description> + </method> + <method name="linear2db"> + <return type="float"> + </return> + <argument index="0" name="nrg" type="float"> + </argument> + <description> + Converts from linear energy to decibels (audio). + </description> + </method> + <method name="load"> + <return type="Object"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + 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". + [codeblock] + # load a scene called main located in the root of the project directory + var main = load("res://main.tscn") + [/codeblock] + </description> + </method> + <method name="log"> + <return type="float"> + </return> + <argument index="0" name="s" type="float"> + </argument> + <description> + 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. + [codeblock] + log(10) # returns 2.302585 + [/codeblock] + </description> + </method> + <method name="max"> + <return type="float"> + </return> + <argument index="0" name="a" type="float"> + </argument> + <argument index="1" name="b" type="float"> + </argument> + <description> + Returns the maximum of two values. + [codeblock] + max(1,2) # returns 2 + max(-3.99, -4) # returns -3.99 + [/codeblock] + </description> + </method> + <method name="min"> + <return type="float"> + </return> + <argument index="0" name="a" type="float"> + </argument> + <argument index="1" name="b" type="float"> + </argument> + <description> + Returns the minimum of two values. + [codeblock] + min(1,2) # returns 1 + min(-3.99, -4) # returns -4 + [/codeblock] + </description> + </method> + <method name="nearest_po2"> + <return type="int"> + </return> + <argument index="0" name="val" type="int"> + </argument> + <description> + Returns the nearest larger power of 2 for integer [code]val[/code]. + [codeblock] + nearest_po2(3) # returns 4 + nearest_po2(4) # returns 4 + nearest_po2(5) # returns 8 + [/codeblock] + </description> + </method> + <method name="parse_json"> + <return type="Variant"> + </return> + <argument index="0" name="json" type="String"> + </argument> + <description> + Parse JSON text to a Variant (use [method 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 all numerical values to [float] types. + [codeblock] + p = parse_json('["a", "b", "c"]') + if typeof(p) == TYPE_ARRAY: + print(p[0]) # prints a + else: + print("unexpected results") + [/codeblock] + </description> + </method> + <method name="pow"> + <return type="float"> + </return> + <argument index="0" name="x" type="float"> + </argument> + <argument index="1" name="y" type="float"> + </argument> + <description> + Returns the result of [code]x[/code] raised to the power of [code]y[/code]. + [codeblock] + pow(2,5) # returns 32 + [/codeblock] + </description> + </method> + <method name="preload"> + <return type="Resource"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + 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". + [codeblock] + # load a scene called main located in the root of the project directory + var main = preload("res://main.tscn") + [/codeblock] + </description> + </method> + <method name="print" qualifiers="vararg"> + <return type="void"> + </return> + <description> + Converts one or more arguments to strings in the best way possible and prints them to the console. + [codeblock] + a = [1,2,3] + print("a","b",a) # prints ab[1, 2, 3] + [/codeblock] + </description> + </method> + <method name="print_stack"> + <return type="void"> + </return> + <description> + Prints a stack track at code location, only works when running with debugger turned on. + Output in the console would look something like this: + [codeblock] + Frame 0 - res://test.gd:16 in function '_process' + [/codeblock] + </description> + </method> + <method name="printerr" qualifiers="vararg"> + <return type="void"> + </return> + <description> + Prints one or more arguments to strings in the best way possible to standard error line. + [codeblock] + printerr("prints to stderr") + [/codeblock] + </description> + </method> + <method name="printraw" qualifiers="vararg"> + <return type="void"> + </return> + <description> + Prints one or more arguments to strings in the best way possible to console. No newline is added at the end. + [codeblock] + printraw("A") + printraw("B") + # prints AB + [/codeblock] + </description> + </method> + <method name="prints" qualifiers="vararg"> + <return type="void"> + </return> + <description> + Prints one or more arguments to the console with a space between each argument. + [codeblock] + prints("A", "B", "C") # prints A B C + [/codeblock] + </description> + </method> + <method name="printt" qualifiers="vararg"> + <return type="void"> + </return> + <description> + Prints one or more arguments to the console with a tab between each argument. + [codeblock] + printt("A", "B", "C") # prints A B C + [/codeblock] + </description> + </method> + <method name="rad2deg"> + <return type="float"> + </return> + <argument index="0" name="rad" type="float"> + </argument> + <description> + Converts from radians to degrees. + [codeblock] + rad2deg(0.523599) # returns 30 + [/codeblock] + </description> + </method> + <method name="rand_range"> + <return type="float"> + </return> + <argument index="0" name="from" type="float"> + </argument> + <argument index="1" name="to" type="float"> + </argument> + <description> + Random range, any floating point value between [code]from[/code] and [code]to[/code]. + [codeblock] + prints(rand_range(0, 1), rand_range(0, 1)) # prints 0.135591 0.405263 + [/codeblock] + </description> + </method> + <method name="rand_seed"> + <return type="Array"> + </return> + <argument index="0" name="seed" type="int"> + </argument> + <description> + Random from seed: pass a [code]seed[/code], 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. + </description> + </method> + <method name="randf"> + <return type="float"> + </return> + <description> + Returns a random floating point value between 0 and 1. + [codeblock] + randf() # returns 0.375671 + [/codeblock] + </description> + </method> + <method name="randi"> + <return type="int"> + </return> + <description> + 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). + [codeblock] + 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 + [/codeblock] + </description> + </method> + <method name="randomize"> + <return type="void"> + </return> + <description> + Randomizes the seed (or the internal state) of the random number generator. Current implementation reseeds using a number based on time. + [codeblock] + func _ready(): + randomize() + [/codeblock] + </description> + </method> + <method name="range" qualifiers="vararg"> + <return type="Array"> + </return> + <description> + 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). + [codeblock] + for i in range(4): + print(i) + for i in range(2, 5): + print(i) + for i in range(0, 6, 2): + print(i) + [/codeblock] + Output: + [codeblock] + 0 + 1 + 2 + 3 + + 2 + 3 + 4 + + 0 + 2 + 4 + [/codeblock] + </description> + </method> + <method name="range_lerp"> + <return type="float"> + </return> + <argument index="0" name="value" type="float"> + </argument> + <argument index="1" name="istart" type="float"> + </argument> + <argument index="2" name="istop" type="float"> + </argument> + <argument index="3" name="ostart" type="float"> + </argument> + <argument index="4" name="ostop" type="float"> + </argument> + <description> + Maps a [code]value[/code] from range [code][istart, istop][/code] to [code][ostart, ostop][/code]. + [codeblock] + range_lerp(75, 0, 100, -1, 1) # returns 0.5 + [/codeblock] + </description> + </method> + <method name="round"> + <return type="float"> + </return> + <argument index="0" name="s" type="float"> + </argument> + <description> + Returns the integral value that is nearest to [code]s[/code], with halfway cases rounded away from zero. + [codeblock] + round(2.6) # returns 3 + [/codeblock] + </description> + </method> + <method name="seed"> + <return type="void"> + </return> + <argument index="0" name="seed" type="int"> + </argument> + <description> + Sets seed for the random number generator. + [codeblock] + my_seed = "Godot Rocks" + seed(my_seed.hash()) + [/codeblock] + </description> + </method> + <method name="sign"> + <return type="float"> + </return> + <argument index="0" name="s" type="float"> + </argument> + <description> + Returns sign of [code]s[/code] -1 or 1. + [codeblock] + sign(-6) # returns -1 + sign(6) # returns 1 + [/codeblock] + </description> + </method> + <method name="sin"> + <return type="float"> + </return> + <argument index="0" name="s" type="float"> + </argument> + <description> + Returns the sine of angle [code]s[/code] in radians. + [codeblock] + sin(0.523599) # returns 0.5 + [/codeblock] + </description> + </method> + <method name="sinh"> + <return type="float"> + </return> + <argument index="0" name="s" type="float"> + </argument> + <description> + Returns the hyperbolic sine of [code]s[/code]. + [codeblock] + a = log(2.0) # returns 0.693147 + sinh(a) # returns 0.75 + [/codeblock] + </description> + </method> + <method name="sqrt"> + <return type="float"> + </return> + <argument index="0" name="s" type="float"> + </argument> + <description> + Returns the square root of [code]s[/code]. + [codeblock] + sqrt(9) # returns 3 + [/codeblock] + </description> + </method> + <method name="stepify"> + <return type="float"> + </return> + <argument index="0" name="s" type="float"> + </argument> + <argument index="1" name="step" type="float"> + </argument> + <description> + Snaps float value [code]s[/code] to a given [code]step[/code]. + </description> + </method> + <method name="str" qualifiers="vararg"> + <return type="String"> + </return> + <description> + Converts one or more arguments to string in the best way possible. + [codeblock] + var a = [10, 20, 30] + var b = str(a); + len(a) # returns 3 + len(b) # returns 12 + [/codeblock] + </description> + </method> + <method name="str2var"> + <return type="Variant"> + </return> + <argument index="0" name="string" type="String"> + </argument> + <description> + Converts a formatted string that was returned by [method var2str] to the original value. + [codeblock] + a = '{ "a": 1, "b": 2 }' + b = str2var(a) + print(b['a']) # prints 1 + [/codeblock] + </description> + </method> + <method name="tan"> + <return type="float"> + </return> + <argument index="0" name="s" type="float"> + </argument> + <description> + Returns the tangent of angle [code]s[/code] in radians. + [codeblock] + tan( deg2rad(45) ) # returns 1 + [/codeblock] + </description> + </method> + <method name="tanh"> + <return type="float"> + </return> + <argument index="0" name="s" type="float"> + </argument> + <description> + Returns the hyperbolic tangent of [code]s[/code]. + [codeblock] + a = log(2.0) # returns 0.693147 + tanh(a) # returns 0.6 + [/codeblock] + </description> + </method> + <method name="to_json"> + <return type="String"> + </return> + <argument index="0" name="var" type="Variant"> + </argument> + <description> + Converts a Variant [code]var[/code] to JSON text and return the result. Useful for serializing data to store or send over the network. + [codeblock] + a = { 'a': 1, 'b': 2 } + b = to_json(a) + print(b) # {"a":1, "b":2} + [/codeblock] + </description> + </method> + <method name="type_exists"> + <return type="bool"> + </return> + <argument index="0" name="type" type="String"> + </argument> + <description> + Returns whether the given class exists in [ClassDB]. + [codeblock] + type_exists("Sprite") # returns true + type_exists("Variant") # returns false + [/codeblock] + </description> + </method> + <method name="typeof"> + <return type="int"> + </return> + <argument index="0" name="what" type="Variant"> + </argument> + <description> + Returns the internal type of the given Variant object, using the TYPE_* enum in [@Global Scope]. + [codeblock] + p = parse_json('["a", "b", "c"]') + if typeof(p) == TYPE_ARRAY: + print(p[0]) # prints a + else: + print("unexpected results") + [/codeblock] + </description> + </method> + <method name="validate_json"> + <return type="String"> + </return> + <argument index="0" name="json" type="String"> + </argument> + <description> + Checks that [code]json[/code] is valid JSON data. Returns empty string if valid. Returns error message if not valid. + [codeblock] + j = to_json([1, 2, 3]) + v = validate_json(j) + if not v: + print("valid") + else: + prints("invalid", v) + [/codeblock] + </description> + </method> + <method name="var2bytes"> + <return type="PoolByteArray"> + </return> + <argument index="0" name="var" type="Variant"> + </argument> + <description> + Encodes a variable value to a byte array. + </description> + </method> + <method name="var2str"> + <return type="String"> + </return> + <argument index="0" name="var" type="Variant"> + </argument> + <description> + Converts a Variant [code]var[/code] to a formatted string that can later be parsed using [method str2var]. + [codeblock] + a = { 'a': 1, 'b': 2 } + print(var2str(a)) + [/codeblock] + prints + [codeblock] + { + "a": 1, + "b": 2 + } + [/codeblock] + </description> + </method> + <method name="weakref"> + <return type="Object"> + </return> + <argument index="0" name="obj" type="Object"> + </argument> + <description> + 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. + </description> + </method> + <method name="yield"> + <return type="GDFunctionState"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="signal" type="String"> + </argument> + <description> + Stops the function execution and returns the current state. Call [method 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. + </description> + </method> + </methods> + <constants> + <constant name="PI" value="3.141593" enum=""> + Constant that represents how many times the diameter of a circumference fits around its perimeter. + </constant> + <constant name="INF" value="inf" enum=""> + A positive infinity. (For negative infinity, use -INF). + </constant> + <constant name="NAN" value="nan" enum=""> + Macro constant that expands to an expression of type float that represents a NaN. + The NaN values are used to identify undefined or non-representable values for floating-point elements, such as the square root of negative numbers or the result of 0/0. + </constant> + </constants> +</class> diff --git a/doc/classes/@Global Scope.xml b/doc/classes/@Global Scope.xml new file mode 100644 index 0000000000..a8fd377ecf --- /dev/null +++ b/doc/classes/@Global Scope.xml @@ -0,0 +1,1235 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="@Global Scope" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Global scope constants and variables. + </brief_description> + <description> + Global scope constants and variables. This is all that resides in the globals, constants regarding error codes, scancodes, property hints, etc. It's not much. + Singletons are also documented here, since they can be accessed from anywhere. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="ARVRServer" type="ARVRServer" setter="" getter=""> + [ARVRServer] singleton + </member> + <member name="AudioServer" type="AudioServer" setter="" getter=""> + [AudioServer] singleton + </member> + <member name="ClassDB" type="ClassDB" setter="" getter=""> + [ClassDB] singleton + </member> + <member name="Engine" type="Engine" setter="" getter=""> + [Engine] singleton + </member> + <member name="Geometry" type="Geometry" setter="" getter=""> + [Geometry] singleton + </member> + <member name="IP" type="IP" setter="" getter=""> + [IP] singleton + </member> + <member name="Input" type="Input" setter="" getter=""> + [Input] singleton + </member> + <member name="InputMap" type="InputMap" setter="" getter=""> + [InputMap] singleton + </member> + <member name="JSON" type="JSON" setter="" getter=""> + </member> + <member name="Marshalls" type="Reference" setter="" getter=""> + [Marshalls] singleton + </member> + <member name="OS" type="OS" setter="" getter=""> + [OS] singleton + </member> + <member name="Performance" type="Performance" setter="" getter=""> + [Performance] singleton + </member> + <member name="Physics2DServer" type="Physics2DServer" setter="" getter=""> + [Physics2DServer] singleton + </member> + <member name="PhysicsServer" type="PhysicsServer" setter="" getter=""> + [PhysicsServer] singleton + </member> + <member name="ProjectSettings" type="ProjectSettings" setter="" getter=""> + [ProjectSettings] singleton + </member> + <member name="ResourceLoader" type="ResourceLoader" setter="" getter=""> + [ResourceLoader] singleton + </member> + <member name="ResourceSaver" type="ResourceSaver" setter="" getter=""> + [ResourceSaver] singleton + </member> + <member name="TranslationServer" type="TranslationServer" setter="" getter=""> + [TranslationServer] singleton + </member> + <member name="VisualServer" type="VisualServer" setter="" getter=""> + [VisualServer] singleton + </member> + </members> + <constants> + <constant name="MARGIN_LEFT" value="0"> + Left margin, used usually for [Control] or [StyleBox] derived classes. + </constant> + <constant name="MARGIN_TOP" value="1"> + Top margin, used usually for [Control] or [StyleBox] derived classes. + </constant> + <constant name="MARGIN_RIGHT" value="2"> + Right margin, used usually for [Control] or [StyleBox] derived classes. + </constant> + <constant name="MARGIN_BOTTOM" value="3"> + Bottom margin, used usually for [Control] or [StyleBox] derived classes. + </constant> + <constant name="VERTICAL" value="1"> + General vertical alignment, used usually for [Separator], [ScrollBar], [Slider], etc. + </constant> + <constant name="HORIZONTAL" value="0"> + General horizontal alignment, used usually for [Separator], [ScrollBar], [Slider], etc. + </constant> + <constant name="HALIGN_LEFT" value="0"> + Horizontal left alignment, usually for text-derived classes. + </constant> + <constant name="HALIGN_CENTER" value="1"> + Horizontal center alignment, usually for text-derived classes. + </constant> + <constant name="HALIGN_RIGHT" value="2"> + Horizontal right alignment, usually for text-derived classes. + </constant> + <constant name="VALIGN_TOP" value="0"> + Vertical top alignment, usually for text-derived classes. + </constant> + <constant name="VALIGN_CENTER" value="1"> + Vertical center alignment, usually for text-derived classes. + </constant> + <constant name="VALIGN_BOTTOM" value="2"> + Vertical bottom alignment, usually for text-derived classes. + </constant> + <constant name="SPKEY" value="16777216" enum=""> + Scancodes with this bit applied are non printable. + </constant> + <constant name="KEY_ESCAPE" value="16777217"> + Escape Key + </constant> + <constant name="KEY_TAB" value="16777218"> + Tab Key + </constant> + <constant name="KEY_BACKTAB" value="16777219"> + Shift-Tab Key + </constant> + <constant name="KEY_BACKSPACE" value="16777220"> + Backspace Key + </constant> + <constant name="KEY_ENTER" value="16777221"> + Return Key (On Main Keyboard) + </constant> + <constant name="KEY_KP_ENTER" value="16777222"> + Enter Key (On Numpad) + </constant> + <constant name="KEY_INSERT" value="16777223"> + Insert Key + </constant> + <constant name="KEY_DELETE" value="16777224"> + Delete Key + </constant> + <constant name="KEY_PAUSE" value="16777225"> + Pause Key + </constant> + <constant name="KEY_PRINT" value="16777226"> + Printscreen Key + </constant> + <constant name="KEY_SYSREQ" value="16777227"> + </constant> + <constant name="KEY_CLEAR" value="16777228"> + </constant> + <constant name="KEY_HOME" value="16777229"> + Home Key + </constant> + <constant name="KEY_END" value="16777230"> + End Key + </constant> + <constant name="KEY_LEFT" value="16777231"> + Left Arrow Key + </constant> + <constant name="KEY_UP" value="16777232"> + Up Arrow Key + </constant> + <constant name="KEY_RIGHT" value="16777233"> + Right Arrow Key + </constant> + <constant name="KEY_DOWN" value="16777234"> + Down Arrow Key + </constant> + <constant name="KEY_PAGEUP" value="16777235"> + Pageup Key + </constant> + <constant name="KEY_PAGEDOWN" value="16777236"> + Pagedown Key + </constant> + <constant name="KEY_SHIFT" value="16777237"> + Shift Key + </constant> + <constant name="KEY_CONTROL" value="16777238"> + Control Key + </constant> + <constant name="KEY_META" value="16777239"> + </constant> + <constant name="KEY_ALT" value="16777240"> + Alt Key + </constant> + <constant name="KEY_CAPSLOCK" value="16777241"> + Capslock Key + </constant> + <constant name="KEY_NUMLOCK" value="16777242"> + Numlock Key + </constant> + <constant name="KEY_SCROLLLOCK" value="16777243"> + Scrolllock Key + </constant> + <constant name="KEY_F1" value="16777244"> + F1 Key + </constant> + <constant name="KEY_F2" value="16777245"> + F2 Key + </constant> + <constant name="KEY_F3" value="16777246"> + F3 Key + </constant> + <constant name="KEY_F4" value="16777247"> + F4 Key + </constant> + <constant name="KEY_F5" value="16777248"> + F5 Key + </constant> + <constant name="KEY_F6" value="16777249"> + F6 Key + </constant> + <constant name="KEY_F7" value="16777250"> + F7 Key + </constant> + <constant name="KEY_F8" value="16777251"> + F8 Key + </constant> + <constant name="KEY_F9" value="16777252"> + F9 Key + </constant> + <constant name="KEY_F10" value="16777253"> + F10 Key + </constant> + <constant name="KEY_F11" value="16777254"> + F11 Key + </constant> + <constant name="KEY_F12" value="16777255"> + F12 Key + </constant> + <constant name="KEY_F13" value="16777256"> + F13 Key + </constant> + <constant name="KEY_F14" value="16777257"> + F14 Key + </constant> + <constant name="KEY_F15" value="16777258"> + F15 Key + </constant> + <constant name="KEY_F16" value="16777259"> + F16 Key + </constant> + <constant name="KEY_KP_MULTIPLY" value="16777345"> + Multiply Key on Numpad + </constant> + <constant name="KEY_KP_DIVIDE" value="16777346"> + Divide Key on Numpad + </constant> + <constant name="KEY_KP_SUBTRACT" value="16777347"> + Subtract Key on Numpad + </constant> + <constant name="KEY_KP_PERIOD" value="16777348"> + Period Key on Numpad + </constant> + <constant name="KEY_KP_ADD" value="16777349"> + Add Key on Numpad + </constant> + <constant name="KEY_KP_0" value="16777350"> + Number 0 on Numpad + </constant> + <constant name="KEY_KP_1" value="16777351"> + Number 1 on Numpad + </constant> + <constant name="KEY_KP_2" value="16777352"> + Number 2 on Numpad + </constant> + <constant name="KEY_KP_3" value="16777353"> + Number 3 on Numpad + </constant> + <constant name="KEY_KP_4" value="16777354"> + Number 4 on Numpad + </constant> + <constant name="KEY_KP_5" value="16777355"> + Number 5 on Numpad + </constant> + <constant name="KEY_KP_6" value="16777356"> + Number 6 on Numpad + </constant> + <constant name="KEY_KP_7" value="16777357"> + Number 7 on Numpad + </constant> + <constant name="KEY_KP_8" value="16777358"> + Number 8 on Numpad + </constant> + <constant name="KEY_KP_9" value="16777359"> + Number 9 on Numpad + </constant> + <constant name="KEY_SUPER_L" value="16777260"> + Super Left key (windows key) + </constant> + <constant name="KEY_SUPER_R" value="16777261"> + Super Left key (windows key) + </constant> + <constant name="KEY_MENU" value="16777262"> + Context menu key + </constant> + <constant name="KEY_HYPER_L" value="16777263"> + </constant> + <constant name="KEY_HYPER_R" value="16777264"> + </constant> + <constant name="KEY_HELP" value="16777265"> + Help key + </constant> + <constant name="KEY_DIRECTION_L" value="16777266"> + </constant> + <constant name="KEY_DIRECTION_R" value="16777267"> + </constant> + <constant name="KEY_BACK" value="16777280"> + Back key + </constant> + <constant name="KEY_FORWARD" value="16777281"> + Forward key + </constant> + <constant name="KEY_STOP" value="16777282"> + Stop key + </constant> + <constant name="KEY_REFRESH" value="16777283"> + Refresh key + </constant> + <constant name="KEY_VOLUMEDOWN" value="16777284"> + Volume down key + </constant> + <constant name="KEY_VOLUMEMUTE" value="16777285"> + Mute volume key + </constant> + <constant name="KEY_VOLUMEUP" value="16777286"> + Volume up key + </constant> + <constant name="KEY_BASSBOOST" value="16777287"> + </constant> + <constant name="KEY_BASSUP" value="16777288"> + </constant> + <constant name="KEY_BASSDOWN" value="16777289"> + </constant> + <constant name="KEY_TREBLEUP" value="16777290"> + </constant> + <constant name="KEY_TREBLEDOWN" value="16777291"> + </constant> + <constant name="KEY_MEDIAPLAY" value="16777292"> + Media play key + </constant> + <constant name="KEY_MEDIASTOP" value="16777293"> + Media stop key + </constant> + <constant name="KEY_MEDIAPREVIOUS" value="16777294"> + Previous song key + </constant> + <constant name="KEY_MEDIANEXT" value="16777295"> + Next song key + </constant> + <constant name="KEY_MEDIARECORD" value="16777296"> + Media record key + </constant> + <constant name="KEY_HOMEPAGE" value="16777297"> + Home page key + </constant> + <constant name="KEY_FAVORITES" value="16777298"> + Favorites key + </constant> + <constant name="KEY_SEARCH" value="16777299"> + Search key + </constant> + <constant name="KEY_STANDBY" value="16777300"> + </constant> + <constant name="KEY_OPENURL" value="16777301"> + </constant> + <constant name="KEY_LAUNCHMAIL" value="16777302"> + </constant> + <constant name="KEY_LAUNCHMEDIA" value="16777303"> + </constant> + <constant name="KEY_LAUNCH0" value="16777304"> + </constant> + <constant name="KEY_LAUNCH1" value="16777305"> + </constant> + <constant name="KEY_LAUNCH2" value="16777306"> + </constant> + <constant name="KEY_LAUNCH3" value="16777307"> + </constant> + <constant name="KEY_LAUNCH4" value="16777308"> + </constant> + <constant name="KEY_LAUNCH5" value="16777309"> + </constant> + <constant name="KEY_LAUNCH6" value="16777310"> + </constant> + <constant name="KEY_LAUNCH7" value="16777311"> + </constant> + <constant name="KEY_LAUNCH8" value="16777312"> + </constant> + <constant name="KEY_LAUNCH9" value="16777313"> + </constant> + <constant name="KEY_LAUNCHA" value="16777314"> + </constant> + <constant name="KEY_LAUNCHB" value="16777315"> + </constant> + <constant name="KEY_LAUNCHC" value="16777316"> + </constant> + <constant name="KEY_LAUNCHD" value="16777317"> + </constant> + <constant name="KEY_LAUNCHE" value="16777318"> + </constant> + <constant name="KEY_LAUNCHF" value="16777319"> + </constant> + <constant name="KEY_UNKNOWN" value="33554431"> + </constant> + <constant name="KEY_SPACE" value="32"> + Space Key + </constant> + <constant name="KEY_EXCLAM" value="33"> + ! key + </constant> + <constant name="KEY_QUOTEDBL" value="34"> + " key + </constant> + <constant name="KEY_NUMBERSIGN" value="35"> + # key + </constant> + <constant name="KEY_DOLLAR" value="36"> + $ key + </constant> + <constant name="KEY_PERCENT" value="37"> + % key + </constant> + <constant name="KEY_AMPERSAND" value="38"> + & key + </constant> + <constant name="KEY_APOSTROPHE" value="39"> + ' key + </constant> + <constant name="KEY_PARENLEFT" value="40"> + ( key + </constant> + <constant name="KEY_PARENRIGHT" value="41"> + ) key + </constant> + <constant name="KEY_ASTERISK" value="42"> + * key + </constant> + <constant name="KEY_PLUS" value="43"> + + key + </constant> + <constant name="KEY_COMMA" value="44"> + , key + </constant> + <constant name="KEY_MINUS" value="45"> + - key + </constant> + <constant name="KEY_PERIOD" value="46"> + . key + </constant> + <constant name="KEY_SLASH" value="47"> + / key + </constant> + <constant name="KEY_0" value="48"> + Number 0 + </constant> + <constant name="KEY_1" value="49"> + Number 1 + </constant> + <constant name="KEY_2" value="50"> + Number 2 + </constant> + <constant name="KEY_3" value="51"> + Number 3 + </constant> + <constant name="KEY_4" value="52"> + Number 4 + </constant> + <constant name="KEY_5" value="53"> + Number 5 + </constant> + <constant name="KEY_6" value="54"> + Number 6 + </constant> + <constant name="KEY_7" value="55"> + Number 7 + </constant> + <constant name="KEY_8" value="56"> + Number 8 + </constant> + <constant name="KEY_9" value="57"> + Number 9 + </constant> + <constant name="KEY_COLON" value="58"> + : key + </constant> + <constant name="KEY_SEMICOLON" value="59"> + ; key + </constant> + <constant name="KEY_LESS" value="60"> + Lower than key + </constant> + <constant name="KEY_EQUAL" value="61"> + = key + </constant> + <constant name="KEY_GREATER" value="62"> + Greater than key + </constant> + <constant name="KEY_QUESTION" value="63"> + ? key + </constant> + <constant name="KEY_AT" value="64"> + @ key + </constant> + <constant name="KEY_A" value="65"> + A Key + </constant> + <constant name="KEY_B" value="66"> + B Key + </constant> + <constant name="KEY_C" value="67"> + C Key + </constant> + <constant name="KEY_D" value="68"> + D Key + </constant> + <constant name="KEY_E" value="69"> + E Key + </constant> + <constant name="KEY_F" value="70"> + F Key + </constant> + <constant name="KEY_G" value="71"> + G Key + </constant> + <constant name="KEY_H" value="72"> + H Key + </constant> + <constant name="KEY_I" value="73"> + I Key + </constant> + <constant name="KEY_J" value="74"> + J Key + </constant> + <constant name="KEY_K" value="75"> + K Key + </constant> + <constant name="KEY_L" value="76"> + L Key + </constant> + <constant name="KEY_M" value="77"> + M Key + </constant> + <constant name="KEY_N" value="78"> + N Key + </constant> + <constant name="KEY_O" value="79"> + O Key + </constant> + <constant name="KEY_P" value="80"> + P Key + </constant> + <constant name="KEY_Q" value="81"> + Q Key + </constant> + <constant name="KEY_R" value="82"> + R Key + </constant> + <constant name="KEY_S" value="83"> + S Key + </constant> + <constant name="KEY_T" value="84"> + T Key + </constant> + <constant name="KEY_U" value="85"> + U Key + </constant> + <constant name="KEY_V" value="86"> + V Key + </constant> + <constant name="KEY_W" value="87"> + W Key + </constant> + <constant name="KEY_X" value="88"> + X Key + </constant> + <constant name="KEY_Y" value="89"> + Y Key + </constant> + <constant name="KEY_Z" value="90"> + Z Key + </constant> + <constant name="KEY_BRACKETLEFT" value="91"> + [ key + </constant> + <constant name="KEY_BACKSLASH" value="92"> + \ key + </constant> + <constant name="KEY_BRACKETRIGHT" value="93"> + ] key + </constant> + <constant name="KEY_ASCIICIRCUM" value="94"> + ^ key + </constant> + <constant name="KEY_UNDERSCORE" value="95"> + _ key + </constant> + <constant name="KEY_QUOTELEFT" value="96"> + </constant> + <constant name="KEY_BRACELEFT" value="123"> + { key + </constant> + <constant name="KEY_BAR" value="124"> + | key + </constant> + <constant name="KEY_BRACERIGHT" value="125"> + } key + </constant> + <constant name="KEY_ASCIITILDE" value="126"> + ~ key + </constant> + <constant name="KEY_NOBREAKSPACE" value="160"> + </constant> + <constant name="KEY_EXCLAMDOWN" value="161"> + </constant> + <constant name="KEY_CENT" value="162"> + ¢ key + </constant> + <constant name="KEY_STERLING" value="163"> + </constant> + <constant name="KEY_CURRENCY" value="164"> + </constant> + <constant name="KEY_YEN" value="165"> + </constant> + <constant name="KEY_BROKENBAR" value="166"> + ¦ key + </constant> + <constant name="KEY_SECTION" value="167"> + § key + </constant> + <constant name="KEY_DIAERESIS" value="168"> + ¨ key + </constant> + <constant name="KEY_COPYRIGHT" value="169"> + © key + </constant> + <constant name="KEY_ORDFEMININE" value="170"> + </constant> + <constant name="KEY_GUILLEMOTLEFT" value="171"> + « key + </constant> + <constant name="KEY_NOTSIGN" value="172"> + » key + </constant> + <constant name="KEY_HYPHEN" value="173"> + ‐ key + </constant> + <constant name="KEY_REGISTERED" value="174"> + ® key + </constant> + <constant name="KEY_MACRON" value="175"> + </constant> + <constant name="KEY_DEGREE" value="176"> + ° key + </constant> + <constant name="KEY_PLUSMINUS" value="177"> + ± key + </constant> + <constant name="KEY_TWOSUPERIOR" value="178"> + ² key + </constant> + <constant name="KEY_THREESUPERIOR" value="179"> + ³ key + </constant> + <constant name="KEY_ACUTE" value="180"> + ´ key + </constant> + <constant name="KEY_MU" value="181"> + µ key + </constant> + <constant name="KEY_PARAGRAPH" value="182"> + </constant> + <constant name="KEY_PERIODCENTERED" value="183"> + · key + </constant> + <constant name="KEY_CEDILLA" value="184"> + ¬ key + </constant> + <constant name="KEY_ONESUPERIOR" value="185"> + </constant> + <constant name="KEY_MASCULINE" value="186"> + </constant> + <constant name="KEY_GUILLEMOTRIGHT" value="187"> + </constant> + <constant name="KEY_ONEQUARTER" value="188"> + </constant> + <constant name="KEY_ONEHALF" value="189"> + ½ key + </constant> + <constant name="KEY_THREEQUARTERS" value="190"> + </constant> + <constant name="KEY_QUESTIONDOWN" value="191"> + </constant> + <constant name="KEY_AGRAVE" value="192"> + </constant> + <constant name="KEY_AACUTE" value="193"> + </constant> + <constant name="KEY_ACIRCUMFLEX" value="194"> + </constant> + <constant name="KEY_ATILDE" value="195"> + </constant> + <constant name="KEY_ADIAERESIS" value="196"> + </constant> + <constant name="KEY_ARING" value="197"> + </constant> + <constant name="KEY_AE" value="198"> + </constant> + <constant name="KEY_CCEDILLA" value="199"> + </constant> + <constant name="KEY_EGRAVE" value="200"> + </constant> + <constant name="KEY_EACUTE" value="201"> + </constant> + <constant name="KEY_ECIRCUMFLEX" value="202"> + </constant> + <constant name="KEY_EDIAERESIS" value="203"> + </constant> + <constant name="KEY_IGRAVE" value="204"> + </constant> + <constant name="KEY_IACUTE" value="205"> + </constant> + <constant name="KEY_ICIRCUMFLEX" value="206"> + </constant> + <constant name="KEY_IDIAERESIS" value="207"> + </constant> + <constant name="KEY_ETH" value="208"> + </constant> + <constant name="KEY_NTILDE" value="209"> + </constant> + <constant name="KEY_OGRAVE" value="210"> + </constant> + <constant name="KEY_OACUTE" value="211"> + </constant> + <constant name="KEY_OCIRCUMFLEX" value="212"> + </constant> + <constant name="KEY_OTILDE" value="213"> + </constant> + <constant name="KEY_ODIAERESIS" value="214"> + </constant> + <constant name="KEY_MULTIPLY" value="215"> + </constant> + <constant name="KEY_OOBLIQUE" value="216"> + </constant> + <constant name="KEY_UGRAVE" value="217"> + </constant> + <constant name="KEY_UACUTE" value="218"> + </constant> + <constant name="KEY_UCIRCUMFLEX" value="219"> + </constant> + <constant name="KEY_UDIAERESIS" value="220"> + </constant> + <constant name="KEY_YACUTE" value="221"> + </constant> + <constant name="KEY_THORN" value="222"> + </constant> + <constant name="KEY_SSHARP" value="223"> + </constant> + <constant name="KEY_DIVISION" value="247"> + </constant> + <constant name="KEY_YDIAERESIS" value="255"> + </constant> + <constant name="KEY_CODE_MASK" value="33554431"> + </constant> + <constant name="KEY_MODIFIER_MASK" value="-16777216"> + </constant> + <constant name="KEY_MASK_SHIFT" value="33554432"> + </constant> + <constant name="KEY_MASK_ALT" value="67108864"> + </constant> + <constant name="KEY_MASK_META" value="134217728"> + </constant> + <constant name="KEY_MASK_CTRL" value="268435456"> + </constant> + <constant name="KEY_MASK_CMD" value="268435456"> + </constant> + <constant name="KEY_MASK_KPAD" value="536870912"> + </constant> + <constant name="KEY_MASK_GROUP_SWITCH" value="1073741824"> + </constant> + <constant name="BUTTON_LEFT" value="1" enum=""> + Left Mouse Button + </constant> + <constant name="BUTTON_RIGHT" value="2" enum=""> + Right Mouse Button + </constant> + <constant name="BUTTON_MIDDLE" value="3" enum=""> + Middle Mouse Button + </constant> + <constant name="BUTTON_WHEEL_UP" value="4" enum=""> + Mouse wheel up + </constant> + <constant name="BUTTON_WHEEL_DOWN" value="5" enum=""> + Mouse wheel down + </constant> + <constant name="BUTTON_WHEEL_LEFT" value="6" enum=""> + Mouse wheel left button + </constant> + <constant name="BUTTON_WHEEL_RIGHT" value="7" enum=""> + Mouse wheel right button + </constant> + <constant name="BUTTON_MASK_LEFT" value="1" enum=""> + </constant> + <constant name="BUTTON_MASK_RIGHT" value="2" enum=""> + </constant> + <constant name="BUTTON_MASK_MIDDLE" value="4" enum=""> + </constant> + <constant name="JOY_BUTTON_0" value="0" enum=""> + Joypad Button 0 + </constant> + <constant name="JOY_BUTTON_1" value="1" enum=""> + Joypad Button 1 + </constant> + <constant name="JOY_BUTTON_2" value="2" enum=""> + Joypad Button 2 + </constant> + <constant name="JOY_BUTTON_3" value="3" enum=""> + Joypad Button 3 + </constant> + <constant name="JOY_BUTTON_4" value="4" enum=""> + Joypad Button 4 + </constant> + <constant name="JOY_BUTTON_5" value="5" enum=""> + Joypad Button 5 + </constant> + <constant name="JOY_BUTTON_6" value="6" enum=""> + Joypad Button 6 + </constant> + <constant name="JOY_BUTTON_7" value="7" enum=""> + Joypad Button 7 + </constant> + <constant name="JOY_BUTTON_8" value="8" enum=""> + Joypad Button 8 + </constant> + <constant name="JOY_BUTTON_9" value="9" enum=""> + Joypad Button 9 + </constant> + <constant name="JOY_BUTTON_10" value="10" enum=""> + Joypad Button 10 + </constant> + <constant name="JOY_BUTTON_11" value="11" enum=""> + Joypad Button 11 + </constant> + <constant name="JOY_BUTTON_12" value="12" enum=""> + Joypad Button 12 + </constant> + <constant name="JOY_BUTTON_13" value="13" enum=""> + Joypad Button 13 + </constant> + <constant name="JOY_BUTTON_14" value="14" enum=""> + Joypad Button 14 + </constant> + <constant name="JOY_BUTTON_15" value="15" enum=""> + Joypad Button 15 + </constant> + <constant name="JOY_BUTTON_MAX" value="16" enum=""> + Joypad Button 16 + </constant> + <constant name="JOY_SONY_CIRCLE" value="1" enum=""> + DUALSHOCK circle button + </constant> + <constant name="JOY_SONY_X" value="0" enum=""> + DUALSHOCK X button + </constant> + <constant name="JOY_SONY_SQUARE" value="2" enum=""> + DUALSHOCK square button + </constant> + <constant name="JOY_SONY_TRIANGLE" value="3" enum=""> + DUALSHOCK triangle button + </constant> + <constant name="JOY_XBOX_B" value="1" enum=""> + XBOX controller B button + </constant> + <constant name="JOY_XBOX_A" value="0" enum=""> + XBOX controller A button + </constant> + <constant name="JOY_XBOX_X" value="2" enum=""> + XBOX controller X button + </constant> + <constant name="JOY_XBOX_Y" value="3" enum=""> + XBOX controller Y button + </constant> + <constant name="JOY_DS_A" value="1" enum=""> + </constant> + <constant name="JOY_DS_B" value="0" enum=""> + </constant> + <constant name="JOY_DS_X" value="3" enum=""> + </constant> + <constant name="JOY_DS_Y" value="2" enum=""> + </constant> + <constant name="JOY_SELECT" value="10" enum=""> + Joypad Button Select + </constant> + <constant name="JOY_START" value="11" enum=""> + Joypad Button Start + </constant> + <constant name="JOY_DPAD_UP" value="12" enum=""> + Joypad DPad Up + </constant> + <constant name="JOY_DPAD_DOWN" value="13" enum=""> + Joypad DPad Down + </constant> + <constant name="JOY_DPAD_LEFT" value="14" enum=""> + Joypad DPad Left + </constant> + <constant name="JOY_DPAD_RIGHT" value="15" enum=""> + Joypad DPad Right + </constant> + <constant name="JOY_L" value="4" enum=""> + Joypad Left Shoulder Button + </constant> + <constant name="JOY_L2" value="6" enum=""> + Joypad Left Trigger + </constant> + <constant name="JOY_L3" value="8" enum=""> + Joypad Left Stick Click + </constant> + <constant name="JOY_R" value="5" enum=""> + Joypad Right Shoulder Button + </constant> + <constant name="JOY_R2" value="7" enum=""> + Joypad Right Trigger + </constant> + <constant name="JOY_R3" value="9" enum=""> + Joypad Right Stick Click + </constant> + <constant name="JOY_AXIS_0" value="0" enum=""> + Joypad Left Stick Horizontal Axis + </constant> + <constant name="JOY_AXIS_1" value="1" enum=""> + Joypad Left Stick Vertical Axis + </constant> + <constant name="JOY_AXIS_2" value="2" enum=""> + Joypad Right Stick Horizontal Axis + </constant> + <constant name="JOY_AXIS_3" value="3" enum=""> + Joypad Right Stick Vertical Axis + </constant> + <constant name="JOY_AXIS_4" value="4" enum=""> + </constant> + <constant name="JOY_AXIS_5" value="5" enum=""> + </constant> + <constant name="JOY_AXIS_6" value="6" enum=""> + Joypad Left Trigger Analog Axis + </constant> + <constant name="JOY_AXIS_7" value="7" enum=""> + Joypad Right Trigger Analog Axis + </constant> + <constant name="JOY_AXIS_MAX" value="8" enum=""> + </constant> + <constant name="JOY_ANALOG_LX" value="0" enum=""> + Joypad Left Stick Horizontal Axis + </constant> + <constant name="JOY_ANALOG_LY" value="1" enum=""> + Joypad Left Stick Vertical Axis + </constant> + <constant name="JOY_ANALOG_RX" value="2" enum=""> + Joypad Right Stick Horizontal Axis + </constant> + <constant name="JOY_ANALOG_RY" value="3" enum=""> + Joypad Right Stick Vertical Axis + </constant> + <constant name="JOY_ANALOG_L2" value="6" enum=""> + </constant> + <constant name="JOY_ANALOG_R2" value="7" enum=""> + </constant> + <constant name="OK" value="0"> + Functions that return Error return OK when everything went ok. Most functions don't return error anyway and/or just print errors to stdout. + </constant> + <constant name="FAILED" value="1"> + Generic fail return error. + </constant> + <constant name="ERR_UNAVAILABLE" value="2"> + </constant> + <constant name="ERR_UNCONFIGURED" value="3"> + </constant> + <constant name="ERR_UNAUTHORIZED" value="4"> + </constant> + <constant name="ERR_PARAMETER_RANGE_ERROR" value="5"> + </constant> + <constant name="ERR_OUT_OF_MEMORY" value="6"> + </constant> + <constant name="ERR_FILE_NOT_FOUND" value="7"> + </constant> + <constant name="ERR_FILE_BAD_DRIVE" value="8"> + </constant> + <constant name="ERR_FILE_BAD_PATH" value="9"> + </constant> + <constant name="ERR_FILE_NO_PERMISSION" value="10"> + </constant> + <constant name="ERR_FILE_ALREADY_IN_USE" value="11"> + </constant> + <constant name="ERR_FILE_CANT_OPEN" value="12"> + </constant> + <constant name="ERR_FILE_CANT_WRITE" value="13"> + </constant> + <constant name="ERR_FILE_CANT_READ" value="14"> + </constant> + <constant name="ERR_FILE_UNRECOGNIZED" value="15"> + </constant> + <constant name="ERR_FILE_CORRUPT" value="16"> + </constant> + <constant name="ERR_FILE_MISSING_DEPENDENCIES" value="17"> + </constant> + <constant name="ERR_FILE_EOF" value="18"> + </constant> + <constant name="ERR_CANT_OPEN" value="19"> + </constant> + <constant name="ERR_CANT_CREATE" value="20"> + </constant> + <constant name="ERR_PARSE_ERROR" value="43"> + </constant> + <constant name="ERR_QUERY_FAILED" value="21"> + </constant> + <constant name="ERR_ALREADY_IN_USE" value="22"> + </constant> + <constant name="ERR_LOCKED" value="23"> + </constant> + <constant name="ERR_TIMEOUT" value="24"> + </constant> + <constant name="ERR_CANT_AQUIRE_RESOURCE" value="28"> + </constant> + <constant name="ERR_INVALID_DATA" value="30"> + </constant> + <constant name="ERR_INVALID_PARAMETER" value="31"> + </constant> + <constant name="ERR_ALREADY_EXISTS" value="32"> + </constant> + <constant name="ERR_DOES_NOT_EXIST" value="33"> + </constant> + <constant name="ERR_DATABASE_CANT_READ" value="34"> + </constant> + <constant name="ERR_DATABASE_CANT_WRITE" value="35"> + </constant> + <constant name="ERR_COMPILATION_FAILED" value="36"> + </constant> + <constant name="ERR_METHOD_NOT_FOUND" value="37"> + </constant> + <constant name="ERR_LINK_FAILED" value="38"> + </constant> + <constant name="ERR_SCRIPT_FAILED" value="39"> + </constant> + <constant name="ERR_CYCLIC_LINK" value="40"> + </constant> + <constant name="ERR_BUSY" value="44"> + </constant> + <constant name="ERR_HELP" value="46"> + </constant> + <constant name="ERR_BUG" value="47"> + </constant> + <constant name="ERR_WTF" value="49"> + </constant> + <constant name="PROPERTY_HINT_NONE" value="0"> + No hint for edited property. + </constant> + <constant name="PROPERTY_HINT_RANGE" value="1"> + Hints that the string is a range, defined as "min,max" or "min,max,step". This is valid for integers and floats. + </constant> + <constant name="PROPERTY_HINT_EXP_RANGE" value="2"> + Hints that the string is an exponential range, defined as "min,max" or "min,max,step". This is valid for integers and floats. + </constant> + <constant name="PROPERTY_HINT_ENUM" value="3"> + Property hint for an enumerated value, like "Hello,Something,Else". This is valid for integer, float and string properties. + </constant> + <constant name="PROPERTY_HINT_EXP_EASING" value="4"> + </constant> + <constant name="PROPERTY_HINT_LENGTH" value="5"> + </constant> + <constant name="PROPERTY_HINT_KEY_ACCEL" value="7"> + </constant> + <constant name="PROPERTY_HINT_FLAGS" value="8"> + Property hint for a bitmask description, for bits 0,1,2,3 and 5 the hint would be like "Bit0,Bit1,Bit2,Bit3,,Bit5". Valid only for integers. + </constant> + <constant name="PROPERTY_HINT_LAYERS_2D_RENDER" value="9"> + </constant> + <constant name="PROPERTY_HINT_LAYERS_2D_PHYSICS" value="10"> + </constant> + <constant name="PROPERTY_HINT_LAYERS_3D_RENDER" value="11"> + </constant> + <constant name="PROPERTY_HINT_LAYERS_3D_PHYSICS" value="12"> + </constant> + <constant name="PROPERTY_HINT_FILE" value="13"> + String property is a file (so pop up a file dialog when edited). Hint string can be a set of wildcards like "*.doc". + </constant> + <constant name="PROPERTY_HINT_DIR" value="14"> + String property is a directory (so pop up a file dialog when edited). + </constant> + <constant name="PROPERTY_HINT_GLOBAL_FILE" value="15"> + </constant> + <constant name="PROPERTY_HINT_GLOBAL_DIR" value="16"> + </constant> + <constant name="PROPERTY_HINT_RESOURCE_TYPE" value="17"> + String property is a resource, so open the resource popup menu when edited. + </constant> + <constant name="PROPERTY_HINT_MULTILINE_TEXT" value="18"> + </constant> + <constant name="PROPERTY_HINT_COLOR_NO_ALPHA" value="19"> + </constant> + <constant name="PROPERTY_HINT_IMAGE_COMPRESS_LOSSY" value="20"> + </constant> + <constant name="PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS" value="21"> + </constant> + <constant name="PROPERTY_USAGE_STORAGE" value="1"> + Property will be used as storage (default). + </constant> + <constant name="PROPERTY_USAGE_EDITOR" value="2"> + Property will be visible in editor (default). + </constant> + <constant name="PROPERTY_USAGE_NETWORK" value="4"> + </constant> + <constant name="PROPERTY_USAGE_EDITOR_HELPER" value="8"> + </constant> + <constant name="PROPERTY_USAGE_CHECKABLE" value="16"> + </constant> + <constant name="PROPERTY_USAGE_CHECKED" value="32"> + </constant> + <constant name="PROPERTY_USAGE_INTERNATIONALIZED" value="64"> + </constant> + <constant name="PROPERTY_USAGE_GROUP" value="128"> + </constant> + <constant name="PROPERTY_USAGE_CATEGORY" value="256"> + </constant> + <constant name="PROPERTY_USAGE_STORE_IF_NONZERO" value="512"> + </constant> + <constant name="PROPERTY_USAGE_STORE_IF_NONONE" value="1024"> + </constant> + <constant name="PROPERTY_USAGE_NO_INSTANCE_STATE" value="2048"> + </constant> + <constant name="PROPERTY_USAGE_RESTART_IF_CHANGED" value="4096"> + </constant> + <constant name="PROPERTY_USAGE_SCRIPT_VARIABLE" value="8192"> + </constant> + <constant name="PROPERTY_USAGE_DEFAULT" value="7"> + Default usage (storage and editor). + </constant> + <constant name="PROPERTY_USAGE_DEFAULT_INTL" value="71"> + </constant> + <constant name="PROPERTY_USAGE_NOEDITOR" value="5"> + </constant> + <constant name="METHOD_FLAG_NORMAL" value="1"> + </constant> + <constant name="METHOD_FLAG_EDITOR" value="2"> + </constant> + <constant name="METHOD_FLAG_NOSCRIPT" value="4"> + </constant> + <constant name="METHOD_FLAG_CONST" value="8"> + </constant> + <constant name="METHOD_FLAG_REVERSE" value="16"> + </constant> + <constant name="METHOD_FLAG_VIRTUAL" value="32"> + </constant> + <constant name="METHOD_FLAG_FROM_SCRIPT" value="64"> + </constant> + <constant name="METHOD_FLAGS_DEFAULT" value="1"> + </constant> + <constant name="TYPE_NIL" value="0"> + Variable is of type nil (only applied for null). + </constant> + <constant name="TYPE_BOOL" value="1"> + Variable is of type [bool]. + </constant> + <constant name="TYPE_INT" value="2"> + Variable is of type [int]. + </constant> + <constant name="TYPE_REAL" value="3"> + Variable is of type [float]/real. + </constant> + <constant name="TYPE_STRING" value="4"> + Variable is of type [String]. + </constant> + <constant name="TYPE_VECTOR2" value="5"> + Variable is of type [Vector2]. + </constant> + <constant name="TYPE_RECT2" value="6"> + Variable is of type [Rect2]. + </constant> + <constant name="TYPE_VECTOR3" value="7"> + Variable is of type [Vector3]. + </constant> + <constant name="TYPE_TRANSFORM2D" value="8"> + Variable is of type [Transform2D]. + </constant> + <constant name="TYPE_PLANE" value="9"> + Variable is of type [Plane]. + </constant> + <constant name="TYPE_QUAT" value="10"> + Variable is of type [Quat]. + </constant> + <constant name="TYPE_RECT3" value="11"> + Variable is of type [Rect3]. + </constant> + <constant name="TYPE_BASIS" value="12"> + Variable is of type [Basis]. + </constant> + <constant name="TYPE_TRANSFORM" value="13"> + Variable is of type [Transform]. + </constant> + <constant name="TYPE_COLOR" value="14"> + Variable is of type [Color]. + </constant> + <constant name="TYPE_NODE_PATH" value="15"> + Variable is of type [NodePath]. + </constant> + <constant name="TYPE_RID" value="16"> + Variable is of type [RID]. + </constant> + <constant name="TYPE_OBJECT" value="17"> + Variable is of type [Object]. + </constant> + <constant name="TYPE_DICTIONARY" value="18"> + Variable is of type [Dictionary]. + </constant> + <constant name="TYPE_ARRAY" value="19"> + Variable is of type [Array]. + </constant> + <constant name="TYPE_RAW_ARRAY" value="20"> + Variable is of type [PoolByteArray]. + </constant> + <constant name="TYPE_INT_ARRAY" value="21"> + Variable is of type [PoolIntArray]. + </constant> + <constant name="TYPE_REAL_ARRAY" value="22"> + Variable is of type [PoolRealArray]. + </constant> + <constant name="TYPE_STRING_ARRAY" value="23"> + Variable is of type [PoolStringArray]. + </constant> + <constant name="TYPE_VECTOR2_ARRAY" value="24"> + Variable is of type [PoolVector2Array]. + </constant> + <constant name="TYPE_VECTOR3_ARRAY" value="25"> + Variable is of type [PoolVector3Array]. + </constant> + <constant name="TYPE_COLOR_ARRAY" value="26"> + Variable is of type [PoolColorArray]. + </constant> + <constant name="TYPE_MAX" value="27"> + </constant> + </constants> +</class> diff --git a/doc/classes/@NativeScript.xml b/doc/classes/@NativeScript.xml new file mode 100644 index 0000000000..03e6416b19 --- /dev/null +++ b/doc/classes/@NativeScript.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="@NativeScript" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/@VisualScript.xml b/doc/classes/@VisualScript.xml new file mode 100644 index 0000000000..2392e3ecca --- /dev/null +++ b/doc/classes/@VisualScript.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="@VisualScript" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/ARVRAnchor.xml b/doc/classes/ARVRAnchor.xml new file mode 100644 index 0000000000..4ff39390b2 --- /dev/null +++ b/doc/classes/ARVRAnchor.xml @@ -0,0 +1,60 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ARVRAnchor" inherits="Spatial" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Anchor point in AR Space + </brief_description> + <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. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_anchor_id" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the anchor id for this anchor. + </description> + </method> + <method name="get_anchor_name" qualifiers="const"> + <return type="String"> + </return> + <description> + Returns the name given to this anchor. + </description> + </method> + <method name="get_is_active" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns true if the anchor is being tracked and false if no anchor with this id is currently known. + </description> + </method> + <method name="get_size" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + 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. + </description> + </method> + <method name="set_anchor_id"> + <return type="void"> + </return> + <argument index="0" name="anchor_id" type="int"> + </argument> + <description> + 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. + </description> + </method> + </methods> + <members> + <member name="anchor_id" type="int" setter="set_anchor_id" getter="get_anchor_id"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/ARVRCamera.xml b/doc/classes/ARVRCamera.xml new file mode 100644 index 0000000000..e6817d3417 --- /dev/null +++ b/doc/classes/ARVRCamera.xml @@ -0,0 +1,18 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ARVRCamera" inherits="Camera" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + A camera node with a few overrules for AR/VR applied such as location tracking. + </brief_description> + <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. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/ARVRController.xml b/doc/classes/ARVRController.xml new file mode 100644 index 0000000000..557f915c1d --- /dev/null +++ b/doc/classes/ARVRController.xml @@ -0,0 +1,100 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ARVRController" inherits="Spatial" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + A spatial node representing a spatially tracked controller. + </brief_description> + <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. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_controller_id" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the controller id currently assigned to this node. + </description> + </method> + <method name="get_controller_name" qualifiers="const"> + <return type="String"> + </return> + <description> + If active, returns the name of the associated controller if provided by the AR/VR SDK used. + </description> + </method> + <method name="get_hand" qualifiers="const"> + <return type="int" enum="ARVRPositionalTracker.TrackerHand"> + </return> + <description> + </description> + </method> + <method name="get_is_active" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns true if the controller bound to this node is currently active and being tracked. + </description> + </method> + <method name="get_joystick_axis" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="axis" type="int"> + </argument> + <description> + Returns the value of the given axis for things like triggers, touchpads, etc. that are embedded into the controller. + </description> + </method> + <method name="get_joystick_id" qualifiers="const"> + <return type="int"> + </return> + <description> + 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. + </description> + </method> + <method name="is_button_pressed" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="button" type="int"> + </argument> + <description> + Is the given button currently pressed? + </description> + </method> + <method name="set_controller_id"> + <return type="void"> + </return> + <argument index="0" name="controller_id" type="int"> + </argument> + <description> + 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. + </description> + </method> + </methods> + <members> + <member name="controller_id" type="int" setter="set_controller_id" getter="get_controller_id"> + </member> + </members> + <signals> + <signal name="button_pressed"> + <argument index="0" name="button" type="int"> + </argument> + <description> + When a button on this controller is pressed, this signal is given. + </description> + </signal> + <signal name="button_release"> + <argument index="0" name="button" type="int"> + </argument> + <description> + When a button on this controller is released, this signal is given. + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/ARVRInterface.xml b/doc/classes/ARVRInterface.xml new file mode 100644 index 0000000000..fad9571628 --- /dev/null +++ b/doc/classes/ARVRInterface.xml @@ -0,0 +1,107 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ARVRInterface" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base class for ARVR interface implementation. + </brief_description> + <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. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_name" qualifiers="const"> + <return type="String"> + </return> + <description> + Returns the name of this interface (OpenVR, OpenHMD, ARKit, etc). + </description> + </method> + <method name="get_recommended_render_targetsize"> + <return type="Vector2"> + </return> + <description> + Returns the resolution at which we should render our intermediate results before things like lens distortion are applied by the VR platform. + </description> + </method> + <method name="hmd_is_present"> + <return type="bool"> + </return> + <description> + Returns true if an HMD is available for this interface. + </description> + </method> + <method name="initialize"> + <return type="bool"> + </return> + <description> + 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. + </description> + </method> + <method name="is_initialized"> + <return type="bool"> + </return> + <description> + Returns true if this interface is active. + </description> + </method> + <method name="is_installed"> + <return type="bool"> + </return> + <description> + 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. + </description> + </method> + <method name="is_primary"> + <return type="bool"> + </return> + <description> + Returns true if this interface is currently the primary interface (the interface responsible for showing the output). + </description> + </method> + <method name="set_is_primary"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set this interface to the primary interface (unset the old one). + </description> + </method> + <method name="supports_hmd"> + <return type="bool"> + </return> + <description> + Returns true if this interface supports HMDs and by extension uses stereo scopic rendering. + </description> + </method> + <method name="uninitialize"> + <return type="void"> + </return> + <description> + Turns the interface off. + </description> + </method> + </methods> + <members> + <member name="primary" type="bool" setter="set_is_primary" getter="is_primary"> + </member> + </members> + <constants> + <constant name="EYE_MONO" value="0"> + Mono output, this is mostly used internally when retrieving positioning information for our camera node or when stereo scopic rendering is not supported. + </constant> + <constant name="EYE_LEFT" value="1"> + Left eye output, this is mostly used internally when rendering the image for the left eye and obtaining positioning and projection information. + </constant> + <constant name="EYE_RIGHT" value="2"> + Right eye output, this is mostly used internally when rendering the image for the right eye and obtaining positioning and projection information. + </constant> + </constants> +</class> diff --git a/doc/classes/ARVROrigin.xml b/doc/classes/ARVROrigin.xml new file mode 100644 index 0000000000..28864bb3ae --- /dev/null +++ b/doc/classes/ARVROrigin.xml @@ -0,0 +1,42 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ARVROrigin" inherits="Spatial" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Our origin point in AR/VR. + </brief_description> + <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. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_world_scale" qualifiers="const"> + <return type="float"> + </return> + <description> + Get the world scale applied to our positioning. + </description> + </method> + <method name="set_world_scale"> + <return type="void"> + </return> + <argument index="0" name="world_scale" type="float"> + </argument> + <description> + 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. + </description> + </method> + </methods> + <members> + <member name="world_scale" type="float" setter="set_world_scale" getter="get_world_scale"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/ARVRPositionalTracker.xml b/doc/classes/ARVRPositionalTracker.xml new file mode 100644 index 0000000000..1379677344 --- /dev/null +++ b/doc/classes/ARVRPositionalTracker.xml @@ -0,0 +1,89 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ARVRPositionalTracker" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + A tracked object + </brief_description> + <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. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_hand" qualifiers="const"> + <return type="int" enum="ARVRPositionalTracker.TrackerHand"> + </return> + <description> + </description> + </method> + <method name="get_joy_id" qualifiers="const"> + <return type="int"> + </return> + <description> + If this is a controller that is being tracked the controller will also be represented by a joystick entry with this id. + </description> + </method> + <method name="get_name" qualifiers="const"> + <return type="String"> + </return> + <description> + If available this returns the name of the controller or anchor point. + </description> + </method> + <method name="get_orientation" qualifiers="const"> + <return type="Basis"> + </return> + <description> + Returns the orientation matrix of the controller. + </description> + </method> + <method name="get_position" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + Returns the position of the controller adjusted by world scale. + </description> + </method> + <method name="get_tracks_orientation" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns true if the orientation of this device is being tracked. + </description> + </method> + <method name="get_tracks_position" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns true if the position of this device is being tracked. + </description> + </method> + <method name="get_transform" qualifiers="const"> + <return type="Transform"> + </return> + <argument index="0" name="adjust_by_reference_frame" type="bool"> + </argument> + <description> + Returns the transform combining the orientation and position of this device. + </description> + </method> + <method name="get_type" qualifiers="const"> + <return type="int" enum="ARVRServer.TrackerType"> + </return> + <description> + Type of tracker. + </description> + </method> + </methods> + <constants> + <constant name="TRACKER_HAND_UNKNOWN" value="0"> + </constant> + <constant name="TRACKER_LEFT_HAND" value="1"> + </constant> + <constant name="TRACKER_RIGHT_HAND" value="2"> + </constant> + </constants> +</class> diff --git a/doc/classes/ARVRScriptInterface.xml b/doc/classes/ARVRScriptInterface.xml new file mode 100644 index 0000000000..54415539e0 --- /dev/null +++ b/doc/classes/ARVRScriptInterface.xml @@ -0,0 +1,109 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ARVRScriptInterface" inherits="ARVRInterface" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base class for GDNative based ARVR interfaces. + </brief_description> + <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. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="_get_projection_for_eye" qualifiers="virtual"> + <return type="void"> + </return> + <description> + Should return the projection 4x4 matrix for the requested eye. + </description> + </method> + <method name="commit_for_eye" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="eye" type="int"> + </argument> + <argument index="1" name="render_target" type="RID"> + </argument> + <description> + Outputs a finished render buffer to the AR/VR device for the given eye. + </description> + </method> + <method name="get_recommended_render_targetsize" qualifiers="virtual"> + <return type="Vector2"> + </return> + <description> + Returns the size at which we should render our scene to get optimal quality on the output device. + </description> + </method> + <method name="get_transform_for_eye" qualifiers="virtual"> + <return type="Transform"> + </return> + <argument index="0" name="eye" type="int"> + </argument> + <argument index="1" name="cam_transform" type="Transform"> + </argument> + <description> + Get the location and orientation transform used when rendering a specific eye. + </description> + </method> + <method name="hmd_is_present" qualifiers="virtual"> + <return type="bool"> + </return> + <description> + Return true is an HMD is available. + </description> + </method> + <method name="initialize" qualifiers="virtual"> + <return type="bool"> + </return> + <description> + Initialize this interface. + </description> + </method> + <method name="is_initialized" qualifiers="virtual"> + <return type="bool"> + </return> + <description> + Returns true if this interface has been initialized and is active. + </description> + </method> + <method name="is_installed" qualifiers="virtual"> + <return type="bool"> + </return> + <description> + Returns true if the required middleware is installed. + </description> + </method> + <method name="is_stereo" qualifiers="virtual"> + <return type="bool"> + </return> + <description> + Returns true if we require stereoscopic rendering for this interface. + </description> + </method> + <method name="process" qualifiers="virtual"> + <return type="void"> + </return> + <description> + Gets called before rendering each frame so tracking data gets updated in time. + </description> + </method> + <method name="supports_hmd" qualifiers="virtual"> + <return type="bool"> + </return> + <description> + Returns true if this interface supports HMDs. + </description> + </method> + <method name="uninitialize" qualifiers="virtual"> + <return type="void"> + </return> + <description> + Turn this interface off. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/ARVRServer.xml b/doc/classes/ARVRServer.xml new file mode 100644 index 0000000000..282f25bec9 --- /dev/null +++ b/doc/classes/ARVRServer.xml @@ -0,0 +1,184 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ARVRServer" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + This is our AR/VR Server. + </brief_description> + <description> + The AR/VR Server is the heart of our AR/VR solution and handles all the processing. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_interface"> + <return type="void"> + </return> + <argument index="0" name="arg0" type="ARVRInterface"> + </argument> + <description> + Mostly exposed for GDNative based interfaces, this is called to register an available interface with the AR/VR server. + </description> + </method> + <method name="find_interface" qualifiers="const"> + <return type="ARVRInterface"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + 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. + </description> + </method> + <method name="get_interface" qualifiers="const"> + <return type="ARVRInterface"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Get the interface registered at a given index in our list of interfaces. + </description> + </method> + <method name="get_interface_count" qualifiers="const"> + <return type="int"> + </return> + <description> + 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. + </description> + </method> + <method name="get_reference_frame" qualifiers="const"> + <return type="Transform"> + </return> + <description> + Gets our reference frame transform, mostly used internally and exposed for GDNative build interfaces. + </description> + </method> + <method name="get_tracker" qualifiers="const"> + <return type="ARVRPositionalTracker"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Get the positional tracker at the given ID. + </description> + </method> + <method name="get_tracker_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Get the number of trackers currently registered. + </description> + </method> + <method name="get_world_scale" qualifiers="const"> + <return type="float"> + </return> + <description> + Returns our world scale (see ARVROrigin for more information). + </description> + </method> + <method name="remove_interface"> + <return type="void"> + </return> + <argument index="0" name="arg0" type="ARVRInterface"> + </argument> + <description> + Removes a registered interface, again exposed mostly for GDNative based interfaces. + </description> + </method> + <method name="request_reference_frame"> + <return type="void"> + </return> + <argument index="0" name="ignore_tilt" type="bool"> + </argument> + <argument index="1" name="keep_height" type="bool"> + </argument> + <description> + 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. + </description> + </method> + <method name="set_primary_interface"> + <return type="void"> + </return> + <argument index="0" name="arg0" type="ARVRInterface"> + </argument> + <description> + Changes the primary interface to the specified interface. Again mostly exposed for GDNative interfaces. + </description> + </method> + <method name="set_world_scale"> + <return type="void"> + </return> + <argument index="0" name="arg0" type="float"> + </argument> + <description> + Changing the world scale, see the ARVROrigin documentation for more information. + </description> + </method> + </methods> + <members> + <member name="world_scale" type="float" setter="set_world_scale" getter="get_world_scale"> + </member> + </members> + <signals> + <signal name="interface_added"> + <argument index="0" name="name" type="String"> + </argument> + <description> + Signal send when a new interface has been added. + </description> + </signal> + <signal name="interface_removed"> + <argument index="0" name="name" type="String"> + </argument> + <description> + Signal send when an interface is removed. + </description> + </signal> + <signal name="tracker_added"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="int"> + </argument> + <argument index="2" name="id" type="int"> + </argument> + <description> + 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. + </description> + </signal> + <signal name="tracker_removed"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="int"> + </argument> + <argument index="2" name="id" type="int"> + </argument> + <description> + 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). + </description> + </signal> + </signals> + <constants> + <constant name="TRACKER_CONTROLLER" value="1"> + Our tracker tracks the location of a controller. + </constant> + <constant name="TRACKER_BASESTATION" value="2"> + Our tracker tracks the location of a base station. + </constant> + <constant name="TRACKER_ANCHOR" value="4"> + Our tracker tracks the location and size of an AR anchor. + </constant> + <constant name="TRACKER_UNKNOWN" value="128"> + Used internally if we haven't set the tracker type yet. + </constant> + <constant name="TRACKER_ANY_KNOWN" value="127"> + Used internally to filter trackers of any known type. + </constant> + <constant name="TRACKER_ANY" value="255"> + Used interally to select all trackers. + </constant> + </constants> +</class> diff --git a/doc/classes/AStar.xml b/doc/classes/AStar.xml new file mode 100644 index 0000000000..d94b8355ba --- /dev/null +++ b/doc/classes/AStar.xml @@ -0,0 +1,226 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AStar" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + AStar class representation that uses vectors as edges. + </brief_description> + <description> + A* (A star) is a computer algorithm that is widely used in pathfinding and graph traversal, the process of plotting an efficiently directed path between multiple points. It enjoys widespread use due to its performance and accuracy. Godot's A* implementation make use of vectors as points. + You must add points manually with [method AStar.add_point] and create segments manually with [method AStar.connect_points]. So you can test if there is a path between two points with the [method AStar.are_points_connected] function, get the list of existing ids in the found path with [method AStar.get_id_path], or the points list with [method AStar.get_point_path]. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="_compute_cost" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="from_id" type="int"> + </argument> + <argument index="1" name="to_id" type="int"> + </argument> + <description> + Called when computing the cost between two connected points. + </description> + </method> + <method name="_estimate_cost" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="from_id" type="int"> + </argument> + <argument index="1" name="to_id" type="int"> + </argument> + <description> + Called when estimating the cost between a point and the path's ending point. + </description> + </method> + <method name="add_point"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="pos" type="Vector3"> + </argument> + <argument index="2" name="weight_scale" type="float" default="1.0"> + </argument> + <description> + Adds a new point at the given position with the given identifier. The algorithm prefers points with lower [code]weight_scale[/code] to form a path. The [code]id[/code] must be 0 or larger, and the [code]weight_scale[/code] must be 1 or larger. + [codeblock] + 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 + [/codeblock] + </description> + </method> + <method name="are_points_connected" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="to_id" type="int"> + </argument> + <description> + Returns whether there is a connection/segment between the given points. + </description> + </method> + <method name="clear"> + <return type="void"> + </return> + <description> + Clears all the points and segments. + </description> + </method> + <method name="connect_points"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="to_id" type="int"> + </argument> + <argument index="2" name="bidirectional" type="bool" default="true"> + </argument> + <description> + Creates a segment between the given points. + [codeblock] + 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. + [/codeblock] + </description> + </method> + <method name="disconnect_points"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="to_id" type="int"> + </argument> + <description> + Deletes the segment between the given points. + </description> + </method> + <method name="get_available_point_id" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns an id with no point associated to it. + </description> + </method> + <method name="get_closest_point" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="to_pos" type="Vector3"> + </argument> + <description> + Returns the id of the closest point to [code]to_pos[/code]. Returns -1 if there are no points in the points pool. + </description> + </method> + <method name="get_closest_pos_in_segment" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="to_pos" type="Vector3"> + </argument> + <description> + Returns the closest position to [code]to_pos[/code] that resides inside a segment between two connected points. + [codeblock] + 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_pos_in_segment(Vector3(3,3,0)) # returns (0, 3, 0) + [/codeblock] + The result is in the segment that goes from [code]y=0[/code] to [code]y=5[/code]. It's the closest position in the segment to the given point. + </description> + </method> + <method name="get_id_path"> + <return type="PoolIntArray"> + </return> + <argument index="0" name="from_id" type="int"> + </argument> + <argument index="1" name="to_id" type="int"> + </argument> + <description> + 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. + [codeblock] + 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] + [/codeblock] + If you change the 2nd point's weight to 3, then the result will be [code][1, 4, 3][/code] instead, because now even though the distance is longer, it's "easier" to get through point 4 than through point 2. + </description> + </method> + <method name="get_point_path"> + <return type="PoolVector3Array"> + </return> + <argument index="0" name="from_id" type="int"> + </argument> + <argument index="1" name="to_id" type="int"> + </argument> + <description> + 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. + </description> + </method> + <method name="get_point_pos" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + Returns the position of the point associated with the given id. + </description> + </method> + <method name="get_point_weight_scale" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + Returns the weight scale of the point associated with the given id. + </description> + </method> + <method name="get_points"> + <return type="Array"> + </return> + <description> + </description> + </method> + <method name="has_point" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + Returns whether a point associated with the given id exists. + </description> + </method> + <method name="remove_point"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + Removes the point associated with the given id from the points pool. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/AcceptDialog.xml b/doc/classes/AcceptDialog.xml new file mode 100644 index 0000000000..4244e66a35 --- /dev/null +++ b/doc/classes/AcceptDialog.xml @@ -0,0 +1,115 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AcceptDialog" inherits="WindowDialog" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base dialog for user notification. + </brief_description> + <description> + This dialog is useful for small notifications to the user about an event. It can only be accepted or closed, with the same result. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_button"> + <return type="Button"> + </return> + <argument index="0" name="text" type="String"> + </argument> + <argument index="1" name="right" type="bool" default="false"> + </argument> + <argument index="2" name="action" type="String" default=""""> + </argument> + <description> + Adds a button with label [i]text[/i] and a custom [i]action[/i] to the dialog and returns the created button. [i]action[/i] will be passed to the [custom_action] signal when pressed. + If [code]true[/code], [i]right[/i] will place the button to the right of any sibling buttons. Default value: [code]false[/code]. + </description> + </method> + <method name="add_cancel"> + <return type="Button"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Adds a button with label [i]name[/i] and a cancel action to the dialog and returns the created button. + </description> + </method> + <method name="get_hide_on_ok" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if the dialog will be hidden when accepted (default true). + </description> + </method> + <method name="get_label"> + <return type="Label"> + </return> + <description> + Return the label used for built-in text. + </description> + </method> + <method name="get_ok"> + <return type="Button"> + </return> + <description> + Return the OK Button. + </description> + </method> + <method name="get_text" qualifiers="const"> + <return type="String"> + </return> + <description> + Return the built-in label text. + </description> + </method> + <method name="register_text_enter"> + <return type="void"> + </return> + <argument index="0" name="line_edit" type="Node"> + </argument> + <description> + Registers a [LineEdit] in the dialog. When the enter key is pressed, the dialog will be accepted. + </description> + </method> + <method name="set_hide_on_ok"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Set whether the dialog is hidden when accepted (default true). + </description> + </method> + <method name="set_text"> + <return type="void"> + </return> + <argument index="0" name="text" type="String"> + </argument> + <description> + Set the built-in label text. + </description> + </method> + </methods> + <members> + <member name="dialog_hide_on_ok" type="bool" setter="set_hide_on_ok" getter="get_hide_on_ok"> + </member> + <member name="dialog_text" type="String" setter="set_text" getter="get_text"> + </member> + </members> + <signals> + <signal name="confirmed"> + <description> + Emitted when the dialog is accepted. + </description> + </signal> + <signal name="custom_action"> + <argument index="0" name="action" type="String"> + </argument> + <description> + Emitted when a custom button is pressed. See [method add_button]. + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/AnimatedSprite.xml b/doc/classes/AnimatedSprite.xml new file mode 100644 index 0000000000..f8663e90e0 --- /dev/null +++ b/doc/classes/AnimatedSprite.xml @@ -0,0 +1,182 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AnimatedSprite" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Sprite node that can use multiple textures for animation. + </brief_description> + <description> + Sprite node that can use multiple textures for animation. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_animation" qualifiers="const"> + <return type="String"> + </return> + <description> + Return the name of the current animation set to the node. + </description> + </method> + <method name="get_frame" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the visible frame index. + </description> + </method> + <method name="get_offset" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the offset of the sprite in the node origin. + </description> + </method> + <method name="get_sprite_frames" qualifiers="const"> + <return type="SpriteFrames"> + </return> + <description> + Get the [SpriteFrames] resource, which contains all frames. + </description> + </method> + <method name="is_centered" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true when centered. See [method set_centered]. + </description> + </method> + <method name="is_flipped_h" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if sprite is flipped horizontally. + </description> + </method> + <method name="is_flipped_v" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if sprite is flipped vertically. + </description> + </method> + <method name="is_playing" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if an animation if currently being played. + </description> + </method> + <method name="play"> + <return type="void"> + </return> + <argument index="0" name="anim" type="String" default=""""> + </argument> + <description> + Play the animation set in parameter. If no parameter is provided, the current animation is played. + </description> + </method> + <method name="set_animation"> + <return type="void"> + </return> + <argument index="0" name="animation" type="String"> + </argument> + <description> + Set the current animation of the node and reinits the frame counter of the animation. + </description> + </method> + <method name="set_centered"> + <return type="void"> + </return> + <argument index="0" name="centered" type="bool"> + </argument> + <description> + When turned on, offset at (0,0) is the center of the sprite, when off, the top-left corner is. + </description> + </method> + <method name="set_flip_h"> + <return type="void"> + </return> + <argument index="0" name="flip_h" type="bool"> + </argument> + <description> + If true, sprite is flipped horizontally. + </description> + </method> + <method name="set_flip_v"> + <return type="void"> + </return> + <argument index="0" name="flip_v" type="bool"> + </argument> + <description> + If true, sprite is flipped vertically. + </description> + </method> + <method name="set_frame"> + <return type="void"> + </return> + <argument index="0" name="frame" type="int"> + </argument> + <description> + Set the visible sprite frame index (from the list of frames inside the [SpriteFrames] resource). + </description> + </method> + <method name="set_offset"> + <return type="void"> + </return> + <argument index="0" name="offset" type="Vector2"> + </argument> + <description> + Set the offset of the sprite in the node origin. Position varies depending on whether it is centered or not. + </description> + </method> + <method name="set_sprite_frames"> + <return type="void"> + </return> + <argument index="0" name="sprite_frames" type="SpriteFrames"> + </argument> + <description> + Set the [SpriteFrames] resource, which contains all frames. + </description> + </method> + <method name="stop"> + <return type="void"> + </return> + <description> + Stop the current animation (does not reset the frame counter). + </description> + </method> + </methods> + <members> + <member name="animation" type="String" setter="set_animation" getter="get_animation"> + </member> + <member name="centered" type="bool" setter="set_centered" getter="is_centered"> + </member> + <member name="flip_h" type="bool" setter="set_flip_h" getter="is_flipped_h"> + </member> + <member name="flip_v" type="bool" setter="set_flip_v" getter="is_flipped_v"> + </member> + <member name="frame" type="int" setter="set_frame" getter="get_frame"> + </member> + <member name="frames" type="SpriteFrames" setter="set_sprite_frames" getter="get_sprite_frames"> + </member> + <member name="offset" type="Vector2" setter="set_offset" getter="get_offset"> + </member> + <member name="playing" type="bool" setter="_set_playing" getter="_is_playing"> + </member> + </members> + <signals> + <signal name="animation_finished"> + <description> + Emitted when the animation is finished (when it plays the last frame). If the animation is looping, this signal is emitted every time the last frame is drawn, before looping. + </description> + </signal> + <signal name="frame_changed"> + <description> + Emitted when frame is changed. + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/AnimatedSprite3D.xml b/doc/classes/AnimatedSprite3D.xml new file mode 100644 index 0000000000..4e28f7de8d --- /dev/null +++ b/doc/classes/AnimatedSprite3D.xml @@ -0,0 +1,103 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AnimatedSprite3D" inherits="SpriteBase3D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_animation" qualifiers="const"> + <return type="String"> + </return> + <description> + Return the name of the current animation set to the node. + </description> + </method> + <method name="get_frame" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the visible frame index. + </description> + </method> + <method name="get_sprite_frames" qualifiers="const"> + <return type="SpriteFrames"> + </return> + <description> + Get the [SpriteFrames] resource, which contains all frames. + </description> + </method> + <method name="is_playing" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if an animation if currently being played. + </description> + </method> + <method name="play"> + <return type="void"> + </return> + <argument index="0" name="anim" type="String" default=""""> + </argument> + <description> + Play the animation set in parameter. If no parameter is provided, the current animation is played. + </description> + </method> + <method name="set_animation"> + <return type="void"> + </return> + <argument index="0" name="animation" type="String"> + </argument> + <description> + Set the current animation of the node and reinits the frame counter of the animation. + </description> + </method> + <method name="set_frame"> + <return type="void"> + </return> + <argument index="0" name="frame" type="int"> + </argument> + <description> + Set the visible sprite frame index (from the list of frames inside the [SpriteFrames] resource). + </description> + </method> + <method name="set_sprite_frames"> + <return type="void"> + </return> + <argument index="0" name="sprite_frames" type="SpriteFrames"> + </argument> + <description> + Set the [SpriteFrames] resource, which contains all frames. + </description> + </method> + <method name="stop"> + <return type="void"> + </return> + <description> + Stop the current animation (does not reset the frame counter). + </description> + </method> + </methods> + <members> + <member name="animation" type="String" setter="set_animation" getter="get_animation"> + </member> + <member name="frame" type="int" setter="set_frame" getter="get_frame"> + </member> + <member name="frames" type="SpriteFrames" setter="set_sprite_frames" getter="get_sprite_frames"> + </member> + <member name="playing" type="bool" setter="_set_playing" getter="_is_playing"> + </member> + </members> + <signals> + <signal name="frame_changed"> + <description> + Emitted when frame is changed. + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml new file mode 100644 index 0000000000..b80edb24da --- /dev/null +++ b/doc/classes/Animation.xml @@ -0,0 +1,455 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Animation" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Contains data used to animate everything in the engine. + </brief_description> + <description> + An Animation resource contains data used to animate everything in the engine. Animations are divided into tracks, and each track must be linked to a node. The state of that node can be changed through time, by adding timed keys (events) to the track. + Animations are just data containers, and must be added to odes such as an [AnimationPlayer] or [AnimationTreePlayer] to be played back. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_track"> + <return type="int"> + </return> + <argument index="0" name="type" type="int" enum="Animation.TrackType"> + </argument> + <argument index="1" name="at_pos" type="int" default="-1"> + </argument> + <description> + Add a track to the Animation. The track type must be specified as any of the values in the TYPE_* enumeration. + </description> + </method> + <method name="clear"> + <return type="void"> + </return> + <description> + Clear the animation (clear all tracks and reset all). + </description> + </method> + <method name="find_track" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="path" type="NodePath"> + </argument> + <description> + Return the index of the specified track. If the track is not found, return -1. + </description> + </method> + <method name="get_length" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the total length of the animation (in seconds). + </description> + </method> + <method name="get_step" qualifiers="const"> + <return type="float"> + </return> + <description> + Get the animation step value. + </description> + </method> + <method name="get_track_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the amount of tracks in the animation. + </description> + </method> + <method name="has_loop" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether the animation has the loop flag set. + </description> + </method> + <method name="method_track_get_key_indices" qualifiers="const"> + <return type="PoolIntArray"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="time_sec" type="float"> + </argument> + <argument index="2" name="delta" type="float"> + </argument> + <description> + Return all the key indices of a method track, given a position and delta time. + </description> + </method> + <method name="method_track_get_name" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="key_idx" type="int"> + </argument> + <description> + Return the method name of a method track. + </description> + </method> + <method name="method_track_get_params" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="key_idx" type="int"> + </argument> + <description> + Return the arguments values to be called on a method track for a given key in a given track. + </description> + </method> + <method name="remove_track"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Remove a track by specifying the track index. + </description> + </method> + <method name="set_length"> + <return type="void"> + </return> + <argument index="0" name="time_sec" type="float"> + </argument> + <description> + Set the total length of the animation (in seconds). Note that length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping. + </description> + </method> + <method name="set_loop"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Set a flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation. + </description> + </method> + <method name="set_step"> + <return type="void"> + </return> + <argument index="0" name="size_sec" type="float"> + </argument> + <description> + Set the animation step value. + </description> + </method> + <method name="track_find_key" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="time" type="float"> + </argument> + <argument index="2" name="exact" type="bool" default="false"> + </argument> + <description> + Find the key index by time in a given track. Optionally, only find it if the exact time is given. + </description> + </method> + <method name="track_get_interpolation_loop_wrap" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="track_get_interpolation_type" qualifiers="const"> + <return type="int" enum="Animation.InterpolationType"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return the interpolation type of a given track, from the INTERPOLATION_* enum. + </description> + </method> + <method name="track_get_key_count" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return the amount of keys in a given track. + </description> + </method> + <method name="track_get_key_time" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="key_idx" type="int"> + </argument> + <description> + Return the time at which the key is located. + </description> + </method> + <method name="track_get_key_transition" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="key_idx" type="int"> + </argument> + <description> + Return the transition curve (easing) for a specific key (see built-in math function "ease"). + </description> + </method> + <method name="track_get_key_value" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="key_idx" type="int"> + </argument> + <description> + Return the value of a given key in a given track. + </description> + </method> + <method name="track_get_path" qualifiers="const"> + <return type="NodePath"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Get the path of a track. for more information on the path format, see [method track_set_path] + </description> + </method> + <method name="track_get_type" qualifiers="const"> + <return type="int" enum="Animation.TrackType"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Get the type of a track. + </description> + </method> + <method name="track_insert_key"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="time" type="float"> + </argument> + <argument index="2" name="key" type="Variant"> + </argument> + <argument index="3" name="transition" type="float" default="1"> + </argument> + <description> + Insert a generic key in a given track. + </description> + </method> + <method name="track_is_imported" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return true if the given track is imported. Else, return false. + </description> + </method> + <method name="track_move_down"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Move a track down. + </description> + </method> + <method name="track_move_up"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Move a track up. + </description> + </method> + <method name="track_remove_key"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="key_idx" type="int"> + </argument> + <description> + Remove a key by index in a given track. + </description> + </method> + <method name="track_remove_key_at_pos"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="pos" type="float"> + </argument> + <description> + Remove a key by position (seconds) in a given track. + </description> + </method> + <method name="track_set_imported"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="imported" type="bool"> + </argument> + <description> + Set the given track as imported or not. + </description> + </method> + <method name="track_set_interpolation_loop_wrap"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="interpolation" type="bool"> + </argument> + <description> + </description> + </method> + <method name="track_set_interpolation_type"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="interpolation" type="int" enum="Animation.InterpolationType"> + </argument> + <description> + Set the interpolation type of a given track, from the INTERPOLATION_* enum. + </description> + </method> + <method name="track_set_key_transition"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="key_idx" type="int"> + </argument> + <argument index="2" name="transition" type="float"> + </argument> + <description> + Set the transition curve (easing) for a specific key (see built-in math function "ease"). + </description> + </method> + <method name="track_set_key_value"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="key" type="int"> + </argument> + <argument index="2" name="value" type="Variant"> + </argument> + <description> + Set the value of an existing key. + </description> + </method> + <method name="track_set_path"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="path" type="NodePath"> + </argument> + <description> + Set the path of a track. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by ":". Example: "character/skeleton:ankle" or "character/mesh:transform/local" + </description> + </method> + <method name="transform_track_insert_key"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="time" type="float"> + </argument> + <argument index="2" name="loc" type="Vector3"> + </argument> + <argument index="3" name="rot" type="Quat"> + </argument> + <argument index="4" name="scale" type="Vector3"> + </argument> + <description> + Insert a transform key for a transform track. + </description> + </method> + <method name="transform_track_interpolate" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="time_sec" type="float"> + </argument> + <description> + Return the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position ([Vector3]), rotation ([Quat]) and scale ([Vector3]). + </description> + </method> + <method name="value_track_get_key_indices" qualifiers="const"> + <return type="PoolIntArray"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="time_sec" type="float"> + </argument> + <argument index="2" name="delta" type="float"> + </argument> + <description> + Return all the key indices of a value track, given a position and delta time. + </description> + </method> + <method name="value_track_get_update_mode" qualifiers="const"> + <return type="int" enum="Animation.UpdateMode"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return the update mode of a value track. + </description> + </method> + <method name="value_track_set_update_mode"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="mode" type="int" enum="Animation.UpdateMode"> + </argument> + <description> + Set the update mode (UPDATE_*) of a value track. + </description> + </method> + </methods> + <constants> + <constant name="TYPE_VALUE" value="0"> + Value tracks set values in node properties, but only those which can be Interpolated. + </constant> + <constant name="TYPE_TRANSFORM" value="1"> + Transform tracks are used to change node local transforms or skeleton pose bones. Transitions are Interpolated. + </constant> + <constant name="TYPE_METHOD" value="2"> + Method tracks call functions with given arguments per key. + </constant> + <constant name="INTERPOLATION_NEAREST" value="0"> + No interpolation (nearest value). + </constant> + <constant name="INTERPOLATION_LINEAR" value="1"> + Linear interpolation. + </constant> + <constant name="INTERPOLATION_CUBIC" value="2"> + Cubic interpolation. + </constant> + <constant name="UPDATE_CONTINUOUS" value="0"> + Update between keyframes. + </constant> + <constant name="UPDATE_DISCRETE" value="1"> + Update at the keyframes and hold the value. + </constant> + <constant name="UPDATE_TRIGGER" value="2"> + Update at the keyframes. + </constant> + </constants> +</class> diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml new file mode 100644 index 0000000000..746462380b --- /dev/null +++ b/doc/classes/AnimationPlayer.xml @@ -0,0 +1,390 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AnimationPlayer" inherits="Node" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Container and player of [Animation] resources. + </brief_description> + <description> + An animation player is used for general purpose playback of [Animation] resources. It contains a dictionary of animations (referenced by name) and custom blend times between their transitions. Additionally, animations can be played and blended in different channels. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_animation"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="animation" type="Animation"> + </argument> + <description> + Add an animation resource to the player, which will be later referenced by the "name" argument. + </description> + </method> + <method name="advance"> + <return type="void"> + </return> + <argument index="0" name="delta" type="float"> + </argument> + <description> + Used to skip ahead or skip back in an animation. Delta is the time in seconds to skip. + </description> + </method> + <method name="animation_get_next" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="anim_from" type="String"> + </argument> + <description> + Return the name of the next animation in the queue. + </description> + </method> + <method name="animation_set_next"> + <return type="void"> + </return> + <argument index="0" name="anim_from" type="String"> + </argument> + <argument index="1" name="anim_to" type="String"> + </argument> + <description> + Set the name of an animation that will be played after. + </description> + </method> + <method name="clear_caches"> + <return type="void"> + </return> + <description> + The animation player creates caches for faster access to the nodes it will animate. However, if a specific node is removed, it may not notice it, so clear_caches will force the player to search for the nodes again. + </description> + </method> + <method name="clear_queue"> + <return type="void"> + </return> + <description> + If animations are queued to play, clear them. + </description> + </method> + <method name="find_animation" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="animation" type="Animation"> + </argument> + <description> + Find an animation name by resource. + </description> + </method> + <method name="get_animation" qualifiers="const"> + <return type="Animation"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Get an [Animation] resource by requesting a name. + </description> + </method> + <method name="get_animation_list" qualifiers="const"> + <return type="PoolStringArray"> + </return> + <description> + Get the list of names of the animations stored in the player. + </description> + </method> + <method name="get_animation_process_mode" qualifiers="const"> + <return type="int" enum="AnimationPlayer.AnimationProcessMode"> + </return> + <description> + Return the mode in which the animation player processes. See [method set_animation_process_mode]. + </description> + </method> + <method name="get_autoplay" qualifiers="const"> + <return type="String"> + </return> + <description> + Return the name of the animation that will be automatically played when the scene is loaded. + </description> + </method> + <method name="get_blend_time" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="anim_from" type="String"> + </argument> + <argument index="1" name="anim_to" type="String"> + </argument> + <description> + Get the blend time between two animations, referenced by their names. + </description> + </method> + <method name="get_current_animation" qualifiers="const"> + <return type="String"> + </return> + <description> + Return the name of the animation being played. + </description> + </method> + <method name="get_current_animation_length" qualifiers="const"> + <return type="float"> + </return> + <description> + Get the length (in seconds) of the currently being played animation. + </description> + </method> + <method name="get_current_animation_pos" qualifiers="const"> + <return type="float"> + </return> + <description> + Get the position (in seconds) of the currently being played animation. + </description> + </method> + <method name="get_default_blend_time" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the default blend time between animations. + </description> + </method> + <method name="get_pos" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the playback position (in seconds) in an animation channel (or channel 0 if none is provided). + </description> + </method> + <method name="get_root" qualifiers="const"> + <return type="NodePath"> + </return> + <description> + Return path to root node (see [method set_root]). + </description> + </method> + <method name="get_speed_scale" qualifiers="const"> + <return type="float"> + </return> + <description> + Get the speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is [i]1[/i] (no scaling). + </description> + </method> + <method name="has_animation" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Request whether an [Animation] name exist within the player. + </description> + </method> + <method name="is_active" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if the player is active. + </description> + </method> + <method name="is_playing" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether an animation is playing. + </description> + </method> + <method name="play"> + <return type="void"> + </return> + <argument index="0" name="name" type="String" default=""""> + </argument> + <argument index="1" name="custom_blend" type="float" default="-1"> + </argument> + <argument index="2" name="custom_speed" type="float" default="1.0"> + </argument> + <argument index="3" name="from_end" type="bool" default="false"> + </argument> + <description> + Play a given animation by the animation name. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being true can play the animation backwards. + </description> + </method> + <method name="play_backwards"> + <return type="void"> + </return> + <argument index="0" name="name" type="String" default=""""> + </argument> + <argument index="1" name="custom_blend" type="float" default="-1"> + </argument> + <description> + Play a given animation by the animation name in reverse. + </description> + </method> + <method name="queue"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Queue an animation for playback once the current one is done. + </description> + </method> + <method name="remove_animation"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Remove an animation from the player (by supplying the same name used to add it). + </description> + </method> + <method name="rename_animation"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="newname" type="String"> + </argument> + <description> + Rename an existing animation. + </description> + </method> + <method name="seek"> + <return type="void"> + </return> + <argument index="0" name="pos_sec" type="float"> + </argument> + <argument index="1" name="update" type="bool" default="false"> + </argument> + <description> + 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. + </description> + </method> + <method name="set_active"> + <return type="void"> + </return> + <argument index="0" name="active" type="bool"> + </argument> + <description> + Set the player as active (playing). If false, it will do nothing. + </description> + </method> + <method name="set_animation_process_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="AnimationPlayer.AnimationProcessMode"> + </argument> + <description> + Set the mode in which the animation player processes. By default, it processes on idle time (framerate dependent), but using fixed time works well for animating static collision bodies in 2D and 3D. See enum ANIMATION_PROCESS_*. + </description> + </method> + <method name="set_autoplay"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Set the name of the animation that will be automatically played when the scene is loaded. + </description> + </method> + <method name="set_blend_time"> + <return type="void"> + </return> + <argument index="0" name="anim_from" type="String"> + </argument> + <argument index="1" name="anim_to" type="String"> + </argument> + <argument index="2" name="sec" type="float"> + </argument> + <description> + Specify a blend time (in seconds) between two animations, referenced by their names. + </description> + </method> + <method name="set_current_animation"> + <return type="void"> + </return> + <argument index="0" name="anim" type="String"> + </argument> + <description> + Set the current animation (even if no playback occurs). Using set_current_animation() and set_active() are similar to calling play(). + </description> + </method> + <method name="set_default_blend_time"> + <return type="void"> + </return> + <argument index="0" name="sec" type="float"> + </argument> + <description> + Set the default blend time between animations. + </description> + </method> + <method name="set_root"> + <return type="void"> + </return> + <argument index="0" name="path" type="NodePath"> + </argument> + <description> + AnimationPlayer resolves animation track paths from this node (which is relative to itself), by default root is "..", but it can be changed. + </description> + </method> + <method name="set_speed_scale"> + <return type="void"> + </return> + <argument index="0" name="speed" type="float"> + </argument> + <description> + Set a speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is [i]1[/i] (no scaling). + </description> + </method> + <method name="stop"> + <return type="void"> + </return> + <argument index="0" name="reset" type="bool" default="true"> + </argument> + <description> + Stop the currently playing animation. + </description> + </method> + <method name="stop_all"> + <return type="void"> + </return> + <description> + Stop playback of animations (deprecated). + </description> + </method> + </methods> + <members> + <member name="playback_default_blend_time" type="float" setter="set_default_blend_time" getter="get_default_blend_time"> + </member> + <member name="playback_process_mode" type="int" setter="set_animation_process_mode" getter="get_animation_process_mode" enum="AnimationPlayer.AnimationProcessMode"> + </member> + <member name="root_node" type="NodePath" setter="set_root" getter="get_root"> + </member> + </members> + <signals> + <signal name="animation_changed"> + <argument index="0" name="old_name" type="String"> + </argument> + <argument index="1" name="new_name" type="String"> + </argument> + <description> + If the currently being played animation changes, this signal will notify of such change. + </description> + </signal> + <signal name="animation_finished"> + <argument index="0" name="name" type="String"> + </argument> + <description> + Notifies when an animation finished playing. + </description> + </signal> + <signal name="animation_started"> + <argument index="0" name="name" type="String"> + </argument> + <description> + Notifies when an animation starts playing. + </description> + </signal> + </signals> + <constants> + <constant name="ANIMATION_PROCESS_FIXED" value="0"> + Process animation on fixed process. This is specially useful when animating kinematic bodies. + </constant> + <constant name="ANIMATION_PROCESS_IDLE" value="1"> + Process animation on idle process. + </constant> + </constants> +</class> diff --git a/doc/classes/AnimationTreePlayer.xml b/doc/classes/AnimationTreePlayer.xml new file mode 100644 index 0000000000..e128b4d865 --- /dev/null +++ b/doc/classes/AnimationTreePlayer.xml @@ -0,0 +1,667 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AnimationTreePlayer" inherits="Node" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Animation Player that uses a node graph for the blending. + </brief_description> + <description> + Animation Player that uses a node graph for the blending. This kind of player is very useful when animating character or other skeleton based rigs, because it can combine several animations to form a desired pose. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_node"> + <return type="void"> + </return> + <argument index="0" name="type" type="int" enum="AnimationTreePlayer.NodeType"> + </argument> + <argument index="1" name="id" type="String"> + </argument> + <description> + Add a node of a given type in the graph with given id. + </description> + </method> + <method name="advance"> + <return type="void"> + </return> + <argument index="0" name="delta" type="float"> + </argument> + <description> + </description> + </method> + <method name="animation_node_get_animation" qualifiers="const"> + <return type="Animation"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <description> + Returns an animation given its name. + </description> + </method> + <method name="animation_node_get_master_animation" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <description> + </description> + </method> + <method name="animation_node_set_animation"> + <return type="void"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="animation" type="Animation"> + </argument> + <description> + Set the animation for an animation node. + </description> + </method> + <method name="animation_node_set_filter_path"> + <return type="void"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="path" type="NodePath"> + </argument> + <argument index="2" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="animation_node_set_master_animation"> + <return type="void"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="source" type="String"> + </argument> + <description> + </description> + </method> + <method name="are_nodes_connected" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="dst_id" type="String"> + </argument> + <argument index="2" name="dst_input_idx" type="int"> + </argument> + <description> + Returns whether node [code]id[/code] and [code]dst_id[/code] are connected at the specified slot. + </description> + </method> + <method name="blend2_node_get_amount" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <description> + Returns the blend amount of a Blend2 node given its name. + </description> + </method> + <method name="blend2_node_set_amount"> + <return type="void"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="blend" type="float"> + </argument> + <description> + Sets the blend amount of a Blend2 node given its name and value. + </description> + </method> + <method name="blend2_node_set_filter_path"> + <return type="void"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="path" type="NodePath"> + </argument> + <argument index="2" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="blend3_node_get_amount" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <description> + Returns the blend amount of a Blend3 node given its name. + </description> + </method> + <method name="blend3_node_set_amount"> + <return type="void"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="blend" type="float"> + </argument> + <description> + Sets the blend amount of a Blend3 node given its name and value. + </description> + </method> + <method name="blend4_node_get_amount" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <description> + Returns the blend amount of a Blend4 node given its name. + </description> + </method> + <method name="blend4_node_set_amount"> + <return type="void"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="blend" type="Vector2"> + </argument> + <description> + Sets the blend amount of a Blend4 node given its name and value. + </description> + </method> + <method name="connect_nodes"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="dst_id" type="String"> + </argument> + <argument index="2" name="dst_input_idx" type="int"> + </argument> + <description> + Connects node [code]id[/code] to [code]dst_id[/code] at the specified input slot. + </description> + </method> + <method name="disconnect_nodes"> + <return type="void"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="dst_input_idx" type="int"> + </argument> + <description> + Disconnects nodes connected to [code]id[/code] at the specified input slot. + </description> + </method> + <method name="get_animation_process_mode" qualifiers="const"> + <return type="int" enum="AnimationTreePlayer.AnimationProcessMode"> + </return> + <description> + Returns playback process mode of this AnimationTreePlayer. + </description> + </method> + <method name="get_base_path" qualifiers="const"> + <return type="NodePath"> + </return> + <description> + </description> + </method> + <method name="get_master_player" qualifiers="const"> + <return type="NodePath"> + </return> + <description> + </description> + </method> + <method name="get_node_list"> + <return type="PoolStringArray"> + </return> + <description> + Returns a PoolStringArray containing the name of all nodes. + </description> + </method> + <method name="is_active" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns whether this AnimationTreePlayer is active. + </description> + </method> + <method name="mix_node_get_amount" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <description> + Returns mix amount of a Mix node given its name. + </description> + </method> + <method name="mix_node_set_amount"> + <return type="void"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="ratio" type="float"> + </argument> + <description> + Sets mix amount of a Mix node given its name and value. + </description> + </method> + <method name="node_exists" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="node" type="String"> + </argument> + <description> + Check if a node exists (by name). + </description> + </method> + <method name="node_get_input_count" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <description> + Return the input count for a given node. Different types of nodes have different amount of inputs. + </description> + </method> + <method name="node_get_input_source" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="idx" type="int"> + </argument> + <description> + Return the input source for a given node input. + </description> + </method> + <method name="node_get_pos" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <description> + Returns position of a node in the graph given its name. + </description> + </method> + <method name="node_get_type" qualifiers="const"> + <return type="int" enum="AnimationTreePlayer.NodeType"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <description> + Get the node type, will return from NODE_* enum. + </description> + </method> + <method name="node_rename"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="node" type="String"> + </argument> + <argument index="1" name="new_name" type="String"> + </argument> + <description> + Rename a node in the graph. + </description> + </method> + <method name="node_set_pos"> + <return type="void"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="screen_pos" type="Vector2"> + </argument> + <description> + Sets position of a node in the graph given its name and position. + </description> + </method> + <method name="oneshot_node_get_autorestart_delay" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <description> + Returns autostart delay of a OneShot node given its name. + </description> + </method> + <method name="oneshot_node_get_autorestart_random_delay" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <description> + Returns autostart random delay of a OneShot node given its name. + </description> + </method> + <method name="oneshot_node_get_fadein_time" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <description> + Returns fade in time of a OneShot node given its name. + </description> + </method> + <method name="oneshot_node_get_fadeout_time" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <description> + Returns fade out time of a OneShot node given its name. + </description> + </method> + <method name="oneshot_node_has_autorestart" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <description> + Returns whether a OneShot node will auto restart given its name. + </description> + </method> + <method name="oneshot_node_is_active" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <description> + Returns whether a OneShot node is active given its name. + </description> + </method> + <method name="oneshot_node_set_autorestart"> + <return type="void"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> + <description> + Sets autorestart property of a OneShot node given its name and value. + </description> + </method> + <method name="oneshot_node_set_autorestart_delay"> + <return type="void"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="delay_sec" type="float"> + </argument> + <description> + Sets autorestart delay of a OneShot node given its name and value in seconds. + </description> + </method> + <method name="oneshot_node_set_autorestart_random_delay"> + <return type="void"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="rand_sec" type="float"> + </argument> + <description> + Sets autorestart random delay of a OneShot node given its name and value in seconds. + </description> + </method> + <method name="oneshot_node_set_fadein_time"> + <return type="void"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="time_sec" type="float"> + </argument> + <description> + Sets fade in time of a OneShot node given its name and value in seconds. + </description> + </method> + <method name="oneshot_node_set_fadeout_time"> + <return type="void"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="time_sec" type="float"> + </argument> + <description> + Sets fade out time of a OneShot node given its name and value in seconds. + </description> + </method> + <method name="oneshot_node_set_filter_path"> + <return type="void"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="path" type="NodePath"> + </argument> + <argument index="2" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="oneshot_node_start"> + <return type="void"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <description> + Starts a OneShot node given its name. + </description> + </method> + <method name="oneshot_node_stop"> + <return type="void"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <description> + Stops a OneShot node given its name. + </description> + </method> + <method name="recompute_caches"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="remove_node"> + <return type="void"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <description> + </description> + </method> + <method name="reset"> + <return type="void"> + </return> + <description> + Resets this AnimationTreePlayer. + </description> + </method> + <method name="set_active"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Sets whether this AnimationTreePlayer is active. AnimationTreePlayer will start processing if set to active. + </description> + </method> + <method name="set_animation_process_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="AnimationTreePlayer.AnimationProcessMode"> + </argument> + <description> + Sets process mode (ANIMATION_PROCESS_*) of this AnimationTreePlayer. + </description> + </method> + <method name="set_base_path"> + <return type="void"> + </return> + <argument index="0" name="path" type="NodePath"> + </argument> + <description> + Sets base path of this AnimationTreePlayer. + </description> + </method> + <method name="set_master_player"> + <return type="void"> + </return> + <argument index="0" name="nodepath" type="NodePath"> + </argument> + <description> + </description> + </method> + <method name="timescale_node_get_scale" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <description> + Returns time scale value of a TimeScale node given its name. + </description> + </method> + <method name="timescale_node_set_scale"> + <return type="void"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="scale" type="float"> + </argument> + <description> + Sets time scale value of a TimeScale node given its name and value. + </description> + </method> + <method name="timeseek_node_seek"> + <return type="void"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="pos_sec" type="float"> + </argument> + <description> + Sets time seek value of a TimeSeek node given its name and value. + </description> + </method> + <method name="transition_node_delete_input"> + <return type="void"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="input_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="transition_node_get_current" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <description> + </description> + </method> + <method name="transition_node_get_input_count" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <description> + </description> + </method> + <method name="transition_node_get_xfade_time" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <description> + </description> + </method> + <method name="transition_node_has_input_auto_advance" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="input_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="transition_node_set_current"> + <return type="void"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="input_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="transition_node_set_input_auto_advance"> + <return type="void"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="input_idx" type="int"> + </argument> + <argument index="2" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="transition_node_set_input_count"> + <return type="void"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="count" type="int"> + </argument> + <description> + </description> + </method> + <method name="transition_node_set_xfade_time"> + <return type="void"> + </return> + <argument index="0" name="id" type="String"> + </argument> + <argument index="1" name="time_sec" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="playback_process_mode" type="int" setter="set_animation_process_mode" getter="get_animation_process_mode" enum="AnimationTreePlayer.AnimationProcessMode"> + </member> + </members> + <constants> + <constant name="NODE_OUTPUT" value="0"> + Output node. + </constant> + <constant name="NODE_ANIMATION" value="1"> + Animation node. + </constant> + <constant name="NODE_ONESHOT" value="2"> + OneShot node. + </constant> + <constant name="NODE_MIX" value="3"> + Mix node. + </constant> + <constant name="NODE_BLEND2" value="4"> + Blend2 node. + </constant> + <constant name="NODE_BLEND3" value="5"> + Blend3 node. + </constant> + <constant name="NODE_BLEND4" value="6"> + Blend4 node. + </constant> + <constant name="NODE_TIMESCALE" value="7"> + TimeScale node. + </constant> + <constant name="NODE_TIMESEEK" value="8"> + TimeSeek node. + </constant> + <constant name="NODE_TRANSITION" value="9"> + Transition node. + </constant> + <constant name="ANIMATION_PROCESS_FIXED" value="0"> + </constant> + <constant name="ANIMATION_PROCESS_IDLE" value="1"> + </constant> + </constants> +</class> diff --git a/doc/classes/Area.xml b/doc/classes/Area.xml new file mode 100644 index 0000000000..c59bbee084 --- /dev/null +++ b/doc/classes/Area.xml @@ -0,0 +1,507 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Area" inherits="CollisionObject" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + General purpose area detection and influence for 3D physics. + </brief_description> + <description> + General purpose area detection for 3D 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. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_angular_damp" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the angular damp rate. + </description> + </method> + <method name="get_audio_bus" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_collision_layer" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the physics layer this area is in. + </description> + </method> + <method name="get_collision_layer_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <description> + Return an individual bit on the layer mask. + </description> + </method> + <method name="get_collision_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the physics layers this area can scan for collisions. + </description> + </method> + <method name="get_collision_mask_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <description> + Return an individual bit on the collision mask. + </description> + </method> + <method name="get_gravity" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the gravity intensity. + </description> + </method> + <method name="get_gravity_distance_scale" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the falloff factor for point gravity. + </description> + </method> + <method name="get_gravity_vector" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + Return the gravity vector. If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center. + </description> + </method> + <method name="get_linear_damp" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the linear damp rate. + </description> + </method> + <method name="get_overlapping_areas" qualifiers="const"> + <return type="Array"> + </return> + <description> + Return a list of the areas that are totally or partially inside this area. + </description> + </method> + <method name="get_overlapping_bodies" qualifiers="const"> + <return type="Array"> + </return> + <description> + Return a list of the bodies ([PhysicsBody]) that are totally or partially inside this area. + </description> + </method> + <method name="get_priority" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the processing order of this area. + </description> + </method> + <method name="get_reverb_amount" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_reverb_bus" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_reverb_uniformity" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_space_override_mode" qualifiers="const"> + <return type="int" enum="Area.SpaceOverride"> + </return> + <description> + Return the space override mode. + </description> + </method> + <method name="is_gravity_a_point" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction. + </description> + </method> + <method name="is_monitorable" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether this area can be detected by other, monitoring, areas. + </description> + </method> + <method name="is_monitoring" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether this area detects bodies/areas entering/exiting it. + </description> + </method> + <method name="is_overriding_audio_bus" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_using_reverb_bus" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="overlaps_area" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="area" type="Node"> + </argument> + <description> + Return whether the area passed is totally or partially inside this area. + </description> + </method> + <method name="overlaps_body" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="body" type="Node"> + </argument> + <description> + Return whether the body passed is totally or partially inside this area. + </description> + </method> + <method name="set_angular_damp"> + <return type="void"> + </return> + <argument index="0" name="angular_damp" type="float"> + </argument> + <description> + Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. + 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. + </description> + </method> + <method name="set_audio_bus"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_audio_bus_override"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_collision_layer"> + <return type="void"> + </return> + <argument index="0" name="collision_layer" type="int"> + </argument> + <description> + Set the physics layers this area 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 layer scanned by object A. + </description> + </method> + <method name="set_collision_layer_bit"> + <return type="void"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> + <description> + Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. + </description> + </method> + <method name="set_collision_mask"> + <return type="void"> + </return> + <argument index="0" name="collision_mask" type="int"> + </argument> + <description> + Set the physics layers this area can scan for collisions. + </description> + </method> + <method name="set_collision_mask_bit"> + <return type="void"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> + <description> + Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. + </description> + </method> + <method name="set_gravity"> + <return type="void"> + </return> + <argument index="0" name="gravity" type="float"> + </argument> + <description> + Set the gravity intensity. 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). + </description> + </method> + <method name="set_gravity_distance_scale"> + <return type="void"> + </return> + <argument index="0" name="distance_scale" type="float"> + </argument> + <description> + Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance. + </description> + </method> + <method name="set_gravity_is_point"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use [method set_gravity_vector]/[method get_gravity_vector]. + </description> + </method> + <method name="set_gravity_vector"> + <return type="void"> + </return> + <argument index="0" name="vector" type="Vector3"> + </argument> + <description> + Set the gravity vector. This vector does not have to be normalized. + If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center. + </description> + </method> + <method name="set_linear_damp"> + <return type="void"> + </return> + <argument index="0" name="linear_damp" type="float"> + </argument> + <description> + Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. + 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. + </description> + </method> + <method name="set_monitorable"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so. + </description> + </method> + <method name="set_monitoring"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set whether this area can detect bodies/areas entering/exiting it. + </description> + </method> + <method name="set_priority"> + <return type="void"> + </return> + <argument index="0" name="priority" type="float"> + </argument> + <description> + Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have a space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent. + Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important. + </description> + </method> + <method name="set_reverb_amount"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_reverb_bus"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_reverb_uniformity"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_space_override_mode"> + <return type="void"> + </return> + <argument index="0" name="enable" type="int" enum="Area.SpaceOverride"> + </argument> + <description> + Set the space override mode. This mode controls how an area affects gravity and damp. + AREA_SPACE_OVERRIDE_DISABLED: This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. + AREA_SPACE_OVERRIDE_COMBINE: 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. + AREA_SPACE_OVERRIDE_COMBINE_REPLACE: 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. + AREA_SPACE_OVERRIDE_REPLACE: This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. + AREA_SPACE_OVERRIDE_REPLACE_COMBINE: This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. + </description> + </method> + <method name="set_use_reverb_bus"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp"> + </member> + <member name="audio_bus_name" type="String" setter="set_audio_bus" getter="get_audio_bus"> + </member> + <member name="audio_bus_override" type="bool" setter="set_audio_bus_override" getter="is_overriding_audio_bus"> + </member> + <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer"> + </member> + <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask"> + </member> + <member name="gravity" type="float" setter="set_gravity" getter="get_gravity"> + </member> + <member name="gravity_distance_scale" type="float" setter="set_gravity_distance_scale" getter="get_gravity_distance_scale"> + </member> + <member name="gravity_point" type="bool" setter="set_gravity_is_point" getter="is_gravity_a_point"> + </member> + <member name="gravity_vec" type="Vector3" setter="set_gravity_vector" getter="get_gravity_vector"> + </member> + <member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp"> + </member> + <member name="monitorable" type="bool" setter="set_monitorable" getter="is_monitorable"> + </member> + <member name="monitoring" type="bool" setter="set_monitoring" getter="is_monitoring"> + </member> + <member name="priority" type="float" setter="set_priority" getter="get_priority"> + </member> + <member name="reverb_bus_amount" type="float" setter="set_reverb_amount" getter="get_reverb_amount"> + </member> + <member name="reverb_bus_enable" type="bool" setter="set_use_reverb_bus" getter="is_using_reverb_bus"> + </member> + <member name="reverb_bus_name" type="String" setter="set_reverb_bus" getter="get_reverb_bus"> + </member> + <member name="reverb_bus_uniformity" type="float" setter="set_reverb_uniformity" getter="get_reverb_uniformity"> + </member> + <member name="space_override" type="int" setter="set_space_override_mode" getter="get_space_override_mode" enum="Area.SpaceOverride"> + </member> + </members> + <signals> + <signal name="area_entered"> + <argument index="0" name="area" type="Object"> + </argument> + <description> + This signal is triggered only once when an area enters this area. The only parameter passed is the area that entered this area. + </description> + </signal> + <signal name="area_exited"> + <argument index="0" name="area" type="Object"> + </argument> + <description> + This signal is triggered only once when an area exits this area. The only parameter passed is the area that exited this area. + </description> + </signal> + <signal name="area_shape_entered"> + <argument index="0" name="area_id" type="int"> + </argument> + <argument index="1" name="area" type="Object"> + </argument> + <argument index="2" name="area_shape" type="int"> + </argument> + <argument index="3" name="self_shape" type="int"> + </argument> + <description> + This signal triggers only once when an area enters this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering. + </description> + </signal> + <signal name="area_shape_exited"> + <argument index="0" name="area_id" type="int"> + </argument> + <argument index="1" name="area" type="Object"> + </argument> + <argument index="2" name="area_shape" type="int"> + </argument> + <argument index="3" name="self_shape" type="int"> + </argument> + <description> + This signal triggers only once when an area exits this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering. + </description> + </signal> + <signal name="body_entered"> + <argument index="0" name="body" type="Object"> + </argument> + <description> + This signal is triggered only once when a body enters this area. The only parameter passed is the body that entered this area. + </description> + </signal> + <signal name="body_exited"> + <argument index="0" name="body" type="Object"> + </argument> + <description> + This signal is triggered only once when a body exits this area. The only parameter passed is the body that exited this area. + </description> + </signal> + <signal name="body_shape_entered"> + <argument index="0" name="body_id" type="int"> + </argument> + <argument index="1" name="body" type="Object"> + </argument> + <argument index="2" name="body_shape" type="int"> + </argument> + <argument index="3" name="area_shape" type="int"> + </argument> + <description> + This signal triggers only once when a body enters this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape of the body that entered this area, and the fourth one is the index of the shape in this area that reported the entering. + </description> + </signal> + <signal name="body_shape_exited"> + <argument index="0" name="body_id" type="int"> + </argument> + <argument index="1" name="body" type="Object"> + </argument> + <argument index="2" name="body_shape" type="int"> + </argument> + <argument index="3" name="area_shape" type="int"> + </argument> + <description> + This signal triggers only once when a body exits this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape exiting this area, and the fourth one is the index of the shape in this area that reported the exit. + </description> + </signal> + </signals> + <constants> + <constant name="SPACE_OVERRIDE_DISABLED" value="0"> + </constant> + <constant name="SPACE_OVERRIDE_COMBINE" value="1"> + </constant> + <constant name="SPACE_OVERRIDE_COMBINE_REPLACE" value="2"> + </constant> + <constant name="SPACE_OVERRIDE_REPLACE" value="3"> + </constant> + <constant name="SPACE_OVERRIDE_REPLACE_COMBINE" value="4"> + </constant> + </constants> +</class> diff --git a/doc/classes/Area2D.xml b/doc/classes/Area2D.xml new file mode 100644 index 0000000000..e093b5cb49 --- /dev/null +++ b/doc/classes/Area2D.xml @@ -0,0 +1,465 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Area2D" inherits="CollisionObject2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + 2D area that detects nodes that enter or exit it. Can override 2D physics properties within range. + </brief_description> + <description> + 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 [CollisionObject2D] for usage. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_angular_damp" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the angular damp rate. + </description> + </method> + <method name="get_audio_bus" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_collision_layer" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the physics layer this area is in. + </description> + </method> + <method name="get_collision_layer_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <description> + Return an individual bit on the layer mask. Describes whether other areas will collide with this one on the given layer. + </description> + </method> + <method name="get_collision_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the physics layers this area will scan to determine collisions. + </description> + </method> + <method name="get_collision_mask_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <description> + Return an individual bit on the collision mask. Describes whether this area will collide with others on the given layer. + </description> + </method> + <method name="get_gravity" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the gravity intensity. + </description> + </method> + <method name="get_gravity_distance_scale" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the falloff factor for point gravity. + </description> + </method> + <method name="get_gravity_vector" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the gravity vector. If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center. + </description> + </method> + <method name="get_linear_damp" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the linear damp rate. + </description> + </method> + <method name="get_overlapping_areas" qualifiers="const"> + <return type="Array"> + </return> + <description> + Returns a list of the [Area2D]s that intersect with this area. + </description> + </method> + <method name="get_overlapping_bodies" qualifiers="const"> + <return type="Array"> + </return> + <description> + Return a list of the [PhysicsBody2D]s that intersect with this area. + </description> + </method> + <method name="get_priority" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the processing order of this area. + </description> + </method> + <method name="get_space_override_mode" qualifiers="const"> + <return type="int" enum="Area2D.SpaceOverride"> + </return> + <description> + Return the space override mode. + </description> + </method> + <method name="is_gravity_a_point" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction. + </description> + </method> + <method name="is_monitorable" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether this area can be detected by other, monitoring, areas. + </description> + </method> + <method name="is_monitoring" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether this area detects bodies/areas entering/exiting it. + </description> + </method> + <method name="is_overriding_audio_bus" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="overlaps_area" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="area" type="Node"> + </argument> + <description> + Return whether the area passed is totally or partially inside this area. + </description> + </method> + <method name="overlaps_body" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="body" type="Node"> + </argument> + <description> + Return whether the body passed is totally or partially inside this area. + </description> + </method> + <method name="set_angular_damp"> + <return type="void"> + </return> + <argument index="0" name="angular_damp" type="float"> + </argument> + <description> + Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. + 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. + </description> + </method> + <method name="set_audio_bus"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_audio_bus_override"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_collision_layer"> + <return type="void"> + </return> + <argument index="0" name="collision_layer" type="int"> + </argument> + <description> + Set the physics layers this area 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 layer scanned by object A. + </description> + </method> + <method name="set_collision_layer_bit"> + <return type="void"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> + <description> + Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. + </description> + </method> + <method name="set_collision_mask"> + <return type="void"> + </return> + <argument index="0" name="collision_mask" type="int"> + </argument> + <description> + Set the physics layers this area can scan for collisions. + </description> + </method> + <method name="set_collision_mask_bit"> + <return type="void"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> + <description> + Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. + </description> + </method> + <method name="set_gravity"> + <return type="void"> + </return> + <argument index="0" name="gravity" type="float"> + </argument> + <description> + Set the gravity intensity. 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). + </description> + </method> + <method name="set_gravity_distance_scale"> + <return type="void"> + </return> + <argument index="0" name="distance_scale" type="float"> + </argument> + <description> + Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance. + </description> + </method> + <method name="set_gravity_is_point"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use [method set_gravity_vector]/[method get_gravity_vector]. + </description> + </method> + <method name="set_gravity_vector"> + <return type="void"> + </return> + <argument index="0" name="vector" type="Vector2"> + </argument> + <description> + Set the gravity vector. This vector does not have to be normalized. + If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center. + </description> + </method> + <method name="set_linear_damp"> + <return type="void"> + </return> + <argument index="0" name="linear_damp" type="float"> + </argument> + <description> + Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. + 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. + </description> + </method> + <method name="set_monitorable"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so. + </description> + </method> + <method name="set_monitoring"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set whether this area can detect bodies/areas entering/exiting it. + </description> + </method> + <method name="set_priority"> + <return type="void"> + </return> + <argument index="0" name="priority" type="float"> + </argument> + <description> + Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have a space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent. + Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important. + </description> + </method> + <method name="set_space_override_mode"> + <return type="void"> + </return> + <argument index="0" name="space_override_mode" type="int" enum="Area2D.SpaceOverride"> + </argument> + <description> + Set the space override mode. This mode controls how an area affects gravity and damp. + AREA_SPACE_OVERRIDE_DISABLED: This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. + AREA_SPACE_OVERRIDE_COMBINE: 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. + AREA_SPACE_OVERRIDE_COMBINE_REPLACE: 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. + AREA_SPACE_OVERRIDE_REPLACE: This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. + AREA_SPACE_OVERRIDE_REPLACE_COMBINE: This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. + </description> + </method> + </methods> + <members> + <member name="angular_damp" type="float" setter="set_angular_damp" getter="get_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'. + </member> + <member name="audio_bus_name" type="String" setter="set_audio_bus" getter="get_audio_bus"> + The name of the Area2D's audio bus. + </member> + <member name="audio_bus_override" type="bool" setter="set_audio_bus_override" getter="is_overriding_audio_bus"> + If [code]true[/code], overrides the default audio bus with the Area2D's. Defaults to [code]false[/code]. + </member> + <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_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. + </member> + <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask"> + The physics layers this Area2D scans to determine collision detections. + </member> + <member name="gravity" type="float" setter="set_gravity" getter="get_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). + </member> + <member name="gravity_distance_scale" type="float" setter="set_gravity_distance_scale" getter="get_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. + </member> + <member name="gravity_point" type="bool" setter="set_gravity_is_point" getter="is_gravity_a_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]. + </member> + <member name="gravity_vec" type="Vector2" setter="set_gravity_vector" getter="get_gravity_vector"> + 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. + </member> + <member name="linear_damp" type="float" setter="set_linear_damp" getter="get_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'. + </member> + <member name="monitorable" type="bool" setter="set_monitorable" getter="is_monitorable"> + If [code]true[/code], other monitoring areas can detect this Area2D (is it undetectable at the moment?). Defaults to [code]true[/code]. + </member> + <member name="monitoring" type="bool" setter="set_monitoring" getter="is_monitoring"> + If [code]true[/code], this detects bodies/areas entering/exiting it (can it detect others at the moment?). Defaults to [code]true[/code]. + </member> + <member name="priority" type="float" setter="set_priority" getter="get_priority"> + The processing order for this priority. Ranges from 0 to 128. Defaults to 0. Higher priorities are processed first. + </member> + <member name="space_override" type="int" setter="set_space_override_mode" getter="get_space_override_mode" enum="Area2D.SpaceOverride"> + How to override gravity and damping calculations within this Area2D, if at all. Consult the SPACE_OVERRIDE_* constants for available options. + </member> + </members> + <signals> + <signal name="area_entered"> + <argument index="0" name="area" type="Object"> + </argument> + <description> + This signal is triggered only once when an area enters this area. The only parameter passed is the area that entered this area. + </description> + </signal> + <signal name="area_exited"> + <argument index="0" name="area" type="Object"> + </argument> + <description> + This signal is triggered only once when an area exits this area. The only parameter passed is the area that exited this area. + </description> + </signal> + <signal name="area_shape_entered"> + <argument index="0" name="area_id" type="int"> + </argument> + <argument index="1" name="area" type="Object"> + </argument> + <argument index="2" name="area_shape" type="int"> + </argument> + <argument index="3" name="self_shape" type="int"> + </argument> + <description> + This signal triggers only once when an area enters this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering. + </description> + </signal> + <signal name="area_shape_exited"> + <argument index="0" name="area_id" type="int"> + </argument> + <argument index="1" name="area" type="Object"> + </argument> + <argument index="2" name="area_shape" type="int"> + </argument> + <argument index="3" name="self_shape" type="int"> + </argument> + <description> + This signal triggers only once when an area exits this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering. + </description> + </signal> + <signal name="body_entered"> + <argument index="0" name="body" type="Object"> + </argument> + <description> + This signal is triggered only once when a body enters this area. The only parameter passed is the body that entered this area. + </description> + </signal> + <signal name="body_exited"> + <argument index="0" name="body" type="Object"> + </argument> + <description> + This signal is triggered only once when a body exits this area. The only parameter passed is the body that exited this area. + </description> + </signal> + <signal name="body_shape_entered"> + <argument index="0" name="body_id" type="int"> + </argument> + <argument index="1" name="body" type="Object"> + </argument> + <argument index="2" name="body_shape" type="int"> + </argument> + <argument index="3" name="area_shape" type="int"> + </argument> + <description> + This signal triggers only once when a body enters this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape of the body that entered this area, and the fourth one is the index of the shape in this area that reported the entering. + </description> + </signal> + <signal name="body_shape_exited"> + <argument index="0" name="body_id" type="int"> + </argument> + <argument index="1" name="body" type="Object"> + </argument> + <argument index="2" name="body_shape" type="int"> + </argument> + <argument index="3" name="area_shape" type="int"> + </argument> + <description> + This signal triggers only once when a body exits this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape exiting this area, and the fourth one is the index of the shape in this area that reported the exit. + </description> + </signal> + </signals> + <constants> + <constant name="SPACE_OVERRIDE_DISABLED" value="0"> + This area does not affect gravity/damp. These are areas that exist only to detect collisions and objects entering or exiting them. + </constant> + <constant name="SPACE_OVERRIDE_COMBINE" value="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. + </constant> + <constant name="SPACE_OVERRIDE_COMBINE_REPLACE" value="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. + </constant> + <constant name="SPACE_OVERRIDE_REPLACE" value="3"> + This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. + </constant> + <constant name="SPACE_OVERRIDE_REPLACE_COMBINE" value="4"> + This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. + </constant> + </constants> +</class> diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml new file mode 100644 index 0000000000..042dfb3e12 --- /dev/null +++ b/doc/classes/Array.xml @@ -0,0 +1,257 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Array" category="Built-In Types" version="3.0.alpha.custom_build"> + <brief_description> + Generic array datatype. + </brief_description> + <description> + Generic array, contains several elements of any type, accessible by numerical index starting at 0. Negative indices can be used to count from the right, like in Python. Arrays are always passed by reference. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="Array"> + <return type="Array"> + </return> + <argument index="0" name="from" type="PoolColorArray"> + </argument> + <description> + Construct an array from a [PoolColorArray]. + </description> + </method> + <method name="Array"> + <return type="Array"> + </return> + <argument index="0" name="from" type="PoolVector3Array"> + </argument> + <description> + Construct an array from a [PoolVector3Array]. + </description> + </method> + <method name="Array"> + <return type="Array"> + </return> + <argument index="0" name="from" type="PoolVector2Array"> + </argument> + <description> + Construct an array from a [PoolVector2Array]. + </description> + </method> + <method name="Array"> + <return type="Array"> + </return> + <argument index="0" name="from" type="PoolStringArray"> + </argument> + <description> + Construct an array from a [PoolStringArray]. + </description> + </method> + <method name="Array"> + <return type="Array"> + </return> + <argument index="0" name="from" type="PoolRealArray"> + </argument> + <description> + Construct an array from a [PoolRealArray]. + </description> + </method> + <method name="Array"> + <return type="Array"> + </return> + <argument index="0" name="from" type="PoolIntArray"> + </argument> + <description> + Construct an array from a [PoolIntArray]. + </description> + </method> + <method name="Array"> + <return type="Array"> + </return> + <argument index="0" name="from" type="PoolByteArray"> + </argument> + <description> + Construct an array from a [PoolByteArray]. + </description> + </method> + <method name="append"> + <argument index="0" name="value" type="var"> + </argument> + <description> + Append an element at the end of the array (alias of [method push_back]). + </description> + </method> + <method name="back"> + <description> + Returns the last element of the array if the array is not empty (size>0). + </description> + </method> + <method name="clear"> + <description> + Clear the array (resize to 0). + </description> + </method> + <method name="count"> + <return type="int"> + </return> + <argument index="0" name="value" type="var"> + </argument> + <description> + Return the amount of times an element is in the array. + </description> + </method> + <method name="duplicate"> + <return type="Array"> + </return> + <description> + </description> + </method> + <method name="empty"> + <return type="bool"> + </return> + <description> + Return true if the array is empty (size==0). + </description> + </method> + <method name="erase"> + <argument index="0" name="value" type="var"> + </argument> + <description> + Remove the first occurrence of a value from the array. + </description> + </method> + <method name="find"> + <return type="int"> + </return> + <argument index="0" name="what" type="var"> + </argument> + <argument index="1" name="from" type="int" default="0"> + </argument> + <description> + Searches the array for a value and returns its index or -1 if not found. Optionally, the initial search index can be passed. + </description> + </method> + <method name="find_last"> + <return type="int"> + </return> + <argument index="0" name="value" type="var"> + </argument> + <description> + Searches the array in reverse order for a value and returns its index or -1 if not found. + </description> + </method> + <method name="front"> + <description> + Returns the first element of the array if the array is not empty (size>0). + </description> + </method> + <method name="has"> + <return type="bool"> + </return> + <argument index="0" name="value" type="var"> + </argument> + <description> + Return true if the array contains given value. + [codeblock] + [ "inside", 7 ].has("inside") == true + [ "inside", 7 ].has("outside") == false + [ "inside", 7 ].has(7) == true + [ "inside", 7 ].has("7") == false + [/codeblock] + </description> + </method> + <method name="hash"> + <return type="int"> + </return> + <description> + Return a hashed integer value representing the array contents. + </description> + </method> + <method name="insert"> + <argument index="0" name="pos" type="int"> + </argument> + <argument index="1" name="value" type="var"> + </argument> + <description> + 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()). + </description> + </method> + <method name="invert"> + <description> + Reverse the order of the elements in the array (so first element will now be the last). + </description> + </method> + <method name="pop_back"> + <description> + Remove the last element of the array. + </description> + </method> + <method name="pop_front"> + <description> + Remove the first element of the array. + </description> + </method> + <method name="push_back"> + <argument index="0" name="value" type="var"> + </argument> + <description> + Append an element at the end of the array. + </description> + </method> + <method name="push_front"> + <argument index="0" name="value" type="var"> + </argument> + <description> + Add an element at the beginning of the array. + </description> + </method> + <method name="remove"> + <argument index="0" name="pos" type="int"> + </argument> + <description> + Remove an element from the array by index. + </description> + </method> + <method name="resize"> + <argument index="0" name="pos" type="int"> + </argument> + <description> + 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. + </description> + </method> + <method name="rfind"> + <return type="int"> + </return> + <argument index="0" name="what" type="var"> + </argument> + <argument index="1" name="from" type="int" default="-1"> + </argument> + <description> + Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. + </description> + </method> + <method name="size"> + <return type="int"> + </return> + <description> + Return the amount of elements in the array. + </description> + </method> + <method name="sort"> + <description> + Sort the array using natural order. + </description> + </method> + <method name="sort_custom"> + <argument index="0" name="obj" type="Object"> + </argument> + <argument index="1" name="func" type="String"> + </argument> + <description> + Sort the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. Note: you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml new file mode 100644 index 0000000000..36f8494c44 --- /dev/null +++ b/doc/classes/ArrayMesh.xml @@ -0,0 +1,267 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ArrayMesh" inherits="Mesh" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_blend_shape"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="add_surface_from_arrays"> + <return type="void"> + </return> + <argument index="0" name="primitive" type="int" enum="Mesh.PrimitiveType"> + </argument> + <argument index="1" name="arrays" type="Array"> + </argument> + <argument index="2" name="blend_shapes" type="Array" default="[ ]"> + </argument> + <argument index="3" name="compress_flags" type="int" default="97792"> + </argument> + <description> + Create a new surface ([method get_surface_count] that will become surf_idx for this. + Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_POINTS, PRIMITIVE_LINES, PRIMITIVE_LINE_STRIP, PRIMITIVE_LINE_LOOP, PRIMITIVE_TRIANGLES, PRIMITIVE_TRIANGLE_STRIP, PRIMITIVE_TRIANGLE_FAN. (As a note, when using indices, it is recommended to only use just points, lines or triangles). + </description> + </method> + <method name="center_geometry"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="clear_blend_shapes"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="get_blend_shape_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_blend_shape_mode" qualifiers="const"> + <return type="int" enum="Mesh.BlendShapeMode"> + </return> + <description> + </description> + </method> + <method name="get_blend_shape_name" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_custom_aabb" qualifiers="const"> + <return type="Rect3"> + </return> + <description> + </description> + </method> + <method name="get_surface_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the amount of surfaces that the [ArrayMesh] holds. + </description> + </method> + <method name="regen_normalmaps"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="set_blend_shape_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="Mesh.BlendShapeMode"> + </argument> + <description> + </description> + </method> + <method name="set_custom_aabb"> + <return type="void"> + </return> + <argument index="0" name="aabb" type="Rect3"> + </argument> + <description> + </description> + </method> + <method name="surface_get_array_index_len" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="surf_idx" type="int"> + </argument> + <description> + Return the length in indices of the index array in the requested surface (see [method add_surface]). + </description> + </method> + <method name="surface_get_array_len" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="surf_idx" type="int"> + </argument> + <description> + Return the length in vertices of the vertex array in the requested surface (see [method add_surface]). + </description> + </method> + <method name="surface_get_arrays" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="surf_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="surface_get_blend_shape_arrays" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="surf_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="surface_get_format" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="surf_idx" type="int"> + </argument> + <description> + Return the format mask of the requested surface (see [method add_surface]). + </description> + </method> + <method name="surface_get_material" qualifiers="const"> + <return type="Material"> + </return> + <argument index="0" name="surf_idx" type="int"> + </argument> + <description> + Return a [Material] in a given surface. Surface is rendered using this material. + </description> + </method> + <method name="surface_get_name" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="surf_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="surface_get_primitive_type" qualifiers="const"> + <return type="int" enum="Mesh.PrimitiveType"> + </return> + <argument index="0" name="surf_idx" type="int"> + </argument> + <description> + Return the primitive type of the requested surface (see [method add_surface]). + </description> + </method> + <method name="surface_remove"> + <return type="void"> + </return> + <argument index="0" name="surf_idx" type="int"> + </argument> + <description> + Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down. + </description> + </method> + <method name="surface_set_material"> + <return type="void"> + </return> + <argument index="0" name="surf_idx" type="int"> + </argument> + <argument index="1" name="material" type="Material"> + </argument> + <description> + </description> + </method> + <method name="surface_set_name"> + <return type="void"> + </return> + <argument index="0" name="surf_idx" type="int"> + </argument> + <argument index="1" name="name" type="String"> + </argument> + <description> + Set a [Material] for a given surface. Surface will be rendered using this material. + </description> + </method> + </methods> + <constants> + <constant name="NO_INDEX_ARRAY" value="-1" enum=""> + Default value used for index_array_len when no indices are present. + </constant> + <constant name="ARRAY_WEIGHTS_SIZE" value="4" enum=""> + Amount of weights/bone indices per vertex (always 4). + </constant> + <constant name="ARRAY_VERTEX" value="0"> + Vertex array (array of [Vector3] vertices). + </constant> + <constant name="ARRAY_NORMAL" value="1"> + Normal array (array of [Vector3] normals). + </constant> + <constant name="ARRAY_TANGENT" value="2"> + Tangent array, array of groups of 4 floats. first 3 floats determine the tangent, and the last the binormal direction as -1 or 1. + </constant> + <constant name="ARRAY_COLOR" value="3"> + Vertex array (array of [Color] colors). + </constant> + <constant name="ARRAY_TEX_UV" value="4"> + UV array (array of [Vector3] UVs or float array of groups of 2 floats (u,v)). + </constant> + <constant name="ARRAY_TEX_UV2" value="5"> + Second UV array (array of [Vector3] UVs or float array of groups of 2 floats (u,v)). + </constant> + <constant name="ARRAY_BONES" value="6"> + Array of bone indices, as a float array. Each element in groups of 4 floats. + </constant> + <constant name="ARRAY_WEIGHTS" value="7"> + Array of bone weights, as a float array. Each element in groups of 4 floats. + </constant> + <constant name="ARRAY_INDEX" value="8"> + Array of integers, used as indices referencing vertices. No index can be beyond the vertex array size. + </constant> + <constant name="ARRAY_MAX" value="9"> + </constant> + <constant name="ARRAY_FORMAT_VERTEX" value="1"> + Array format will include vertices (mandatory). + </constant> + <constant name="ARRAY_FORMAT_NORMAL" value="2"> + Array format will include normals + </constant> + <constant name="ARRAY_FORMAT_TANGENT" value="4"> + Array format will include tangents + </constant> + <constant name="ARRAY_FORMAT_COLOR" value="8"> + Array format will include a color array. + </constant> + <constant name="ARRAY_FORMAT_TEX_UV" value="16"> + Array format will include UVs. + </constant> + <constant name="ARRAY_FORMAT_TEX_UV2" value="32"> + Array format will include another set of UVs. + </constant> + <constant name="ARRAY_FORMAT_BONES" value="64"> + Array format will include bone indices. + </constant> + <constant name="ARRAY_FORMAT_WEIGHTS" value="128"> + Array format will include bone weights. + </constant> + <constant name="ARRAY_FORMAT_INDEX" value="256"> + Index array will be used. + </constant> + </constants> +</class> diff --git a/doc/classes/AtlasTexture.xml b/doc/classes/AtlasTexture.xml new file mode 100644 index 0000000000..179f78f16f --- /dev/null +++ b/doc/classes/AtlasTexture.xml @@ -0,0 +1,71 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AtlasTexture" inherits="Texture" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Packs multiple small textures in a single, bigger one. Helps to optimize video memory costs and render calls. + </brief_description> + <description> + [Texture] resource aimed at managing big textures files that pack multiple smaller textures. Consists of a [Texture], a margin that defines the border width, + and a region that defines the actual area of the AtlasTexture. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_atlas" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="get_margin" qualifiers="const"> + <return type="Rect2"> + </return> + <description> + </description> + </method> + <method name="get_region" qualifiers="const"> + <return type="Rect2"> + </return> + <description> + </description> + </method> + <method name="set_atlas"> + <return type="void"> + </return> + <argument index="0" name="atlas" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_margin"> + <return type="void"> + </return> + <argument index="0" name="margin" type="Rect2"> + </argument> + <description> + </description> + </method> + <method name="set_region"> + <return type="void"> + </return> + <argument index="0" name="region" type="Rect2"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="atlas" type="Texture" setter="set_atlas" getter="get_atlas"> + The texture that contains the atlas. Can be any [Texture] subtype. + </member> + <member name="margin" type="Rect2" setter="set_margin" getter="get_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. + </member> + <member name="region" type="Rect2" setter="set_region" getter="get_region"> + The AtlasTexture's used region. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioBusLayout.xml b/doc/classes/AudioBusLayout.xml new file mode 100644 index 0000000000..e5b17b8dfb --- /dev/null +++ b/doc/classes/AudioBusLayout.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioBusLayout" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioEffect.xml b/doc/classes/AudioEffect.xml new file mode 100644 index 0000000000..627d243f25 --- /dev/null +++ b/doc/classes/AudioEffect.xml @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioEffect" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Audio Effect For Audio. + </brief_description> + <description> + Base resource for audio bus. Applies an audio effect on the bus that the resource is applied on. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioEffectAmplify.xml b/doc/classes/AudioEffectAmplify.xml new file mode 100644 index 0000000000..8497042b53 --- /dev/null +++ b/doc/classes/AudioEffectAmplify.xml @@ -0,0 +1,38 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioEffectAmplify" inherits="AudioEffect" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Amplifies the volume of an audio source. + </brief_description> + <description> + Amplifies the volume of an audio source. Increase gain of the audio being routed through the bus. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_volume_db" qualifiers="const"> + <return type="float"> + </return> + <description> + Returns the set maximum volume. + </description> + </method> + <method name="set_volume_db"> + <return type="void"> + </return> + <argument index="0" name="volume" type="float"> + </argument> + <description> + Sets the maximum volume. + </description> + </method> + </methods> + <members> + <member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db"> + The effect's volume limit. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioEffectBandLimitFilter.xml b/doc/classes/AudioEffectBandLimitFilter.xml new file mode 100644 index 0000000000..96f95fbffd --- /dev/null +++ b/doc/classes/AudioEffectBandLimitFilter.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioEffectBandLimitFilter" inherits="AudioEffectFilter" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioEffectBandPassFilter.xml b/doc/classes/AudioEffectBandPassFilter.xml new file mode 100644 index 0000000000..4437961cc6 --- /dev/null +++ b/doc/classes/AudioEffectBandPassFilter.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioEffectBandPassFilter" inherits="AudioEffectFilter" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioEffectChorus.xml b/doc/classes/AudioEffectChorus.xml new file mode 100644 index 0000000000..b9f27678ec --- /dev/null +++ b/doc/classes/AudioEffectChorus.xml @@ -0,0 +1,268 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioEffectChorus" inherits="AudioEffect" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Adds a chorus audio effect. + </brief_description> + <description> + Adds a chorus audio effect. The effect applies a filter with voices to duplicate the audio source and manipulate it through the filter. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_dry" qualifiers="const"> + <return type="float"> + </return> + <description> + Returns the set dry ratio. + </description> + </method> + <method name="get_voice_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the set voice count. + </description> + </method> + <method name="get_voice_cutoff_hz" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="voice_idx" type="int"> + </argument> + <description> + Returns the voice's set cutoff frequency. + </description> + </method> + <method name="get_voice_delay_ms" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="voice_idx" type="int"> + </argument> + <description> + Returns the voice's set delay. + </description> + </method> + <method name="get_voice_depth_ms" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="voice_idx" type="int"> + </argument> + <description> + Returns the voice's set filter depth. + </description> + </method> + <method name="get_voice_level_db" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="voice_idx" type="int"> + </argument> + <description> + Returns the voice's set maximum volume. + </description> + </method> + <method name="get_voice_pan" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="voice_idx" type="int"> + </argument> + <description> + Returns the voice's set pan. + </description> + </method> + <method name="get_voice_rate_hz" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="voice_idx" type="int"> + </argument> + <description> + Returns the voice filter's set rate in cycles. + </description> + </method> + <method name="get_wet" qualifiers="const"> + <return type="float"> + </return> + <description> + Returns the set applied wetness of the effect. + </description> + </method> + <method name="set_dry"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + Returns the set applied dryness of the effect. + </description> + </method> + <method name="set_voice_count"> + <return type="void"> + </return> + <argument index="0" name="voices" type="int"> + </argument> + <description> + Set the number of voices in the effect's filter. + </description> + </method> + <method name="set_voice_cutoff_hz"> + <return type="void"> + </return> + <argument index="0" name="voice_idx" type="int"> + </argument> + <argument index="1" name="cutoff_hz" type="float"> + </argument> + <description> + Set the cutoff frequency of the voice. The maximum frequency the voice may affect. + </description> + </method> + <method name="set_voice_delay_ms"> + <return type="void"> + </return> + <argument index="0" name="voice_idx" type="int"> + </argument> + <argument index="1" name="delay_ms" type="float"> + </argument> + <description> + Set the delay of the voice's signal. + </description> + </method> + <method name="set_voice_depth_ms"> + <return type="void"> + </return> + <argument index="0" name="voice_idx" type="int"> + </argument> + <argument index="1" name="depth_ms" type="float"> + </argument> + <description> + Set the filter depth of the voice's signal. + </description> + </method> + <method name="set_voice_level_db"> + <return type="void"> + </return> + <argument index="0" name="voice_idx" type="int"> + </argument> + <argument index="1" name="level_db" type="float"> + </argument> + <description> + Set the volume level of the voice. + </description> + </method> + <method name="set_voice_pan"> + <return type="void"> + </return> + <argument index="0" name="voice_idx" type="int"> + </argument> + <argument index="1" name="pan" type="float"> + </argument> + <description> + Set the pan level of the voice. + </description> + </method> + <method name="set_voice_rate_hz"> + <return type="void"> + </return> + <argument index="0" name="voice_idx" type="int"> + </argument> + <argument index="1" name="rate_hz" type="float"> + </argument> + <description> + Set the voice filter's rate. + </description> + </method> + <method name="set_wet"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + Set the amount of effect. + </description> + </method> + </methods> + <members> + <member name="dry" type="float" setter="set_dry" getter="get_dry"> + The effect's raw signal. + </member> + <member name="voice/1/cutoff_hz" type="float" setter="set_voice_cutoff_hz" getter="get_voice_cutoff_hz"> + The voice's cutoff frequency. + </member> + <member name="voice/1/delay_ms" type="float" setter="set_voice_delay_ms" getter="get_voice_delay_ms"> + The voice's signal delay. + </member> + <member name="voice/1/depth_ms" type="float" setter="set_voice_depth_ms" getter="get_voice_depth_ms"> + The voice filter's depth. + </member> + <member name="voice/1/level_db" type="float" setter="set_voice_level_db" getter="get_voice_level_db"> + The voice's volume. + </member> + <member name="voice/1/pan" type="float" setter="set_voice_pan" getter="get_voice_pan"> + The voice's pan level. + </member> + <member name="voice/1/rate_hz" type="float" setter="set_voice_rate_hz" getter="get_voice_rate_hz"> + The voice's filter rate. + </member> + <member name="voice/2/cutoff_hz" type="float" setter="set_voice_cutoff_hz" getter="get_voice_cutoff_hz"> + The voice's cutoff frequency. + </member> + <member name="voice/2/delay_ms" type="float" setter="set_voice_delay_ms" getter="get_voice_delay_ms"> + The voice's signal delay. + </member> + <member name="voice/2/depth_ms" type="float" setter="set_voice_depth_ms" getter="get_voice_depth_ms"> + The voice filter's depth. + </member> + <member name="voice/2/level_db" type="float" setter="set_voice_level_db" getter="get_voice_level_db"> + The voice's volume. + </member> + <member name="voice/2/pan" type="float" setter="set_voice_pan" getter="get_voice_pan"> + The voice's pan level. + </member> + <member name="voice/2/rate_hz" type="float" setter="set_voice_rate_hz" getter="get_voice_rate_hz"> + The voice's filter rate. + </member> + <member name="voice/3/cutoff_hz" type="float" setter="set_voice_cutoff_hz" getter="get_voice_cutoff_hz"> + The voice's cutoff frequency. + </member> + <member name="voice/3/delay_ms" type="float" setter="set_voice_delay_ms" getter="get_voice_delay_ms"> + The voice's signal delay. + </member> + <member name="voice/3/depth_ms" type="float" setter="set_voice_depth_ms" getter="get_voice_depth_ms"> + The voice filter's depth. + </member> + <member name="voice/3/level_db" type="float" setter="set_voice_level_db" getter="get_voice_level_db"> + The voice's volume. + </member> + <member name="voice/3/pan" type="float" setter="set_voice_pan" getter="get_voice_pan"> + The voice's pan level. + </member> + <member name="voice/3/rate_hz" type="float" setter="set_voice_rate_hz" getter="get_voice_rate_hz"> + The voice's filter rate. + </member> + <member name="voice/4/cutoff_hz" type="float" setter="set_voice_cutoff_hz" getter="get_voice_cutoff_hz"> + The voice's cutoff frequency. + </member> + <member name="voice/4/delay_ms" type="float" setter="set_voice_delay_ms" getter="get_voice_delay_ms"> + The voice's signal delay. + </member> + <member name="voice/4/depth_ms" type="float" setter="set_voice_depth_ms" getter="get_voice_depth_ms"> + The voice filter's depth. + </member> + <member name="voice/4/level_db" type="float" setter="set_voice_level_db" getter="get_voice_level_db"> + The voice's volume. + </member> + <member name="voice/4/pan" type="float" setter="set_voice_pan" getter="get_voice_pan"> + The voice's pan level. + </member> + <member name="voice/4/rate_hz" type="float" setter="set_voice_rate_hz" getter="get_voice_rate_hz"> + The voice's filter rate. + </member> + <member name="voice_count" type="int" setter="set_voice_count" getter="get_voice_count"> + The amount of voices in the effect. + </member> + <member name="wet" type="float" setter="set_wet" getter="get_wet"> + The effect's processed signal. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioEffectCompressor.xml b/doc/classes/AudioEffectCompressor.xml new file mode 100644 index 0000000000..5a7a91ede0 --- /dev/null +++ b/doc/classes/AudioEffectCompressor.xml @@ -0,0 +1,129 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioEffectCompressor" inherits="AudioEffect" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_attack_us" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_gain" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_mix" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_ratio" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_release_ms" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_sidechain" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_threshold" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="set_attack_us"> + <return type="void"> + </return> + <argument index="0" name="attack_us" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_gain"> + <return type="void"> + </return> + <argument index="0" name="gain" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_mix"> + <return type="void"> + </return> + <argument index="0" name="mix" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_ratio"> + <return type="void"> + </return> + <argument index="0" name="ratio" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_release_ms"> + <return type="void"> + </return> + <argument index="0" name="release_ms" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_sidechain"> + <return type="void"> + </return> + <argument index="0" name="sidechain" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_threshold"> + <return type="void"> + </return> + <argument index="0" name="threshold" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="attack_us" type="float" setter="set_attack_us" getter="get_attack_us"> + </member> + <member name="gain" type="float" setter="set_gain" getter="get_gain"> + </member> + <member name="mix" type="float" setter="set_mix" getter="get_mix"> + </member> + <member name="ratio" type="float" setter="set_ratio" getter="get_ratio"> + </member> + <member name="release_ms" type="float" setter="set_release_ms" getter="get_release_ms"> + </member> + <member name="sidechain" type="String" setter="set_sidechain" getter="get_sidechain"> + </member> + <member name="threshold" type="float" setter="set_threshold" getter="get_threshold"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioEffectDelay.xml b/doc/classes/AudioEffectDelay.xml new file mode 100644 index 0000000000..8d317b3c46 --- /dev/null +++ b/doc/classes/AudioEffectDelay.xml @@ -0,0 +1,225 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioEffectDelay" inherits="AudioEffect" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_dry"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_feedback_delay_ms" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_feedback_level_db" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_feedback_lowpass" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_tap1_delay_ms" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_tap1_level_db" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_tap1_pan" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_tap2_delay_ms" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_tap2_level_db" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_tap2_pan" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="is_feedback_active" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_tap1_active" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_tap2_active" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_dry"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_feedback_active"> + <return type="void"> + </return> + <argument index="0" name="amount" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_feedback_delay_ms"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_feedback_level_db"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_feedback_lowpass"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_tap1_active"> + <return type="void"> + </return> + <argument index="0" name="amount" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_tap1_delay_ms"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_tap1_level_db"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_tap1_pan"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_tap2_active"> + <return type="void"> + </return> + <argument index="0" name="amount" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_tap2_delay_ms"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_tap2_level_db"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_tap2_pan"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="dry" type="float" setter="set_dry" getter="get_dry"> + </member> + <member name="feedback/active" type="bool" setter="set_feedback_active" getter="is_feedback_active"> + </member> + <member name="feedback/delay_ms" type="float" setter="set_feedback_delay_ms" getter="get_feedback_delay_ms"> + </member> + <member name="feedback/level_db" type="float" setter="set_feedback_level_db" getter="get_feedback_level_db"> + </member> + <member name="feedback/lowpass" type="float" setter="set_feedback_lowpass" getter="get_feedback_lowpass"> + </member> + <member name="tap1/active" type="bool" setter="set_tap1_active" getter="is_tap1_active"> + </member> + <member name="tap1/delay_ms" type="float" setter="set_tap1_delay_ms" getter="get_tap1_delay_ms"> + </member> + <member name="tap1/level_db" type="float" setter="set_tap1_level_db" getter="get_tap1_level_db"> + </member> + <member name="tap1/pan" type="float" setter="set_tap1_pan" getter="get_tap1_pan"> + </member> + <member name="tap2/active" type="bool" setter="set_tap2_active" getter="is_tap2_active"> + </member> + <member name="tap2/delay_ms" type="float" setter="set_tap2_delay_ms" getter="get_tap2_delay_ms"> + </member> + <member name="tap2/level_db" type="float" setter="set_tap2_level_db" getter="get_tap2_level_db"> + </member> + <member name="tap2/pan" type="float" setter="set_tap2_pan" getter="get_tap2_pan"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioEffectDistortion.xml b/doc/classes/AudioEffectDistortion.xml new file mode 100644 index 0000000000..e5c5a3b50e --- /dev/null +++ b/doc/classes/AudioEffectDistortion.xml @@ -0,0 +1,107 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioEffectDistortion" inherits="AudioEffect" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_drive" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_keep_hf_hz" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_mode" qualifiers="const"> + <return type="int" enum="AudioEffectDistortion.Mode"> + </return> + <description> + </description> + </method> + <method name="get_post_gain" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_pre_gain" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="set_drive"> + <return type="void"> + </return> + <argument index="0" name="drive" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_keep_hf_hz"> + <return type="void"> + </return> + <argument index="0" name="keep_hf_hz" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="AudioEffectDistortion.Mode"> + </argument> + <description> + </description> + </method> + <method name="set_post_gain"> + <return type="void"> + </return> + <argument index="0" name="post_gain" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_pre_gain"> + <return type="void"> + </return> + <argument index="0" name="pre_gain" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="drive" type="float" setter="set_drive" getter="get_drive"> + </member> + <member name="keep_hf_hz" type="float" setter="set_keep_hf_hz" getter="get_keep_hf_hz"> + </member> + <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="AudioEffectDistortion.Mode"> + </member> + <member name="post_gain" type="float" setter="set_post_gain" getter="get_post_gain"> + </member> + <member name="pre_gain" type="float" setter="set_pre_gain" getter="get_pre_gain"> + </member> + </members> + <constants> + <constant name="MODE_CLIP" value="0"> + </constant> + <constant name="MODE_ATAN" value="1"> + </constant> + <constant name="MODE_LOFI" value="2"> + </constant> + <constant name="MODE_OVERDRIVE" value="3"> + </constant> + <constant name="MODE_WAVESHAPE" value="4"> + </constant> + </constants> +</class> diff --git a/doc/classes/AudioEffectEQ.xml b/doc/classes/AudioEffectEQ.xml new file mode 100644 index 0000000000..94d5c696c3 --- /dev/null +++ b/doc/classes/AudioEffectEQ.xml @@ -0,0 +1,39 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioEffectEQ" inherits="AudioEffect" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_band_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_band_gain_db" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="band_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_band_gain_db"> + <return type="void"> + </return> + <argument index="0" name="band_idx" type="int"> + </argument> + <argument index="1" name="volume_db" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioEffectEQ10.xml b/doc/classes/AudioEffectEQ10.xml new file mode 100644 index 0000000000..004236dfde --- /dev/null +++ b/doc/classes/AudioEffectEQ10.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioEffectEQ10" inherits="AudioEffectEQ" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioEffectEQ21.xml b/doc/classes/AudioEffectEQ21.xml new file mode 100644 index 0000000000..e4faa9bb0c --- /dev/null +++ b/doc/classes/AudioEffectEQ21.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioEffectEQ21" inherits="AudioEffectEQ" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioEffectEQ6.xml b/doc/classes/AudioEffectEQ6.xml new file mode 100644 index 0000000000..b74cc5d285 --- /dev/null +++ b/doc/classes/AudioEffectEQ6.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioEffectEQ6" inherits="AudioEffectEQ" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioEffectFilter.xml b/doc/classes/AudioEffectFilter.xml new file mode 100644 index 0000000000..17aa01d60a --- /dev/null +++ b/doc/classes/AudioEffectFilter.xml @@ -0,0 +1,89 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioEffectFilter" inherits="AudioEffect" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_cutoff" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_db" qualifiers="const"> + <return type="int" enum="AudioEffectFilter.FilterDB"> + </return> + <description> + </description> + </method> + <method name="get_gain" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_resonance" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="set_cutoff"> + <return type="void"> + </return> + <argument index="0" name="freq" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_db"> + <return type="void"> + </return> + <argument index="0" name="amount" type="int" enum="AudioEffectFilter.FilterDB"> + </argument> + <description> + </description> + </method> + <method name="set_gain"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_resonance"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="cutoff_hz" type="float" setter="set_cutoff" getter="get_cutoff"> + </member> + <member name="dB" type="int" setter="set_db" getter="get_db" enum="AudioEffectFilter.FilterDB"> + </member> + <member name="gain" type="float" setter="set_gain" getter="get_gain"> + </member> + <member name="resonance" type="float" setter="set_resonance" getter="get_resonance"> + </member> + </members> + <constants> + <constant name="FILTER_6DB" value="0"> + </constant> + <constant name="FILTER_12DB" value="1"> + </constant> + <constant name="FILTER_18DB" value="2"> + </constant> + <constant name="FILTER_24DB" value="3"> + </constant> + </constants> +</class> diff --git a/doc/classes/AudioEffectHighPassFilter.xml b/doc/classes/AudioEffectHighPassFilter.xml new file mode 100644 index 0000000000..641f7cfee2 --- /dev/null +++ b/doc/classes/AudioEffectHighPassFilter.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioEffectHighPassFilter" inherits="AudioEffectFilter" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioEffectHighShelfFilter.xml b/doc/classes/AudioEffectHighShelfFilter.xml new file mode 100644 index 0000000000..a2504d6808 --- /dev/null +++ b/doc/classes/AudioEffectHighShelfFilter.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioEffectHighShelfFilter" inherits="AudioEffectFilter" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioEffectLimiter.xml b/doc/classes/AudioEffectLimiter.xml new file mode 100644 index 0000000000..e52fb57c70 --- /dev/null +++ b/doc/classes/AudioEffectLimiter.xml @@ -0,0 +1,81 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioEffectLimiter" inherits="AudioEffect" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_ceiling_db" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_soft_clip_db" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_soft_clip_ratio" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_threshold_db" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="set_ceiling_db"> + <return type="void"> + </return> + <argument index="0" name="ceiling" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_soft_clip_db"> + <return type="void"> + </return> + <argument index="0" name="soft_clip" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_soft_clip_ratio"> + <return type="void"> + </return> + <argument index="0" name="soft_clip" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_threshold_db"> + <return type="void"> + </return> + <argument index="0" name="threshold" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="ceiling_db" type="float" setter="set_ceiling_db" getter="get_ceiling_db"> + </member> + <member name="soft_clip_db" type="float" setter="set_soft_clip_db" getter="get_soft_clip_db"> + </member> + <member name="soft_clip_ratio" type="float" setter="set_soft_clip_ratio" getter="get_soft_clip_ratio"> + </member> + <member name="threshold_db" type="float" setter="set_threshold_db" getter="get_threshold_db"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioEffectLowPassFilter.xml b/doc/classes/AudioEffectLowPassFilter.xml new file mode 100644 index 0000000000..fcaf32d761 --- /dev/null +++ b/doc/classes/AudioEffectLowPassFilter.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioEffectLowPassFilter" inherits="AudioEffectFilter" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioEffectLowShelfFilter.xml b/doc/classes/AudioEffectLowShelfFilter.xml new file mode 100644 index 0000000000..8cf1a63c81 --- /dev/null +++ b/doc/classes/AudioEffectLowShelfFilter.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioEffectLowShelfFilter" inherits="AudioEffectFilter" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioEffectNotchFilter.xml b/doc/classes/AudioEffectNotchFilter.xml new file mode 100644 index 0000000000..f90577fa5a --- /dev/null +++ b/doc/classes/AudioEffectNotchFilter.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioEffectNotchFilter" inherits="AudioEffectFilter" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioEffectPanner.xml b/doc/classes/AudioEffectPanner.xml new file mode 100644 index 0000000000..b55d7f91c1 --- /dev/null +++ b/doc/classes/AudioEffectPanner.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioEffectPanner" inherits="AudioEffect" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_pan" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="set_pan"> + <return type="void"> + </return> + <argument index="0" name="cpanume" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="pan" type="float" setter="set_pan" getter="get_pan"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioEffectPhaser.xml b/doc/classes/AudioEffectPhaser.xml new file mode 100644 index 0000000000..7e9cd27a47 --- /dev/null +++ b/doc/classes/AudioEffectPhaser.xml @@ -0,0 +1,97 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioEffectPhaser" inherits="AudioEffect" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_depth" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_feedback" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_range_max_hz" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_range_min_hz" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_rate_hz" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="set_depth"> + <return type="void"> + </return> + <argument index="0" name="depth" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_feedback"> + <return type="void"> + </return> + <argument index="0" name="fbk" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_range_max_hz"> + <return type="void"> + </return> + <argument index="0" name="hz" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_range_min_hz"> + <return type="void"> + </return> + <argument index="0" name="hz" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_rate_hz"> + <return type="void"> + </return> + <argument index="0" name="hz" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="depth" type="float" setter="set_depth" getter="get_depth"> + </member> + <member name="feedback" type="float" setter="set_feedback" getter="get_feedback"> + </member> + <member name="range_max_hz" type="float" setter="set_range_max_hz" getter="get_range_max_hz"> + </member> + <member name="range_min_hz" type="float" setter="set_range_min_hz" getter="get_range_min_hz"> + </member> + <member name="rate_hz" type="float" setter="set_rate_hz" getter="get_rate_hz"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioEffectPitchShift.xml b/doc/classes/AudioEffectPitchShift.xml new file mode 100644 index 0000000000..6fc3acdc20 --- /dev/null +++ b/doc/classes/AudioEffectPitchShift.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioEffectPitchShift" inherits="AudioEffect" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_pitch_scale" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="set_pitch_scale"> + <return type="void"> + </return> + <argument index="0" name="rate" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioEffectReverb.xml b/doc/classes/AudioEffectReverb.xml new file mode 100644 index 0000000000..b390fa239c --- /dev/null +++ b/doc/classes/AudioEffectReverb.xml @@ -0,0 +1,145 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioEffectReverb" inherits="AudioEffect" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_damping" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_dry" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_hpf" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_predelay_feedback" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_predelay_msec" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_room_size" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_spread" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_wet" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="set_damping"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_dry"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_hpf"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_predelay_feedback"> + <return type="void"> + </return> + <argument index="0" name="feedback" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_predelay_msec"> + <return type="void"> + </return> + <argument index="0" name="msec" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_room_size"> + <return type="void"> + </return> + <argument index="0" name="size" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_spread"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_wet"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="damping" type="float" setter="set_damping" getter="get_damping"> + </member> + <member name="dry" type="float" setter="set_dry" getter="get_dry"> + </member> + <member name="hipass" type="float" setter="set_hpf" getter="get_hpf"> + </member> + <member name="predelay_feedback" type="float" setter="set_predelay_msec" getter="get_predelay_msec"> + </member> + <member name="predelay_msec" type="float" setter="set_predelay_msec" getter="get_predelay_msec"> + </member> + <member name="room_size" type="float" setter="set_room_size" getter="get_room_size"> + </member> + <member name="spread" type="float" setter="set_spread" getter="get_spread"> + </member> + <member name="wet" type="float" setter="set_wet" getter="get_wet"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioEffectStereoEnhance.xml b/doc/classes/AudioEffectStereoEnhance.xml new file mode 100644 index 0000000000..345d019d85 --- /dev/null +++ b/doc/classes/AudioEffectStereoEnhance.xml @@ -0,0 +1,65 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioEffectStereoEnhance" inherits="AudioEffect" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_pan_pullout" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_surround" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_time_pullout" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="set_pan_pullout"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_surround"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_time_pullout"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="pan_pullout" type="float" setter="set_pan_pullout" getter="get_pan_pullout"> + </member> + <member name="surround" type="float" setter="set_surround" getter="get_surround"> + </member> + <member name="time_pullout_ms" type="float" setter="set_time_pullout" getter="get_time_pullout"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioServer.xml b/doc/classes/AudioServer.xml new file mode 100644 index 0000000000..dc30c0c5f9 --- /dev/null +++ b/doc/classes/AudioServer.xml @@ -0,0 +1,317 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioServer" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Server interface for low level audio access. + </brief_description> + <description> + AudioServer is a low level server interface for audio access. It is in charge of creating sample data (playable audio) as well as its playback via a voice interface. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_bus"> + <return type="void"> + </return> + <argument index="0" name="at_pos" type="int" default="-1"> + </argument> + <description> + </description> + </method> + <method name="add_bus_effect"> + <return type="void"> + </return> + <argument index="0" name="bus_idx" type="int"> + </argument> + <argument index="1" name="effect" type="AudioEffect"> + </argument> + <argument index="2" name="at_pos" type="int" default="-1"> + </argument> + <description> + </description> + </method> + <method name="generate_bus_layout" qualifiers="const"> + <return type="AudioBusLayout"> + </return> + <description> + </description> + </method> + <method name="get_bus_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_bus_effect"> + <return type="AudioEffect"> + </return> + <argument index="0" name="bus_idx" type="int"> + </argument> + <argument index="1" name="effect_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_bus_effect_count"> + <return type="int"> + </return> + <argument index="0" name="bus_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_bus_index" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="bus_name" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_bus_name" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="bus_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_bus_peak_volume_left_db" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="bus_idx" type="int"> + </argument> + <argument index="1" name="channel" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_bus_peak_volume_right_db" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="bus_idx" type="int"> + </argument> + <argument index="1" name="channel" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_bus_send" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="bus_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_bus_volume_db" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="bus_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_mix_rate" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_speaker_mode" qualifiers="const"> + <return type="int" enum="AudioServer.SpeakerMode"> + </return> + <description> + </description> + </method> + <method name="is_bus_bypassing_effects" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="bus_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="is_bus_effect_enabled" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="bus_idx" type="int"> + </argument> + <argument index="1" name="effect_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="is_bus_mute" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="bus_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="is_bus_solo" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="bus_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="lock"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="move_bus"> + <return type="void"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <argument index="1" name="to_index" type="int"> + </argument> + <description> + </description> + </method> + <method name="remove_bus"> + <return type="void"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <description> + </description> + </method> + <method name="remove_bus_effect"> + <return type="void"> + </return> + <argument index="0" name="bus_idx" type="int"> + </argument> + <argument index="1" name="effect_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_bus_bypass_effects"> + <return type="void"> + </return> + <argument index="0" name="bus_idx" type="int"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_bus_count"> + <return type="void"> + </return> + <argument index="0" name="amount" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_bus_effect_enabled"> + <return type="void"> + </return> + <argument index="0" name="bus_idx" type="int"> + </argument> + <argument index="1" name="effect_idx" type="int"> + </argument> + <argument index="2" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_bus_layout"> + <return type="void"> + </return> + <argument index="0" name="bus_layout" type="AudioBusLayout"> + </argument> + <description> + </description> + </method> + <method name="set_bus_mute"> + <return type="void"> + </return> + <argument index="0" name="bus_idx" type="int"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_bus_name"> + <return type="void"> + </return> + <argument index="0" name="bus_idx" type="int"> + </argument> + <argument index="1" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_bus_send"> + <return type="void"> + </return> + <argument index="0" name="bus_idx" type="int"> + </argument> + <argument index="1" name="send" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_bus_solo"> + <return type="void"> + </return> + <argument index="0" name="bus_idx" type="int"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_bus_volume_db"> + <return type="void"> + </return> + <argument index="0" name="bus_idx" type="int"> + </argument> + <argument index="1" name="volume_db" type="float"> + </argument> + <description> + </description> + </method> + <method name="swap_bus_effects"> + <return type="void"> + </return> + <argument index="0" name="bus_idx" type="int"> + </argument> + <argument index="1" name="effect_idx" type="int"> + </argument> + <argument index="2" name="by_effect_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="unlock"> + <return type="void"> + </return> + <description> + </description> + </method> + </methods> + <signals> + <signal name="bus_layout_changed"> + <description> + </description> + </signal> + </signals> + <constants> + <constant name="SPEAKER_MODE_STEREO" value="0"> + </constant> + <constant name="SPEAKER_SURROUND_51" value="2"> + </constant> + <constant name="SPEAKER_SURROUND_71" value="3"> + </constant> + </constants> +</class> diff --git a/doc/classes/AudioStream.xml b/doc/classes/AudioStream.xml new file mode 100644 index 0000000000..b4a98b2d8c --- /dev/null +++ b/doc/classes/AudioStream.xml @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioStream" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base class for audio streams. + </brief_description> + <description> + Base class for audio streams. Audio streams are used for music playback, or other types of streamed sounds that don't fit or require more flexibility than a [Sample]. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioStreamOGGVorbis.xml b/doc/classes/AudioStreamOGGVorbis.xml new file mode 100644 index 0000000000..679438b66b --- /dev/null +++ b/doc/classes/AudioStreamOGGVorbis.xml @@ -0,0 +1,70 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioStreamOGGVorbis" inherits="AudioStream" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + OGG Vorbis audio stream driver. + </brief_description> + <description> + OGG Vorbis audio stream driver. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_data" qualifiers="const"> + <return type="PoolByteArray"> + </return> + <description> + </description> + </method> + <method name="get_loop_offset" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="has_loop" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_data"> + <return type="void"> + </return> + <argument index="0" name="data" type="PoolByteArray"> + </argument> + <description> + </description> + </method> + <method name="set_loop"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_loop_offset"> + <return type="void"> + </return> + <argument index="0" name="seconds" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="data" type="PoolByteArray" setter="set_data" getter="get_data"> + Raw audio data. + </member> + <member name="loop" type="bool" setter="set_loop" getter="has_loop"> + If [code]true[/code], audio will loop continuously. Default value: [code]false[/code]. + </member> + <member name="loop_offset" type="float" setter="set_loop_offset" getter="get_loop_offset"> + If loop is [code]true[/code], loop starts from this position, in seconds. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioStreamPlayback.xml b/doc/classes/AudioStreamPlayback.xml new file mode 100644 index 0000000000..30a9a8f070 --- /dev/null +++ b/doc/classes/AudioStreamPlayback.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioStreamPlayback" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioStreamPlayer.xml b/doc/classes/AudioStreamPlayer.xml new file mode 100644 index 0000000000..edf5dd619b --- /dev/null +++ b/doc/classes/AudioStreamPlayer.xml @@ -0,0 +1,156 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioStreamPlayer" inherits="Node" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Plays back audio. + </brief_description> + <description> + Plays background audio. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_bus" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_mix_target" qualifiers="const"> + <return type="int" enum="AudioStreamPlayer.MixTarget"> + </return> + <description> + </description> + </method> + <method name="get_pos"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_stream" qualifiers="const"> + <return type="AudioStream"> + </return> + <description> + </description> + </method> + <method name="get_volume_db" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="is_autoplay_enabled"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_playing" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="play"> + <return type="void"> + </return> + <argument index="0" name="from_pos" type="float" default="0.0"> + </argument> + <description> + Plays the audio from the given position 'from_pos', in seconds. + </description> + </method> + <method name="seek"> + <return type="void"> + </return> + <argument index="0" name="to_pos" type="float"> + </argument> + <description> + Sets the position from which audio will be played, in seconds. + </description> + </method> + <method name="set_autoplay"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_bus"> + <return type="void"> + </return> + <argument index="0" name="bus" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_mix_target"> + <return type="void"> + </return> + <argument index="0" name="mix_target" type="int" enum="AudioStreamPlayer.MixTarget"> + </argument> + <description> + </description> + </method> + <method name="set_stream"> + <return type="void"> + </return> + <argument index="0" name="stream" type="AudioStream"> + </argument> + <description> + </description> + </method> + <method name="set_volume_db"> + <return type="void"> + </return> + <argument index="0" name="volume_db" type="float"> + </argument> + <description> + </description> + </method> + <method name="stop"> + <return type="void"> + </return> + <description> + Stops the audio. + </description> + </method> + </methods> + <members> + <member name="autoplay" type="bool" setter="set_autoplay" getter="is_autoplay_enabled"> + If [code]true[/code], audio plays when added to scene tree. Default value: [code]false[/code]. + </member> + <member name="bus" type="String" setter="set_bus" getter="get_bus"> + Bus on which this audio is playing. + </member> + <member name="mix_target" type="int" setter="set_mix_target" getter="get_mix_target" enum="AudioStreamPlayer.MixTarget"> + </member> + <member name="playing" type="bool" setter="_set_playing" getter="is_playing"> + If [code]true[/code], audio is playing. + </member> + <member name="stream" type="AudioStream" setter="set_stream" getter="get_stream"> + The [AudioStream] object to be played. + </member> + <member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db"> + Volume of sound, in dB. + </member> + </members> + <signals> + <signal name="finished"> + <description> + Emitted when the audio stops playing. + </description> + </signal> + </signals> + <constants> + <constant name="MIX_TARGET_STEREO" value="0"> + </constant> + <constant name="MIX_TARGET_SURROUND" value="1"> + </constant> + <constant name="MIX_TARGET_CENTER" value="2"> + </constant> + </constants> +</class> diff --git a/doc/classes/AudioStreamPlayer2D.xml b/doc/classes/AudioStreamPlayer2D.xml new file mode 100644 index 0000000000..e31f2dd941 --- /dev/null +++ b/doc/classes/AudioStreamPlayer2D.xml @@ -0,0 +1,186 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioStreamPlayer2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Plays audio in 2D. + </brief_description> + <description> + Plays audio that dampens with distance from screen center. + </description> + <tutorials> + http://docs.godotengine.org/en/latest/learning/features/audio/index.html + </tutorials> + <demos> + </demos> + <methods> + <method name="get_area_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_attenuation" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_bus" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_max_distance" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_pos"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_stream" qualifiers="const"> + <return type="AudioStream"> + </return> + <description> + </description> + </method> + <method name="get_volume_db" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="is_autoplay_enabled"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_playing" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="play"> + <return type="void"> + </return> + <argument index="0" name="from_pos" type="float" default="0.0"> + </argument> + <description> + Plays the audio from the given position 'from_pos', in seconds. + </description> + </method> + <method name="seek"> + <return type="void"> + </return> + <argument index="0" name="to_pos" type="float"> + </argument> + <description> + Sets the position from which audio will be played, in seconds. + </description> + </method> + <method name="set_area_mask"> + <return type="void"> + </return> + <argument index="0" name="mask" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_attenuation"> + <return type="void"> + </return> + <argument index="0" name="curve" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_autoplay"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_bus"> + <return type="void"> + </return> + <argument index="0" name="bus" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_max_distance"> + <return type="void"> + </return> + <argument index="0" name="pixels" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_stream"> + <return type="void"> + </return> + <argument index="0" name="stream" type="AudioStream"> + </argument> + <description> + </description> + </method> + <method name="set_volume_db"> + <return type="void"> + </return> + <argument index="0" name="volume_db" type="float"> + </argument> + <description> + </description> + </method> + <method name="stop"> + <return type="void"> + </return> + <description> + Stops the audio. + </description> + </method> + </methods> + <members> + <member name="area_mask" type="int" setter="set_area_mask" getter="get_area_mask"> + Areas in which this sound plays. + </member> + <member name="attenuation" type="float" setter="set_attenuation" getter="get_attenuation"> + Dampens audio over distance with this as an exponent. + </member> + <member name="autoplay" type="bool" setter="set_autoplay" getter="is_autoplay_enabled"> + If [code]true[/code], audio plays when added to scene tree. Default value: [code]false[/code]. + </member> + <member name="bus" type="String" setter="set_bus" getter="get_bus"> + Bus on which this audio is playing. + </member> + <member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance"> + Maximum distance from which audio is still hearable. + </member> + <member name="playing" type="bool" setter="_set_playing" getter="is_playing"> + If [code]true[/code], audio is playing. + </member> + <member name="stream" type="AudioStream" setter="set_stream" getter="get_stream"> + The [AudioStream] object to be played. + </member> + <member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db"> + Base volume without dampening. + </member> + </members> + <signals> + <signal name="finished"> + <description> + Emitted when the audio stops playing. + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml new file mode 100644 index 0000000000..3aad0ea87a --- /dev/null +++ b/doc/classes/AudioStreamPlayer3D.xml @@ -0,0 +1,363 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioStreamPlayer3D" inherits="Spatial" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Plays 3D sound in 3D space + </brief_description> + <description> + Plays a sound effect with directed sound effects, dampens with distance if needed, generates effect of hearable position in space. + </description> + <tutorials> + http://docs.godotengine.org/en/latest/learning/features/audio/index.html + </tutorials> + <demos> + </demos> + <methods> + <method name="get_area_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_attenuation_filter_cutoff_hz" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_attenuation_filter_db" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_attenuation_model" qualifiers="const"> + <return type="int" enum="AudioStreamPlayer3D.AttenuationModel"> + </return> + <description> + </description> + </method> + <method name="get_bus" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_doppler_tracking" qualifiers="const"> + <return type="int" enum="AudioStreamPlayer3D.DopplerTracking"> + </return> + <description> + </description> + </method> + <method name="get_emission_angle" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_emission_angle_filter_attenuation_db" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_max_db" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_max_distance" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_out_of_range_mode" qualifiers="const"> + <return type="int" enum="AudioStreamPlayer3D.OutOfRangeMode"> + </return> + <description> + </description> + </method> + <method name="get_pos"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_stream" qualifiers="const"> + <return type="AudioStream"> + </return> + <description> + </description> + </method> + <method name="get_unit_db" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_unit_size" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="is_autoplay_enabled"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_emission_angle_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_playing" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="play"> + <return type="void"> + </return> + <argument index="0" name="from_pos" type="float" default="0.0"> + </argument> + <description> + Plays the audio from the given position 'from_pos', in seconds. + </description> + </method> + <method name="seek"> + <return type="void"> + </return> + <argument index="0" name="to_pos" type="float"> + </argument> + <description> + Sets the position from which audio will be played, in seconds. + </description> + </method> + <method name="set_area_mask"> + <return type="void"> + </return> + <argument index="0" name="mask" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_attenuation_filter_cutoff_hz"> + <return type="void"> + </return> + <argument index="0" name="degrees" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_attenuation_filter_db"> + <return type="void"> + </return> + <argument index="0" name="db" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_attenuation_model"> + <return type="void"> + </return> + <argument index="0" name="model" type="int" enum="AudioStreamPlayer3D.AttenuationModel"> + </argument> + <description> + </description> + </method> + <method name="set_autoplay"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_bus"> + <return type="void"> + </return> + <argument index="0" name="bus" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_doppler_tracking"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="AudioStreamPlayer3D.DopplerTracking"> + </argument> + <description> + </description> + </method> + <method name="set_emission_angle"> + <return type="void"> + </return> + <argument index="0" name="degrees" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_emission_angle_enabled"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_emission_angle_filter_attenuation_db"> + <return type="void"> + </return> + <argument index="0" name="db" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_max_db"> + <return type="void"> + </return> + <argument index="0" name="max_db" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_max_distance"> + <return type="void"> + </return> + <argument index="0" name="metres" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_out_of_range_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="AudioStreamPlayer3D.OutOfRangeMode"> + </argument> + <description> + </description> + </method> + <method name="set_stream"> + <return type="void"> + </return> + <argument index="0" name="stream" type="AudioStream"> + </argument> + <description> + </description> + </method> + <method name="set_unit_db"> + <return type="void"> + </return> + <argument index="0" name="unit_db" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_unit_size"> + <return type="void"> + </return> + <argument index="0" name="unit_size" type="float"> + </argument> + <description> + </description> + </method> + <method name="stop"> + <return type="void"> + </return> + <description> + Stops the audio. + </description> + </method> + </methods> + <members> + <member name="area_mask" type="int" setter="set_area_mask" getter="get_area_mask"> + Areas in which this sound plays. + </member> + <member name="attenuation_filter_cutoff_hz" type="float" setter="set_attenuation_filter_cutoff_hz" getter="get_attenuation_filter_cutoff_hz"> + Dampens audio above this frequency, in Hz. + </member> + <member name="attenuation_filter_db" type="float" setter="set_attenuation_filter_db" getter="get_attenuation_filter_db"> + Amount how much the filter affects the loudness, in dB. + </member> + <member name="attenuation_model" type="int" setter="set_attenuation_model" getter="get_attenuation_model" enum="AudioStreamPlayer3D.AttenuationModel"> + Decides if audio should get quieter with distance linearly, quadratically or logarithmically. + </member> + <member name="autoplay" type="bool" setter="set_autoplay" getter="is_autoplay_enabled"> + If [code]true[/code], audio plays audio plays when added to scene tree. Default value: [code]false[/code]. + </member> + <member name="bus" type="String" setter="set_bus" getter="get_bus"> + Bus on which this audio is playing. + </member> + <member name="doppler_tracking" type="int" setter="set_doppler_tracking" getter="get_doppler_tracking" enum="AudioStreamPlayer3D.DopplerTracking"> + Decides in which step the Doppler effect should be calculated. + </member> + <member name="emission_angle_degrees" type="float" setter="set_emission_angle" getter="get_emission_angle"> + The angle in which the audio reaches cameras undampened. + </member> + <member name="emission_angle_enabled" type="bool" setter="set_emission_angle_enabled" getter="is_emission_angle_enabled"> + If [code]true[/code], the audio should be dampened according to the direction of the sound. + </member> + <member name="emission_angle_filter_attenuation_db" type="float" setter="set_emission_angle_filter_attenuation_db" getter="get_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. + </member> + <member name="max_db" type="float" setter="set_max_db" getter="get_max_db"> + Sets the absolute maximum of the soundlevel, in dB. + </member> + <member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance"> + Sets the distance from wich the 'out_of_range_mode' takes effect. Has no effect if set to 0. + </member> + <member name="out_of_range_mode" type="int" setter="set_out_of_range_mode" getter="get_out_of_range_mode" enum="AudioStreamPlayer3D.OutOfRangeMode"> + Decides if audio should pause when source is outside of 'max_distance' range. + </member> + <member name="playing" type="bool" setter="_set_playing" getter="is_playing"> + If [code]true[/code], audio is playing. + </member> + <member name="stream" type="AudioStream" setter="set_stream" getter="get_stream"> + The [AudioStream] object to be played. + </member> + <member name="unit_db" type="float" setter="set_unit_db" getter="get_unit_db"> + Base sound level unaffected by dampening, in dB. + </member> + <member name="unit_size" type="float" setter="set_unit_size" getter="get_unit_size"> + Factor for the attenuation effect. + </member> + </members> + <signals> + <signal name="finished"> + <description> + Fires when the audio stops playing. + </description> + </signal> + </signals> + <constants> + <constant name="ATTENUATION_INVERSE_DISTANCE" value="0"> + Linear dampening of loudness according to distance. + </constant> + <constant name="ATTENUATION_INVERSE_SQUARE_DISTANCE" value="1"> + Squared dampening of loudness according to distance. + </constant> + <constant name="ATTENUATION_LOGARITHMIC" value="2"> + Logarithmic dampening of loudness according to distance. + </constant> + <constant name="OUT_OF_RANGE_MIX" value="0"> + Mix this audio in, even when it's out of range. + </constant> + <constant name="OUT_OF_RANGE_PAUSE" value="1"> + Pause this audio when it gets out of range. + </constant> + <constant name="DOPPLER_TRACKING_DISABLED" value="0"> + Disables doppler tracking. + </constant> + <constant name="DOPPLER_TRACKING_IDLE_STEP" value="1"> + Executes doppler trackin in idle step. + </constant> + <constant name="DOPPLER_TRACKING_FIXED_STEP" value="2"> + Executes doppler tracking in fixed step. + </constant> + </constants> +</class> diff --git a/doc/classes/AudioStreamRandomPitch.xml b/doc/classes/AudioStreamRandomPitch.xml new file mode 100644 index 0000000000..1573a78d1f --- /dev/null +++ b/doc/classes/AudioStreamRandomPitch.xml @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioStreamRandomPitch" inherits="AudioStream" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Plays audio with random pitch tweaking. + </brief_description> + <description> + Randomly varies pitch on each start. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_audio_stream" qualifiers="const"> + <return type="AudioStream"> + </return> + <description> + </description> + </method> + <method name="get_random_pitch" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="set_audio_stream"> + <return type="void"> + </return> + <argument index="0" name="stream" type="AudioStream"> + </argument> + <description> + </description> + </method> + <method name="set_random_pitch"> + <return type="void"> + </return> + <argument index="0" name="scale" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="audio_stream" type="AudioStream" setter="set_audio_stream" getter="get_audio_stream"> + The current [AudioStream]. + </member> + <member name="random_pitch" type="float" setter="set_random_pitch" getter="get_random_pitch"> + The intensity of random pitch variation. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioStreamSample.xml b/doc/classes/AudioStreamSample.xml new file mode 100644 index 0000000000..7f7414e4d3 --- /dev/null +++ b/doc/classes/AudioStreamSample.xml @@ -0,0 +1,156 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioStreamSample" inherits="AudioStream" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Plays audio. + </brief_description> + <description> + Plays audio, can loop. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_data" qualifiers="const"> + <return type="PoolByteArray"> + </return> + <description> + </description> + </method> + <method name="get_format" qualifiers="const"> + <return type="int" enum="AudioStreamSample.Format"> + </return> + <description> + </description> + </method> + <method name="get_loop_begin" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_loop_end" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_loop_mode" qualifiers="const"> + <return type="int" enum="AudioStreamSample.LoopMode"> + </return> + <description> + </description> + </method> + <method name="get_mix_rate" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="is_stereo" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_data"> + <return type="void"> + </return> + <argument index="0" name="data" type="PoolByteArray"> + </argument> + <description> + </description> + </method> + <method name="set_format"> + <return type="void"> + </return> + <argument index="0" name="format" type="int" enum="AudioStreamSample.Format"> + </argument> + <description> + </description> + </method> + <method name="set_loop_begin"> + <return type="void"> + </return> + <argument index="0" name="loop_begin" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_loop_end"> + <return type="void"> + </return> + <argument index="0" name="loop_end" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_loop_mode"> + <return type="void"> + </return> + <argument index="0" name="loop_mode" type="int" enum="AudioStreamSample.LoopMode"> + </argument> + <description> + </description> + </method> + <method name="set_mix_rate"> + <return type="void"> + </return> + <argument index="0" name="mix_rate" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_stereo"> + <return type="void"> + </return> + <argument index="0" name="stereo" type="bool"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="data" type="PoolByteArray" setter="set_data" getter="get_data"> + Raw audio data. + </member> + <member name="format" type="int" setter="set_format" getter="get_format" enum="AudioStreamSample.Format"> + Audio format. See FORMAT_* constants for values. + </member> + <member name="loop_begin" type="int" setter="set_loop_begin" getter="get_loop_begin"> + Loop start in bytes. + </member> + <member name="loop_end" type="int" setter="set_loop_end" getter="get_loop_end"> + Loop end in bytes. + </member> + <member name="loop_mode" type="int" setter="set_loop_mode" getter="get_loop_mode" enum="AudioStreamSample.LoopMode"> + Loop mode. See LOOP_* constants for values. + </member> + <member name="mix_rate" type="int" setter="set_mix_rate" getter="get_mix_rate"> + The sample rate for mixing this audio. + </member> + <member name="stereo" type="bool" setter="set_stereo" getter="is_stereo"> + If [code]true[/code], audio is stereo. Default value: [code]false[/code]. + </member> + </members> + <constants> + <constant name="FORMAT_8_BITS" value="0"> + Audio codec 8 bit. + </constant> + <constant name="FORMAT_16_BITS" value="1"> + Audio codec 16 bit. + </constant> + <constant name="FORMAT_IMA_ADPCM" value="2"> + Audio codec IMA ADPCM. + </constant> + <constant name="LOOP_DISABLED" value="0"> + Audio does not loop. + </constant> + <constant name="LOOP_FORWARD" value="1"> + Audio loops the data between loop_begin and loop_end playing forward only. + </constant> + <constant name="LOOP_PING_PONG" value="2"> + Audio loops the data between loop_begin and loop_end playing back and forth. + </constant> + </constants> +</class> diff --git a/doc/classes/BackBufferCopy.xml b/doc/classes/BackBufferCopy.xml new file mode 100644 index 0000000000..091bd3fa73 --- /dev/null +++ b/doc/classes/BackBufferCopy.xml @@ -0,0 +1,64 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="BackBufferCopy" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Copies a region of the screen (or the whole screen) to a buffer so it can be accessed with the texscreen() shader instruction. + </brief_description> + <description> + Node for back-buffering the currently displayed screen. The region defined in the BackBufferCopy node is bufferized with the content of the screen it covers, or the entire screen according to the copy mode set. Accessing this buffer is done with the texscreen() shader instruction. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_copy_mode" qualifiers="const"> + <return type="int" enum="BackBufferCopy.CopyMode"> + </return> + <description> + Return the copy mode currently applied to the BackBufferCopy (refer to constants section). + </description> + </method> + <method name="get_rect" qualifiers="const"> + <return type="Rect2"> + </return> + <description> + Return the area covered by the BackBufferCopy. + </description> + </method> + <method name="set_copy_mode"> + <return type="void"> + </return> + <argument index="0" name="copy_mode" type="int" enum="BackBufferCopy.CopyMode"> + </argument> + <description> + Set the copy mode of the BackBufferCopy (refer to constants section). + </description> + </method> + <method name="set_rect"> + <return type="void"> + </return> + <argument index="0" name="rect" type="Rect2"> + </argument> + <description> + Defines the area covered by the BackBufferCopy. + </description> + </method> + </methods> + <members> + <member name="copy_mode" type="int" setter="set_copy_mode" getter="get_copy_mode" enum="BackBufferCopy.CopyMode"> + </member> + <member name="rect" type="Rect2" setter="set_rect" getter="get_rect"> + </member> + </members> + <constants> + <constant name="COPY_MODE_DISABLED" value="0"> + Disables the buffering mode. This means the BackBufferCopy node will directly use the portion of screen it covers. + </constant> + <constant name="COPY_MODE_RECT" value="1"> + Sets the copy mode to a region. + </constant> + <constant name="COPY_MODE_VIEWPORT" value="2"> + Sets the copy mode to the entire screen. + </constant> + </constants> +</class> diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml new file mode 100644 index 0000000000..2ad46579b2 --- /dev/null +++ b/doc/classes/BaseButton.xml @@ -0,0 +1,213 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="BaseButton" inherits="Control" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Provides a base class for different kinds of buttons. + </brief_description> + <description> + BaseButton is the abstract base class for buttons, so it shouldn't be used directly (It doesn't display anything). Other types of buttons inherit from it. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="_pressed" qualifiers="virtual"> + <return type="void"> + </return> + <description> + Called when button is pressed. + </description> + </method> + <method name="_toggled" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="pressed" type="bool"> + </argument> + <description> + Called when button is toggled (only if toggle_mode is active). + </description> + </method> + <method name="get_action_mode" qualifiers="const"> + <return type="int" enum="BaseButton.ActionMode"> + </return> + <description> + Return the current mode of action (see [method set_action_mode]) (one of the ACTION_MODE_* constants). + </description> + </method> + <method name="get_button_group" qualifiers="const"> + <return type="ButtonGroup"> + </return> + <description> + </description> + </method> + <method name="get_draw_mode" qualifiers="const"> + <return type="int" enum="BaseButton.DrawMode"> + </return> + <description> + Return the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW_* enum. + </description> + </method> + <method name="get_enabled_focus_mode" qualifiers="const"> + <return type="int" enum="Control.FocusMode"> + </return> + <description> + Returns focus access mode used when switching between enabled/disabled (see [method Control.set_focus_mode] and [method set_disabled]). + </description> + </method> + <method name="get_shortcut" qualifiers="const"> + <return type="ShortCut"> + </return> + <description> + </description> + </method> + <method name="is_disabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether the button is in disabled state (see [method set_disabled]). + </description> + </method> + <method name="is_hovered" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if mouse entered the button before it exit. + </description> + </method> + <method name="is_pressed" qualifiers="const"> + <return type="bool"> + </return> + <description> + If toggle_mode is active, return whether the button is toggled. If toggle_mode is not active, return whether the button is pressed down. + </description> + </method> + <method name="is_toggle_mode" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return the toggle_mode property (see [method set_toggle_mode]). + </description> + </method> + <method name="set_action_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="BaseButton.ActionMode"> + </argument> + <description> + Set the current mode of action, determining when the button is considered clicked (see the ACTION_MODE_* constants). + </description> + </method> + <method name="set_button_group"> + <return type="void"> + </return> + <argument index="0" name="button_group" type="ButtonGroup"> + </argument> + <description> + </description> + </method> + <method name="set_disabled"> + <return type="void"> + </return> + <argument index="0" name="disabled" type="bool"> + </argument> + <description> + Set the button into disabled state. When a button is disabled, it can't be clicked or toggled. + </description> + </method> + <method name="set_enabled_focus_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="Control.FocusMode"> + </argument> + <description> + Sets the focus access mode to use when switching between enabled/disabled (see [method Control.set_focus_mode] and [method set_disabled]). + </description> + </method> + <method name="set_pressed"> + <return type="void"> + </return> + <argument index="0" name="pressed" type="bool"> + </argument> + <description> + Set the button to pressed state (only if toggle_mode is active). + </description> + </method> + <method name="set_shortcut"> + <return type="void"> + </return> + <argument index="0" name="shortcut" type="ShortCut"> + </argument> + <description> + </description> + </method> + <method name="set_toggle_mode"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Set the button toggle_mode property. Toggle mode makes the button flip state between pressed and unpressed each time its area is clicked. + </description> + </method> + </methods> + <members> + <member name="action_mode" type="int" setter="set_action_mode" getter="get_action_mode" enum="BaseButton.ActionMode"> + </member> + <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled"> + </member> + <member name="enabled_focus_mode" type="int" setter="set_enabled_focus_mode" getter="get_enabled_focus_mode" enum="Control.FocusMode"> + </member> + <member name="group" type="ButtonGroup" setter="set_button_group" getter="get_button_group"> + </member> + <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed"> + </member> + <member name="shortcut" type="ShortCut" setter="set_shortcut" getter="get_shortcut"> + </member> + <member name="toggle_mode" type="bool" setter="set_toggle_mode" getter="is_toggle_mode"> + </member> + </members> + <signals> + <signal name="button_down"> + <description> + Emitted when the button starts being held down. + </description> + </signal> + <signal name="button_up"> + <description> + Emitted when the button stops being held down. + </description> + </signal> + <signal name="pressed"> + <description> + This signal is emitted every time the button is toggled or pressed (i.e. activated, so on [code]button_down[/code] if "Click on press" is active and on [code]button_up[/code] otherwise). + </description> + </signal> + <signal name="toggled"> + <argument index="0" name="pressed" type="bool"> + </argument> + <description> + This signal is emitted when the button was just toggled between pressed and normal states (only if toggle_mode is active). The new state is contained in the [i]pressed[/i] argument. + </description> + </signal> + </signals> + <constants> + <constant name="DRAW_NORMAL" value="0"> + The normal state (i.e. not pressed, not hovered, not toggled and enabled) of buttons. + </constant> + <constant name="DRAW_PRESSED" value="1"> + The state of buttons are pressed. + </constant> + <constant name="DRAW_HOVER" value="2"> + The state of buttons are hovered. + </constant> + <constant name="DRAW_DISABLED" value="3"> + The state of buttons are disabled. + </constant> + <constant name="ACTION_MODE_BUTTON_PRESS" value="0"> + Require just a press to consider the button clicked. + </constant> + <constant name="ACTION_MODE_BUTTON_RELEASE" value="1"> + Require a press and a subsequent release before considering the button clicked. + </constant> + </constants> +</class> diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml new file mode 100644 index 0000000000..7731647648 --- /dev/null +++ b/doc/classes/Basis.xml @@ -0,0 +1,182 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Basis" category="Built-In Types" version="3.0.alpha.custom_build"> + <brief_description> + 3x3 matrix datatype. + </brief_description> + <description> + 3x3 matrix used for 3D rotation and scale. Contains 3 vector fields x,y and z as its columns, which can be interpreted as the local basis vectors of a transformation. Can also be accessed as array of 3D vectors. These vectors are orthogonal to each other, but are not necessarily normalized. Almost always used as orthogonal basis for a [Transform]. + For such use, it is composed of a scaling and a rotation matrix, in that order (M = R.S). + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="Basis"> + <return type="Basis"> + </return> + <argument index="0" name="from" type="Quat"> + </argument> + <description> + Create a rotation matrix from the given quaternion. + </description> + </method> + <method name="Basis"> + <return type="Basis"> + </return> + <argument index="0" name="euler" type="Vector3"> + </argument> + <description> + Create a rotation matrix (in the YXZ convention: first Z, then X, and Y last) from the specified Euler angles, given in the vector format as (X-angle, Y-angle, Z-angle). + </description> + </method> + <method name="Basis"> + <return type="Basis"> + </return> + <argument index="0" name="axis" type="Vector3"> + </argument> + <argument index="1" name="phi" type="float"> + </argument> + <description> + Create a rotation matrix which rotates around the given axis by the specified angle. The axis must be a normalized vector. + </description> + </method> + <method name="Basis"> + <return type="Basis"> + </return> + <argument index="0" name="x_axis" type="Vector3"> + </argument> + <argument index="1" name="y_axis" type="Vector3"> + </argument> + <argument index="2" name="z_axis" type="Vector3"> + </argument> + <description> + Create a matrix from 3 axis vectors. + </description> + </method> + <method name="determinant"> + <return type="float"> + </return> + <description> + Return the determinant of the matrix. + </description> + </method> + <method name="get_euler"> + <return type="Vector3"> + </return> + <description> + Assuming that the matrix is a proper rotation matrix (orthonormal matrix with determinant +1), return Euler angles (in the YXZ convention: first Z, then X, and Y last). Returned vector contains the rotation angles in the format (X-angle, Y-angle, Z-angle). + </description> + </method> + <method name="get_orthogonal_index"> + <return type="int"> + </return> + <description> + This function considers a discretization of rotations into 24 points on unit sphere, lying along the vectors (x,y,z) with each component being either -1,0 or 1, and returns the index of the point best representing the orientation of the object. It is mainly used by the grid map editor. For further details, refer to Godot source code. + </description> + </method> + <method name="get_scale"> + <return type="Vector3"> + </return> + <description> + Assuming that the matrix is the combination of a rotation and scaling, return the absolute value of scaling factors along each axis. + </description> + </method> + <method name="inverse"> + <return type="Basis"> + </return> + <description> + Return the inverse of the matrix. + </description> + </method> + <method name="orthonormalized"> + <return type="Basis"> + </return> + <description> + Return the orthonormalized version of the matrix (useful to call from time to time to avoid rounding error for orthogonal matrices). This performs a Gram-Schmidt orthonormalization on the basis of the matrix. + </description> + </method> + <method name="rotated"> + <return type="Basis"> + </return> + <argument index="0" name="axis" type="Vector3"> + </argument> + <argument index="1" name="phi" type="float"> + </argument> + <description> + Introduce an additional rotation around the given axis by phi (radians). Only relevant when the matrix is being used as a part of [Transform]. The axis must be a normalized vector. + </description> + </method> + <method name="scaled"> + <return type="Basis"> + </return> + <argument index="0" name="scale" type="Vector3"> + </argument> + <description> + Introduce an additional scaling specified by the given 3D scaling factor. Only relevant when the matrix is being used as a part of [Transform]. + </description> + </method> + <method name="tdotx"> + <return type="float"> + </return> + <argument index="0" name="with" type="Vector3"> + </argument> + <description> + Transposed dot product with the x axis of the matrix. + </description> + </method> + <method name="tdoty"> + <return type="float"> + </return> + <argument index="0" name="with" type="Vector3"> + </argument> + <description> + Transposed dot product with the y axis of the matrix. + </description> + </method> + <method name="tdotz"> + <return type="float"> + </return> + <argument index="0" name="with" type="Vector3"> + </argument> + <description> + Transposed dot product with the z axis of the matrix. + </description> + </method> + <method name="transposed"> + <return type="Basis"> + </return> + <description> + Return the transposed version of the matrix. + </description> + </method> + <method name="xform"> + <return type="Vector3"> + </return> + <argument index="0" name="v" type="Vector3"> + </argument> + <description> + Return a vector transformed (multiplied) by the matrix. + </description> + </method> + <method name="xform_inv"> + <return type="Vector3"> + </return> + <argument index="0" name="v" type="Vector3"> + </argument> + <description> + Return a vector transformed (multiplied) by the transposed matrix. Note that this results in a multiplication by the inverse of the matrix only if it represents a rotation-reflection. + </description> + </method> + </methods> + <members> + <member name="x" type="Vector3" setter="" getter=""> + </member> + <member name="y" type="Vector3" setter="" getter=""> + </member> + <member name="z" type="Vector3" setter="" getter=""> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/BitMap.xml b/doc/classes/BitMap.xml new file mode 100644 index 0000000000..62b1c9ff4f --- /dev/null +++ b/doc/classes/BitMap.xml @@ -0,0 +1,84 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="BitMap" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Boolean matrix. + </brief_description> + <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. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="create"> + <return type="void"> + </return> + <argument index="0" name="size" type="Vector2"> + </argument> + <description> + Creates a bitmap with the specified size, filled with false. + </description> + </method> + <method name="create_from_image_alpha"> + <return type="void"> + </return> + <argument index="0" name="image" type="Image"> + </argument> + <description> + 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. + </description> + </method> + <method name="get_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="pos" type="Vector2"> + </argument> + <description> + Returns bitmap's value at the specified position. + </description> + </method> + <method name="get_size" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Returns bitmap's dimensions. + </description> + </method> + <method name="get_true_bit_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the amount of bitmap elements that are set to true. + </description> + </method> + <method name="set_bit"> + <return type="void"> + </return> + <argument index="0" name="pos" type="Vector2"> + </argument> + <argument index="1" name="bit" type="bool"> + </argument> + <description> + Sets the bitmap's element at the specified position, to the specified value. + </description> + </method> + <method name="set_bit_rect"> + <return type="void"> + </return> + <argument index="0" name="p_rect" type="Rect2"> + </argument> + <argument index="1" name="bit" type="bool"> + </argument> + <description> + Sets a rectangular portion of the bitmap to the specified value. + </description> + </method> + </methods> + <members> + <member name="data" type="Dictionary" setter="_set_data" getter="_get_data"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/BitmapFont.xml b/doc/classes/BitmapFont.xml new file mode 100644 index 0000000000..e983c59782 --- /dev/null +++ b/doc/classes/BitmapFont.xml @@ -0,0 +1,161 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="BitmapFont" inherits="Font" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_char"> + <return type="void"> + </return> + <argument index="0" name="character" type="int"> + </argument> + <argument index="1" name="texture" type="int"> + </argument> + <argument index="2" name="rect" type="Rect2"> + </argument> + <argument index="3" name="align" type="Vector2" default="Vector2( 0, 0 )"> + </argument> + <argument index="4" name="advance" type="float" default="-1"> + </argument> + <description> + Add a character to the font, where [i]character[/i] is the unicode value, [i]texture[/i] is the texture index, [i]rect[/i] is the region in the texture (in pixels!), [i]align[/i] is the (optional) alignment for the character and [i]advance[/i] is the (optional) advance. + </description> + </method> + <method name="add_kerning_pair"> + <return type="void"> + </return> + <argument index="0" name="char_a" type="int"> + </argument> + <argument index="1" name="char_b" type="int"> + </argument> + <argument index="2" name="kerning" type="int"> + </argument> + <description> + Add a kerning pair to the [BitmapFont] as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character. + </description> + </method> + <method name="add_texture"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <description> + Add a texture to the [BitmapFont]. + </description> + </method> + <method name="clear"> + <return type="void"> + </return> + <description> + Clear all the font data. + </description> + </method> + <method name="create_from_fnt"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_char_size" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="char" type="int"> + </argument> + <argument index="1" name="next" type="int" default="0"> + </argument> + <description> + Return the size of a character, optionally taking kerning into account if the next character is provided. + </description> + </method> + <method name="get_fallback" qualifiers="const"> + <return type="BitmapFont"> + </return> + <description> + </description> + </method> + <method name="get_kerning_pair" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="char_a" type="int"> + </argument> + <argument index="1" name="char_b" type="int"> + </argument> + <description> + Return a kerning pair as a difference. + </description> + </method> + <method name="get_texture" qualifiers="const"> + <return type="Texture"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_texture_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_ascent"> + <return type="void"> + </return> + <argument index="0" name="px" type="float"> + </argument> + <description> + Set the font ascent (number of pixels above the baseline). + </description> + </method> + <method name="set_distance_field_hint"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_fallback"> + <return type="void"> + </return> + <argument index="0" name="fallback" type="BitmapFont"> + </argument> + <description> + </description> + </method> + <method name="set_height"> + <return type="void"> + </return> + <argument index="0" name="px" type="float"> + </argument> + <description> + Set the total font height (ascent plus descent) in pixels. + </description> + </method> + </methods> + <members> + <member name="ascent" type="float" setter="set_ascent" getter="get_ascent"> + </member> + <member name="chars" type="PoolIntArray" setter="_set_chars" getter="_get_chars"> + </member> + <member name="distance_field" type="bool" setter="set_distance_field_hint" getter="is_distance_field_hint"> + </member> + <member name="fallback" type="BitmapFont" setter="set_fallback" getter="get_fallback"> + </member> + <member name="height" type="float" setter="set_height" getter="get_height"> + </member> + <member name="kernings" type="PoolIntArray" setter="_set_kernings" getter="_get_kernings"> + </member> + <member name="textures" type="Array" setter="_set_textures" getter="_get_textures"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/BoneAttachment.xml b/doc/classes/BoneAttachment.xml new file mode 100644 index 0000000000..9297c0e1b1 --- /dev/null +++ b/doc/classes/BoneAttachment.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="BoneAttachment" inherits="Spatial" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + A node that will attach to a bone. + </brief_description> + <description> + This node must be the child of a [Skeleton] node. You can then select a bone for this node to attach to. The BoneAttachment node will copy the transform of the selected bone. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_bone_name" qualifiers="const"> + <return type="String"> + </return> + <description> + Returns the name of the bone node attached to. + </description> + </method> + <method name="set_bone_name"> + <return type="void"> + </return> + <argument index="0" name="bone_name" type="String"> + </argument> + <description> + Changes the name of the bone node + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/BoxContainer.xml b/doc/classes/BoxContainer.xml new file mode 100644 index 0000000000..0c70d919f3 --- /dev/null +++ b/doc/classes/BoxContainer.xml @@ -0,0 +1,56 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="BoxContainer" inherits="Container" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base class for box containers. + </brief_description> + <description> + Arranges child controls vertically or horizontally, and rearranges the controls automatically when their minimum size changes. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_spacer"> + <return type="void"> + </return> + <argument index="0" name="begin" type="bool"> + </argument> + <description> + Adds a control to the box as a spacer. If [code]true[/code], [i]begin[/i] will insert the spacer control in front of other children. + </description> + </method> + <method name="get_alignment" qualifiers="const"> + <return type="int" enum="BoxContainer.AlignMode"> + </return> + <description> + Return the alignment of children in the container. + </description> + </method> + <method name="set_alignment"> + <return type="void"> + </return> + <argument index="0" name="alignment" type="int" enum="BoxContainer.AlignMode"> + </argument> + <description> + Set the alignment of children in the container(Must be one of ALIGN_BEGIN, ALIGN_CENTER or ALIGN_END). + </description> + </method> + </methods> + <members> + <member name="alignment" type="int" setter="set_alignment" getter="get_alignment" enum="BoxContainer.AlignMode"> + The alignment of the container's children (must be one of ALIGN_BEGIN, ALIGN_CENTER, or ALIGN_END). + </member> + </members> + <constants> + <constant name="ALIGN_BEGIN" value="0"> + Aligns children with the beginning of the container. + </constant> + <constant name="ALIGN_CENTER" value="1"> + Aligns children with the center of the container. + </constant> + <constant name="ALIGN_END" value="2"> + Aligns children with the end of the container. + </constant> + </constants> +</class> diff --git a/doc/classes/BoxShape.xml b/doc/classes/BoxShape.xml new file mode 100644 index 0000000000..4e8eb0ba6f --- /dev/null +++ b/doc/classes/BoxShape.xml @@ -0,0 +1,38 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="BoxShape" inherits="Shape" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Box shape resource. + </brief_description> + <description> + 3D box shape that can be a child of a [PhysicsBody] or [Area]. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_extents" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + Return the half extents of the shape. + </description> + </method> + <method name="set_extents"> + <return type="void"> + </return> + <argument index="0" name="extents" type="Vector3"> + </argument> + <description> + Set the half extents for the shape. + </description> + </method> + </methods> + <members> + <member name="extents" type="Vector3" setter="set_extents" getter="get_extents"> + The shape's half extents. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Button.xml b/doc/classes/Button.xml new file mode 100644 index 0000000000..bb02e4266b --- /dev/null +++ b/doc/classes/Button.xml @@ -0,0 +1,137 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Button" inherits="BaseButton" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Standard themed Button. + </brief_description> + <description> + Button is the standard themed button. It can contain text and an icon, and will display them according to the current [Theme]. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_button_icon" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="get_clip_text" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_text" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_text_align" qualifiers="const"> + <return type="int" enum="Button.TextAlign"> + </return> + <description> + </description> + </method> + <method name="is_flat" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_button_icon"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_clip_text"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_flat"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_text"> + <return type="void"> + </return> + <argument index="0" name="text" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_text_align"> + <return type="void"> + </return> + <argument index="0" name="align" type="int" enum="Button.TextAlign"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="align" type="int" setter="set_text_align" getter="get_text_align" enum="Button.TextAlign"> + Text alignment policy for the button's text, use one of the ALIGN_* constants. + </member> + <member name="clip_text" type="bool" setter="set_clip_text" getter="get_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. + </member> + <member name="flat" type="bool" setter="set_flat" getter="is_flat"> + Flat buttons don't display decoration. + </member> + <member name="icon" type="Texture" setter="set_button_icon" getter="get_button_icon"> + Button's icon, if text is present the icon will be placed before the text. + </member> + <member name="text" type="String" setter="set_text" getter="get_text"> + The button's text that will be displayed inside the button's area. + </member> + </members> + <constants> + <constant name="ALIGN_LEFT" value="0"> + Align the text to the left. + </constant> + <constant name="ALIGN_CENTER" value="1"> + Align the text to the center. + </constant> + <constant name="ALIGN_RIGHT" value="2"> + Align the text to the right. + </constant> + </constants> + <theme_items> + <theme_item name="disabled" type="StyleBox"> + </theme_item> + <theme_item name="focus" type="StyleBox"> + </theme_item> + <theme_item name="font" type="Font"> + </theme_item> + <theme_item name="font_color" type="Color"> + </theme_item> + <theme_item name="font_color_disabled" type="Color"> + </theme_item> + <theme_item name="font_color_hover" type="Color"> + </theme_item> + <theme_item name="font_color_pressed" type="Color"> + </theme_item> + <theme_item name="hover" type="StyleBox"> + </theme_item> + <theme_item name="hseparation" type="int"> + </theme_item> + <theme_item name="normal" type="StyleBox"> + </theme_item> + <theme_item name="pressed" type="StyleBox"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/ButtonGroup.xml b/doc/classes/ButtonGroup.xml new file mode 100644 index 0000000000..c2c999f9d8 --- /dev/null +++ b/doc/classes/ButtonGroup.xml @@ -0,0 +1,28 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ButtonGroup" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Group of Buttons. + </brief_description> + <description> + Group of [Button]. All direct and indirect children buttons become radios. Only one allows being pressed. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_pressed_button"> + <return type="BaseButton"> + </return> + <description> + Return the pressed button. + </description> + </method> + </methods> + <constants> + </constants> + <theme_items> + <theme_item name="panel" type="StyleBox"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/Camera.xml b/doc/classes/Camera.xml new file mode 100644 index 0000000000..2302c39e35 --- /dev/null +++ b/doc/classes/Camera.xml @@ -0,0 +1,251 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Camera" inherits="Spatial" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Camera node, displays from a point of view. + </brief_description> + <description> + Camera is a special node that displays what is visible from its current location. Cameras register themselves in the nearest [Viewport] node (when ascending the tree). Only one camera can be active per viewport. If no viewport is available ascending the tree, the Camera will register in the global viewport. In other words, a Camera just provides [i]3D[/i] display capabilities to a [Viewport], and, without one, a scene registered in that [Viewport] (or higher viewports) can't be displayed. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="clear_current"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="get_camera_transform" qualifiers="const"> + <return type="Transform"> + </return> + <description> + Get the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the [Node] transform. + </description> + </method> + <method name="get_cull_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_doppler_tracking" qualifiers="const"> + <return type="int" enum="Camera.DopplerTracking"> + </return> + <description> + </description> + </method> + <method name="get_environment" qualifiers="const"> + <return type="Environment"> + </return> + <description> + </description> + </method> + <method name="get_fov" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_h_offset" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_keep_aspect_mode" qualifiers="const"> + <return type="int" enum="Camera.KeepAspect"> + </return> + <description> + </description> + </method> + <method name="get_projection" qualifiers="const"> + <return type="int" enum="Camera.Projection"> + </return> + <description> + </description> + </method> + <method name="get_size" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_v_offset" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_zfar" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_znear" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="is_current" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether the Camera is the current one in the [Viewport], or plans to become current (if outside the scene tree). + </description> + </method> + <method name="is_position_behind" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="world_point" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="make_current"> + <return type="void"> + </return> + <description> + Make this camera the current Camera for the [Viewport] (see class description). If the Camera Node is outside the scene tree, it will attempt to become current once it's added. + </description> + </method> + <method name="project_local_ray_normal" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="screen_point" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="project_position" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="screen_point" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="project_ray_normal" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="screen_point" type="Vector2"> + </argument> + <description> + Return a normal vector in worldspace, that is the result of projecting a point on the [Viewport] rectangle by the camera projection. This is useful for casting rays in the form of (origin,normal) for object intersection or picking. + </description> + </method> + <method name="project_ray_origin" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="screen_point" type="Vector2"> + </argument> + <description> + Return a 3D position in worldspace, that is the result of projecting a point on the [Viewport] rectangle by the camera projection. This is useful for casting rays in the form of (origin,normal) for object intersection or picking. + </description> + </method> + <method name="set_cull_mask"> + <return type="void"> + </return> + <argument index="0" name="mask" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_doppler_tracking"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="Camera.DopplerTracking"> + </argument> + <description> + </description> + </method> + <method name="set_environment"> + <return type="void"> + </return> + <argument index="0" name="env" type="Environment"> + </argument> + <description> + </description> + </method> + <method name="set_h_offset"> + <return type="void"> + </return> + <argument index="0" name="ofs" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_keep_aspect_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="Camera.KeepAspect"> + </argument> + <description> + </description> + </method> + <method name="set_orthogonal"> + <return type="void"> + </return> + <argument index="0" name="size" type="float"> + </argument> + <argument index="1" name="z_near" type="float"> + </argument> + <argument index="2" name="z_far" type="float"> + </argument> + <description> + Set the camera projection to orthogonal mode, by specifying a width and the [i]near[/i] and [i]far[/i] clip planes in worldspace units. (As a hint, 2D games often use this projection, with values specified in pixels) + </description> + </method> + <method name="set_perspective"> + <return type="void"> + </return> + <argument index="0" name="fov" type="float"> + </argument> + <argument index="1" name="z_near" type="float"> + </argument> + <argument index="2" name="z_far" type="float"> + </argument> + <description> + Set the camera projection to perspective mode, by specifying a [i]FOV[/i] Y angle in degrees (FOV means Field of View), and the [i]near[/i] and [i]far[/i] clip planes in worldspace units. + </description> + </method> + <method name="set_v_offset"> + <return type="void"> + </return> + <argument index="0" name="ofs" type="float"> + </argument> + <description> + </description> + </method> + <method name="unproject_position" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="world_point" type="Vector3"> + </argument> + <description> + Return how a 3D point in worldspace maps to a 2D coordinate in the [Viewport] rectangle. + </description> + </method> + </methods> + <constants> + <constant name="PROJECTION_PERSPECTIVE" value="0"> + Perspective Projection (object's size on the screen becomes smaller when far away). + </constant> + <constant name="PROJECTION_ORTHOGONAL" value="1"> + Orthogonal Projection (objects remain the same size on the screen no matter how far away they are). + </constant> + <constant name="KEEP_WIDTH" value="0"> + </constant> + <constant name="KEEP_HEIGHT" value="1"> + </constant> + <constant name="DOPPLER_TRACKING_DISABLED" value="0"> + </constant> + <constant name="DOPPLER_TRACKING_IDLE_STEP" value="1"> + </constant> + <constant name="DOPPLER_TRACKING_FIXED_STEP" value="2"> + </constant> + </constants> +</class> diff --git a/doc/classes/Camera2D.xml b/doc/classes/Camera2D.xml new file mode 100644 index 0000000000..659efa860d --- /dev/null +++ b/doc/classes/Camera2D.xml @@ -0,0 +1,375 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Camera2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Camera node for 2D scenes. + </brief_description> + <description> + Camera node for 2D scenes. It forces the screen (current layer) to scroll following this node. This makes it easier (and faster) to program scrollable scenes than manually changing the position of [CanvasItem] based nodes. + This node is intended to be a simple helper get get things going quickly and it may happen often that more functionality is desired to change how the camera works. To make your own custom camera node, simply inherit from [Node2D] and change the transform of the canvas by calling get_viewport().set_canvas_transform(m) in [Viewport]. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="align"> + <return type="void"> + </return> + <description> + Align the camera to the tracked node + </description> + </method> + <method name="clear_current"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="force_update_scroll"> + <return type="void"> + </return> + <description> + Force the camera to update scroll immediately. + </description> + </method> + <method name="get_anchor_mode" qualifiers="const"> + <return type="int" enum="Camera2D.AnchorMode"> + </return> + <description> + </description> + </method> + <method name="get_camera_pos" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the camera position. + </description> + </method> + <method name="get_camera_screen_center" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_custom_viewport" qualifiers="const"> + <return type="Node"> + </return> + <description> + </description> + </method> + <method name="get_drag_margin" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <description> + Return the margins needed to drag the camera (see [method set_drag_margin]). + </description> + </method> + <method name="get_follow_smoothing" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_h_offset" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_limit" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <description> + Return the scrolling limit in pixels. + </description> + </method> + <method name="get_offset" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the scroll offset. + </description> + </method> + <method name="get_v_offset" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_zoom" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="is_current" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true of this is the current camera (see [method make_current]). + </description> + </method> + <method name="is_follow_smoothing_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_h_drag_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_limit_drawing_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_limit_smoothing_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_margin_drawing_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_rotating" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_screen_drawing_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_v_drag_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="make_current"> + <return type="void"> + </return> + <description> + Make this the current 2D camera for the scene (viewport and layer), in case there's many cameras in the scene. + </description> + </method> + <method name="reset_smoothing"> + <return type="void"> + </return> + <description> + Set the camera's position immediately to its current smoothing destination. + This has no effect if smoothing is disabled. + </description> + </method> + <method name="set_anchor_mode"> + <return type="void"> + </return> + <argument index="0" name="anchor_mode" type="int" enum="Camera2D.AnchorMode"> + </argument> + <description> + </description> + </method> + <method name="set_custom_viewport"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="Node"> + </argument> + <description> + </description> + </method> + <method name="set_drag_margin"> + <return type="void"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <argument index="1" name="drag_margin" type="float"> + </argument> + <description> + Set the margins needed to drag the camera (relative to the screen size). Margin uses the MARGIN_* enum. Drag margins of 0,0,0,0 will keep the camera at the center of the screen, while drag margins of 1,1,1,1 will only move when the camera is at the edges. + </description> + </method> + <method name="set_enable_follow_smoothing"> + <return type="void"> + </return> + <argument index="0" name="follow_smoothing" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_follow_smoothing"> + <return type="void"> + </return> + <argument index="0" name="follow_smoothing" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_h_drag_enabled"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_h_offset"> + <return type="void"> + </return> + <argument index="0" name="ofs" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_limit"> + <return type="void"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <argument index="1" name="limit" type="int"> + </argument> + <description> + Set the scrolling limit in pixels. + </description> + </method> + <method name="set_limit_drawing_enabled"> + <return type="void"> + </return> + <argument index="0" name="limit_drawing_enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_limit_smoothing_enabled"> + <return type="void"> + </return> + <argument index="0" name="limit_smoothing_enabled" type="bool"> + </argument> + <description> + Smooth camera when reaching camera limits. + This requires camera smoothing being enabled to have a noticeable effect. + </description> + </method> + <method name="set_margin_drawing_enabled"> + <return type="void"> + </return> + <argument index="0" name="margin_drawing_enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_offset"> + <return type="void"> + </return> + <argument index="0" name="offset" type="Vector2"> + </argument> + <description> + Set the scroll offset. Useful for looking around or camera shake animations. + </description> + </method> + <method name="set_rotating"> + <return type="void"> + </return> + <argument index="0" name="rotating" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_screen_drawing_enabled"> + <return type="void"> + </return> + <argument index="0" name="screen_drawing_enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_v_drag_enabled"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_v_offset"> + <return type="void"> + </return> + <argument index="0" name="ofs" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_zoom"> + <return type="void"> + </return> + <argument index="0" name="zoom" type="Vector2"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="anchor_mode" type="int" setter="set_anchor_mode" getter="get_anchor_mode" enum="Camera2D.AnchorMode"> + </member> + <member name="current" type="bool" setter="_set_current" getter="is_current"> + </member> + <member name="drag_margin_bottom" type="float" setter="set_drag_margin" getter="get_drag_margin"> + </member> + <member name="drag_margin_h_enabled" type="bool" setter="set_h_drag_enabled" getter="is_h_drag_enabled"> + </member> + <member name="drag_margin_left" type="float" setter="set_drag_margin" getter="get_drag_margin"> + </member> + <member name="drag_margin_right" type="float" setter="set_drag_margin" getter="get_drag_margin"> + </member> + <member name="drag_margin_top" type="float" setter="set_drag_margin" getter="get_drag_margin"> + </member> + <member name="drag_margin_v_enabled" type="bool" setter="set_v_drag_enabled" getter="is_v_drag_enabled"> + </member> + <member name="editor_draw_drag_margin" type="bool" setter="set_margin_drawing_enabled" getter="is_margin_drawing_enabled"> + </member> + <member name="editor_draw_limits" type="bool" setter="set_limit_drawing_enabled" getter="is_limit_drawing_enabled"> + </member> + <member name="editor_draw_screen" type="bool" setter="set_screen_drawing_enabled" getter="is_screen_drawing_enabled"> + </member> + <member name="limit_bottom" type="int" setter="set_limit" getter="get_limit"> + </member> + <member name="limit_left" type="int" setter="set_limit" getter="get_limit"> + </member> + <member name="limit_right" type="int" setter="set_limit" getter="get_limit"> + </member> + <member name="limit_smoothed" type="bool" setter="set_limit_smoothing_enabled" getter="is_limit_smoothing_enabled"> + </member> + <member name="limit_top" type="int" setter="set_limit" getter="get_limit"> + </member> + <member name="offset" type="Vector2" setter="set_offset" getter="get_offset"> + </member> + <member name="rotating" type="bool" setter="set_rotating" getter="is_rotating"> + </member> + <member name="smoothing_enabled" type="bool" setter="set_enable_follow_smoothing" getter="is_follow_smoothing_enabled"> + </member> + <member name="smoothing_speed" type="float" setter="set_follow_smoothing" getter="get_follow_smoothing"> + </member> + <member name="zoom" type="Vector2" setter="set_zoom" getter="get_zoom"> + </member> + </members> + <constants> + <constant name="ANCHOR_MODE_DRAG_CENTER" value="1"> + </constant> + <constant name="ANCHOR_MODE_FIXED_TOP_LEFT" value="0"> + </constant> + </constants> +</class> diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml new file mode 100644 index 0000000000..26a9e1519b --- /dev/null +++ b/doc/classes/CanvasItem.xml @@ -0,0 +1,671 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="CanvasItem" inherits="Node" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base class of anything 2D. + </brief_description> + <description> + Base class of anything 2D. Canvas items are laid out in a tree and children inherit and extend the transform of their parent. CanvasItem is extended by [Control], for anything GUI related, and by [Node2D] for anything 2D engine related. + Any CanvasItem can draw. For this, the "update" function must be called, then NOTIFICATION_DRAW will be received on idle time to request redraw. Because of this, canvas items don't need to be redraw on every frame, improving the performance significantly. Several functions for drawing on the CanvasItem are provided (see draw_* functions). They can only be used inside the notification, signal or _draw() overrides function, though. + Canvas items are draw in tree order. By default, children are on top of their parents so a root CanvasItem will be drawn behind everything (this can be changed per item though). + Canvas items can also be hidden (hiding also their subtree). They provide many means for changing standard parameters such as opacity (for it and the subtree) and self opacity, blend mode. + Ultimately, a transform notification can be requested, which will notify the node that its global position changed in case the parent tree changed. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="_draw" qualifiers="virtual"> + <return type="void"> + </return> + <description> + Called (if exists) to draw the canvas item. + </description> + </method> + <method name="draw_char"> + <return type="float"> + </return> + <argument index="0" name="font" type="Font"> + </argument> + <argument index="1" name="pos" type="Vector2"> + </argument> + <argument index="2" name="char" type="String"> + </argument> + <argument index="3" name="next" type="String"> + </argument> + <argument index="4" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> + </argument> + <description> + Draw a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char. + </description> + </method> + <method name="draw_circle"> + <return type="void"> + </return> + <argument index="0" name="pos" type="Vector2"> + </argument> + <argument index="1" name="radius" type="float"> + </argument> + <argument index="2" name="color" type="Color"> + </argument> + <description> + Draw a colored circle. + </description> + </method> + <method name="draw_colored_polygon"> + <return type="void"> + </return> + <argument index="0" name="points" type="PoolVector2Array"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <argument index="2" name="uvs" type="PoolVector2Array" default="PoolVector2Array( )"> + </argument> + <argument index="3" name="texture" type="Texture" default="null"> + </argument> + <argument index="4" name="normal_map" type="Texture" default="null"> + </argument> + <argument index="5" name="antialiased" type="bool" default="false"> + </argument> + <description> + Draw a colored polygon of any amount of points, convex or concave. + </description> + </method> + <method name="draw_line"> + <return type="void"> + </return> + <argument index="0" name="from" type="Vector2"> + </argument> + <argument index="1" name="to" type="Vector2"> + </argument> + <argument index="2" name="color" type="Color"> + </argument> + <argument index="3" name="width" type="float" default="1.0"> + </argument> + <argument index="4" name="antialiased" type="bool" default="false"> + </argument> + <description> + Draw a line from a 2D point to another, with a given color and width. It can be optionally antialiased. + </description> + </method> + <method name="draw_polygon"> + <return type="void"> + </return> + <argument index="0" name="points" type="PoolVector2Array"> + </argument> + <argument index="1" name="colors" type="PoolColorArray"> + </argument> + <argument index="2" name="uvs" type="PoolVector2Array" default="PoolVector2Array( )"> + </argument> + <argument index="3" name="texture" type="Texture" default="null"> + </argument> + <argument index="4" name="normal_map" type="Texture" default="null"> + </argument> + <argument index="5" name="antialiased" type="bool" default="false"> + </argument> + <description> + Draw a polygon of any amount of points, convex or concave. + </description> + </method> + <method name="draw_polyline"> + <return type="void"> + </return> + <argument index="0" name="points" type="PoolVector2Array"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <argument index="2" name="width" type="float" default="1.0"> + </argument> + <argument index="3" name="antialiased" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="draw_polyline_colors"> + <return type="void"> + </return> + <argument index="0" name="points" type="PoolVector2Array"> + </argument> + <argument index="1" name="colors" type="PoolColorArray"> + </argument> + <argument index="2" name="width" type="float" default="1.0"> + </argument> + <argument index="3" name="antialiased" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="draw_primitive"> + <return type="void"> + </return> + <argument index="0" name="points" type="PoolVector2Array"> + </argument> + <argument index="1" name="colors" type="PoolColorArray"> + </argument> + <argument index="2" name="uvs" type="PoolVector2Array"> + </argument> + <argument index="3" name="texture" type="Texture" default="null"> + </argument> + <argument index="4" name="width" type="float" default="1.0"> + </argument> + <argument index="5" name="normal_map" type="Texture" default="null"> + </argument> + <description> + Draw a custom primitive, 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad. + </description> + </method> + <method name="draw_rect"> + <return type="void"> + </return> + <argument index="0" name="rect" type="Rect2"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <argument index="2" name="filled" type="bool" default="true"> + </argument> + <description> + Draw a colored rectangle. + </description> + </method> + <method name="draw_set_transform"> + <return type="void"> + </return> + <argument index="0" name="pos" type="Vector2"> + </argument> + <argument index="1" name="rot" type="float"> + </argument> + <argument index="2" name="scale" type="Vector2"> + </argument> + <description> + Set a custom transform for drawing. Anything drawn afterwards will be transformed by this. + </description> + </method> + <method name="draw_set_transform_matrix"> + <return type="void"> + </return> + <argument index="0" name="xform" type="Transform2D"> + </argument> + <description> + </description> + </method> + <method name="draw_string"> + <return type="void"> + </return> + <argument index="0" name="font" type="Font"> + </argument> + <argument index="1" name="pos" type="Vector2"> + </argument> + <argument index="2" name="text" type="String"> + </argument> + <argument index="3" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> + </argument> + <argument index="4" name="clip_w" type="int" default="-1"> + </argument> + <description> + Draw a string using a custom font. + </description> + </method> + <method name="draw_style_box"> + <return type="void"> + </return> + <argument index="0" name="style_box" type="StyleBox"> + </argument> + <argument index="1" name="rect" type="Rect2"> + </argument> + <description> + Draw a styled rectangle. + </description> + </method> + <method name="draw_texture"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <argument index="1" name="pos" type="Vector2"> + </argument> + <argument index="2" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> + </argument> + <argument index="3" name="normal_map" type="Texture" default="null"> + </argument> + <description> + Draw a texture at a given position. + </description> + </method> + <method name="draw_texture_rect"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <argument index="1" name="rect" type="Rect2"> + </argument> + <argument index="2" name="tile" type="bool"> + </argument> + <argument index="3" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> + </argument> + <argument index="4" name="transpose" type="bool" default="false"> + </argument> + <argument index="5" name="normal_map" type="Texture" default="null"> + </argument> + <description> + Draw a textured rectangle at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture. + </description> + </method> + <method name="draw_texture_rect_region"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <argument index="1" name="rect" type="Rect2"> + </argument> + <argument index="2" name="src_rect" type="Rect2"> + </argument> + <argument index="3" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> + </argument> + <argument index="4" name="transpose" type="bool" default="false"> + </argument> + <argument index="5" name="normal_map" type="Texture" default="null"> + </argument> + <argument index="6" name="clip_uv" type="bool" default="true"> + </argument> + <description> + Draw a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture. + </description> + </method> + <method name="edit_get_state" qualifiers="const"> + <return type="Variant"> + </return> + <description> + Used for editing, returns an opaque value representing the transform state. + </description> + </method> + <method name="edit_rotate"> + <return type="void"> + </return> + <argument index="0" name="degrees" type="float"> + </argument> + <description> + Used for editing, handle rotation. + </description> + </method> + <method name="edit_set_rect"> + <return type="void"> + </return> + <argument index="0" name="rect" type="Rect2"> + </argument> + <description> + </description> + </method> + <method name="edit_set_state"> + <return type="void"> + </return> + <argument index="0" name="state" type="Variant"> + </argument> + <description> + Set the transform state of this CanvasItem. For [Node2D], this is an [Array] with (in order) a [Vector2] for position, a float for rotation (radians) and another [Vector2] for scale. For [Control] this is a [Rect2] with the position and size. + </description> + </method> + <method name="get_canvas" qualifiers="const"> + <return type="RID"> + </return> + <description> + Return the [RID] of the [World2D] canvas where this item is in. + </description> + </method> + <method name="get_canvas_item" qualifiers="const"> + <return type="RID"> + </return> + <description> + Return the canvas item RID used by [VisualServer] for this item. + </description> + </method> + <method name="get_canvas_transform" qualifiers="const"> + <return type="Transform2D"> + </return> + <description> + Get the transform matrix of this item's canvas. + </description> + </method> + <method name="get_global_mouse_position" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Get the global position of the mouse. + </description> + </method> + <method name="get_global_transform" qualifiers="const"> + <return type="Transform2D"> + </return> + <description> + Get the global transform matrix of this item. + </description> + </method> + <method name="get_global_transform_with_canvas" qualifiers="const"> + <return type="Transform2D"> + </return> + <description> + Get the global transform matrix of this item in relation to the canvas. + </description> + </method> + <method name="get_item_and_children_rect" qualifiers="const"> + <return type="Rect2"> + </return> + <description> + Get a [Rect2] with the boundaries of this item and its children. + </description> + </method> + <method name="get_item_rect" qualifiers="const"> + <return type="Rect2"> + </return> + <description> + Return a rect containing the editable boundaries of the item. + </description> + </method> + <method name="get_light_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + Get this item's light mask number. + </description> + </method> + <method name="get_local_mouse_pos" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Get the mouse position relative to this item's position. + </description> + </method> + <method name="get_material" qualifiers="const"> + <return type="Material"> + </return> + <description> + Get the material of this item. + </description> + </method> + <method name="get_modulate" qualifiers="const"> + <return type="Color"> + </return> + <description> + Get the modulate of the CanvasItem, which affects children items too. + </description> + </method> + <method name="get_self_modulate" qualifiers="const"> + <return type="Color"> + </return> + <description> + Get the self-modulate of the CanvasItem. + </description> + </method> + <method name="get_transform" qualifiers="const"> + <return type="Transform2D"> + </return> + <description> + Get the transform matrix of this item. + </description> + </method> + <method name="get_use_parent_material" qualifiers="const"> + <return type="bool"> + </return> + <description> + Get whether this item uses its parent's material. + </description> + </method> + <method name="get_viewport_rect" qualifiers="const"> + <return type="Rect2"> + </return> + <description> + Get the viewport's boundaries as a [Rect2]. + </description> + </method> + <method name="get_viewport_transform" qualifiers="const"> + <return type="Transform2D"> + </return> + <description> + Get this item's transform in relation to the viewport. + </description> + </method> + <method name="get_world_2d" qualifiers="const"> + <return type="World2D"> + </return> + <description> + Get the [World2D] where this item is in. + </description> + </method> + <method name="hide"> + <return type="void"> + </return> + <description> + Hide the CanvasItem currently visible. + </description> + </method> + <method name="is_draw_behind_parent_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether the item is drawn behind its parent. + </description> + </method> + <method name="is_local_transform_notification_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_set_as_toplevel" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return if set as toplevel. See [method set_as_toplevel]. + </description> + </method> + <method name="is_transform_notification_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_visible" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if this CanvasItem is visible. It may be invisible because itself or a parent canvas item is hidden. + </description> + </method> + <method name="is_visible_in_tree" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="make_canvas_pos_local" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="screen_point" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="make_input_local" qualifiers="const"> + <return type="InputEvent"> + </return> + <argument index="0" name="event" type="InputEvent"> + </argument> + <description> + </description> + </method> + <method name="set_as_toplevel"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set as top level. This means that it will not inherit transform from parent canvas items. + </description> + </method> + <method name="set_draw_behind_parent"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set whether the canvas item is drawn behind its parent. + </description> + </method> + <method name="set_light_mask"> + <return type="void"> + </return> + <argument index="0" name="light_mask" type="int"> + </argument> + <description> + Set the ligtht mask number of this item. + </description> + </method> + <method name="set_material"> + <return type="void"> + </return> + <argument index="0" name="material" type="Material"> + </argument> + <description> + Set the material of this item. + </description> + </method> + <method name="set_modulate"> + <return type="void"> + </return> + <argument index="0" name="modulate" type="Color"> + </argument> + <description> + Set the modulate of the CanvasItem. This [i]affects[/i] the modulation of children items. + </description> + </method> + <method name="set_notify_local_transform"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_notify_transform"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_self_modulate"> + <return type="void"> + </return> + <argument index="0" name="self_modulate" type="Color"> + </argument> + <description> + Set the self-modulate of the CanvasItem. This does not affect the modulation of children items. + </description> + </method> + <method name="set_use_parent_material"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set whether or not this item should use its parent's material. + </description> + </method> + <method name="set_visible"> + <return type="void"> + </return> + <argument index="0" name="visible" type="bool"> + </argument> + <description> + Set whether this item should be visible or not. + Note that a hidden CanvasItem will make all children hidden too, so no matter what is set here this item won't be shown if its parent or grandparents nodes are hidden. + </description> + </method> + <method name="show"> + <return type="void"> + </return> + <description> + Show the CanvasItem currently hidden. + </description> + </method> + <method name="update"> + <return type="void"> + </return> + <description> + Queue the CanvasItem for update. [code]NOTIFICATION_DRAW[/code] will be called on idle time to request redraw. + </description> + </method> + </methods> + <members> + <member name="light_mask" type="int" setter="set_light_mask" getter="get_light_mask"> + </member> + <member name="material" type="Material" setter="set_material" getter="get_material"> + </member> + <member name="modulate" type="Color" setter="set_modulate" getter="get_modulate"> + </member> + <member name="self_modulate" type="Color" setter="set_self_modulate" getter="get_self_modulate"> + </member> + <member name="show_behind_parent" type="bool" setter="set_draw_behind_parent" getter="is_draw_behind_parent_enabled"> + </member> + <member name="show_on_top" type="bool" setter="_set_on_top" getter="_is_on_top"> + </member> + <member name="use_parent_material" type="bool" setter="set_use_parent_material" getter="get_use_parent_material"> + </member> + <member name="visible" type="bool" setter="set_visible" getter="is_visible"> + </member> + </members> + <signals> + <signal name="draw"> + <description> + Emitted when the CanvasItem must redraw. This can only be connected realtime, as deferred will not allow drawing. + </description> + </signal> + <signal name="hide"> + <description> + Emitted when becoming hidden. + </description> + </signal> + <signal name="item_rect_changed"> + <description> + Emitted when the item rect has changed. + </description> + </signal> + <signal name="visibility_changed"> + <description> + Emitted when the visibility (hidden/visible) changes. + </description> + </signal> + </signals> + <constants> + <constant name="BLEND_MODE_MIX" value="0"> + Mix blending mode. Colors are assumed to be independent of the alpha (opacity) value. + </constant> + <constant name="BLEND_MODE_ADD" value="1"> + Additive blending mode. + </constant> + <constant name="BLEND_MODE_SUB" value="2"> + Subtractive blending mode. + </constant> + <constant name="BLEND_MODE_MUL" value="3"> + Multiplicative blending mode. + </constant> + <constant name="BLEND_MODE_PREMULT_ALPHA" value="4"> + Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value. + </constant> + <constant name="NOTIFICATION_DRAW" value="30" enum=""> + CanvasItem is requested to draw. + </constant> + <constant name="NOTIFICATION_VISIBILITY_CHANGED" value="31" enum=""> + Canvas item visibility has changed. + </constant> + <constant name="NOTIFICATION_ENTER_CANVAS" value="32" enum=""> + Canvas item has entered the canvas. + </constant> + <constant name="NOTIFICATION_EXIT_CANVAS" value="33" enum=""> + Canvas item has exited the canvas. + </constant> + <constant name="NOTIFICATION_TRANSFORM_CHANGED" value="29" enum=""> + Canvas item transform has changed. Only received if requested. + </constant> + </constants> +</class> diff --git a/doc/classes/CanvasItemMaterial.xml b/doc/classes/CanvasItemMaterial.xml new file mode 100644 index 0000000000..2a6553bb6a --- /dev/null +++ b/doc/classes/CanvasItemMaterial.xml @@ -0,0 +1,65 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="CanvasItemMaterial" inherits="Material" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_blend_mode" qualifiers="const"> + <return type="int" enum="CanvasItemMaterial.BlendMode"> + </return> + <description> + </description> + </method> + <method name="get_light_mode" qualifiers="const"> + <return type="int" enum="CanvasItemMaterial.LightMode"> + </return> + <description> + </description> + </method> + <method name="set_blend_mode"> + <return type="void"> + </return> + <argument index="0" name="blend_mode" type="int" enum="CanvasItemMaterial.BlendMode"> + </argument> + <description> + </description> + </method> + <method name="set_light_mode"> + <return type="void"> + </return> + <argument index="0" name="light_mode" type="int" enum="CanvasItemMaterial.LightMode"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="blend_mode" type="int" setter="set_blend_mode" getter="get_blend_mode" enum="CanvasItemMaterial.BlendMode"> + </member> + <member name="light_mode" type="int" setter="set_light_mode" getter="get_light_mode" enum="CanvasItemMaterial.LightMode"> + </member> + </members> + <constants> + <constant name="BLEND_MODE_MIX" value="0"> + </constant> + <constant name="BLEND_MODE_ADD" value="1"> + </constant> + <constant name="BLEND_MODE_SUB" value="2"> + </constant> + <constant name="BLEND_MODE_MUL" value="3"> + </constant> + <constant name="BLEND_MODE_PREMULT_ALPHA" value="4"> + </constant> + <constant name="LIGHT_MODE_NORMAL" value="0"> + </constant> + <constant name="LIGHT_MODE_UNSHADED" value="1"> + </constant> + <constant name="LIGHT_MODE_LIGHT_ONLY" value="2"> + </constant> + </constants> +</class> diff --git a/doc/classes/CanvasLayer.xml b/doc/classes/CanvasLayer.xml new file mode 100644 index 0000000000..3ee1f10536 --- /dev/null +++ b/doc/classes/CanvasLayer.xml @@ -0,0 +1,148 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="CanvasLayer" inherits="Node" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Canvas drawing layer. + </brief_description> + <description> + Canvas drawing layer. [CanvasItem] nodes that are direct or indirect children of a [CanvasLayer] will be drawn in that layer. The layer is a numeric index that defines the draw order. The default 2D scene renders with index 0, so a [CanvasLayer] with index -1 will be drawn below, and one with index 1 will be drawn above. This is very useful for HUDs (in layer 1+ or above), or backgrounds (in layer -1 or below). + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_custom_viewport" qualifiers="const"> + <return type="Node"> + </return> + <description> + </description> + </method> + <method name="get_layer" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the layer index, determines the draw order, a lower value will be below a higher one. + </description> + </method> + <method name="get_offset" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the base offset for this layer (helper). + </description> + </method> + <method name="get_rotation" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the base rotation for this layer in radians (helper). + </description> + </method> + <method name="get_rotationd" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the base rotation for this layer in degrees. + </description> + </method> + <method name="get_scale" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the base scale for this layer (helper). + </description> + </method> + <method name="get_transform" qualifiers="const"> + <return type="Transform2D"> + </return> + <description> + Return the base transform for this layer. + </description> + </method> + <method name="get_world_2d" qualifiers="const"> + <return type="World2D"> + </return> + <description> + Return the [World2D] used by this layer. + </description> + </method> + <method name="set_custom_viewport"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="Node"> + </argument> + <description> + </description> + </method> + <method name="set_layer"> + <return type="void"> + </return> + <argument index="0" name="layer" type="int"> + </argument> + <description> + Set the layer index, determines the draw order, a lower value will be below a higher one. + </description> + </method> + <method name="set_offset"> + <return type="void"> + </return> + <argument index="0" name="offset" type="Vector2"> + </argument> + <description> + Set the base offset for this layer (helper). + </description> + </method> + <method name="set_rotation"> + <return type="void"> + </return> + <argument index="0" name="radians" type="float"> + </argument> + <description> + Set the base rotation for this layer in radians (helper). + </description> + </method> + <method name="set_rotationd"> + <return type="void"> + </return> + <argument index="0" name="degrees" type="float"> + </argument> + <description> + Set the base rotation for this layer in degrees (helper). + </description> + </method> + <method name="set_scale"> + <return type="void"> + </return> + <argument index="0" name="scale" type="Vector2"> + </argument> + <description> + Set the base scale for this layer (helper). + </description> + </method> + <method name="set_transform"> + <return type="void"> + </return> + <argument index="0" name="transform" type="Transform2D"> + </argument> + <description> + Set the base transform for this layer. + </description> + </method> + </methods> + <members> + <member name="layer" type="int" setter="set_layer" getter="get_layer"> + Layer index for draw order. Lower values are drawn first. Default value: [code]1[/code]. + </member> + <member name="offset" type="Vector2" setter="set_offset" getter="get_offset"> + The layer's base offset. + </member> + <member name="rotation" type="float" setter="set_rotationd" getter="get_rotationd"> + The layer's rotation in degrees. + </member> + <member name="scale" type="Vector2" setter="set_scale" getter="get_scale"> + The layer's scale. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/CanvasModulate.xml b/doc/classes/CanvasModulate.xml new file mode 100644 index 0000000000..f0e3132da5 --- /dev/null +++ b/doc/classes/CanvasModulate.xml @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="CanvasModulate" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Tint the entire canvas + </brief_description> + <description> + CanvasModulate tints the canvas elements using its assigned color + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + Gets the canvas tint color + </description> + </method> + <method name="set_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + Sets the canvas tint color + </description> + </method> + </methods> + <members> + <member name="color" type="Color" setter="set_color" getter="get_color"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/CapsuleMesh.xml b/doc/classes/CapsuleMesh.xml new file mode 100644 index 0000000000..13cdfa057d --- /dev/null +++ b/doc/classes/CapsuleMesh.xml @@ -0,0 +1,87 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="CapsuleMesh" inherits="PrimitiveMesh" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Class representing a capsule-shaped [PrimitiveMesh]. + </brief_description> + <description> + Class representing a capsule-shaped [PrimitiveMesh]. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_mid_height" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_radial_segments" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_radius" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_rings" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_mid_height"> + <return type="void"> + </return> + <argument index="0" name="mid_height" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_radial_segments"> + <return type="void"> + </return> + <argument index="0" name="segments" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_radius"> + <return type="void"> + </return> + <argument index="0" name="radius" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_rings"> + <return type="void"> + </return> + <argument index="0" name="rings" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="mid_height" type="float" setter="set_mid_height" getter="get_mid_height"> + Height of the capsule mesh from the center point. Defaults to 1.0. + </member> + <member name="radial_segments" type="int" setter="set_radial_segments" getter="get_radial_segments"> + Number of radial segments on the capsule mesh. Defaults to 64. + </member> + <member name="radius" type="float" setter="set_radius" getter="get_radius"> + Radius of the capsule mesh. Defaults to 1.0. + </member> + <member name="rings" type="int" setter="set_rings" getter="get_rings"> + Number of rings along the height of the capsule. Defaults to 8. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/CapsuleShape.xml b/doc/classes/CapsuleShape.xml new file mode 100644 index 0000000000..db075a504c --- /dev/null +++ b/doc/classes/CapsuleShape.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="CapsuleShape" inherits="Shape" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Capsule shape for collisions. + </brief_description> + <description> + Capsule shape for collisions. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_height" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the capsule height. + </description> + </method> + <method name="get_radius" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the capsule radius. + </description> + </method> + <method name="set_height"> + <return type="void"> + </return> + <argument index="0" name="height" type="float"> + </argument> + <description> + Set the capsule height. + </description> + </method> + <method name="set_radius"> + <return type="void"> + </return> + <argument index="0" name="radius" type="float"> + </argument> + <description> + Set the capsule radius. + </description> + </method> + </methods> + <members> + <member name="height" type="float" setter="set_height" getter="get_height"> + The capsule's height. + </member> + <member name="radius" type="float" setter="set_radius" getter="get_radius"> + The capsule's radius. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/CapsuleShape2D.xml b/doc/classes/CapsuleShape2D.xml new file mode 100644 index 0000000000..df833e0582 --- /dev/null +++ b/doc/classes/CapsuleShape2D.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="CapsuleShape2D" inherits="Shape2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Capsule shape for 2D collisions. + </brief_description> + <description> + Capsule shape for 2D collisions. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_height" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the height of the [CapsuleShape2D]. + </description> + </method> + <method name="get_radius" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the radius of the [CapsuleShape2D]. + </description> + </method> + <method name="set_height"> + <return type="void"> + </return> + <argument index="0" name="height" type="float"> + </argument> + <description> + Set the height of the [CapsuleShape2D]. + </description> + </method> + <method name="set_radius"> + <return type="void"> + </return> + <argument index="0" name="radius" type="float"> + </argument> + <description> + Set the radius of the [CapsuleShape2D]. + </description> + </method> + </methods> + <members> + <member name="height" type="float" setter="set_height" getter="get_height"> + The capsule's height. + </member> + <member name="radius" type="float" setter="set_radius" getter="get_radius"> + The capsules's radius. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/CenterContainer.xml b/doc/classes/CenterContainer.xml new file mode 100644 index 0000000000..2f81e7739f --- /dev/null +++ b/doc/classes/CenterContainer.xml @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="CenterContainer" inherits="Container" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Keeps children controls centered. + </brief_description> + <description> + CenterContainer Keeps children controls centered. This container keeps all children to their minimum size, in the center. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="is_using_top_left" qualifiers="const"> + <return type="bool"> + </return> + <description> + Should put children to the top left corner instead of center of the container. + </description> + </method> + <method name="set_use_top_left"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + This function will anchor the container children to the top left corner of the the container boundaries, moving all its children to that position, (the children new center will be the top left corner of the container). + </description> + </method> + </methods> + <members> + <member name="use_top_left" type="bool" setter="set_use_top_left" getter="is_using_top_left"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/CheckBox.xml b/doc/classes/CheckBox.xml new file mode 100644 index 0000000000..6258eb503f --- /dev/null +++ b/doc/classes/CheckBox.xml @@ -0,0 +1,51 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="CheckBox" inherits="Button" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Binary choice user interface widget + </brief_description> + <description> + A checkbox allows the user to make a binary choice (choosing only one of two posible options), for example Answer 'yes' or 'no'. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> + <theme_items> + <theme_item name="check_vadjust" type="int"> + </theme_item> + <theme_item name="checked" type="Texture"> + </theme_item> + <theme_item name="disabled" type="StyleBox"> + </theme_item> + <theme_item name="focus" type="StyleBox"> + </theme_item> + <theme_item name="font" type="Font"> + </theme_item> + <theme_item name="font_color" type="Color"> + </theme_item> + <theme_item name="font_color_disabled" type="Color"> + </theme_item> + <theme_item name="font_color_hover" type="Color"> + </theme_item> + <theme_item name="font_color_pressed" type="Color"> + </theme_item> + <theme_item name="hover" type="StyleBox"> + </theme_item> + <theme_item name="hseparation" type="int"> + </theme_item> + <theme_item name="normal" type="StyleBox"> + </theme_item> + <theme_item name="pressed" type="StyleBox"> + </theme_item> + <theme_item name="radio_checked" type="Texture"> + </theme_item> + <theme_item name="radio_unchecked" type="Texture"> + </theme_item> + <theme_item name="unchecked" type="Texture"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/CheckButton.xml b/doc/classes/CheckButton.xml new file mode 100644 index 0000000000..bb4e6fc0cb --- /dev/null +++ b/doc/classes/CheckButton.xml @@ -0,0 +1,47 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="CheckButton" inherits="Button" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Checkable button. + </brief_description> + <description> + CheckButton is a toggle button displayed as a check field. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> + <theme_items> + <theme_item name="check_vadjust" type="int"> + </theme_item> + <theme_item name="disabled" type="StyleBox"> + </theme_item> + <theme_item name="focus" type="StyleBox"> + </theme_item> + <theme_item name="font" type="Font"> + </theme_item> + <theme_item name="font_color" type="Color"> + </theme_item> + <theme_item name="font_color_disabled" type="Color"> + </theme_item> + <theme_item name="font_color_hover" type="Color"> + </theme_item> + <theme_item name="font_color_pressed" type="Color"> + </theme_item> + <theme_item name="hover" type="StyleBox"> + </theme_item> + <theme_item name="hseparation" type="int"> + </theme_item> + <theme_item name="normal" type="StyleBox"> + </theme_item> + <theme_item name="off" type="Texture"> + </theme_item> + <theme_item name="on" type="Texture"> + </theme_item> + <theme_item name="pressed" type="StyleBox"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/CircleShape2D.xml b/doc/classes/CircleShape2D.xml new file mode 100644 index 0000000000..1ed54f0705 --- /dev/null +++ b/doc/classes/CircleShape2D.xml @@ -0,0 +1,38 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="CircleShape2D" inherits="Shape2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Circular shape for 2D collisions. + </brief_description> + <description> + Circular shape for 2D collisions. This shape is useful for modeling balls or small characters and its collision detection with everything else is very fast. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_radius" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the radius of the circle shape. + </description> + </method> + <method name="set_radius"> + <return type="void"> + </return> + <argument index="0" name="radius" type="float"> + </argument> + <description> + Set the radius of the circle shape. + </description> + </method> + </methods> + <members> + <member name="radius" type="float" setter="set_radius" getter="get_radius"> + The circle's radius. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/ClassDB.xml b/doc/classes/ClassDB.xml new file mode 100644 index 0000000000..35cf819959 --- /dev/null +++ b/doc/classes/ClassDB.xml @@ -0,0 +1,222 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ClassDB" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Class information repository. + </brief_description> + <description> + Provides access to metadata stored for every available class. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="can_instance" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="class" type="String"> + </argument> + <description> + Returns true if you can instance objects from the specified 'class', false in other case. + </description> + </method> + <method name="class_exists" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="class" type="String"> + </argument> + <description> + Returns whether the specified 'class' is available or not. + </description> + </method> + <method name="class_get_category" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="class" type="String"> + </argument> + <description> + </description> + </method> + <method name="class_get_integer_constant" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="class" type="String"> + </argument> + <argument index="1" name="name" type="String"> + </argument> + <description> + Returns the value of the integer constant 'name' of 'class' or its ancestry. Always returns 0 when the constant could not be found. + </description> + </method> + <method name="class_get_integer_constant_list" qualifiers="const"> + <return type="PoolStringArray"> + </return> + <argument index="0" name="class" type="String"> + </argument> + <argument index="1" name="no_inheritance" type="bool" default="false"> + </argument> + <description> + Returns an array with the names all the integer constants of 'class' or its ancestry. + </description> + </method> + <method name="class_get_method_list" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="class" type="String"> + </argument> + <argument index="1" name="no_inheritance" type="bool" default="false"> + </argument> + <description> + Returns an array with all the methods of 'class' or its ancestry if 'no_inheritance' is false. Every element of the array is a [Dictionary] with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage). + </description> + </method> + <method name="class_get_property" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="property" type="String"> + </argument> + <description> + Returns the value of 'property' of 'class' or its ancestry. + </description> + </method> + <method name="class_get_property_list" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="class" type="String"> + </argument> + <argument index="1" name="no_inheritance" type="bool" default="false"> + </argument> + <description> + Returns an array with all the properties of 'class' or its ancestry if 'no_inheritance' is false. + </description> + </method> + <method name="class_get_signal" qualifiers="const"> + <return type="Dictionary"> + </return> + <argument index="0" name="class" type="String"> + </argument> + <argument index="1" name="signal" type="String"> + </argument> + <description> + Returns the 'signal' data of 'class' or its ancestry. The returned value is a [Dictionary] with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage). + </description> + </method> + <method name="class_get_signal_list" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="class" type="String"> + </argument> + <argument index="1" name="no_inheritance" type="bool" default="false"> + </argument> + <description> + Returns an array with all the signals of 'class' or its ancestry if 'no_inheritance' is false. Every element of the array is a [Dictionary] as described in [class_get_signal]. + </description> + </method> + <method name="class_has_integer_constant" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="class" type="String"> + </argument> + <argument index="1" name="name" type="String"> + </argument> + <description> + Return whether 'class' or its ancestry has an integer constant called 'name' or not. + </description> + </method> + <method name="class_has_method" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="class" type="String"> + </argument> + <argument index="1" name="method" type="String"> + </argument> + <argument index="2" name="no_inheritance" type="bool" default="false"> + </argument> + <description> + Return whether 'class' (or its ancestry if 'no_inheritance' is false) has a method called 'method' or not. + </description> + </method> + <method name="class_has_signal" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="class" type="String"> + </argument> + <argument index="1" name="signal" type="String"> + </argument> + <description> + Return whether 'class' or its ancestry has a signal called 'signal' or not. + </description> + </method> + <method name="class_set_property" qualifiers="const"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="property" type="String"> + </argument> + <argument index="2" name="value" type="Variant"> + </argument> + <description> + Sets 'property' value of 'class' to 'value'. + </description> + </method> + <method name="get_class_list" qualifiers="const"> + <return type="PoolStringArray"> + </return> + <description> + Returns the names of all the classes available. + </description> + </method> + <method name="get_inheriters_from_class" qualifiers="const"> + <return type="PoolStringArray"> + </return> + <argument index="0" name="class" type="String"> + </argument> + <description> + Returns the names of all the classes that directly or indirectly inherit from 'class'. + </description> + </method> + <method name="get_parent_class" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="class" type="String"> + </argument> + <description> + Returns the parent class of 'class'. + </description> + </method> + <method name="instance" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="class" type="String"> + </argument> + <description> + Creates an instance of 'class'. + </description> + </method> + <method name="is_class_enabled" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="class" type="String"> + </argument> + <description> + Returns whether this class is enabled or not. + </description> + </method> + <method name="is_parent_class" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="class" type="String"> + </argument> + <argument index="1" name="inherits" type="String"> + </argument> + <description> + Returns whether 'inherits' is an ancestor of 'class' or not. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/CollisionObject.xml b/doc/classes/CollisionObject.xml new file mode 100644 index 0000000000..791978993c --- /dev/null +++ b/doc/classes/CollisionObject.xml @@ -0,0 +1,232 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="CollisionObject" inherits="Spatial" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="_input_event" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="camera" type="Object"> + </argument> + <argument index="1" name="event" type="InputEvent"> + </argument> + <argument index="2" name="click_pos" type="Vector3"> + </argument> + <argument index="3" name="click_normal" type="Vector3"> + </argument> + <argument index="4" name="shape_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="create_shape_owner"> + <return type="int"> + </return> + <argument index="0" name="owner" type="Object"> + </argument> + <description> + Creates new holder for the shapes. Argument is a [CollisionShape] node. It will return owner_id which usually you will want to save for later use. + </description> + </method> + <method name="get_capture_input_on_drag" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_rid" qualifiers="const"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="get_shape_owners"> + <return type="Array"> + </return> + <description> + Shape owner is a node which is holding concrete shape resources. This method will return an array which is holding an integer numbers that are representing unique ID of each owner. You can use those ids when you are using others shape_owner methods. + </description> + </method> + <method name="is_ray_pickable" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_shape_owner_disabled" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="owner_id" type="int"> + </argument> + <description> + </description> + </method> + <method name="remove_shape_owner"> + <return type="void"> + </return> + <argument index="0" name="owner_id" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_capture_input_on_drag"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_ray_pickable"> + <return type="void"> + </return> + <argument index="0" name="ray_pickable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="shape_find_owner" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="shape_index" type="int"> + </argument> + <description> + </description> + </method> + <method name="shape_owner_add_shape"> + <return type="void"> + </return> + <argument index="0" name="owner_id" type="int"> + </argument> + <argument index="1" name="shape" type="Shape"> + </argument> + <description> + </description> + </method> + <method name="shape_owner_clear_shapes"> + <return type="void"> + </return> + <argument index="0" name="owner_id" type="int"> + </argument> + <description> + Will remove all the shapes associated with given owner. + </description> + </method> + <method name="shape_owner_get_owner" qualifiers="const"> + <return type="Object"> + </return> + <argument index="0" name="owner_id" type="int"> + </argument> + <description> + </description> + </method> + <method name="shape_owner_get_shape" qualifiers="const"> + <return type="Shape"> + </return> + <argument index="0" name="owner_id" type="int"> + </argument> + <argument index="1" name="shape_id" type="int"> + </argument> + <description> + Will return a [Shape]. First argument owner_id is an integer that can be obtained from [method get_shape_owners]. Shape_id is a position of the shape inside owner; it's a value in range from 0 to [method shape_owner_get_shape_count]. + </description> + </method> + <method name="shape_owner_get_shape_count" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="owner_id" type="int"> + </argument> + <description> + Returns number of shapes to which given owner is associated to. + </description> + </method> + <method name="shape_owner_get_shape_index" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="owner_id" type="int"> + </argument> + <argument index="1" name="shape_id" type="int"> + </argument> + <description> + </description> + </method> + <method name="shape_owner_get_transform" qualifiers="const"> + <return type="Transform"> + </return> + <argument index="0" name="owner_id" type="int"> + </argument> + <description> + Will return [Transform] of an owner node. + </description> + </method> + <method name="shape_owner_remove_shape"> + <return type="void"> + </return> + <argument index="0" name="owner_id" type="int"> + </argument> + <argument index="1" name="shape_id" type="int"> + </argument> + <description> + Removes related shape from the owner. + </description> + </method> + <method name="shape_owner_set_disabled"> + <return type="void"> + </return> + <argument index="0" name="owner_id" type="int"> + </argument> + <argument index="1" name="disabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="shape_owner_set_transform"> + <return type="void"> + </return> + <argument index="0" name="owner_id" type="int"> + </argument> + <argument index="1" name="transform" type="Transform"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="input_capture_on_drag" type="bool" setter="set_capture_input_on_drag" getter="get_capture_input_on_drag"> + </member> + <member name="input_ray_pickable" type="bool" setter="set_ray_pickable" getter="is_ray_pickable"> + </member> + </members> + <signals> + <signal name="input_event"> + <argument index="0" name="camera" type="Object"> + </argument> + <argument index="1" name="event" type="Object"> + </argument> + <argument index="2" name="click_pos" type="Vector3"> + </argument> + <argument index="3" name="click_normal" type="Vector3"> + </argument> + <argument index="4" name="shape_idx" type="int"> + </argument> + <description> + </description> + </signal> + <signal name="mouse_entered"> + <description> + </description> + </signal> + <signal name="mouse_exited"> + <description> + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/CollisionObject2D.xml b/doc/classes/CollisionObject2D.xml new file mode 100644 index 0000000000..db1412805f --- /dev/null +++ b/doc/classes/CollisionObject2D.xml @@ -0,0 +1,233 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="CollisionObject2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base node for 2D collisionables. + </brief_description> + <description> + CollisionObject2D is the base class for 2D physics collisionables. They can hold any number of 2D collision shapes. Usually, they are edited by placing [CollisionShape2D] and/or [CollisionPolygon2D] nodes as children. Such nodes are for reference and not present outside the editor, so code should use the regular shape API. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="_input_event" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="viewport" type="Object"> + </argument> + <argument index="1" name="event" type="InputEvent"> + </argument> + <argument index="2" name="shape_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="create_shape_owner"> + <return type="int"> + </return> + <argument index="0" name="owner" type="Object"> + </argument> + <description> + Creates new holder for the shapes. Argument is a [CollisionShape2D] node. It will return owner_id which usually you will want to save for later use. + </description> + </method> + <method name="get_rid" qualifiers="const"> + <return type="RID"> + </return> + <description> + Return the RID of this object. + </description> + </method> + <method name="get_shape_owners"> + <return type="Array"> + </return> + <description> + Shape owner is a node which is holding concrete shape resources. This method will return an array which is holding an integer numbers that are representing unique ID of each owner. You can use those ids when you are using others shape_owner methods. + </description> + </method> + <method name="is_pickable" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether this object is pickable. + </description> + </method> + <method name="is_shape_owner_disabled" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="owner_id" type="int"> + </argument> + <description> + </description> + </method> + <method name="is_shape_owner_one_way_collision_enabled" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="owner_id" type="int"> + </argument> + <description> + </description> + </method> + <method name="remove_shape_owner"> + <return type="void"> + </return> + <argument index="0" name="owner_id" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_pickable"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Set whether this object is pickable. A pickable object can detect the mouse pointer enter/leave it and, if the mouse is inside it, report input events. + </description> + </method> + <method name="shape_find_owner" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="shape_index" type="int"> + </argument> + <description> + </description> + </method> + <method name="shape_owner_add_shape"> + <return type="void"> + </return> + <argument index="0" name="owner_id" type="int"> + </argument> + <argument index="1" name="shape" type="Shape2D"> + </argument> + <description> + </description> + </method> + <method name="shape_owner_clear_shapes"> + <return type="void"> + </return> + <argument index="0" name="owner_id" type="int"> + </argument> + <description> + Will remove all the shapes associated with given owner. + </description> + </method> + <method name="shape_owner_get_owner" qualifiers="const"> + <return type="Object"> + </return> + <argument index="0" name="owner_id" type="int"> + </argument> + <description> + </description> + </method> + <method name="shape_owner_get_shape" qualifiers="const"> + <return type="Shape2D"> + </return> + <argument index="0" name="owner_id" type="int"> + </argument> + <argument index="1" name="shape_id" type="int"> + </argument> + <description> + Will return a [Shape2D]. First argument owner_id is an integer that can be obtained from [method get_shape_owners]. Shape_id is a position of the shape inside owner; it's a value in range from 0 to [method shape_owner_get_shape_count]. + </description> + </method> + <method name="shape_owner_get_shape_count" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="owner_id" type="int"> + </argument> + <description> + Returns number of shapes to which given owner is associated to. + </description> + </method> + <method name="shape_owner_get_shape_index" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="owner_id" type="int"> + </argument> + <argument index="1" name="shape_id" type="int"> + </argument> + <description> + </description> + </method> + <method name="shape_owner_get_transform" qualifiers="const"> + <return type="Transform2D"> + </return> + <argument index="0" name="owner_id" type="int"> + </argument> + <description> + Will return [Transform2D] of an owner node. + </description> + </method> + <method name="shape_owner_remove_shape"> + <return type="void"> + </return> + <argument index="0" name="owner_id" type="int"> + </argument> + <argument index="1" name="shape_id" type="int"> + </argument> + <description> + Removes related shape from the owner. + </description> + </method> + <method name="shape_owner_set_disabled"> + <return type="void"> + </return> + <argument index="0" name="owner_id" type="int"> + </argument> + <argument index="1" name="disabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="shape_owner_set_one_way_collision"> + <return type="void"> + </return> + <argument index="0" name="owner_id" type="int"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="shape_owner_set_transform"> + <return type="void"> + </return> + <argument index="0" name="owner_id" type="int"> + </argument> + <argument index="1" name="transform" type="Transform2D"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="input_pickable" type="bool" setter="set_pickable" getter="is_pickable"> + </member> + </members> + <signals> + <signal name="input_event"> + <argument index="0" name="viewport" type="Object"> + </argument> + <argument index="1" name="event" type="Object"> + </argument> + <argument index="2" name="shape_idx" type="int"> + </argument> + <description> + </description> + </signal> + <signal name="mouse_entered"> + <description> + This event fires only once when the mouse pointer enters any shape of this object. + </description> + </signal> + <signal name="mouse_exited"> + <description> + This event fires only once when the mouse pointer exits all shapes of this object. + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/CollisionPolygon.xml b/doc/classes/CollisionPolygon.xml new file mode 100644 index 0000000000..c2496424d6 --- /dev/null +++ b/doc/classes/CollisionPolygon.xml @@ -0,0 +1,70 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="CollisionPolygon" inherits="Spatial" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Editor-only class for defining a collision polygon in 3D space. + </brief_description> + <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 [Shape] for gameplay. Properties modified during gameplay will have no effect. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_depth" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_polygon" qualifiers="const"> + <return type="PoolVector2Array"> + </return> + <description> + </description> + </method> + <method name="is_disabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_depth"> + <return type="void"> + </return> + <argument index="0" name="depth" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_disabled"> + <return type="void"> + </return> + <argument index="0" name="disabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_polygon"> + <return type="void"> + </return> + <argument index="0" name="polygon" type="PoolVector2Array"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="depth" type="float" setter="set_depth" getter="get_depth"> + Length that the resulting collision extends in either direction perpendicular to its polygon. + </member> + <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled"> + If true, no collision will be produced. + </member> + <member name="polygon" type="PoolVector2Array" setter="set_polygon" getter="get_polygon"> + Array of vertices which define the polygon. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/CollisionPolygon2D.xml b/doc/classes/CollisionPolygon2D.xml new file mode 100644 index 0000000000..d3dee1e9bb --- /dev/null +++ b/doc/classes/CollisionPolygon2D.xml @@ -0,0 +1,96 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="CollisionPolygon2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Editor-only class for defining a collision polygon in 2D space. + </brief_description> + <description> + 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 [Shape2D] for gameplay. Properties modified during gameplay will have no effect. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_build_mode" qualifiers="const"> + <return type="int" enum="CollisionPolygon2D.BuildMode"> + </return> + <description> + Return whether the polygon is a [ConvexPolygonShape2D] ([code]build_mode==0[/code]), or a [ConcavePolygonShape2D] ([code]build_mode==1[/code]). + </description> + </method> + <method name="get_polygon" qualifiers="const"> + <return type="PoolVector2Array"> + </return> + <description> + Return the list of points that define the polygon. + </description> + </method> + <method name="is_disabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_one_way_collision_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_build_mode"> + <return type="void"> + </return> + <argument index="0" name="build_mode" type="int" enum="CollisionPolygon2D.BuildMode"> + </argument> + <description> + Set whether the polygon is to be a [ConvexPolygonShape2D] ([code]build_mode==0[/code]), or a [ConcavePolygonShape2D] ([code]build_mode==1[/code]). + </description> + </method> + <method name="set_disabled"> + <return type="void"> + </return> + <argument index="0" name="disabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_one_way_collision"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_polygon"> + <return type="void"> + </return> + <argument index="0" name="polygon" type="PoolVector2Array"> + </argument> + <description> + Set the array of points forming the polygon. + When editing the point list via the editor, depending on [method get_build_mode], it has to be a list of points (for [code]build_mode==0[/code]), or a list of lines (for [code]build_mode==1[/code]). In the second case, the even elements of the array define the start point of the line, and the odd elements the end point. + </description> + </method> + </methods> + <members> + <member name="build_mode" type="int" setter="set_build_mode" getter="get_build_mode" enum="CollisionPolygon2D.BuildMode"> + 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. + </member> + <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled"> + If true, no collision will be produced. + </member> + <member name="one_way_collision" type="bool" setter="set_one_way_collision" getter="is_one_way_collision_enabled"> + If true, only edges that face up, relative to CollisionPolygon2D's rotation, will collide with other objects. + </member> + <member name="polygon" type="PoolVector2Array" setter="set_polygon" getter="get_polygon"> + Array of vertices which define the polygon. + </member> + </members> + <constants> + <constant name="BUILD_SOLIDS" value="0"> + </constant> + <constant name="BUILD_SEGMENTS" value="1"> + </constant> + </constants> +</class> diff --git a/doc/classes/CollisionShape.xml b/doc/classes/CollisionShape.xml new file mode 100644 index 0000000000..6e98d2f979 --- /dev/null +++ b/doc/classes/CollisionShape.xml @@ -0,0 +1,69 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="CollisionShape" inherits="Spatial" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Node that represents collision shape data in 3D space. + </brief_description> + <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 [Area] to give it a detection shape, or add it to a [PhysicsBody] to give create solid object. [b]IMPORTANT[/b]: this is an Editor-only helper to create shapes, use [method get_shape] to get the actual shape. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_shape" qualifiers="const"> + <return type="Shape"> + </return> + <description> + </description> + </method> + <method name="is_disabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="make_convex_from_brothers"> + <return type="void"> + </return> + <description> + Sets the collision shape's shape to the addition of all its convexed [MeshInstance] siblings geometry. + </description> + </method> + <method name="resource_changed"> + <return type="void"> + </return> + <argument index="0" name="resource" type="Resource"> + </argument> + <description> + If this method exists within a script it will be called whenever the shape resource has been modified. + </description> + </method> + <method name="set_disabled"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_shape"> + <return type="void"> + </return> + <argument index="0" name="shape" type="Shape"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled"> + A disabled collision shape has no effect in the world. + </member> + <member name="shape" type="Shape" setter="set_shape" getter="get_shape"> + The actual shape owned by this collision shape. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/CollisionShape2D.xml b/doc/classes/CollisionShape2D.xml new file mode 100644 index 0000000000..cefa0c1c81 --- /dev/null +++ b/doc/classes/CollisionShape2D.xml @@ -0,0 +1,70 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="CollisionShape2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Node that represents collision shape data in 2D space. + </brief_description> + <description> + Editor facility for creating and editing collision shapes in 2D space. You can use this node to represent all sorts of collision shapes, for example, add this to an [Area2D] to give it a detection shape, or add it to a [PhysicsBody2D] to give create solid object. [b]IMPORTANT[/b]: this is an Editor-only helper to create shapes, use [method get_shape] to get the actual shape. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_shape" qualifiers="const"> + <return type="Shape2D"> + </return> + <description> + </description> + </method> + <method name="is_disabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_one_way_collision_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_disabled"> + <return type="void"> + </return> + <argument index="0" name="disabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_one_way_collision"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_shape"> + <return type="void"> + </return> + <argument index="0" name="shape" type="Shape2D"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled"> + A disabled collision shape has no effect in the world. + </member> + <member name="one_way_collision" type="bool" setter="set_one_way_collision" getter="is_one_way_collision_enabled"> + Sets whether this collision shape should only detect collision on one side (top or bottom). + </member> + <member name="shape" type="Shape2D" setter="set_shape" getter="get_shape"> + The actual shape owned by this collision shape. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml new file mode 100644 index 0000000000..4547771b63 --- /dev/null +++ b/doc/classes/Color.xml @@ -0,0 +1,222 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Color" category="Built-In Types" version="3.0.alpha.custom_build"> + <brief_description> + Color in RGBA format with some support for ARGB format. + </brief_description> + <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(color)) may accept values > 1. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="Color"> + <return type="Color"> + </return> + <argument index="0" name="r" type="float"> + </argument> + <argument index="1" name="g" type="float"> + </argument> + <argument index="2" name="b" type="float"> + </argument> + <argument index="3" name="a" type="float"> + </argument> + <description> + Constructs a color from an RGBA profile using values between 0 and 1 (float). + [codeblock] + var c = Color(0.2, 1.0, .7, .8) # a color of an RGBA(51, 255, 178, 204) + [/codeblock] + </description> + </method> + <method name="Color"> + <return type="Color"> + </return> + <argument index="0" name="r" type="float"> + </argument> + <argument index="1" name="g" type="float"> + </argument> + <argument index="2" name="b" type="float"> + </argument> + <description> + Constructs a color from an RGB profile using values between 0 and 1 (float). Alpha will always be 1. + [codeblock] + var c = Color(0.2, 1.0, .7) # a color of an RGBA(51, 255, 178, 255) + [/codeblock] + </description> + </method> + <method name="Color"> + <return type="Color"> + </return> + <argument index="0" name="from" type="int"> + </argument> + <description> + Constructs a color from a 32-bit integer (each byte represents a component of the RGBA profile). + [codeblock] + var c = Color(274) # a color of an RGBA(0, 0, 1, 18) + [/codeblock] + </description> + </method> + <method name="Color"> + <return type="Color"> + </return> + <argument index="0" name="from" type="String"> + </argument> + <description> + Constructs a color from an HTML hexadecimal color string in ARGB or RGB format. + The following string formats are supported: + [code]"#ff00ff00"[/code] - ARGB format with '#' + [code]"ff00ff00"[/code] - ARGB format + [code]"#ff00ff"[/code] - RGB format with '#' + [code]"ff00ff"[/code] - RGB format + [codeblock] + # 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 + [/codeblock] + </description> + </method> + <method name="blend"> + <return type="Color"> + </return> + <argument index="0" name="over" type="Color"> + </argument> + <description> + 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. + [codeblock] + 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% + [/codeblock] + </description> + </method> + <method name="contrasted"> + <return type="Color"> + </return> + <description> + Returns the most contrasting color. + [codeblock] + var c = Color(.3, .4, .9) + var contrastedColor = c.contrasted() # a color of an RGBA(204, 229, 102, 255) + [/codeblock] + </description> + </method> + <method name="gray"> + <return type="float"> + </return> + <description> + Returns the color's grayscale. + The gray is calculated by (r + g + b) / 3. + [codeblock] + var c = Color(0.2, 0.45, 0.82) + var gray = c.gray() # a value of 0.466667 + [/codeblock] + </description> + </method> + <method name="inverted"> + <return type="Color"> + </return> + <description> + Returns the inverted color (1-r, 1-g, 1-b, 1-a). + [codeblock] + var c = Color(.3, .4, .9) + var invertedColor = c.inverted() # a color of an RGBA(178, 153, 26, 255) + [/codeblock] + </description> + </method> + <method name="linear_interpolate"> + <return type="Color"> + </return> + <argument index="0" name="b" type="Color"> + </argument> + <argument index="1" name="t" type="float"> + </argument> + <description> + Returns the color of the linear interpolation with another color. The value t is between 0 and 1 (float). + [codeblock] + 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) + [/codeblock] + </description> + </method> + <method name="to_argb32"> + <return type="int"> + </return> + <description> + Returns the color's 32-bit integer in ARGB format (each byte represents a component of the ARGB profile). More compatible with DirectX. + [codeblock] + var c = Color(1, .5, .2) + print(str(c.to_32())) # prints 4294934323 + [/codeblock] + </description> + </method> + <method name="to_html"> + <return type="String"> + </return> + <argument index="0" name="with_alpha" type="bool" default="True"> + </argument> + <description> + Returns the color's HTML hexadecimal color string in ARGB format (ex: [code]ff34f822[/code]). + Optionally flag 'false' to not include alpha in hexadecimal string. + [codeblock] + var c = Color(1, 1, 1, .5) + var s1 = c.to_html() # Results "7fffffff" + var s2 = c.to_html(false) # Results 'ffffff' + [/codeblock] + </description> + </method> + <method name="to_rgba32"> + <return type="int"> + </return> + <description> + Returns the color's 32-bit integer in ARGB format (each byte represents a component of the ARGB profile). + [codeblock] + var c = Color(1, .5, .2) + print(str(c.to_32())) # prints 4294934323 + [/codeblock] + + [i]This is same as [method to_ARGB32] but may be changed later to support RGBA format instead[/i]. + </description> + </method> + </methods> + <members> + <member name="a" type="float" setter="" getter=""> + Alpha (0 to 1) + </member> + <member name="a8" type="int" setter="" getter=""> + Alpha (0 to 255) + </member> + <member name="b" type="float" setter="" getter=""> + Blue (0 to 1) + </member> + <member name="b8" type="int" setter="" getter=""> + Blue (0 to 255) + </member> + <member name="g" type="float" setter="" getter=""> + Green (0 to 1) + </member> + <member name="g8" type="int" setter="" getter=""> + Green (0 to 255) + </member> + <member name="h" type="float" setter="" getter=""> + Hue (0 to 1) + </member> + <member name="r" type="float" setter="" getter=""> + Red (0 to 1) + </member> + <member name="r8" type="int" setter="" getter=""> + Red (0 to 255) + </member> + <member name="s" type="float" setter="" getter=""> + Saturation (0 to 1) + </member> + <member name="v" type="float" setter="" getter=""> + Value (0 to 1) + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/ColorPicker.xml b/doc/classes/ColorPicker.xml new file mode 100644 index 0000000000..87414eb03a --- /dev/null +++ b/doc/classes/ColorPicker.xml @@ -0,0 +1,103 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ColorPicker" inherits="BoxContainer" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Color picker control. + </brief_description> + <description> + This is a simple color picker [Control]. It's useful for selecting a color from an RGB/RGBA colorspace. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_preset"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + Adds the current selected to color to a list of colors (presets), the presets will be displayed in the color picker and the user will be able to select them, notice that the presets list is only for this color picker. + </description> + </method> + <method name="get_pick_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + Gets the current color. + </description> + </method> + <method name="is_editing_alpha" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns whether the color has transparency or not. + </description> + </method> + <method name="is_raw_mode" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns whether this color picker is in raw mode or not, raw mode will allow the color R, G, B component values to go beyond 1, you have to consider that the max value for color components is 1, going beyond that value will not have effect in the color, but can be used for special operations that require it (like tinting without darkening or rendering sprites in HDR). + </description> + </method> + <method name="set_edit_alpha"> + <return type="void"> + </return> + <argument index="0" name="show" type="bool"> + </argument> + <description> + Set true if you want the color to have an alpha channel (transparency), or false if you want a solid color. + </description> + </method> + <method name="set_pick_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + Select the current color. + </description> + </method> + <method name="set_raw_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="bool"> + </argument> + <description> + Set whether this color picker is using raw mode or not, see [method is_raw_mode]. + </description> + </method> + </methods> + <signals> + <signal name="color_changed"> + <argument index="0" name="color" type="Color"> + </argument> + <description> + Emitted when the color is changed. + </description> + </signal> + </signals> + <constants> + </constants> + <theme_items> + <theme_item name="add_preset" type="Texture"> + </theme_item> + <theme_item name="color_hue" type="Texture"> + </theme_item> + <theme_item name="color_sample" type="Texture"> + </theme_item> + <theme_item name="h_width" type="int"> + </theme_item> + <theme_item name="label_width" type="int"> + </theme_item> + <theme_item name="margin" type="int"> + </theme_item> + <theme_item name="screen_picker" type="Texture"> + </theme_item> + <theme_item name="sv_height" type="int"> + </theme_item> + <theme_item name="sv_width" type="int"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/ColorPickerButton.xml b/doc/classes/ColorPickerButton.xml new file mode 100644 index 0000000000..59b74edd77 --- /dev/null +++ b/doc/classes/ColorPickerButton.xml @@ -0,0 +1,98 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ColorPickerButton" inherits="Button" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Button that pops out a [ColorPicker] + </brief_description> + <description> + Encapsulates a [ColorPicker] making it accesible by pressing a button, pressing the button will toggle the [ColorPicker] visibility + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_pick_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_picker"> + <return type="ColorPicker"> + </return> + <description> + </description> + </method> + <method name="is_editing_alpha" qualifiers="const"> + <return type="bool"> + </return> + <description> + See [method ColorPicker.is_edit_alpha] + </description> + </method> + <method name="set_edit_alpha"> + <return type="void"> + </return> + <argument index="0" name="show" type="bool"> + </argument> + <description> + See [method ColorPicker.set_edit_alpha] + </description> + </method> + <method name="set_pick_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + Set new color to ColorRect. + + [codeblock] + var cr = get_node("colorrect_node") + cr.set_frame_color(Color(1, 0, 0, 1)) # Set color rect node to red + [/codeblock] + </description> + </method> + </methods> + <members> + <member name="color" type="Color" setter="set_pick_color" getter="get_pick_color"> + </member> + <member name="edit_alpha" type="bool" setter="set_edit_alpha" getter="is_editing_alpha"> + </member> + </members> + <signals> + <signal name="color_changed"> + <argument index="0" name="color" type="Color"> + </argument> + <description> + Emitted when the color is changed. + </description> + </signal> + </signals> + <constants> + </constants> + <theme_items> + <theme_item name="disabled" type="StyleBox"> + </theme_item> + <theme_item name="focus" type="StyleBox"> + </theme_item> + <theme_item name="font" type="Font"> + </theme_item> + <theme_item name="font_color" type="Color"> + </theme_item> + <theme_item name="font_color_disabled" type="Color"> + </theme_item> + <theme_item name="font_color_hover" type="Color"> + </theme_item> + <theme_item name="font_color_pressed" type="Color"> + </theme_item> + <theme_item name="hover" type="StyleBox"> + </theme_item> + <theme_item name="hseparation" type="int"> + </theme_item> + <theme_item name="normal" type="StyleBox"> + </theme_item> + <theme_item name="pressed" type="StyleBox"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/ColorRect.xml b/doc/classes/ColorRect.xml new file mode 100644 index 0000000000..90e88603b0 --- /dev/null +++ b/doc/classes/ColorRect.xml @@ -0,0 +1,45 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ColorRect" inherits="Control" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Colored rect for canvas. + </brief_description> + <description> + An object that is represented on the canvas as a rect with color. [Color] is used to set or get color info for the rect. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_frame_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + Return the color in RGBA format. + [codeblock] + var cr = get_node("colorrect_node") + var c = cr.get_frame_color() # Default color is white + [/codeblock] + </description> + </method> + <method name="set_frame_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + Set new color to ColorRect. + [codeblock] + var cr = get_node("colorrect_node") + cr.set_frame_color(Color(1, 0, 0, 1)) # Set color rect node to red + [/codeblock] + </description> + </method> + </methods> + <members> + <member name="color" type="Color" setter="set_frame_color" getter="get_frame_color"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/ConcavePolygonShape.xml b/doc/classes/ConcavePolygonShape.xml new file mode 100644 index 0000000000..0b1cbf9c21 --- /dev/null +++ b/doc/classes/ConcavePolygonShape.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ConcavePolygonShape" inherits="Shape" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Concave polygon shape. + </brief_description> + <description> + Concave polygon shape resource, which can be set into a [PhysicsBody] or area. This shape is created by feeding a list of triangles. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_faces" qualifiers="const"> + <return type="PoolVector3Array"> + </return> + <description> + Return the faces (an array of triangles). + </description> + </method> + <method name="set_faces"> + <return type="void"> + </return> + <argument index="0" name="faces" type="PoolVector3Array"> + </argument> + <description> + Set the faces (an array of triangles). + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/ConcavePolygonShape2D.xml b/doc/classes/ConcavePolygonShape2D.xml new file mode 100644 index 0000000000..018d64b643 --- /dev/null +++ b/doc/classes/ConcavePolygonShape2D.xml @@ -0,0 +1,38 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ConcavePolygonShape2D" inherits="Shape2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Concave polygon 2D shape resource for physics. + </brief_description> + <description> + Concave polygon 2D shape resource for physics. It is made out of segments and is very optimal for complex polygonal concave collisions. It is really not advised to use for [RigidBody2D] nodes. A CollisionPolygon2D in convex decomposition mode (solids) or several convex objects are advised for that instead. Otherwise, a concave polygon 2D shape is better for static collisions. + The main difference between a [ConvexPolygonShape2D] and a [ConcavePolygonShape2D] is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_segments" qualifiers="const"> + <return type="PoolVector2Array"> + </return> + <description> + Return the array of segments. + </description> + </method> + <method name="set_segments"> + <return type="void"> + </return> + <argument index="0" name="segments" type="PoolVector2Array"> + </argument> + <description> + Set the array of segments. + </description> + </method> + </methods> + <members> + <member name="segments" type="PoolVector2Array" setter="set_segments" getter="get_segments"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/ConeTwistJoint.xml b/doc/classes/ConeTwistJoint.xml new file mode 100644 index 0000000000..67c7cc4cfe --- /dev/null +++ b/doc/classes/ConeTwistJoint.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ConeTwistJoint" inherits="Joint" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_param" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="param" type="int" enum="ConeTwistJoint.Param"> + </argument> + <description> + </description> + </method> + <method name="set_param"> + <return type="void"> + </return> + <argument index="0" name="param" type="int" enum="ConeTwistJoint.Param"> + </argument> + <argument index="1" name="value" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="bias" type="float" setter="set_param" getter="get_param"> + </member> + <member name="relaxation" type="float" setter="set_param" getter="get_param"> + </member> + <member name="softness" type="float" setter="set_param" getter="get_param"> + </member> + <member name="swing_span" type="float" setter="_set_swing_span" getter="_get_swing_span"> + </member> + <member name="twist_span" type="float" setter="_set_twist_span" getter="_get_twist_span"> + </member> + </members> + <constants> + <constant name="PARAM_SWING_SPAN" value="0"> + </constant> + <constant name="PARAM_TWIST_SPAN" value="1"> + </constant> + <constant name="PARAM_BIAS" value="2"> + </constant> + <constant name="PARAM_SOFTNESS" value="3"> + </constant> + <constant name="PARAM_RELAXATION" value="4"> + </constant> + <constant name="PARAM_MAX" value="5"> + </constant> + </constants> +</class> diff --git a/doc/classes/ConfigFile.xml b/doc/classes/ConfigFile.xml new file mode 100644 index 0000000000..c2d1ec1355 --- /dev/null +++ b/doc/classes/ConfigFile.xml @@ -0,0 +1,119 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ConfigFile" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Helper class to handle INI-style files. + </brief_description> + <description> + This helper class can be used to store [Variant] values on the filesystem using an INI-style formatting. The stored values as referenced by a section and a key. The stored data can be saved to or parsed from a file, though ConfigFile objects can also be used directly with accessing the filesystem. + The following example shows how to parse a INI-style file from the system, read its contents and store new values in it: + [codeblock] + var config = ConfigFile.new() + var err = config.load("user://settings.cfg") + if err == OK: # if not, something went wrong with the file loading + # Look for the display/width pair, and default to 1024 if missing + var screen_width = get_value("display", "width", 1024) + # Store a variable if and only it hasn't been defined yet + if not config.has_section_key("audio", "mute"): + config.set_value("audio", "mute", false) + # Save the changes by overwriting the previous file + config.save("user://settings.cfg") + [/codeblock] + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="erase_section"> + <return type="void"> + </return> + <argument index="0" name="section" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_section_keys" qualifiers="const"> + <return type="PoolStringArray"> + </return> + <argument index="0" name="section" type="String"> + </argument> + <description> + Return an array of all defined key identifiers in the specified section. + </description> + </method> + <method name="get_sections" qualifiers="const"> + <return type="PoolStringArray"> + </return> + <description> + Return an array of all defined section identifiers. + </description> + </method> + <method name="get_value" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="section" type="String"> + </argument> + <argument index="1" name="key" type="String"> + </argument> + <argument index="2" name="default" type="Variant" default="null"> + </argument> + <description> + Return the current value for the specified section and key. If the section and/or the key do not exist, the method returns the value of the optional [i]default[/i] argument (and thus [code]NULL[/code] if not specified). + </description> + </method> + <method name="has_section" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="section" type="String"> + </argument> + <description> + Check if the specified section exists. + </description> + </method> + <method name="has_section_key" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="section" type="String"> + </argument> + <argument index="1" name="key" type="String"> + </argument> + <description> + Check if the specified section-key pair exists. + </description> + </method> + <method name="load"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + Load the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object from which the method was called. The return value is one of the OK, FAILED or ERR_* constants listed in [@Global Scope] (if the load was successful, it returns OK). + </description> + </method> + <method name="save"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + Save the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. + The return value is one of the OK, FAILED or ERR_* constants listed in [@Global Scope] (if the save was successful, it returns OK). + </description> + </method> + <method name="set_value"> + <return type="void"> + </return> + <argument index="0" name="section" type="String"> + </argument> + <argument index="1" name="key" type="String"> + </argument> + <argument index="2" name="value" type="Variant"> + </argument> + <description> + Assign a value to the specified key of the the specified section. If the section and/or the key do not exist, they are created. Passing a [code]NULL[/code] value deletes the specified key if it exists (and deletes the section if it ends up empty once the key has been removed). + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/ConfirmationDialog.xml b/doc/classes/ConfirmationDialog.xml new file mode 100644 index 0000000000..84de287519 --- /dev/null +++ b/doc/classes/ConfirmationDialog.xml @@ -0,0 +1,24 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ConfirmationDialog" inherits="AcceptDialog" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Dialog for confirmation of actions. + </brief_description> + <description> + Dialog for confirmation of actions. This dialog inherits from [AcceptDialog], but has by default an OK and Cancel button (in host OS order). + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_cancel"> + <return type="Button"> + </return> + <description> + Return the cancel button. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Container.xml b/doc/classes/Container.xml new file mode 100644 index 0000000000..844c17a1d9 --- /dev/null +++ b/doc/classes/Container.xml @@ -0,0 +1,46 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Container" inherits="Control" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base node for containers. + </brief_description> + <description> + Base node for containers. A [Container] contains other controls and automatically arranges them in a certain way. + A Control can inherit this to create custom container classes. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="fit_child_in_rect"> + <return type="void"> + </return> + <argument index="0" name="child" type="Control"> + </argument> + <argument index="1" name="rect" type="Rect2"> + </argument> + <description> + Fit a child control in a given rect. This is mainly a helper for creating custom container classes. + </description> + </method> + <method name="queue_sort"> + <return type="void"> + </return> + <description> + Queue resort of the contained children. This is called automatically anyway, but can be called upon request. + </description> + </method> + </methods> + <signals> + <signal name="sort_children"> + <description> + Emitted when sorting the children is needed. + </description> + </signal> + </signals> + <constants> + <constant name="NOTIFICATION_SORT_CHILDREN" value="50" enum=""> + Notification for when sorting the children, it must be obeyed immediately. + </constant> + </constants> +</class> diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml new file mode 100644 index 0000000000..5d77f3a450 --- /dev/null +++ b/doc/classes/Control.xml @@ -0,0 +1,1062 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Control" inherits="CanvasItem" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base node for all User Interface components. + </brief_description> + <description> + 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 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 [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. + Godot sends Input events to the root node first, via [method 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 [method MainLoop._input_event]. No need to enable [method Node.set_process_input] on Controls to receive input events. Call [method accept_event] to ensure no other node receives the event, not even [method Node._unhandled_input]. + Only the one Control node in focus receives keyboard events. To do so, the Control must get the focus mode with [method set_focus_mode]. It loses focus when another Control gets it, or if the current Control in focus is hidden. + You'll sometimes want Controls to ignore mouse or touch events. For example, if you place an icon on top of a button. Call [method set_ignore_mouse] for that. + [Theme] resources change the Control's appearance. If you change the [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 [method add_font_override]. You can also override the theme from the editor. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="_get_minimum_size" qualifiers="virtual"> + <return type="Vector2"> + </return> + <description> + Returns the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size. + </description> + </method> + <method name="_gui_input" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="event" type="InputEvent"> + </argument> + <description> + </description> + </method> + <method name="accept_event"> + <return type="void"> + </return> + <description> + 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 [method Node._unhandled_input] or [method Node._unhandled_key_input]. + </description> + </method> + <method name="add_color_override"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="add_constant_override"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="constant" type="int"> + </argument> + <description> + Override a single constant (integer) in the theme of this Control. If constant equals Theme.INVALID_CONSTANT, override is cleared. + </description> + </method> + <method name="add_font_override"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="font" type="Font"> + </argument> + <description> + Override a single font (font) in the theme of this Control. If font is empty, override is cleared. + </description> + </method> + <method name="add_icon_override"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="texture" type="Texture"> + </argument> + <description> + Override a single icon ([Texture]) in the theme of this Control. If texture is empty, override is cleared. + </description> + </method> + <method name="add_shader_override"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="shader" type="Shader"> + </argument> + <description> + </description> + </method> + <method name="add_style_override"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="stylebox" type="StyleBox"> + </argument> + <description> + Override a single stylebox ([Stylebox]) in the theme of this Control. If stylebox is empty, override is cleared. + </description> + </method> + <method name="can_drop_data" qualifiers="virtual"> + <return type="bool"> + </return> + <argument index="0" name="pos" type="Vector2"> + </argument> + <argument index="1" name="data" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="drop_data" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="pos" type="Vector2"> + </argument> + <argument index="1" name="data" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="force_drag"> + <return type="void"> + </return> + <argument index="0" name="data" type="Variant"> + </argument> + <argument index="1" name="preview" type="Control"> + </argument> + <description> + </description> + </method> + <method name="get_anchor" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <description> + Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). + </description> + </method> + <method name="get_begin" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_color" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String" default=""""> + </argument> + <description> + </description> + </method> + <method name="get_combined_minimum_size" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_constant" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String" default=""""> + </argument> + <description> + </description> + </method> + <method name="get_cursor_shape" qualifiers="const"> + <return type="int" enum="Control.CursorShape"> + </return> + <argument index="0" name="pos" type="Vector2" default="Vector2( 0, 0 )"> + </argument> + <description> + Return the cursor shape at a certain position in the control. + </description> + </method> + <method name="get_custom_minimum_size" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_default_cursor_shape" qualifiers="const"> + <return type="int" enum="Control.CursorShape"> + </return> + <description> + Return the default cursor shape for this control. See enum CURSOR_* for the list of shapes. + </description> + </method> + <method name="get_drag_data" qualifiers="virtual"> + <return type="Object"> + </return> + <argument index="0" name="pos" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="get_end" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Returns MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]). + </description> + </method> + <method name="get_focus_mode" qualifiers="const"> + <return type="int" enum="Control.FocusMode"> + </return> + <description> + Returns the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL) (see [method set_focus_mode]). + </description> + </method> + <method name="get_focus_neighbour" qualifiers="const"> + <return type="NodePath"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <description> + Return the forced neighbour for moving the input focus to. When pressing TAB or directional/joypad directions focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function. + </description> + </method> + <method name="get_focus_owner" qualifiers="const"> + <return type="Control"> + </return> + <description> + Return which control is owning the keyboard focus, or null if no one. + </description> + </method> + <method name="get_font" qualifiers="const"> + <return type="Font"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String" default=""""> + </argument> + <description> + </description> + </method> + <method name="get_global_position" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode. + </description> + </method> + <method name="get_global_rect" qualifiers="const"> + <return type="Rect2"> + </return> + <description> + Return position and size of the Control, relative to the top-left corner of the [i]window[/i] Control. This is a helper (see [method get_global_position], [method get_size]). + </description> + </method> + <method name="get_h_grow_direction" qualifiers="const"> + <return type="int" enum="Control.GrowDirection"> + </return> + <description> + </description> + </method> + <method name="get_h_size_flags" qualifiers="const"> + <return type="int"> + </return> + <description> + Hint for containers, return horizontal positioning flags. + </description> + </method> + <method name="get_icon" qualifiers="const"> + <return type="Texture"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String" default=""""> + </argument> + <description> + </description> + </method> + <method name="get_margin" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <description> + Return a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being returned depends on the anchor mode. + </description> + </method> + <method name="get_minimum_size" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size. + </description> + </method> + <method name="get_mouse_filter" qualifiers="const"> + <return type="int" enum="Control.MouseFilter"> + </return> + <description> + Return when the control is ignoring mouse events (even touchpad events send mouse events). + </description> + </method> + <method name="get_parent_area_size" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_parent_control" qualifiers="const"> + <return type="Control"> + </return> + <description> + </description> + </method> + <method name="get_pivot_offset" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_position" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode. + </description> + </method> + <method name="get_rect" qualifiers="const"> + <return type="Rect2"> + </return> + <description> + Return position and size of the Control, relative to the top-left corner of the parent Control. This is a helper (see [method get_position], [method get_size]). + </description> + </method> + <method name="get_rotation" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the rotation (in radians) + </description> + </method> + <method name="get_rotation_deg" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the rotation (in degrees) + </description> + </method> + <method name="get_scale" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_size" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Returns the size of the Control, computed from all margins, however the size returned will [b]never be smaller than the minimum size reported by[/b] [method get_minimum_size]. This means that even if end position of the Control rectangle is smaller than the begin position, the Control will still display and interact correctly. (see description, [method get_minimum_size], [method set_margin], [method set_anchor]). + </description> + </method> + <method name="get_stretch_ratio" qualifiers="const"> + <return type="float"> + </return> + <description> + Hint for containers, return the stretch ratio. This value is relative to other stretch ratio, so if this control has 2 and another has 1, this one will be twice as big. + </description> + </method> + <method name="get_stylebox" qualifiers="const"> + <return type="StyleBox"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String" default=""""> + </argument> + <description> + </description> + </method> + <method name="get_theme" qualifiers="const"> + <return type="Theme"> + </return> + <description> + Return a [Theme] override, if one exists (see [method set_theme]). + </description> + </method> + <method name="get_tooltip" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="atpos" type="Vector2" default="Vector2( 0, 0 )"> + </argument> + <description> + Return the tooltip, which will appear when the cursor is resting over this control. + </description> + </method> + <method name="get_v_grow_direction" qualifiers="const"> + <return type="int" enum="Control.GrowDirection"> + </return> + <description> + </description> + </method> + <method name="get_v_size_flags" qualifiers="const"> + <return type="int"> + </return> + <description> + Hint for containers, return vertical positioning flags. + </description> + </method> + <method name="grab_click_focus"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="grab_focus"> + <return type="void"> + </return> + <description> + Steal the focus from another control and become the focused control (see [method set_focus_mode]). + </description> + </method> + <method name="has_color" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String" default=""""> + </argument> + <description> + </description> + </method> + <method name="has_color_override" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="has_constant" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String" default=""""> + </argument> + <description> + </description> + </method> + <method name="has_constant_override" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="has_focus" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether the Control is the current focused control (see [method set_focus_mode]). + </description> + </method> + <method name="has_font" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String" default=""""> + </argument> + <description> + </description> + </method> + <method name="has_font_override" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="has_icon" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String" default=""""> + </argument> + <description> + </description> + </method> + <method name="has_icon_override" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="has_point" qualifiers="virtual"> + <return type="bool"> + </return> + <argument index="0" name="point" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="has_stylebox" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String" default=""""> + </argument> + <description> + </description> + </method> + <method name="has_stylebox_override" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="is_clipping_contents"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="minimum_size_changed"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="release_focus"> + <return type="void"> + </return> + <description> + Give up the focus, no other control will be able to receive keyboard input. + </description> + </method> + <method name="set_anchor"> + <return type="void"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <argument index="1" name="anchor" type="float"> + </argument> + <argument index="2" name="keep_margin" type="bool" default="false"> + </argument> + <argument index="3" name="push_opposite_anchor" type="bool" default="true"> + </argument> + <description> + </description> + </method> + <method name="set_anchor_and_margin"> + <return type="void"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <argument index="1" name="anchor" type="float"> + </argument> + <argument index="2" name="offset" type="float"> + </argument> + <argument index="3" name="push_opposite_anchor" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="set_anchors_preset"> + <return type="void"> + </return> + <argument index="0" name="preset" type="int" enum="Control.LayoutPreset"> + </argument> + <argument index="1" name="keep_margin" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="set_area_as_parent_rect"> + <return type="void"> + </return> + <argument index="0" name="margin" type="int" default="0"> + </argument> + <description> + Change all margins and anchors, so this Control always takes up the same area as the parent Control. This is a helper (see [method set_anchor], [method set_margin]). + </description> + </method> + <method name="set_begin"> + <return type="void"> + </return> + <argument index="0" name="pos" type="Vector2"> + </argument> + <description> + Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]). + </description> + </method> + <method name="set_clip_contents"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_custom_minimum_size"> + <return type="void"> + </return> + <argument index="0" name="size" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_default_cursor_shape"> + <return type="void"> + </return> + <argument index="0" name="shape" type="int" enum="Control.CursorShape"> + </argument> + <description> + Set the default cursor shape for this control. See enum CURSOR_* for the list of shapes. + </description> + </method> + <method name="set_drag_forwarding"> + <return type="void"> + </return> + <argument index="0" name="target" type="Control"> + </argument> + <description> + </description> + </method> + <method name="set_drag_preview"> + <return type="void"> + </return> + <argument index="0" name="control" type="Control"> + </argument> + <description> + </description> + </method> + <method name="set_end"> + <return type="void"> + </return> + <argument index="0" name="pos" type="Vector2"> + </argument> + <description> + Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see [method set_margin]). + </description> + </method> + <method name="set_focus_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="Control.FocusMode"> + </argument> + <description> + Set the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL). Only one Control can be focused at the same time, and it will receive keyboard signals. + </description> + </method> + <method name="set_focus_neighbour"> + <return type="void"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <argument index="1" name="neighbour" type="NodePath"> + </argument> + <description> + Force a neighbour for moving the input focus to. When pressing TAB or directional/joypad directions focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function. + </description> + </method> + <method name="set_global_position"> + <return type="void"> + </return> + <argument index="0" name="pos" type="Vector2"> + </argument> + <description> + Move the Control to a new position, relative to the top-left corner of the [i]window[/i] Control, and without changing current anchor mode. (see [method set_margin]). + </description> + </method> + <method name="set_h_grow_direction"> + <return type="void"> + </return> + <argument index="0" name="direction" type="int" enum="Control.GrowDirection"> + </argument> + <description> + </description> + </method> + <method name="set_h_size_flags"> + <return type="void"> + </return> + <argument index="0" name="flags" type="int"> + </argument> + <description> + Hint for containers, set horizontal positioning flags. + </description> + </method> + <method name="set_margin"> + <return type="void"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <argument index="1" name="offset" type="float"> + </argument> + <description> + Set a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being set depends on the anchor mode. + </description> + </method> + <method name="set_mouse_filter"> + <return type="void"> + </return> + <argument index="0" name="filter" type="int" enum="Control.MouseFilter"> + </argument> + <description> + Set when the control is ignoring mouse events (even touchpad events send mouse events). (see the MOUSE_FILTER_* constants) + </description> + </method> + <method name="set_pivot_offset"> + <return type="void"> + </return> + <argument index="0" name="pivot_offset" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_position"> + <return type="void"> + </return> + <argument index="0" name="pos" type="Vector2"> + </argument> + <description> + 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 [method set_margin]). + </description> + </method> + <method name="set_rotation"> + <return type="void"> + </return> + <argument index="0" name="radians" type="float"> + </argument> + <description> + Set the rotation (in radians). + </description> + </method> + <method name="set_rotation_deg"> + <return type="void"> + </return> + <argument index="0" name="degrees" type="float"> + </argument> + <description> + Set the rotation (in degrees). + </description> + </method> + <method name="set_scale"> + <return type="void"> + </return> + <argument index="0" name="scale" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_size"> + <return type="void"> + </return> + <argument index="0" name="size" type="Vector2"> + </argument> + <description> + Changes MARGIN_RIGHT and MARGIN_BOTTOM to fit a given size. This is a helper (see [method set_margin]). + </description> + </method> + <method name="set_stretch_ratio"> + <return type="void"> + </return> + <argument index="0" name="ratio" type="float"> + </argument> + <description> + Hint for containers, set the stretch ratio. This value is relative to other stretch ratio, so if this control has 2 and another has 1, this one will be twice as big. + </description> + </method> + <method name="set_theme"> + <return type="void"> + </return> + <argument index="0" name="theme" type="Theme"> + </argument> + <description> + Override whole the [Theme] for this Control and all its children controls. + </description> + </method> + <method name="set_tooltip"> + <return type="void"> + </return> + <argument index="0" name="tooltip" type="String"> + </argument> + <description> + Set a tooltip, which will appear when the cursor is resting over this control. + </description> + </method> + <method name="set_v_grow_direction"> + <return type="void"> + </return> + <argument index="0" name="direction" type="int" enum="Control.GrowDirection"> + </argument> + <description> + </description> + </method> + <method name="set_v_size_flags"> + <return type="void"> + </return> + <argument index="0" name="flags" type="int"> + </argument> + <description> + Hint for containers, set vertical positioning flags. + </description> + </method> + <method name="show_modal"> + <return type="void"> + </return> + <argument index="0" name="exclusive" type="bool" default="false"> + </argument> + <description> + Display a Control as modal. Control must be a subwindow. Modal controls capture the input signals until closed or the area outside them is accessed. When a modal control loses focus, or the ESC key is pressed, they automatically hide. Modal controls are used extensively for popup dialogs and menus. + </description> + </method> + <method name="warp_mouse"> + <return type="void"> + </return> + <argument index="0" name="to_pos" type="Vector2"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="anchor_bottom" type="float" setter="_set_anchor" getter="get_anchor"> + </member> + <member name="anchor_left" type="float" setter="_set_anchor" getter="get_anchor"> + </member> + <member name="anchor_right" type="float" setter="_set_anchor" getter="get_anchor"> + </member> + <member name="anchor_top" type="float" setter="_set_anchor" getter="get_anchor"> + </member> + <member name="focus_neighbour_bottom" type="NodePath" setter="set_focus_neighbour" getter="get_focus_neighbour"> + </member> + <member name="focus_neighbour_left" type="NodePath" setter="set_focus_neighbour" getter="get_focus_neighbour"> + </member> + <member name="focus_neighbour_right" type="NodePath" setter="set_focus_neighbour" getter="get_focus_neighbour"> + </member> + <member name="focus_neighbour_top" type="NodePath" setter="set_focus_neighbour" getter="get_focus_neighbour"> + </member> + <member name="grow_horizontal" type="int" setter="set_h_grow_direction" getter="get_h_grow_direction" enum="Control.GrowDirection"> + </member> + <member name="grow_vertical" type="int" setter="set_v_grow_direction" getter="get_v_grow_direction" enum="Control.GrowDirection"> + </member> + <member name="hint_tooltip" type="String" setter="set_tooltip" getter="_get_tooltip"> + </member> + <member name="margin_bottom" type="float" setter="set_margin" getter="get_margin"> + </member> + <member name="margin_left" type="float" setter="set_margin" getter="get_margin"> + </member> + <member name="margin_right" type="float" setter="set_margin" getter="get_margin"> + </member> + <member name="margin_top" type="float" setter="set_margin" getter="get_margin"> + </member> + <member name="mouse_filter" type="int" setter="set_mouse_filter" getter="get_mouse_filter" enum="Control.MouseFilter"> + </member> + <member name="rect_clip_content" type="bool" setter="set_clip_contents" getter="is_clipping_contents"> + </member> + <member name="rect_min_size" type="Vector2" setter="set_custom_minimum_size" getter="get_custom_minimum_size"> + </member> + <member name="rect_pivot_offset" type="Vector2" setter="set_pivot_offset" getter="get_pivot_offset"> + </member> + <member name="rect_position" type="Vector2" setter="set_position" getter="get_position"> + </member> + <member name="rect_rotation" type="float" setter="set_rotation_deg" getter="get_rotation_deg"> + </member> + <member name="rect_scale" type="Vector2" setter="set_scale" getter="get_scale"> + </member> + <member name="rect_size" type="Vector2" setter="set_size" getter="get_size"> + </member> + <member name="size_flags_horizontal" type="int" setter="set_h_size_flags" getter="get_h_size_flags"> + </member> + <member name="size_flags_stretch_ratio" type="float" setter="set_stretch_ratio" getter="get_stretch_ratio"> + </member> + <member name="size_flags_vertical" type="int" setter="set_v_size_flags" getter="get_v_size_flags"> + </member> + <member name="theme" type="Theme" setter="set_theme" getter="get_theme"> + </member> + </members> + <signals> + <signal name="focus_entered"> + <description> + Emitted when the node gains keyboard focus. + </description> + </signal> + <signal name="focus_exited"> + <description> + Emitted when the node loses keyboard focus. + </description> + </signal> + <signal name="gui_input"> + <argument index="0" name="ev" type="Object"> + </argument> + <description> + </description> + </signal> + <signal name="minimum_size_changed"> + <description> + Emitted when the node's minimum size changes. + </description> + </signal> + <signal name="modal_closed"> + <description> + </description> + </signal> + <signal name="mouse_entered"> + <description> + Emitted when the mouse enters the control's area. + </description> + </signal> + <signal name="mouse_exited"> + <description> + Emitted when the mouse leaves the control's area. + </description> + </signal> + <signal name="resized"> + <description> + Emitted when the control changes size. + </description> + </signal> + <signal name="size_flags_changed"> + <description> + Emitted when the size flags change. + </description> + </signal> + </signals> + <constants> + <constant name="FOCUS_NONE" value="0"> + Control can't acquire focus. + </constant> + <constant name="FOCUS_CLICK" value="1"> + Control can acquire focus only if clicked. + </constant> + <constant name="FOCUS_ALL" value="2"> + Control can acquire focus if clicked, or by pressing TAB/Directionals in the keyboard from another Control. + </constant> + <constant name="NOTIFICATION_RESIZED" value="40" enum=""> + Control changed size (get_size() reports the new size). + </constant> + <constant name="NOTIFICATION_MOUSE_ENTER" value="41" enum=""> + Mouse pointer entered the area of the Control. + </constant> + <constant name="NOTIFICATION_MOUSE_EXIT" value="42" enum=""> + Mouse pointer exited the area of the Control. + </constant> + <constant name="NOTIFICATION_FOCUS_ENTER" value="43" enum=""> + Control gained focus. + </constant> + <constant name="NOTIFICATION_FOCUS_EXIT" value="44" enum=""> + Control lost focus. + </constant> + <constant name="NOTIFICATION_THEME_CHANGED" value="45" enum=""> + Theme changed. Redrawing is desired. + </constant> + <constant name="NOTIFICATION_MODAL_CLOSE" value="46" enum=""> + Modal control was closed. + </constant> + <constant name="CURSOR_ARROW" value="0"> + </constant> + <constant name="CURSOR_IBEAM" value="1"> + </constant> + <constant name="CURSOR_POINTING_HAND" value="2"> + </constant> + <constant name="CURSOR_CROSS" value="3"> + </constant> + <constant name="CURSOR_WAIT" value="4"> + </constant> + <constant name="CURSOR_BUSY" value="5"> + </constant> + <constant name="CURSOR_DRAG" value="6"> + </constant> + <constant name="CURSOR_CAN_DROP" value="7"> + </constant> + <constant name="CURSOR_FORBIDDEN" value="8"> + </constant> + <constant name="CURSOR_VSIZE" value="9"> + </constant> + <constant name="CURSOR_HSIZE" value="10"> + </constant> + <constant name="CURSOR_BDIAGSIZE" value="11"> + </constant> + <constant name="CURSOR_FDIAGSIZE" value="12"> + </constant> + <constant name="CURSOR_MOVE" value="13"> + </constant> + <constant name="CURSOR_VSPLIT" value="14"> + </constant> + <constant name="CURSOR_HSPLIT" value="15"> + </constant> + <constant name="CURSOR_HELP" value="16"> + </constant> + <constant name="PRESET_TOP_LEFT" value="0"> + </constant> + <constant name="PRESET_TOP_RIGHT" value="1"> + </constant> + <constant name="PRESET_BOTTOM_LEFT" value="2"> + </constant> + <constant name="PRESET_BOTTOM_RIGHT" value="3"> + </constant> + <constant name="PRESET_CENTER_LEFT" value="4"> + </constant> + <constant name="PRESET_CENTER_TOP" value="5"> + </constant> + <constant name="PRESET_CENTER_RIGHT" value="6"> + </constant> + <constant name="PRESET_CENTER_BOTTOM" value="7"> + </constant> + <constant name="PRESET_CENTER" value="8"> + </constant> + <constant name="PRESET_LEFT_WIDE" value="9"> + </constant> + <constant name="PRESET_TOP_WIDE" value="10"> + </constant> + <constant name="PRESET_RIGHT_WIDE" value="11"> + </constant> + <constant name="PRESET_BOTTOM_WIDE" value="12"> + </constant> + <constant name="PRESET_VCENTER_WIDE" value="13"> + </constant> + <constant name="PRESET_HCENTER_WIDE" value="14"> + </constant> + <constant name="PRESET_WIDE" value="15"> + </constant> + <constant name="SIZE_EXPAND" value="2"> + </constant> + <constant name="SIZE_FILL" value="1"> + </constant> + <constant name="SIZE_EXPAND_FILL" value="3"> + </constant> + <constant name="SIZE_SHRINK_CENTER" value="4"> + </constant> + <constant name="SIZE_SHRINK_END" value="8"> + </constant> + <constant name="MOUSE_FILTER_STOP" value="0"> + </constant> + <constant name="MOUSE_FILTER_PASS" value="1"> + </constant> + <constant name="MOUSE_FILTER_IGNORE" value="2"> + </constant> + <constant name="GROW_DIRECTION_BEGIN" value="0"> + </constant> + <constant name="GROW_DIRECTION_END" value="1"> + </constant> + <constant name="ANCHOR_BEGIN" value="0"> + X is relative to MARGIN_LEFT, Y is relative to MARGIN_TOP. + </constant> + <constant name="ANCHOR_END" value="1"> + X is relative to -MARGIN_RIGHT, Y is relative to -MARGIN_BOTTOM. + </constant> + </constants> +</class> diff --git a/doc/classes/ConvexPolygonShape.xml b/doc/classes/ConvexPolygonShape.xml new file mode 100644 index 0000000000..9a7cb0d475 --- /dev/null +++ b/doc/classes/ConvexPolygonShape.xml @@ -0,0 +1,35 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ConvexPolygonShape" inherits="Shape" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Convex Polygon Shape. + </brief_description> + <description> + Convex polygon shape resource, which can be set into a [PhysicsBody] or area. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_points" qualifiers="const"> + <return type="PoolVector3Array"> + </return> + <description> + </description> + </method> + <method name="set_points"> + <return type="void"> + </return> + <argument index="0" name="points" type="PoolVector3Array"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="points" type="PoolVector3Array" setter="set_points" getter="get_points"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/ConvexPolygonShape2D.xml b/doc/classes/ConvexPolygonShape2D.xml new file mode 100644 index 0000000000..c5b6d90041 --- /dev/null +++ b/doc/classes/ConvexPolygonShape2D.xml @@ -0,0 +1,47 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ConvexPolygonShape2D" inherits="Shape2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Convex Polygon Shape for 2D physics. + </brief_description> + <description> + Convex Polygon Shape for 2D physics. A convex polygon, whatever its shape, is internally decomposed into as many convex polygons as needed to ensure all collision checks against it are always done on convex polygons (which are faster to check). + The main difference between a [ConvexPolygonShape2D] and a [ConcavePolygonShape2D] is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_points" qualifiers="const"> + <return type="PoolVector2Array"> + </return> + <description> + Return a list of points in either clockwise or counter clockwise order, forming a convex polygon. + </description> + </method> + <method name="set_point_cloud"> + <return type="void"> + </return> + <argument index="0" name="point_cloud" type="PoolVector2Array"> + </argument> + <description> + Currently, this method does nothing. + </description> + </method> + <method name="set_points"> + <return type="void"> + </return> + <argument index="0" name="points" type="PoolVector2Array"> + </argument> + <description> + Set a list of points in either clockwise or counter clockwise order, forming a convex polygon. + </description> + </method> + </methods> + <members> + <member name="points" type="PoolVector2Array" setter="set_points" getter="get_points"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/CubeMap.xml b/doc/classes/CubeMap.xml new file mode 100644 index 0000000000..ac2ff3fc57 --- /dev/null +++ b/doc/classes/CubeMap.xml @@ -0,0 +1,113 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="CubeMap" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_flags" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_height" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_lossy_storage_quality" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_side" qualifiers="const"> + <return type="Image"> + </return> + <argument index="0" name="side" type="int" enum="CubeMap.Side"> + </argument> + <description> + </description> + </method> + <method name="get_storage" qualifiers="const"> + <return type="int" enum="CubeMap.Storage"> + </return> + <description> + </description> + </method> + <method name="get_width" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_flags"> + <return type="void"> + </return> + <argument index="0" name="flags" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_lossy_storage_quality"> + <return type="void"> + </return> + <argument index="0" name="quality" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_side"> + <return type="void"> + </return> + <argument index="0" name="side" type="int" enum="CubeMap.Side"> + </argument> + <argument index="1" name="image" type="Image"> + </argument> + <description> + </description> + </method> + <method name="set_storage"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="CubeMap.Storage"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + <constant name="STORAGE_RAW" value="0"> + </constant> + <constant name="STORAGE_COMPRESS_LOSSY" value="1"> + </constant> + <constant name="STORAGE_COMPRESS_LOSSLESS" value="2"> + </constant> + <constant name="SIDE_LEFT" value="0"> + </constant> + <constant name="SIDE_RIGHT" value="1"> + </constant> + <constant name="SIDE_BOTTOM" value="2"> + </constant> + <constant name="SIDE_TOP" value="3"> + </constant> + <constant name="SIDE_FRONT" value="4"> + </constant> + <constant name="SIDE_BACK" value="5"> + </constant> + <constant name="FLAG_MIPMAPS" value="1"> + </constant> + <constant name="FLAG_REPEAT" value="2"> + </constant> + <constant name="FLAG_FILTER" value="4"> + </constant> + <constant name="FLAGS_DEFAULT" value="7"> + </constant> + </constants> +</class> diff --git a/doc/classes/CubeMesh.xml b/doc/classes/CubeMesh.xml new file mode 100644 index 0000000000..642f37c393 --- /dev/null +++ b/doc/classes/CubeMesh.xml @@ -0,0 +1,87 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="CubeMesh" inherits="PrimitiveMesh" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Generate an axis-aligned cuboid [PrimitiveMesh]. + </brief_description> + <description> + Generate an axis-aligned cuboid [PrimitiveMesh]. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_size" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_subdivide_depth" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_subdivide_height" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_subdivide_width" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_size"> + <return type="void"> + </return> + <argument index="0" name="size" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="set_subdivide_depth"> + <return type="void"> + </return> + <argument index="0" name="divisions" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_subdivide_height"> + <return type="void"> + </return> + <argument index="0" name="divisions" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_subdivide_width"> + <return type="void"> + </return> + <argument index="0" name="subdivide" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="size" type="Vector3" setter="set_size" getter="get_size"> + Size of the cuboid mesh. Defaults to (2, 2, 2). + </member> + <member name="subdivide_depth" type="int" setter="set_subdivide_depth" getter="get_subdivide_depth"> + Number of extra edge loops inserted along the z-axis. Defaults to 0. + </member> + <member name="subdivide_height" type="int" setter="set_subdivide_height" getter="get_subdivide_height"> + Number of extra edge loops inserted along the y-axis. Defaults to 0. + </member> + <member name="subdivide_width" type="int" setter="set_subdivide_width" getter="get_subdivide_width"> + Number of extra edge loops inserted along the x-axis. Defaults to 0. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Curve.xml b/doc/classes/Curve.xml new file mode 100644 index 0000000000..d676f635c9 --- /dev/null +++ b/doc/classes/Curve.xml @@ -0,0 +1,237 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Curve" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_point"> + <return type="int"> + </return> + <argument index="0" name="pos" type="Vector2"> + </argument> + <argument index="1" name="left_tangent" type="float" default="0"> + </argument> + <argument index="2" name="right_tangent" type="float" default="0"> + </argument> + <argument index="3" name="left_mode" type="int" enum="Curve.TangentMode" default="0"> + </argument> + <argument index="4" name="right_mode" type="int" enum="Curve.TangentMode" default="0"> + </argument> + <description> + </description> + </method> + <method name="bake"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="clean_dupes"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="clear_points"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="get_bake_resolution" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_max_value" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_min_value" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_point_left_mode" qualifiers="const"> + <return type="int" enum="Curve.TangentMode"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_point_left_tangent" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_point_pos" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_point_right_mode" qualifiers="const"> + <return type="int" enum="Curve.TangentMode"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_point_right_tangent" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <description> + </description> + </method> + <method name="interpolate" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="offset" type="float"> + </argument> + <description> + </description> + </method> + <method name="interpolate_baked"> + <return type="float"> + </return> + <argument index="0" name="offset" type="float"> + </argument> + <description> + </description> + </method> + <method name="remove_point"> + <return type="void"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_bake_resolution"> + <return type="void"> + </return> + <argument index="0" name="resolution" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_max_value"> + <return type="void"> + </return> + <argument index="0" name="max" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_min_value"> + <return type="void"> + </return> + <argument index="0" name="min" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_point_left_mode"> + <return type="void"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <argument index="1" name="mode" type="int" enum="Curve.TangentMode"> + </argument> + <description> + </description> + </method> + <method name="set_point_left_tangent"> + <return type="void"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <argument index="1" name="tangent" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_point_offset"> + <return type="void"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <argument index="1" name="offset" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_point_right_mode"> + <return type="void"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <argument index="1" name="mode" type="int" enum="Curve.TangentMode"> + </argument> + <description> + </description> + </method> + <method name="set_point_right_tangent"> + <return type="void"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <argument index="1" name="tangent" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_point_value"> + <return type="void"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <argument index="1" name="y" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="_data" type="Array" setter="_set_data" getter="_get_data"> + </member> + <member name="bake_resolution" type="int" setter="set_bake_resolution" getter="get_bake_resolution"> + </member> + <member name="max_value" type="float" setter="set_max_value" getter="get_max_value"> + </member> + <member name="min_value" type="float" setter="set_min_value" getter="get_min_value"> + </member> + </members> + <signals> + <signal name="range_changed"> + <description> + </description> + </signal> + </signals> + <constants> + <constant name="TANGENT_FREE" value="0"> + </constant> + <constant name="TANGENT_LINEAR" value="1"> + </constant> + <constant name="TANGENT_MODE_COUNT" value="2"> + </constant> + </constants> +</class> diff --git a/doc/classes/Curve2D.xml b/doc/classes/Curve2D.xml new file mode 100644 index 0000000000..ccf6101829 --- /dev/null +++ b/doc/classes/Curve2D.xml @@ -0,0 +1,200 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Curve2D" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Describes a Bezier curve in 2D space. + </brief_description> + <description> + This class describes a Bezier curve in 2D space. It is mainly used to give a shape to a [Path2D], but can be manually sampled for other purposes. + It keeps a cache of precalculated points along the curve, to speed further calculations up. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_point"> + <return type="void"> + </return> + <argument index="0" name="pos" type="Vector2"> + </argument> + <argument index="1" name="in" type="Vector2" default="Vector2( 0, 0 )"> + </argument> + <argument index="2" name="out" type="Vector2" default="Vector2( 0, 0 )"> + </argument> + <argument index="3" name="atpos" type="int" default="-1"> + </argument> + <description> + Adds a point to a curve, at position "pos", 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 >= [method get_point_count]), the point will be appended at the end of the point list. + </description> + </method> + <method name="clear_points"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="get_bake_interval" qualifiers="const"> + <return type="float"> + </return> + <description> + Returns the distance between two adjacent cached points. + </description> + </method> + <method name="get_baked_length" qualifiers="const"> + <return type="float"> + </return> + <description> + Returns the total length of the curve, based on the cached points. Given enough density (see [method set_bake_interval]), it should be approximate enough. + </description> + </method> + <method name="get_baked_points" qualifiers="const"> + <return type="PoolVector2Array"> + </return> + <description> + Returns the cache of points as a [PoolVector2Array]. + </description> + </method> + <method name="get_point_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the number of points describing the curve. + </description> + </method> + <method name="get_point_in" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Returns the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0). + </description> + </method> + <method name="get_point_out" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + 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). + </description> + </method> + <method name="get_point_pos" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + 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). + </description> + </method> + <method name="interpolate" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="t" type="float"> + </argument> + <description> + Returns the position between the vertex "idx" and the vertex "idx"+1, where "t" controls if the point is the first vertex (t = 0.0), the last vertex (t = 1.0), or in between. Values of "t" outside the range (0.0 >= t <=1) give strange, but predictable results. + If "idx" is out of bounds it is truncated to the first or last vertex, and "t" is ignored. If the curve has no points, the function sends an error to the console, and returns (0, 0). + </description> + </method> + <method name="interpolate_baked" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="offset" type="float"> + </argument> + <argument index="1" name="cubic" type="bool" default="false"> + </argument> + <description> + Returns a point within the curve at position "offset", where "offset" is measured as a pixel distance along the curve. + To do that, it finds the two cached points where the "offset" lies between, then interpolates the values. This interpolation is cubic if "cubic" is set to true, or linear if set to false. + Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough). + </description> + </method> + <method name="interpolatef" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="fofs" type="float"> + </argument> + <description> + Returns the position at the vertex "fofs". It calls [method interpolate] using the integer part of fofs as "idx", and its fractional part as "t". + </description> + </method> + <method name="remove_point"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds. + </description> + </method> + <method name="set_bake_interval"> + <return type="void"> + </return> + <argument index="0" name="distance" type="float"> + </argument> + <description> + Sets the distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care. + </description> + </method> + <method name="set_point_in"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="pos" type="Vector2"> + </argument> + <description> + 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. + </description> + </method> + <method name="set_point_out"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="pos" type="Vector2"> + </argument> + <description> + 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. + </description> + </method> + <method name="set_point_pos"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="pos" type="Vector2"> + </argument> + <description> + Sets the position for the vertex "idx". If the index is out of bounds, the function sends an error to the console. + </description> + </method> + <method name="tessellate" qualifiers="const"> + <return type="PoolVector2Array"> + </return> + <argument index="0" name="max_stages" type="int" default="5"> + </argument> + <argument index="1" name="tolerance_degrees" type="float" default="4"> + </argument> + <description> + Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. + This approximation makes straight segments between each point, then subdivides those segments until the resulting shape is similar enough. + "max_stages" controls how many subdivisions a curve segment may face before it is considered approximate enough. Each subdivision splits the segment in half, so the default 5 stages may mean up to 32 subdivisions per curve segment. Increase with care! + "tolerance_degrees" controls how many degrees the midpoint of a segment may deviate from the real curve, before the segment has to be subdivided. + </description> + </method> + </methods> + <members> + <member name="_data" type="Dictionary" setter="_set_data" getter="_get_data"> + </member> + <member name="bake_interval" type="float" setter="set_bake_interval" getter="get_bake_interval"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Curve3D.xml b/doc/classes/Curve3D.xml new file mode 100644 index 0000000000..8ea0e04b14 --- /dev/null +++ b/doc/classes/Curve3D.xml @@ -0,0 +1,228 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Curve3D" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Describes a Bezier curve in 3D space. + </brief_description> + <description> + This class describes a Bezier curve in 3D space. It is mainly used to give a shape to a [Path], but can be manually sampled for other purposes. + It keeps a cache of precalculated points along the curve, to speed further calculations up. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_point"> + <return type="void"> + </return> + <argument index="0" name="pos" type="Vector3"> + </argument> + <argument index="1" name="in" type="Vector3" default="Vector3( 0, 0, 0 )"> + </argument> + <argument index="2" name="out" type="Vector3" default="Vector3( 0, 0, 0 )"> + </argument> + <argument index="3" name="atpos" type="int" default="-1"> + </argument> + <description> + Adds a point to a curve, at position "pos", 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 >= [method get_point_count]), the point will be appended at the end of the point list. + </description> + </method> + <method name="clear_points"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="get_bake_interval" qualifiers="const"> + <return type="float"> + </return> + <description> + Returns the distance between two adjacent cached points. + </description> + </method> + <method name="get_baked_length" qualifiers="const"> + <return type="float"> + </return> + <description> + Returns the total length of the curve, based on the cached points. Given enough density (see [method set_bake_interval]), it should be approximate enough. + </description> + </method> + <method name="get_baked_points" qualifiers="const"> + <return type="PoolVector3Array"> + </return> + <description> + Returns the cache of points as a [PoolVector3Array]. + </description> + </method> + <method name="get_baked_tilts" qualifiers="const"> + <return type="PoolRealArray"> + </return> + <description> + Returns the cache of tilts as a [RealArray]. + </description> + </method> + <method name="get_point_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the number of points describing the curve. + </description> + </method> + <method name="get_point_in" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Returns the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0). + </description> + </method> + <method name="get_point_out" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + 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). + </description> + </method> + <method name="get_point_pos" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + 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). + </description> + </method> + <method name="get_point_tilt" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Returns the tilt angle in radians for the point "idx". If the index is out of bounds, the function sends an error to the console, and returns 0. + </description> + </method> + <method name="interpolate" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="t" type="float"> + </argument> + <description> + Returns the position between the vertex "idx" and the vertex "idx"+1, where "t" controls if the point is the first vertex (t = 0.0), the last vertex (t = 1.0), or in between. Values of "t" outside the range (0.0 >= t <=1) give strange, but predictable results. + If "idx" is out of bounds it is truncated to the first or last vertex, and "t" is ignored. If the curve has no points, the function sends an error to the console, and returns (0, 0, 0). + </description> + </method> + <method name="interpolate_baked" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="offset" type="float"> + </argument> + <argument index="1" name="cubic" type="bool" default="false"> + </argument> + <description> + Returns a point within the curve at position "offset", where "offset" is measured as a distance in 3D units along the curve. + To do that, it finds the two cached points where the "offset" lies between, then interpolates the values. This interpolation is cubic if "cubic" is set to true, or linear if set to false. + Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough). + </description> + </method> + <method name="interpolatef" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="fofs" type="float"> + </argument> + <description> + Returns the position at the vertex "fofs". It calls [method interpolate] using the integer part of fofs as "idx", and its fractional part as "t". + </description> + </method> + <method name="remove_point"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds. + </description> + </method> + <method name="set_bake_interval"> + <return type="void"> + </return> + <argument index="0" name="distance" type="float"> + </argument> + <description> + Sets the distance in 3D units between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care. + </description> + </method> + <method name="set_point_in"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="pos" type="Vector3"> + </argument> + <description> + 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. + </description> + </method> + <method name="set_point_out"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="pos" type="Vector3"> + </argument> + <description> + 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. + </description> + </method> + <method name="set_point_pos"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="pos" type="Vector3"> + </argument> + <description> + Sets the position for the vertex "idx". If the index is out of bounds, the function sends an error to the console. + </description> + </method> + <method name="set_point_tilt"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="tilt" type="float"> + </argument> + <description> + Sets the tilt angle in radians for the point "idx". If the index is out of bounds, the function sends an error to the console. + The tilt controls the rotation along the look-at axis an object traveling the path would have. In the case of a curve controlling a [PathFollow], this tilt is an offset over the natural tilt the PathFollow calculates. + </description> + </method> + <method name="tessellate" qualifiers="const"> + <return type="PoolVector3Array"> + </return> + <argument index="0" name="max_stages" type="int" default="5"> + </argument> + <argument index="1" name="tolerance_degrees" type="float" default="4"> + </argument> + <description> + Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. + This approximation makes straight segments between each point, then subdivides those segments until the resulting shape is similar enough. + "max_stages" controls how many subdivisions a curve segment may face before it is considered approximate enough. Each subdivision splits the segment in half, so the default 5 stages may mean up to 32 subdivisions per curve segment. Increase with care! + "tolerance_degrees" controls how many degrees the midpoint of a segment may deviate from the real curve, before the segment has to be subdivided. + </description> + </method> + </methods> + <members> + <member name="_data" type="Dictionary" setter="_set_data" getter="_get_data"> + </member> + <member name="bake_interval" type="float" setter="set_bake_interval" getter="get_bake_interval"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/CurveTexture.xml b/doc/classes/CurveTexture.xml new file mode 100644 index 0000000000..8f8f60968a --- /dev/null +++ b/doc/classes/CurveTexture.xml @@ -0,0 +1,43 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="CurveTexture" inherits="Texture" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_curve" qualifiers="const"> + <return type="Curve"> + </return> + <description> + </description> + </method> + <method name="set_curve"> + <return type="void"> + </return> + <argument index="0" name="curve" type="Curve"> + </argument> + <description> + </description> + </method> + <method name="set_width"> + <return type="void"> + </return> + <argument index="0" name="width" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="curve" type="Curve" setter="set_curve" getter="get_curve"> + </member> + <member name="width" type="int" setter="set_width" getter="get_width"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/CylinderMesh.xml b/doc/classes/CylinderMesh.xml new file mode 100644 index 0000000000..8399312dac --- /dev/null +++ b/doc/classes/CylinderMesh.xml @@ -0,0 +1,104 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="CylinderMesh" inherits="PrimitiveMesh" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Class representing a cylindrical [PrimitiveMesh]. + </brief_description> + <description> + Class representing a cylindrical [PrimitiveMesh]. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_bottom_radius" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_height" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_radial_segments" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_rings" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_top_radius" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="set_bottom_radius"> + <return type="void"> + </return> + <argument index="0" name="radius" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_height"> + <return type="void"> + </return> + <argument index="0" name="height" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_radial_segments"> + <return type="void"> + </return> + <argument index="0" name="segments" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_rings"> + <return type="void"> + </return> + <argument index="0" name="rings" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_top_radius"> + <return type="void"> + </return> + <argument index="0" name="radius" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="bottom_radius" type="float" setter="set_bottom_radius" getter="get_bottom_radius"> + Bottom radius of the cylinder. Defaults to 1.0. + </member> + <member name="height" type="float" setter="set_height" getter="get_height"> + Full height of the cylinder. Defaults to 2.0. + </member> + <member name="radial_segments" type="int" setter="set_radial_segments" getter="get_radial_segments"> + Number of radial segments on the cylinder. Defaults to 64. + </member> + <member name="rings" type="int" setter="set_rings" getter="get_rings"> + Number of edge rings along the height of the cylinder. Defaults to 4. + </member> + <member name="top_radius" type="float" setter="set_top_radius" getter="get_top_radius"> + Top radius of the cylinder. Defaults to 1.0. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/DampedSpringJoint2D.xml b/doc/classes/DampedSpringJoint2D.xml new file mode 100644 index 0000000000..18554820fa --- /dev/null +++ b/doc/classes/DampedSpringJoint2D.xml @@ -0,0 +1,91 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="DampedSpringJoint2D" inherits="Joint2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Damped spring constraint for 2D physics. + </brief_description> + <description> + Damped spring constraint for 2D physics. This resembles a spring joint that always wants to go back to a given length. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_damping" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping). + </description> + </method> + <method name="get_length" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the maximum length of the spring joint. + </description> + </method> + <method name="get_rest_length" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the resting length of the spring joint. The joint will always try to go to back this length when pulled apart. + </description> + </method> + <method name="get_stiffness" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length. + </description> + </method> + <method name="set_damping"> + <return type="void"> + </return> + <argument index="0" name="damping" type="float"> + </argument> + <description> + Set the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping). + </description> + </method> + <method name="set_length"> + <return type="void"> + </return> + <argument index="0" name="length" type="float"> + </argument> + <description> + Set the maximum length of the spring joint. + </description> + </method> + <method name="set_rest_length"> + <return type="void"> + </return> + <argument index="0" name="rest_length" type="float"> + </argument> + <description> + Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart. + </description> + </method> + <method name="set_stiffness"> + <return type="void"> + </return> + <argument index="0" name="stiffness" type="float"> + </argument> + <description> + Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length. + </description> + </method> + </methods> + <members> + <member name="damping" type="float" setter="set_damping" getter="get_damping"> + </member> + <member name="length" type="float" setter="set_length" getter="get_length"> + </member> + <member name="rest_length" type="float" setter="set_rest_length" getter="get_rest_length"> + </member> + <member name="stiffness" type="float" setter="set_stiffness" getter="get_stiffness"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Dictionary.xml b/doc/classes/Dictionary.xml new file mode 100644 index 0000000000..447c0d7ed3 --- /dev/null +++ b/doc/classes/Dictionary.xml @@ -0,0 +1,82 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Dictionary" category="Built-In Types" version="3.0.alpha.custom_build"> + <brief_description> + Dictionary type. + </brief_description> + <description> + Dictionary type. Associative container which contains values referenced by unique keys. Dictionaries are always passed by reference. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="clear"> + <description> + Clear the dictionary, removing all key/value pairs. + </description> + </method> + <method name="empty"> + <return type="bool"> + </return> + <description> + Return true if the dictionary is empty. + </description> + </method> + <method name="erase"> + <argument index="0" name="key" type="var"> + </argument> + <description> + Erase a dictionary key/value pair by key. + </description> + </method> + <method name="has"> + <return type="bool"> + </return> + <argument index="0" name="key" type="var"> + </argument> + <description> + Return true if the dictionary has a given key. + </description> + </method> + <method name="has_all"> + <return type="bool"> + </return> + <argument index="0" name="keys" type="Array"> + </argument> + <description> + Return true if the dictionary has all of the keys in the given array. + </description> + </method> + <method name="hash"> + <return type="int"> + </return> + <description> + Return a hashed integer value representing the dictionary contents. + </description> + </method> + <method name="keys"> + <return type="Array"> + </return> + <description> + Return the list of keys in the [Dictionary]. + </description> + </method> + <method name="size"> + <return type="int"> + </return> + <description> + Return the size of the dictionary (in pairs). + </description> + </method> + <method name="values"> + <return type="Array"> + </return> + <description> + Return the list of values in the [Dictionary]. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/DirectionalLight.xml b/doc/classes/DirectionalLight.xml new file mode 100644 index 0000000000..7de1791519 --- /dev/null +++ b/doc/classes/DirectionalLight.xml @@ -0,0 +1,89 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="DirectionalLight" inherits="Light" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Directional Light, such as the Sun or the Moon. + </brief_description> + <description> + A DirectionalLight is a type of [Light] node that emits light constantly in one direction (the negative z axis of the node). It is used lights with strong intensity that are located far away from the scene to model sunlight or moonlight. The worldspace location of the DirectionalLight transform (origin) is ignored, only the basis is used do determine light direction. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_shadow_depth_range" qualifiers="const"> + <return type="int" enum="DirectionalLight.ShadowDepthRange"> + </return> + <description> + </description> + </method> + <method name="get_shadow_mode" qualifiers="const"> + <return type="int" enum="DirectionalLight.ShadowMode"> + </return> + <description> + </description> + </method> + <method name="is_blend_splits_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_blend_splits"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_shadow_depth_range"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="DirectionalLight.ShadowDepthRange"> + </argument> + <description> + </description> + </method> + <method name="set_shadow_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="DirectionalLight.ShadowMode"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="directional_shadow_bias_split_scale" type="float" setter="set_param" getter="get_param"> + </member> + <member name="directional_shadow_blend_splits" type="bool" setter="set_blend_splits" getter="is_blend_splits_enabled"> + </member> + <member name="directional_shadow_depth_range" type="int" setter="set_shadow_depth_range" getter="get_shadow_depth_range" enum="DirectionalLight.ShadowDepthRange"> + </member> + <member name="directional_shadow_max_distance" type="float" setter="set_param" getter="get_param"> + </member> + <member name="directional_shadow_mode" type="int" setter="set_shadow_mode" getter="get_shadow_mode" enum="DirectionalLight.ShadowMode"> + </member> + <member name="directional_shadow_normal_bias" type="float" setter="set_param" getter="get_param"> + </member> + <member name="directional_shadow_split_1" type="float" setter="set_param" getter="get_param"> + </member> + <member name="directional_shadow_split_2" type="float" setter="set_param" getter="get_param"> + </member> + <member name="directional_shadow_split_3" type="float" setter="set_param" getter="get_param"> + </member> + </members> + <constants> + <constant name="SHADOW_ORTHOGONAL" value="0"> + </constant> + <constant name="SHADOW_PARALLEL_2_SPLITS" value="1"> + </constant> + <constant name="SHADOW_PARALLEL_4_SPLITS" value="2"> + </constant> + <constant name="SHADOW_DEPTH_RANGE_STABLE" value="0"> + </constant> + <constant name="SHADOW_DEPTH_RANGE_OPTIMIZED" value="1"> + </constant> + </constants> +</class> diff --git a/doc/classes/Directory.xml b/doc/classes/Directory.xml new file mode 100644 index 0000000000..ee0b873084 --- /dev/null +++ b/doc/classes/Directory.xml @@ -0,0 +1,196 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Directory" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Type used to handle the filesystem. + </brief_description> + <description> + Directory type. It is used to manage directories and their content (not restricted to the project folder). + Here is an example on how to iterate through the files of a directory: + [codeblock] + func dir_contents(path): + var dir = Directory.new() + if dir.open(path) == OK: + dir.list_dir_begin() + var file_name = dir.get_next() + while (file_name != ""): + if dir.current_is_dir(): + print("Found directory: " + file_name) + else: + print("Found file: " + file_name) + file_name = dir.get_next() + else: + print("An error occurred when trying to access the path.") + [/codeblock] + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="change_dir"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="todir" type="String"> + </argument> + <description> + Change the currently opened directory to the one passed as an argument. The argument can be relative to the current directory (e.g. [code]newdir[/code] or [code]../newdir[/code]), or an absolute path (e.g. [code]/tmp/newdir[/code] or [code]res://somedir/newdir[/code]). + The method returns one of the error code constants defined in [@Global Scope] (OK or ERR_*). + </description> + </method> + <method name="copy"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="from" type="String"> + </argument> + <argument index="1" name="to" type="String"> + </argument> + <description> + Copy the [i]from[/i] file to the [i]to[/i] destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten. + Returns one of the error code constants defined in [@Global Scope] (OK, FAILED or ERR_*). + </description> + </method> + <method name="current_is_dir" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether the current item processed with the last [method get_next] call is a directory ([code].[/code] and [code]..[/code] are considered directories). + </description> + </method> + <method name="dir_exists"> + <return type="bool"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + Return whether the target directory exists. The argument can be relative to the current directory, or an absolute path. + </description> + </method> + <method name="file_exists"> + <return type="bool"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + Return whether the target file exists. The argument can be relative to the current directory, or an absolute path. + </description> + </method> + <method name="get_current_dir"> + <return type="String"> + </return> + <description> + Return the absolute path to the currently opened directory (e.g. [code]res://folder[/code] or [code]C:\tmp\folder[/code]). + </description> + </method> + <method name="get_current_drive"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_drive"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + On Windows, return the name of the drive (partition) passed as an argument (e.g. [code]C:[/code]). On other platforms, or if the requested drive does not existed, the method returns an empty String. + </description> + </method> + <method name="get_drive_count"> + <return type="int"> + </return> + <description> + On Windows, return the number of drives (partitions) mounted on the current filesystem. On other platforms, the method returns 0. + </description> + </method> + <method name="get_next"> + <return type="String"> + </return> + <description> + Return the next element (file or directory) in the current directory (including [code].[/code] and [code]..[/code], unless [code]skip_navigational[/code] was given to [method list_dir_begin]). + The name of the file or directory is returned (and not its full path). Once the stream has been fully processed, the method returns an empty String and closes the stream automatically (i.e. [method list_dir_end] would not be mandatory in such a case). + </description> + </method> + <method name="get_space_left"> + <return type="int"> + </return> + <description> + On Unix desktop systems, return the available space on the current directory's disk. On other platforms, this information is not available and the method returns 0 or -1. + </description> + </method> + <method name="list_dir_begin"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="skip_navigational" type="bool" default="false"> + </argument> + <argument index="1" name="skip_hidden" type="bool" default="false"> + </argument> + <description> + Initialise the stream used to list all files and directories using the [method get_next] function, closing the current opened stream if needed. Once the stream has been processed, it should typically be closed with [method list_dir_end]. + If you pass [code]skip_navigational[/code], then [code].[/code] and [code]..[/code] would be filtered out. + If you pass [code]skip_hidden[/code], then hidden files would be filtered out. + </description> + </method> + <method name="list_dir_end"> + <return type="void"> + </return> + <description> + Close the current stream opened with [method list_dir_begin] (whether it has been fully processed with [method get_next] or not does not matter). + </description> + </method> + <method name="make_dir"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + Create a directory. The argument can be relative to the current directory, or an absolute path. The target directory should be placed in an already existing directory (to create the full path recursively, see [method make_dir_recursive]). + The method returns one of the error code constants defined in [@Global Scope] (OK, FAILED or ERR_*). + </description> + </method> + <method name="make_dir_recursive"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + Create a target directory and all necessary intermediate directories in its path, by calling [method make_dir] recursively. The argument can be relative to the current directory, or an absolute path. + Return one of the error code constants defined in [@Global Scope] (OK, FAILED or ERR_*). + </description> + </method> + <method name="open"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + Open an existing directory of the filesystem. The [i]path[/i] argument can be within the project tree ([code]res://folder[/code]), the user directory ([code]user://folder[/code]) or an absolute path of the user filesystem (e.g. [code]/tmp/folder[/code] or [code]C:\tmp\folder[/code]). + The method returns one of the error code constants defined in [@Global Scope] (OK or ERR_*). + </description> + </method> + <method name="remove"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + Delete the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail. + Return one of the error code constants defined in [@Global Scope] (OK or FAILED). + </description> + </method> + <method name="rename"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="from" type="String"> + </argument> + <argument index="1" name="to" type="String"> + </argument> + <description> + Rename (move) the [i]from[/i] file to the [i]to[/i] destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten. + Return one of the error code constants defined in [@Global Scope] (OK or FAILED). + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/DynamicFont.xml b/doc/classes/DynamicFont.xml new file mode 100644 index 0000000000..e4ce2ff3f0 --- /dev/null +++ b/doc/classes/DynamicFont.xml @@ -0,0 +1,155 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="DynamicFont" inherits="Font" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_fallback"> + <return type="void"> + </return> + <argument index="0" name="data" type="DynamicFontData"> + </argument> + <description> + </description> + </method> + <method name="get_fallback" qualifiers="const"> + <return type="DynamicFontData"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_fallback_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_font_data" qualifiers="const"> + <return type="DynamicFontData"> + </return> + <description> + </description> + </method> + <method name="get_size" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_spacing" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="type" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_use_filter" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_use_mipmaps" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="remove_fallback"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_fallback"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="data" type="DynamicFontData"> + </argument> + <description> + </description> + </method> + <method name="set_font_data"> + <return type="void"> + </return> + <argument index="0" name="data" type="DynamicFontData"> + </argument> + <description> + </description> + </method> + <method name="set_size"> + <return type="void"> + </return> + <argument index="0" name="data" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_spacing"> + <return type="void"> + </return> + <argument index="0" name="type" type="int"> + </argument> + <argument index="1" name="value" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_use_filter"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_use_mipmaps"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="extra_spacing_bottom" type="int" setter="set_spacing" getter="get_spacing"> + </member> + <member name="extra_spacing_char" type="int" setter="set_spacing" getter="get_spacing"> + </member> + <member name="extra_spacing_space" type="int" setter="set_spacing" getter="get_spacing"> + </member> + <member name="extra_spacing_top" type="int" setter="set_spacing" getter="get_spacing"> + </member> + <member name="font_data" type="DynamicFontData" setter="set_font_data" getter="get_font_data"> + </member> + <member name="size" type="int" setter="set_size" getter="get_size"> + </member> + <member name="use_filter" type="bool" setter="set_use_filter" getter="get_use_filter"> + </member> + <member name="use_mipmaps" type="bool" setter="set_use_mipmaps" getter="get_use_mipmaps"> + </member> + </members> + <constants> + <constant name="SPACING_TOP" value="0"> + </constant> + <constant name="SPACING_BOTTOM" value="1"> + </constant> + <constant name="SPACING_CHAR" value="2"> + </constant> + <constant name="SPACING_SPACE" value="3"> + </constant> + </constants> +</class> diff --git a/doc/classes/DynamicFontData.xml b/doc/classes/DynamicFontData.xml new file mode 100644 index 0000000000..51e4e0d231 --- /dev/null +++ b/doc/classes/DynamicFontData.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="DynamicFontData" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_font_path" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="set_font_path"> + <return type="void"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="font_path" type="String" setter="set_font_path" getter="get_font_path"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/EditorExportPlugin.xml b/doc/classes/EditorExportPlugin.xml new file mode 100644 index 0000000000..b0ed24b767 --- /dev/null +++ b/doc/classes/EditorExportPlugin.xml @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorExportPlugin" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="_export_begin" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="features" type="PoolStringArray"> + </argument> + <description> + </description> + </method> + <method name="_export_file" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="type" type="String"> + </argument> + <argument index="2" name="features" type="PoolStringArray"> + </argument> + <description> + </description> + </method> + <method name="add_file"> + <return type="void"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="file" type="PoolByteArray"> + </argument> + <argument index="2" name="remap" type="bool"> + </argument> + <description> + </description> + </method> + <method name="add_shared_object"> + <return type="void"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + </description> + </method> + <method name="skip"> + <return type="void"> + </return> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/EditorFileDialog.xml b/doc/classes/EditorFileDialog.xml new file mode 100644 index 0000000000..6ae893f189 --- /dev/null +++ b/doc/classes/EditorFileDialog.xml @@ -0,0 +1,193 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorFileDialog" inherits="ConfirmationDialog" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_filter"> + <return type="void"> + </return> + <argument index="0" name="filter" type="String"> + </argument> + <description> + </description> + </method> + <method name="clear_filters"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="get_access" qualifiers="const"> + <return type="int" enum="EditorFileDialog.Access"> + </return> + <description> + </description> + </method> + <method name="get_current_dir" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_current_file" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_current_path" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_display_mode" qualifiers="const"> + <return type="int" enum="EditorFileDialog.DisplayMode"> + </return> + <description> + </description> + </method> + <method name="get_mode" qualifiers="const"> + <return type="int" enum="EditorFileDialog.Mode"> + </return> + <description> + </description> + </method> + <method name="get_vbox"> + <return type="VBoxContainer"> + </return> + <description> + </description> + </method> + <method name="invalidate"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="is_overwrite_warning_disabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_showing_hidden_files" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_access"> + <return type="void"> + </return> + <argument index="0" name="access" type="int" enum="EditorFileDialog.Access"> + </argument> + <description> + </description> + </method> + <method name="set_current_dir"> + <return type="void"> + </return> + <argument index="0" name="dir" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_current_file"> + <return type="void"> + </return> + <argument index="0" name="file" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_current_path"> + <return type="void"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_disable_overwrite_warning"> + <return type="void"> + </return> + <argument index="0" name="disable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_display_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="EditorFileDialog.DisplayMode"> + </argument> + <description> + </description> + </method> + <method name="set_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="EditorFileDialog.Mode"> + </argument> + <description> + </description> + </method> + <method name="set_show_hidden_files"> + <return type="void"> + </return> + <argument index="0" name="show" type="bool"> + </argument> + <description> + </description> + </method> + </methods> + <signals> + <signal name="dir_selected"> + <argument index="0" name="dir" type="String"> + </argument> + <description> + </description> + </signal> + <signal name="file_selected"> + <argument index="0" name="path" type="String"> + </argument> + <description> + </description> + </signal> + <signal name="files_selected"> + <argument index="0" name="paths" type="PoolStringArray"> + </argument> + <description> + </description> + </signal> + </signals> + <constants> + <constant name="MODE_OPEN_FILE" value="0"> + </constant> + <constant name="MODE_OPEN_FILES" value="1"> + </constant> + <constant name="MODE_OPEN_DIR" value="2"> + </constant> + <constant name="MODE_OPEN_ANY" value="3"> + </constant> + <constant name="MODE_SAVE_FILE" value="4"> + </constant> + <constant name="ACCESS_RESOURCES" value="0"> + </constant> + <constant name="ACCESS_USERDATA" value="1"> + </constant> + <constant name="ACCESS_FILESYSTEM" value="2"> + </constant> + <constant name="DISPLAY_THUMBNAILS" value="0"> + </constant> + <constant name="DISPLAY_LIST" value="1"> + </constant> + </constants> +</class> diff --git a/doc/classes/EditorFileSystem.xml b/doc/classes/EditorFileSystem.xml new file mode 100644 index 0000000000..6a2f811425 --- /dev/null +++ b/doc/classes/EditorFileSystem.xml @@ -0,0 +1,98 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorFileSystem" inherits="Node" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Resource filesystem, as the editor sees it. + </brief_description> + <description> + This object holds information of all resources in the filesystem, their types, etc. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_file_type" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + Get the type of the file, given the full path. + </description> + </method> + <method name="get_filesystem"> + <return type="EditorFileSystemDirectory"> + </return> + <description> + Get the root directory object. + </description> + </method> + <method name="get_filesystem_path"> + <return type="EditorFileSystemDirectory"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_scanning_progress" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the scan progress for 0 to 1 if the FS is being scanned. + </description> + </method> + <method name="is_scanning" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true of the filesystem is being scanned. + </description> + </method> + <method name="scan"> + <return type="void"> + </return> + <description> + Scan the filesystem for changes. + </description> + </method> + <method name="scan_sources"> + <return type="void"> + </return> + <description> + Check if the source of any imported resource changed. + </description> + </method> + <method name="update_file"> + <return type="void"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + Update a file information. Call this if an external program (not Godot) modified the file. + </description> + </method> + </methods> + <signals> + <signal name="filesystem_changed"> + <description> + Emitted if the filesystem changed. + </description> + </signal> + <signal name="resources_reimported"> + <argument index="0" name="resources" type="PoolStringArray"> + </argument> + <description> + </description> + </signal> + <signal name="sources_changed"> + <argument index="0" name="exist" type="bool"> + </argument> + <description> + Emitted if the source of any imported file changed. + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/EditorFileSystemDirectory.xml b/doc/classes/EditorFileSystemDirectory.xml new file mode 100644 index 0000000000..7d284f864e --- /dev/null +++ b/doc/classes/EditorFileSystemDirectory.xml @@ -0,0 +1,102 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorFileSystemDirectory" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + A diretory for the resource filesystem. + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="find_dir_index" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="find_file_index" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_file" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_file_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_file_import_is_valid" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_file_path" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_file_type" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_name"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_parent"> + <return type="EditorFileSystemDirectory"> + </return> + <description> + </description> + </method> + <method name="get_path" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_subdir"> + <return type="EditorFileSystemDirectory"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_subdir_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/EditorImportPlugin.xml b/doc/classes/EditorImportPlugin.xml new file mode 100644 index 0000000000..0ced30bda6 --- /dev/null +++ b/doc/classes/EditorImportPlugin.xml @@ -0,0 +1,93 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorImportPlugin" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_import_options" qualifiers="virtual"> + <return type="Array"> + </return> + <argument index="0" name="preset" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_importer_name" qualifiers="virtual"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_option_visibility" qualifiers="virtual"> + <return type="bool"> + </return> + <argument index="0" name="option" type="String"> + </argument> + <argument index="1" name="options" type="Dictionary"> + </argument> + <description> + </description> + </method> + <method name="get_preset_count" qualifiers="virtual"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_preset_name" qualifiers="virtual"> + <return type="String"> + </return> + <argument index="0" name="preset" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_recognized_extensions" qualifiers="virtual"> + <return type="Array"> + </return> + <description> + </description> + </method> + <method name="get_resource_type" qualifiers="virtual"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_save_extension" qualifiers="virtual"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_visible_name" qualifiers="virtual"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="import" qualifiers="virtual"> + <return type="int"> + </return> + <argument index="0" name="source_file" type="String"> + </argument> + <argument index="1" name="save_path" type="String"> + </argument> + <argument index="2" name="options" type="Dictionary"> + </argument> + <argument index="3" name="r_platform_variants" type="Array"> + </argument> + <argument index="4" name="r_gen_files" type="Array"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/EditorInterface.xml b/doc/classes/EditorInterface.xml new file mode 100644 index 0000000000..0422e9a64e --- /dev/null +++ b/doc/classes/EditorInterface.xml @@ -0,0 +1,129 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorInterface" inherits="Node" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="edit_resource"> + <return type="void"> + </return> + <argument index="0" name="resource" type="Resource"> + </argument> + <description> + </description> + </method> + <method name="get_base_control"> + <return type="Control"> + </return> + <description> + </description> + </method> + <method name="get_edited_scene_root"> + <return type="Node"> + </return> + <description> + </description> + </method> + <method name="get_editor_settings"> + <return type="EditorSettings"> + </return> + <description> + </description> + </method> + <method name="get_editor_viewport"> + <return type="Control"> + </return> + <description> + </description> + </method> + <method name="get_open_scenes" qualifiers="const"> + <return type="Array"> + </return> + <description> + </description> + </method> + <method name="get_resource_filesystem"> + <return type="EditorFileSystem"> + </return> + <description> + </description> + </method> + <method name="get_resource_previewer"> + <return type="EditorResourcePreview"> + </return> + <description> + </description> + </method> + <method name="get_script_editor"> + <return type="ScriptEditor"> + </return> + <description> + </description> + </method> + <method name="get_selection"> + <return type="EditorSelection"> + </return> + <description> + </description> + </method> + <method name="inspect_object"> + <return type="void"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="for_property" type="String" default=""""> + </argument> + <description> + </description> + </method> + <method name="make_mesh_previews"> + <return type="Array"> + </return> + <argument index="0" name="arg0" type="Array"> + </argument> + <argument index="1" name="arg1" type="int"> + </argument> + <description> + </description> + </method> + <method name="open_scene_from_path"> + <return type="void"> + </return> + <argument index="0" name="scene_filepath" type="String"> + </argument> + <description> + </description> + </method> + <method name="reload_scene_from_path"> + <return type="void"> + </return> + <argument index="0" name="scene_filepath" type="String"> + </argument> + <description> + </description> + </method> + <method name="save_scene"> + <return type="int" enum="Error"> + </return> + <description> + </description> + </method> + <method name="save_scene_as"> + <return type="void"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="with_preview" type="bool" default="true"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml new file mode 100644 index 0000000000..2831555d41 --- /dev/null +++ b/doc/classes/EditorPlugin.xml @@ -0,0 +1,390 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorPlugin" inherits="Node" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Used by the editor to extend its functionality. + </brief_description> + <description> + Plugins are used by the editor to extend functionality. The most common types of plugins are those which edit a given node or resource type, import plugins and export plugins. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_control_to_bottom_panel"> + <return type="ToolButton"> + </return> + <argument index="0" name="control" type="Control"> + </argument> + <argument index="1" name="title" type="String"> + </argument> + <description> + Add a control to the bottom panel (together with Output, Debug, Animation, etc). Returns a reference to the button added. It's up to you to hide/show the button when needed. If your plugin is being removed, also make sure to remove your control by calling [method remove_control_from_bottom_panel]. + </description> + </method> + <method name="add_control_to_container"> + <return type="void"> + </return> + <argument index="0" name="container" type="int" enum="EditorPlugin.CustomControlContainer"> + </argument> + <argument index="1" name="control" type="Control"> + </argument> + <description> + Add a custom control to a container (see CONTAINER_* enum). There are many locations where custom controls can be added in the editor UI. + Please remember that you have to manage the visibility of your custom controls yourself (and likely hide it after adding it). + If your plugin is being removed, also make sure to remove your custom controls too. + </description> + </method> + <method name="add_control_to_dock"> + <return type="void"> + </return> + <argument index="0" name="slot" type="int" enum="EditorPlugin.DockSlot"> + </argument> + <argument index="1" name="control" type="Control"> + </argument> + <description> + Add the control to a specific dock slot (see DOCK_* enum for options). + If the dock is repositioned and as long as the plugin is active, the editor will save the dock position on further sessions. + If your plugin is being removed, also make sure to remove your control by calling [method remove_control_from_docks]. + </description> + </method> + <method name="add_custom_type"> + <return type="void"> + </return> + <argument index="0" name="type" type="String"> + </argument> + <argument index="1" name="base" type="String"> + </argument> + <argument index="2" name="script" type="Script"> + </argument> + <argument index="3" name="icon" type="Texture"> + </argument> + <description> + Add a custom type, which will appear in the list of nodes or resources. An icon can be optionally passed. + When given node or resource is selected, the base type will be instanced (ie, "Spatial", "Control", "Resource"), then the script will be loaded and set to this object. + You can use the [method EditorPlugin.handles] to check if your custom object is being edited by checking the script or using 'is' keyword. + During run-time, this will be a simple object with a script so this function does not need to be called then. + </description> + </method> + <method name="add_export_plugin"> + <return type="void"> + </return> + <argument index="0" name="exporter" type="EditorExportPlugin"> + </argument> + <description> + </description> + </method> + <method name="add_import_plugin"> + <return type="void"> + </return> + <argument index="0" name="importer" type="EditorImportPlugin"> + </argument> + <description> + </description> + </method> + <method name="add_tool_submenu_item"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="submenu" type="Object"> + </argument> + <description> + </description> + </method> + <method name="apply_changes" qualifiers="virtual"> + <return type="void"> + </return> + <description> + This method is called when the editor is about to save the project, switch to another tab, etc. It asks the plugin to apply any pending state changes to ensure consistency. + This is used, for example, in shader editors to let the plugin know that it must apply the shader code being written by the user to the object. + </description> + </method> + <method name="clear" qualifiers="virtual"> + <return type="void"> + </return> + <description> + Clear all the state and reset the object being edited to zero. This ensures your plugin does not keep editing a currently existing node, or a node from the wrong scene. + </description> + </method> + <method name="create_spatial_gizmo" qualifiers="virtual"> + <return type="EditorSpatialGizmo"> + </return> + <argument index="0" name="for_spatial" type="Spatial"> + </argument> + <description> + This is used for plugins that create gizmos used by the spatial editor. Just check that the node passed in the "for_spatial" argument matches your plugin. + </description> + </method> + <method name="edit" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <description> + This function is used for plugins that edit specific object types (nodes or resources). It requests the editor to edit the given object. + </description> + </method> + <method name="forward_canvas_gui_input" qualifiers="virtual"> + <return type="bool"> + </return> + <argument index="0" name="canvas_xform" type="Transform2D"> + </argument> + <argument index="1" name="event" type="InputEvent"> + </argument> + <description> + </description> + </method> + <method name="forward_draw_over_canvas" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="canvas_xform" type="Transform2D"> + </argument> + <argument index="1" name="canvas" type="Control"> + </argument> + <description> + This function is called every time the 2D canvas editor draws (which overlays over the edited scene). Drawing over the supplied control will draw over the edited scene. To convert from control coordinates to edited scene coordinates (including zoom and offset), a transform is also provided. If you require this control to be redraw, call [method update_canvas]. + </description> + </method> + <method name="forward_spatial_gui_input" qualifiers="virtual"> + <return type="bool"> + </return> + <argument index="0" name="camera" type="Camera"> + </argument> + <argument index="1" name="event" type="InputEvent"> + </argument> + <description> + Implement this function if you are interested in 3D view screen input events. It will be called only if currently selected node is handled by your plugin. + If you would like to always gets those input events then additionally use [method set_input_forwarding_always_enabled]. + </description> + </method> + <method name="get_breakpoints" qualifiers="virtual"> + <return type="PoolStringArray"> + </return> + <description> + This is for editors that edit script based objects. You can return a list of breakpoints in the format (script:line), for example: res://path_to_script.gd:25 + </description> + </method> + <method name="get_editor_interface"> + <return type="EditorInterface"> + </return> + <description> + </description> + </method> + <method name="get_plugin_name" qualifiers="virtual"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_state" qualifiers="virtual"> + <return type="Dictionary"> + </return> + <description> + Get the state of your plugin editor. This is used when saving the scene (so state is kept when opening it again) and for switching tabs (so state can be restored when the tab returns). + </description> + </method> + <method name="get_undo_redo"> + <return type="UndoRedo"> + </return> + <description> + Get the undo/redo object. Most actions in the editor can be undoable, so use this object to make sure this happens when it's worth it. + </description> + </method> + <method name="get_window_layout" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="layout" type="ConfigFile"> + </argument> + <description> + Get the GUI layout of the plugin. This is used to save the project's editor layout when the [method EditorPlugin.queue_save_layout] is called or the editor layout was changed(For example changing the position of a dock). + </description> + </method> + <method name="handles" qualifiers="virtual"> + <return type="bool"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <description> + Implement this function if your plugin edits a specific type of object (Resource or Node). If you return true, then you will get the functions [method EditorPlugin.edit] and [method EditorPlugin.make_visible] called when the editor requests them. + </description> + </method> + <method name="has_main_screen" qualifiers="virtual"> + <return type="bool"> + </return> + <description> + Return true if this is a main screen editor plugin (it goes in the main screen selector together with 2D, 3D, Script). + </description> + </method> + <method name="hide_bottom_panel"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="make_bottom_panel_item_visible"> + <return type="void"> + </return> + <argument index="0" name="item" type="Control"> + </argument> + <description> + </description> + </method> + <method name="make_visible" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="visible" type="bool"> + </argument> + <description> + This function will be called when the editor is requested to become visible. It is used for plugins that edit a specific object type. + Remember that you have to manage the visibility of all your editor controls manually. + </description> + </method> + <method name="queue_save_layout" qualifiers="const"> + <return type="void"> + </return> + <description> + Queue save the project's editor layout. + </description> + </method> + <method name="remove_control_from_bottom_panel"> + <return type="void"> + </return> + <argument index="0" name="control" type="Control"> + </argument> + <description> + Remove the control from the bottom panel. Don't forget to call this if you added one, so the editor can remove it cleanly. + </description> + </method> + <method name="remove_control_from_docks"> + <return type="void"> + </return> + <argument index="0" name="control" type="Control"> + </argument> + <description> + Remove the control from the dock. Don't forget to call this if you added one, so the editor can save the layout and remove it cleanly. + </description> + </method> + <method name="remove_custom_type"> + <return type="void"> + </return> + <argument index="0" name="type" type="String"> + </argument> + <description> + Remove a custom type added by [method EditorPlugin.add_custom_type] + </description> + </method> + <method name="remove_export_plugin"> + <return type="void"> + </return> + <argument index="0" name="exporter" type="EditorExportPlugin"> + </argument> + <description> + </description> + </method> + <method name="remove_import_plugin"> + <return type="void"> + </return> + <argument index="0" name="importer" type="EditorImportPlugin"> + </argument> + <description> + </description> + </method> + <method name="save_external_data" qualifiers="virtual"> + <return type="void"> + </return> + <description> + This method is called after the editor saves the project or when it's closed. It asks the plugin to save edited external scenes/resources. + </description> + </method> + <method name="set_input_event_forwarding_always_enabled"> + <return type="void"> + </return> + <description> + Use this method if you always want to receive inputs from 3D view screen inside [method forward_spatial_gui_input]. It might be especially usable if your plugin will want to use raycast in the scene. + </description> + </method> + <method name="set_state" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="state" type="Dictionary"> + </argument> + <description> + Restore the state saved by [method EditorPlugin.get_state]. + </description> + </method> + <method name="set_window_layout" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="layout" type="ConfigFile"> + </argument> + <description> + Restore the plugin GUI layout saved by [method EditorPlugin.get_window_layout]. + </description> + </method> + <method name="update_canvas"> + <return type="void"> + </return> + <description> + Updates the control used to draw the edited scene over the 2D canvas. This is used together with [method forward_canvas_input_event]. + </description> + </method> + </methods> + <signals> + <signal name="main_screen_changed"> + <argument index="0" name="screen_name" type="String"> + </argument> + <description> + Emitted when user change main screen view (2D, 3D, Script, AssetLib). Works also with screens which are defined by plugins. + </description> + </signal> + <signal name="scene_changed"> + <argument index="0" name="scene_root" type="Object"> + </argument> + <description> + Emitted when user change scene. The argument is a root node of freshly opened scene. + </description> + </signal> + <signal name="scene_closed"> + <argument index="0" name="filepath" type="String"> + </argument> + <description> + Emitted when user close scene. The argument is file path to a closed scene. + </description> + </signal> + </signals> + <constants> + <constant name="CONTAINER_TOOLBAR" value="0"> + </constant> + <constant name="CONTAINER_SPATIAL_EDITOR_MENU" value="1"> + </constant> + <constant name="CONTAINER_SPATIAL_EDITOR_SIDE" value="2"> + </constant> + <constant name="CONTAINER_SPATIAL_EDITOR_BOTTOM" value="3"> + </constant> + <constant name="CONTAINER_CANVAS_EDITOR_MENU" value="4"> + </constant> + <constant name="CONTAINER_CANVAS_EDITOR_SIDE" value="5"> + </constant> + <constant name="CONTAINER_PROPERTY_EDITOR_BOTTOM" value="7"> + </constant> + <constant name="DOCK_SLOT_LEFT_UL" value="0"> + </constant> + <constant name="DOCK_SLOT_LEFT_BL" value="1"> + </constant> + <constant name="DOCK_SLOT_LEFT_UR" value="2"> + </constant> + <constant name="DOCK_SLOT_LEFT_BR" value="3"> + </constant> + <constant name="DOCK_SLOT_RIGHT_UL" value="4"> + </constant> + <constant name="DOCK_SLOT_RIGHT_BL" value="5"> + </constant> + <constant name="DOCK_SLOT_RIGHT_UR" value="6"> + </constant> + <constant name="DOCK_SLOT_RIGHT_BR" value="7"> + </constant> + <constant name="DOCK_SLOT_MAX" value="8"> + </constant> + </constants> +</class> diff --git a/doc/classes/EditorResourcePreview.xml b/doc/classes/EditorResourcePreview.xml new file mode 100644 index 0000000000..e530557a23 --- /dev/null +++ b/doc/classes/EditorResourcePreview.xml @@ -0,0 +1,83 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorResourcePreview" inherits="Node" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Helper to generate previews of reources or files. + </brief_description> + <description> + This object is used to generate previews for resources of files. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_preview_generator"> + <return type="void"> + </return> + <argument index="0" name="generator" type="EditorResourcePreviewGenerator"> + </argument> + <description> + Create an own, custom preview generator. + </description> + </method> + <method name="check_for_invalidation"> + <return type="void"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + Check if the resource changed, if so it will be invalidated and the corresponding signal emitted. + </description> + </method> + <method name="queue_edited_resource_preview"> + <return type="void"> + </return> + <argument index="0" name="resource" type="Resource"> + </argument> + <argument index="1" name="receiver" type="Object"> + </argument> + <argument index="2" name="receiver_func" type="String"> + </argument> + <argument index="3" name="userdata" type="Variant"> + </argument> + <description> + Queue a resource being edited for preview (using an instance). Once the preview is ready, your receiver.receiver_func will be called either containing the preview texture or an empty texure (if no preview was possible). Callback must have the format: (path,texture,userdata). Userdata can be anything. + </description> + </method> + <method name="queue_resource_preview"> + <return type="void"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="receiver" type="Object"> + </argument> + <argument index="2" name="receiver_func" type="String"> + </argument> + <argument index="3" name="userdata" type="Variant"> + </argument> + <description> + Queue a resource file for preview (using a path). Once the preview is ready, your receiver.receiver_func will be called either containing the preview texture or an empty texure (if no preview was possible). Callback must have the format: (path,texture,userdata). Userdata can be anything. + </description> + </method> + <method name="remove_preview_generator"> + <return type="void"> + </return> + <argument index="0" name="generator" type="EditorResourcePreviewGenerator"> + </argument> + <description> + Remove a custom preview generator. + </description> + </method> + </methods> + <signals> + <signal name="preview_invalidated"> + <argument index="0" name="path" type="String"> + </argument> + <description> + If a preview was invalidated (changed) this signal will emit (using the path of the preview) + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/EditorResourcePreviewGenerator.xml b/doc/classes/EditorResourcePreviewGenerator.xml new file mode 100644 index 0000000000..231198516e --- /dev/null +++ b/doc/classes/EditorResourcePreviewGenerator.xml @@ -0,0 +1,48 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorResourcePreviewGenerator" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Custom generator of previews. + </brief_description> + <description> + Custom code to generate previews. Please check "file_dialog/thumbnail_size" in EditorSettings to find out the right size to do previews at. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="generate" qualifiers="virtual"> + <return type="Texture"> + </return> + <argument index="0" name="from" type="Resource"> + </argument> + <description> + Generate a preview from a given resource. This must be always implemented. + Returning an empty texture is an OK way to fail and let another generator take care. + Care must be taken because this function is always called from a thread (not the main thread). + </description> + </method> + <method name="generate_from_path" qualifiers="virtual"> + <return type="Texture"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + Generate a preview directly from a path, implementing this is optional, as default code will load and call generate() + Returning an empty texture is an OK way to fail and let another generator take care. + Care must be taken because this function is always called from a thread (not the main thread). + </description> + </method> + <method name="handles" qualifiers="virtual"> + <return type="bool"> + </return> + <argument index="0" name="type" type="String"> + </argument> + <description> + Return if your generator supports this resource type. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/EditorScript.xml b/doc/classes/EditorScript.xml new file mode 100644 index 0000000000..48cf3e9843 --- /dev/null +++ b/doc/classes/EditorScript.xml @@ -0,0 +1,43 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorScript" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Simple script to perform changes in the currently edited scene. + </brief_description> + <description> + This script can be run from the Scene -> Run Script menu option. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="_run" qualifiers="virtual"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="add_root_node"> + <return type="void"> + </return> + <argument index="0" name="node" type="Node"> + </argument> + <description> + </description> + </method> + <method name="get_editor_interface"> + <return type="EditorInterface"> + </return> + <description> + </description> + </method> + <method name="get_scene"> + <return type="Node"> + </return> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/EditorSelection.xml b/doc/classes/EditorSelection.xml new file mode 100644 index 0000000000..8d9bdd2c05 --- /dev/null +++ b/doc/classes/EditorSelection.xml @@ -0,0 +1,63 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorSelection" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Manages the SceneTree selection in the editor. + </brief_description> + <description> + This object manages the SceneTree selection in the editor. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_node"> + <return type="void"> + </return> + <argument index="0" name="node" type="Node"> + </argument> + <description> + Add a node to the selection. + </description> + </method> + <method name="clear"> + <return type="void"> + </return> + <description> + Clear the selection. + </description> + </method> + <method name="get_selected_nodes"> + <return type="Array"> + </return> + <description> + Get the list of selectes nodes. + </description> + </method> + <method name="get_transformable_selected_nodes"> + <return type="Array"> + </return> + <description> + Get the list of selected nodes, optimized for transform operations (ie, moving them, rotating, etc). This list avoids situations where a node is selected and also chid/grandchild. + </description> + </method> + <method name="remove_node"> + <return type="void"> + </return> + <argument index="0" name="node" type="Node"> + </argument> + <description> + Remove a node from the selection. + </description> + </method> + </methods> + <signals> + <signal name="selection_changed"> + <description> + Emitted when the selection changes. + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/EditorSettings.xml b/doc/classes/EditorSettings.xml new file mode 100644 index 0000000000..37c7a47a51 --- /dev/null +++ b/doc/classes/EditorSettings.xml @@ -0,0 +1,108 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorSettings" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Object that holds the project-independent editor settings. + </brief_description> + <description> + Object that holds the project-independent editor settings. These settings are generally visible in the Editor Settings menu. + Accessing the settings is done by using the regular [Object] API, such as: + [codeblock] + settings.set(prop,value) + settings.get(prop) + list_of_settings = settings.get_property_list() + [/codeblock] + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_property_info"> + <return type="void"> + </return> + <argument index="0" name="info" type="Dictionary"> + </argument> + <description> + Add a custom property info to a property. The dictionary must contain: name:[String](the name of the property) and type:[int](see TYPE_* in [@Global Scope]), and optionally hint:[int](see PROPERTY_HINT_* in [@Global Scope]), hint_string:[String]. + Example: + [codeblock] + editor_settings.set("category/property_name", 0) + + var property_info = { + "name": "category/property_name", + "type": TYPE_INT, + "hint": PROPERTY_HINT_ENUM, + "hint_string": "one,two,three" + } + + editor_settings.add_property_info(property_info) + [/codeblock] + </description> + </method> + <method name="erase"> + <return type="void"> + </return> + <argument index="0" name="property" type="String"> + </argument> + <description> + Erase a given setting (pass full property path). + </description> + </method> + <method name="get_favorite_dirs" qualifiers="const"> + <return type="PoolStringArray"> + </return> + <description> + Get the list of favorite directories for this project. + </description> + </method> + <method name="get_project_settings_path" qualifiers="const"> + <return type="String"> + </return> + <description> + Get the specific project settings path. Projects all have a unique sub-directory inside the settings path where project specific settings are saved. + </description> + </method> + <method name="get_recent_dirs" qualifiers="const"> + <return type="PoolStringArray"> + </return> + <description> + Get the list of recently visited folders in the file dialog for this project. + </description> + </method> + <method name="get_settings_path" qualifiers="const"> + <return type="String"> + </return> + <description> + Get the global settings path for the engine. Inside this path you can find some standard paths such as: + settings/tmp - used for temporary storage of files + settings/templates - where export templates are located + </description> + </method> + <method name="set_favorite_dirs"> + <return type="void"> + </return> + <argument index="0" name="dirs" type="PoolStringArray"> + </argument> + <description> + Set the list of favorite directories for this project. + </description> + </method> + <method name="set_recent_dirs"> + <return type="void"> + </return> + <argument index="0" name="dirs" type="PoolStringArray"> + </argument> + <description> + Set the list of recently visited folders in the file dialog for this project. + </description> + </method> + </methods> + <signals> + <signal name="settings_changed"> + <description> + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/EditorSpatialGizmo.xml b/doc/classes/EditorSpatialGizmo.xml new file mode 100644 index 0000000000..de9ea5282a --- /dev/null +++ b/doc/classes/EditorSpatialGizmo.xml @@ -0,0 +1,152 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EditorSpatialGizmo" inherits="SpatialGizmo" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Custom gizmo for editing Spatial objects. + </brief_description> + <description> + Custom gizmo that is used for providing custom visualization and editing (handles) for 3D Spatial objects. These are created by [method EditorPlugin.create_spatial_gizmo]. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_collision_segments"> + <return type="void"> + </return> + <argument index="0" name="segments" type="PoolVector3Array"> + </argument> + <description> + </description> + </method> + <method name="add_collision_triangles"> + <return type="void"> + </return> + <argument index="0" name="triangles" type="TriangleMesh"> + </argument> + <description> + Add collision triangles to the gizmo for picking. A [TriangleMesh] can be generated from a regular [Mesh] too. Call this function during [method redraw]. + </description> + </method> + <method name="add_handles"> + <return type="void"> + </return> + <argument index="0" name="handles" type="PoolVector3Array"> + </argument> + <argument index="1" name="billboard" type="bool" default="false"> + </argument> + <argument index="2" name="secondary" type="bool" default="false"> + </argument> + <description> + Add a list of handles (points) which can be used to deform the object being edited. + There are virtual functions which will be called upon editing of these handles. Call this function during [method redraw]. + </description> + </method> + <method name="add_lines"> + <return type="void"> + </return> + <argument index="0" name="lines" type="PoolVector3Array"> + </argument> + <argument index="1" name="material" type="Material"> + </argument> + <argument index="2" name="billboard" type="bool" default="false"> + </argument> + <description> + Add lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this function during [method redraw]. + </description> + </method> + <method name="add_mesh"> + <return type="void"> + </return> + <argument index="0" name="mesh" type="ArrayMesh"> + </argument> + <argument index="1" name="billboard" type="bool" default="false"> + </argument> + <argument index="2" name="skeleton" type="RID"> + </argument> + <description> + </description> + </method> + <method name="add_unscaled_billboard"> + <return type="void"> + </return> + <argument index="0" name="material" type="Material"> + </argument> + <argument index="1" name="default_scale" type="float" default="1"> + </argument> + <description> + Add an unscaled billboard for visualization. Call this function during [method redraw]. + </description> + </method> + <method name="clear"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="commit_handle" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <argument index="1" name="restore" type="Variant"> + </argument> + <argument index="2" name="cancel" type="bool" default="false"> + </argument> + <description> + Commit a handle being edited (handles must have been prevously added by [method add_handles]). + If the cancel parameter is true, an option to restore the edited value to the original is provided. + </description> + </method> + <method name="get_handle_name" qualifiers="virtual"> + <return type="String"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <description> + Get the name of an edited handle (handles must have been previously added by [method add_handles]). + Handles can be named for reference to the user when editing. + </description> + </method> + <method name="get_handle_value" qualifiers="virtual"> + <return type="Variant"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <description> + Get actual value of a handle. This value can be anything and used for eventually undoing the motion when calling [method commit_handle] + </description> + </method> + <method name="redraw" qualifiers="virtual"> + <return type="void"> + </return> + <description> + This function is called when the Spatial this gizmo refers to changes (the [method Spatial.update_gizmo] is called). + </description> + </method> + <method name="set_handle" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <argument index="1" name="camera" type="Camera"> + </argument> + <argument index="2" name="point" type="Vector2"> + </argument> + <description> + This function is used when the user drags a gizmo handle (previously added with [method add_handles]) in screen coordinates. + The [Camera] is also provided so screen coordinates can be converted to raycasts. + </description> + </method> + <method name="set_spatial_node"> + <return type="void"> + </return> + <argument index="0" name="node" type="Node"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/EncodedObjectAsID.xml b/doc/classes/EncodedObjectAsID.xml new file mode 100644 index 0000000000..412e60bf99 --- /dev/null +++ b/doc/classes/EncodedObjectAsID.xml @@ -0,0 +1,29 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="EncodedObjectAsID" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_object_id" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_object_id"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Engine.xml b/doc/classes/Engine.xml new file mode 100644 index 0000000000..2372c619f5 --- /dev/null +++ b/doc/classes/Engine.xml @@ -0,0 +1,114 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Engine" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_frames_drawn"> + <return type="int"> + </return> + <description> + Return the total amount of frames drawn. + </description> + </method> + <method name="get_frames_per_second" qualifiers="const"> + <return type="float"> + </return> + <description> + Returns the frames per second of the running game. + </description> + </method> + <method name="get_iterations_per_second" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the amount of fixed iterations per second (for fixed process and physics). + </description> + </method> + <method name="get_main_loop" qualifiers="const"> + <return type="MainLoop"> + </return> + <description> + Return the main loop object (see [MainLoop] and [SceneTree]). + </description> + </method> + <method name="get_target_fps" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_time_scale"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_version_info" qualifiers="const"> + <return type="Dictionary"> + </return> + <description> + Returns the current engine version information in a Dictionary. + + "major" - Holds the major version number as a String + "minor" - Holds the minor version number as a String + "patch" - Holds the patch version number as a String + "status" - Holds the status (e.g. "beta", "rc1", "rc2", ... "stable") as a String + "revision" - Holds the revision (e.g. "custom-build") as a String + "string" - major + minor + patch + status + revision in a single String + </description> + </method> + <method name="is_editor_hint" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_in_fixed_frame" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_editor_hint"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_iterations_per_second"> + <return type="void"> + </return> + <argument index="0" name="iterations_per_second" type="int"> + </argument> + <description> + Set the amount of fixed iterations per second (for fixed process and physics). + </description> + </method> + <method name="set_target_fps"> + <return type="void"> + </return> + <argument index="0" name="target_fps" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_time_scale"> + <return type="void"> + </return> + <argument index="0" name="time_scale" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml new file mode 100644 index 0000000000..4338b188a6 --- /dev/null +++ b/doc/classes/Environment.xml @@ -0,0 +1,1173 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Environment" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_adjustment_brightness" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_adjustment_color_correction" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="get_adjustment_contrast" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_adjustment_saturation" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_ambient_light_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_ambient_light_energy" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_ambient_light_sky_contribution" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_background" qualifiers="const"> + <return type="int" enum="Environment.BGMode"> + </return> + <description> + </description> + </method> + <method name="get_bg_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_bg_energy" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_canvas_max_layer" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_dof_blur_far_amount" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_dof_blur_far_distance" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_dof_blur_far_quality" qualifiers="const"> + <return type="int" enum="Environment.DOFBlurQuality"> + </return> + <description> + </description> + </method> + <method name="get_dof_blur_far_transition" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_dof_blur_near_amount" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_dof_blur_near_distance" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_dof_blur_near_quality" qualifiers="const"> + <return type="int" enum="Environment.DOFBlurQuality"> + </return> + <description> + </description> + </method> + <method name="get_dof_blur_near_transition" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_fog_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_fog_depth_begin" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_fog_depth_curve" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_fog_height_curve" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_fog_height_max" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_fog_height_min" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_fog_sun_amount" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_fog_sun_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_fog_transmit_curve" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_glow_blend_mode" qualifiers="const"> + <return type="int" enum="Environment.GlowBlendMode"> + </return> + <description> + </description> + </method> + <method name="get_glow_bloom" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_glow_hdr_bleed_scale" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_glow_hdr_bleed_threshold" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_glow_intensity" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_glow_strength" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_sky" qualifiers="const"> + <return type="Sky"> + </return> + <description> + </description> + </method> + <method name="get_sky_scale" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_ssao_bias" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_ssao_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_ssao_direct_light_affect" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_ssao_intensity" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_ssao_intensity2" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_ssao_radius" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_ssao_radius2" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_ssr_depth_tolerance" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_ssr_fade_in" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_ssr_fade_out" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_ssr_max_steps" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_tonemap_auto_exposure" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_tonemap_auto_exposure_grey" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_tonemap_auto_exposure_max" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_tonemap_auto_exposure_min" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_tonemap_auto_exposure_speed" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_tonemap_exposure" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_tonemap_white" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_tonemapper" qualifiers="const"> + <return type="int" enum="Environment.ToneMapper"> + </return> + <description> + </description> + </method> + <method name="is_adjustment_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_dof_blur_far_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_dof_blur_near_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_fog_depth_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_fog_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_fog_height_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_fog_transmit_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_glow_bicubic_upscale_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_glow_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_glow_level_enabled" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="is_ssao_blur_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_ssao_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_ssr_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_ssr_rough" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_adjustment_brightness"> + <return type="void"> + </return> + <argument index="0" name="brightness" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_adjustment_color_correction"> + <return type="void"> + </return> + <argument index="0" name="color_correction" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_adjustment_contrast"> + <return type="void"> + </return> + <argument index="0" name="contrast" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_adjustment_enable"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_adjustment_saturation"> + <return type="void"> + </return> + <argument index="0" name="saturation" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_ambient_light_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_ambient_light_energy"> + <return type="void"> + </return> + <argument index="0" name="energy" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_ambient_light_sky_contribution"> + <return type="void"> + </return> + <argument index="0" name="energy" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_background"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="Environment.BGMode"> + </argument> + <description> + </description> + </method> + <method name="set_bg_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_bg_energy"> + <return type="void"> + </return> + <argument index="0" name="energy" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_canvas_max_layer"> + <return type="void"> + </return> + <argument index="0" name="layer" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_dof_blur_far_amount"> + <return type="void"> + </return> + <argument index="0" name="intensity" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_dof_blur_far_distance"> + <return type="void"> + </return> + <argument index="0" name="intensity" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_dof_blur_far_enabled"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_dof_blur_far_quality"> + <return type="void"> + </return> + <argument index="0" name="intensity" type="int" enum="Environment.DOFBlurQuality"> + </argument> + <description> + </description> + </method> + <method name="set_dof_blur_far_transition"> + <return type="void"> + </return> + <argument index="0" name="intensity" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_dof_blur_near_amount"> + <return type="void"> + </return> + <argument index="0" name="intensity" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_dof_blur_near_distance"> + <return type="void"> + </return> + <argument index="0" name="intensity" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_dof_blur_near_enabled"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_dof_blur_near_quality"> + <return type="void"> + </return> + <argument index="0" name="level" type="int" enum="Environment.DOFBlurQuality"> + </argument> + <description> + </description> + </method> + <method name="set_dof_blur_near_transition"> + <return type="void"> + </return> + <argument index="0" name="intensity" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_fog_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_fog_depth_begin"> + <return type="void"> + </return> + <argument index="0" name="distance" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_fog_depth_curve"> + <return type="void"> + </return> + <argument index="0" name="curve" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_fog_depth_enabled"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_fog_enabled"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_fog_height_curve"> + <return type="void"> + </return> + <argument index="0" name="curve" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_fog_height_enabled"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_fog_height_max"> + <return type="void"> + </return> + <argument index="0" name="height" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_fog_height_min"> + <return type="void"> + </return> + <argument index="0" name="height" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_fog_sun_amount"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_fog_sun_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_fog_transmit_curve"> + <return type="void"> + </return> + <argument index="0" name="curve" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_fog_transmit_enabled"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_glow_bicubic_upscale"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_glow_blend_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="Environment.GlowBlendMode"> + </argument> + <description> + </description> + </method> + <method name="set_glow_bloom"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_glow_enabled"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_glow_hdr_bleed_scale"> + <return type="void"> + </return> + <argument index="0" name="scale" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_glow_hdr_bleed_threshold"> + <return type="void"> + </return> + <argument index="0" name="threshold" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_glow_intensity"> + <return type="void"> + </return> + <argument index="0" name="intensity" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_glow_level"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_glow_strength"> + <return type="void"> + </return> + <argument index="0" name="strength" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_sky"> + <return type="void"> + </return> + <argument index="0" name="sky" type="Sky"> + </argument> + <description> + </description> + </method> + <method name="set_sky_scale"> + <return type="void"> + </return> + <argument index="0" name="scale" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_ssao_bias"> + <return type="void"> + </return> + <argument index="0" name="bias" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_ssao_blur"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_ssao_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_ssao_direct_light_affect"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_ssao_enabled"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_ssao_intensity"> + <return type="void"> + </return> + <argument index="0" name="intensity" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_ssao_intensity2"> + <return type="void"> + </return> + <argument index="0" name="intensity" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_ssao_radius"> + <return type="void"> + </return> + <argument index="0" name="radius" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_ssao_radius2"> + <return type="void"> + </return> + <argument index="0" name="radius" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_ssr_depth_tolerance"> + <return type="void"> + </return> + <argument index="0" name="depth_tolerance" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_ssr_enabled"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_ssr_fade_in"> + <return type="void"> + </return> + <argument index="0" name="fade_in" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_ssr_fade_out"> + <return type="void"> + </return> + <argument index="0" name="fade_out" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_ssr_max_steps"> + <return type="void"> + </return> + <argument index="0" name="max_steps" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_ssr_rough"> + <return type="void"> + </return> + <argument index="0" name="rough" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_tonemap_auto_exposure"> + <return type="void"> + </return> + <argument index="0" name="auto_exposure" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_tonemap_auto_exposure_grey"> + <return type="void"> + </return> + <argument index="0" name="exposure_grey" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_tonemap_auto_exposure_max"> + <return type="void"> + </return> + <argument index="0" name="exposure_max" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_tonemap_auto_exposure_min"> + <return type="void"> + </return> + <argument index="0" name="exposure_min" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_tonemap_auto_exposure_speed"> + <return type="void"> + </return> + <argument index="0" name="exposure_speed" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_tonemap_exposure"> + <return type="void"> + </return> + <argument index="0" name="exposure" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_tonemap_white"> + <return type="void"> + </return> + <argument index="0" name="white" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_tonemapper"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="Environment.ToneMapper"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="adjustment_brightness" type="float" setter="set_adjustment_brightness" getter="get_adjustment_brightness"> + </member> + <member name="adjustment_color_correction" type="Texture" setter="set_adjustment_color_correction" getter="get_adjustment_color_correction"> + </member> + <member name="adjustment_contrast" type="float" setter="set_adjustment_contrast" getter="get_adjustment_contrast"> + </member> + <member name="adjustment_enabled" type="bool" setter="set_adjustment_enable" getter="is_adjustment_enabled"> + </member> + <member name="adjustment_saturation" type="float" setter="set_adjustment_saturation" getter="get_adjustment_saturation"> + </member> + <member name="ambient_light_color" type="Color" setter="set_ambient_light_color" getter="get_ambient_light_color"> + </member> + <member name="ambient_light_energy" type="float" setter="set_ambient_light_energy" getter="get_ambient_light_energy"> + </member> + <member name="ambient_light_sky_contribution" type="float" setter="set_ambient_light_sky_contribution" getter="get_ambient_light_sky_contribution"> + </member> + <member name="auto_exposure_enabled" type="bool" setter="set_tonemap_auto_exposure" getter="get_tonemap_auto_exposure"> + </member> + <member name="auto_exposure_max_luma" type="float" setter="set_tonemap_auto_exposure_max" getter="get_tonemap_auto_exposure_max"> + </member> + <member name="auto_exposure_min_luma" type="float" setter="set_tonemap_auto_exposure_min" getter="get_tonemap_auto_exposure_min"> + </member> + <member name="auto_exposure_scale" type="float" setter="set_tonemap_auto_exposure_grey" getter="get_tonemap_auto_exposure_grey"> + </member> + <member name="auto_exposure_speed" type="float" setter="set_tonemap_auto_exposure_speed" getter="get_tonemap_auto_exposure_speed"> + </member> + <member name="background_canvas_max_layer" type="int" setter="set_canvas_max_layer" getter="get_canvas_max_layer"> + </member> + <member name="background_color" type="Color" setter="set_bg_color" getter="get_bg_color"> + </member> + <member name="background_energy" type="float" setter="set_bg_energy" getter="get_bg_energy"> + </member> + <member name="background_mode" type="int" setter="set_background" getter="get_background" enum="Environment.BGMode"> + </member> + <member name="background_sky" type="Sky" setter="set_sky" getter="get_sky"> + </member> + <member name="background_sky_scale" type="float" setter="set_sky_scale" getter="get_sky_scale"> + </member> + <member name="dof_blur_far_amount" type="float" setter="set_dof_blur_far_amount" getter="get_dof_blur_far_amount"> + </member> + <member name="dof_blur_far_distance" type="float" setter="set_dof_blur_far_distance" getter="get_dof_blur_far_distance"> + </member> + <member name="dof_blur_far_enabled" type="bool" setter="set_dof_blur_far_enabled" getter="is_dof_blur_far_enabled"> + </member> + <member name="dof_blur_far_quality" type="int" setter="set_dof_blur_far_quality" getter="get_dof_blur_far_quality" enum="Environment.DOFBlurQuality"> + </member> + <member name="dof_blur_far_transition" type="float" setter="set_dof_blur_far_transition" getter="get_dof_blur_far_transition"> + </member> + <member name="dof_blur_near_amount" type="float" setter="set_dof_blur_near_amount" getter="get_dof_blur_near_amount"> + </member> + <member name="dof_blur_near_distance" type="float" setter="set_dof_blur_near_distance" getter="get_dof_blur_near_distance"> + </member> + <member name="dof_blur_near_enabled" type="bool" setter="set_dof_blur_near_enabled" getter="is_dof_blur_near_enabled"> + </member> + <member name="dof_blur_near_quality" type="int" setter="set_dof_blur_near_quality" getter="get_dof_blur_near_quality" enum="Environment.DOFBlurQuality"> + </member> + <member name="dof_blur_near_transition" type="float" setter="set_dof_blur_near_transition" getter="get_dof_blur_near_transition"> + </member> + <member name="fog_color" type="Color" setter="set_fog_color" getter="get_fog_color"> + </member> + <member name="fog_depth_begin" type="float" setter="set_fog_depth_begin" getter="get_fog_depth_begin"> + </member> + <member name="fog_depth_curve" type="float" setter="set_fog_depth_curve" getter="get_fog_depth_curve"> + </member> + <member name="fog_depth_enabled" type="bool" setter="set_fog_depth_enabled" getter="is_fog_depth_enabled"> + </member> + <member name="fog_enabled" type="bool" setter="set_fog_enabled" getter="is_fog_enabled"> + </member> + <member name="fog_height_curve" type="float" setter="set_fog_height_curve" getter="get_fog_height_curve"> + </member> + <member name="fog_height_enabled" type="bool" setter="set_fog_height_enabled" getter="is_fog_height_enabled"> + </member> + <member name="fog_height_max" type="float" setter="set_fog_height_max" getter="get_fog_height_max"> + </member> + <member name="fog_height_min" type="float" setter="set_fog_height_min" getter="get_fog_height_min"> + </member> + <member name="fog_sun_amount" type="float" setter="set_fog_sun_amount" getter="get_fog_sun_amount"> + </member> + <member name="fog_sun_color" type="Color" setter="set_fog_sun_color" getter="get_fog_sun_color"> + </member> + <member name="fog_transmit_curve" type="float" setter="set_fog_transmit_curve" getter="get_fog_transmit_curve"> + </member> + <member name="fog_transmit_enabled" type="bool" setter="set_fog_transmit_enabled" getter="is_fog_transmit_enabled"> + </member> + <member name="glow_bicubic_upscale" type="bool" setter="set_glow_bicubic_upscale" getter="is_glow_bicubic_upscale_enabled"> + </member> + <member name="glow_blend_mode" type="int" setter="set_glow_blend_mode" getter="get_glow_blend_mode" enum="Environment.GlowBlendMode"> + </member> + <member name="glow_bloom" type="float" setter="set_glow_bloom" getter="get_glow_bloom"> + </member> + <member name="glow_enabled" type="bool" setter="set_glow_enabled" getter="is_glow_enabled"> + </member> + <member name="glow_hdr_scale" type="float" setter="set_glow_hdr_bleed_scale" getter="get_glow_hdr_bleed_scale"> + </member> + <member name="glow_hdr_threshold" type="float" setter="set_glow_hdr_bleed_threshold" getter="get_glow_hdr_bleed_threshold"> + </member> + <member name="glow_intensity" type="float" setter="set_glow_intensity" getter="get_glow_intensity"> + </member> + <member name="glow_levels/1" type="bool" setter="set_glow_level" getter="is_glow_level_enabled"> + </member> + <member name="glow_levels/2" type="bool" setter="set_glow_level" getter="is_glow_level_enabled"> + </member> + <member name="glow_levels/3" type="bool" setter="set_glow_level" getter="is_glow_level_enabled"> + </member> + <member name="glow_levels/4" type="bool" setter="set_glow_level" getter="is_glow_level_enabled"> + </member> + <member name="glow_levels/5" type="bool" setter="set_glow_level" getter="is_glow_level_enabled"> + </member> + <member name="glow_levels/6" type="bool" setter="set_glow_level" getter="is_glow_level_enabled"> + </member> + <member name="glow_levels/7" type="bool" setter="set_glow_level" getter="is_glow_level_enabled"> + </member> + <member name="glow_strength" type="float" setter="set_glow_strength" getter="get_glow_strength"> + </member> + <member name="ss_reflections_depth_tolerance" type="float" setter="set_ssr_depth_tolerance" getter="get_ssr_depth_tolerance"> + </member> + <member name="ss_reflections_enabled" type="bool" setter="set_ssr_enabled" getter="is_ssr_enabled"> + </member> + <member name="ss_reflections_fade_in" type="float" setter="set_ssr_fade_in" getter="get_ssr_fade_in"> + </member> + <member name="ss_reflections_fade_out" type="float" setter="set_ssr_fade_out" getter="get_ssr_fade_out"> + </member> + <member name="ss_reflections_max_steps" type="int" setter="set_ssr_max_steps" getter="get_ssr_max_steps"> + </member> + <member name="ss_reflections_roughness" type="bool" setter="set_ssr_rough" getter="is_ssr_rough"> + </member> + <member name="ssao_bias" type="float" setter="set_ssao_bias" getter="get_ssao_bias"> + </member> + <member name="ssao_blur" type="bool" setter="set_ssao_blur" getter="is_ssao_blur_enabled"> + </member> + <member name="ssao_color" type="Color" setter="set_ssao_color" getter="get_ssao_color"> + </member> + <member name="ssao_enabled" type="bool" setter="set_ssao_enabled" getter="is_ssao_enabled"> + </member> + <member name="ssao_intensity" type="float" setter="set_ssao_intensity" getter="get_ssao_intensity"> + </member> + <member name="ssao_intensity2" type="float" setter="set_ssao_intensity2" getter="get_ssao_intensity2"> + </member> + <member name="ssao_light_affect" type="float" setter="set_ssao_direct_light_affect" getter="get_ssao_direct_light_affect"> + </member> + <member name="ssao_radius" type="float" setter="set_ssao_radius" getter="get_ssao_radius"> + </member> + <member name="ssao_radius2" type="float" setter="set_ssao_radius2" getter="get_ssao_radius2"> + </member> + <member name="tonemap_exposure" type="float" setter="set_tonemap_exposure" getter="get_tonemap_exposure"> + </member> + <member name="tonemap_mode" type="int" setter="set_tonemapper" getter="get_tonemapper" enum="Environment.ToneMapper"> + </member> + <member name="tonemap_white" type="float" setter="set_tonemap_white" getter="get_tonemap_white"> + </member> + </members> + <constants> + <constant name="BG_KEEP" value="5"> + </constant> + <constant name="BG_CLEAR_COLOR" value="0"> + </constant> + <constant name="BG_COLOR" value="1"> + </constant> + <constant name="BG_SKY" value="2"> + </constant> + <constant name="BG_COLOR_SKY" value="3"> + </constant> + <constant name="BG_CANVAS" value="4"> + </constant> + <constant name="BG_MAX" value="6"> + </constant> + <constant name="GLOW_BLEND_MODE_ADDITIVE" value="0"> + </constant> + <constant name="GLOW_BLEND_MODE_SCREEN" value="1"> + </constant> + <constant name="GLOW_BLEND_MODE_SOFTLIGHT" value="2"> + </constant> + <constant name="GLOW_BLEND_MODE_REPLACE" value="3"> + </constant> + <constant name="TONE_MAPPER_LINEAR" value="0"> + </constant> + <constant name="TONE_MAPPER_REINHARDT" value="1"> + </constant> + <constant name="TONE_MAPPER_FILMIC" value="2"> + </constant> + <constant name="TONE_MAPPER_ACES" value="3"> + </constant> + <constant name="DOF_BLUR_QUALITY_LOW" value="0"> + </constant> + <constant name="DOF_BLUR_QUALITY_MEDIUM" value="1"> + </constant> + <constant name="DOF_BLUR_QUALITY_HIGH" value="2"> + </constant> + </constants> +</class> diff --git a/doc/classes/File.xml b/doc/classes/File.xml new file mode 100644 index 0000000000..4e73cd8ae2 --- /dev/null +++ b/doc/classes/File.xml @@ -0,0 +1,420 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="File" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Type to handle file reading and writing operations. + </brief_description> + <description> + File type. This is used to permanently store data into the user device's file system and to read from it. This can be used to store game save data or player configuration files, for example. + Here's a sample on how to write and read from a file: + [codeblock] + func save(content): + var file = File.new() + file.open("user://save_game.dat", file.WRITE) + file.store_string(content) + file.close() + + func load(): + var file = File.new() + file.open("user://save_game.dat", file.READ) + var content = file.get_as_text() + file.close() + return content + [/codeblock] + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="close"> + <return type="void"> + </return> + <description> + Close the currently opened file. + </description> + </method> + <method name="eof_reached" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether the file cursor reached the end of the file. + </description> + </method> + <method name="file_exists" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + Get whether or not the file in the specified path exists. + </description> + </method> + <method name="get_16" qualifiers="const"> + <return type="int"> + </return> + <description> + Get the next 16 bits from the file as an integer. + </description> + </method> + <method name="get_32" qualifiers="const"> + <return type="int"> + </return> + <description> + Get the next 32 bits from the file as an integer. + </description> + </method> + <method name="get_64" qualifiers="const"> + <return type="int"> + </return> + <description> + Get the next 64 bits from the file as an integer. + </description> + </method> + <method name="get_8" qualifiers="const"> + <return type="int"> + </return> + <description> + Get the next 8 bits from the file as an integer. + </description> + </method> + <method name="get_as_text" qualifiers="const"> + <return type="String"> + </return> + <description> + Get the whole file as a [String]. + </description> + </method> + <method name="get_buffer" qualifiers="const"> + <return type="PoolByteArray"> + </return> + <argument index="0" name="len" type="int"> + </argument> + <description> + Get next len bytes of the file as a [PoolByteArray]. + </description> + </method> + <method name="get_csv_line" qualifiers="const"> + <return type="PoolStringArray"> + </return> + <argument index="0" name="delim" type="String" default="",""> + </argument> + <description> + Get the next value of the file in CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma). + </description> + </method> + <method name="get_double" qualifiers="const"> + <return type="float"> + </return> + <description> + Get the next 64 bits from the file as a floating point number. + </description> + </method> + <method name="get_endian_swap"> + <return type="bool"> + </return> + <description> + Get whether endian swap is enabled for this file. + </description> + </method> + <method name="get_error" qualifiers="const"> + <return type="int" enum="Error"> + </return> + <description> + Get the last error that happened when trying to perform operations. Compare with the [code]ERR_FILE_*[/code] constants from [@Global Scope]. + </description> + </method> + <method name="get_float" qualifiers="const"> + <return type="float"> + </return> + <description> + Get the next 32 bits from the file as a floating point number. + </description> + </method> + <method name="get_len" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the size of the file in bytes. + </description> + </method> + <method name="get_line" qualifiers="const"> + <return type="String"> + </return> + <description> + Get the next line of the file as a [String]. + </description> + </method> + <method name="get_md5" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + Return a md5 String representing the file at the given path or an empty [String] on failure. + </description> + </method> + <method name="get_modified_time" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="file" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_pascal_string"> + <return type="String"> + </return> + <description> + Get a [String] saved in Pascal format from the file. + </description> + </method> + <method name="get_pos" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the file cursor position. + </description> + </method> + <method name="get_real" qualifiers="const"> + <return type="float"> + </return> + <description> + Get the next bits from the file as a floating point number. + </description> + </method> + <method name="get_sha256" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + Return a sha256 String representing the file at the given path or an empty [String] on failure. + </description> + </method> + <method name="get_var" qualifiers="const"> + <return type="Variant"> + </return> + <description> + Get the next Variant value from the file. + </description> + </method> + <method name="is_open" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether the file is currently opened. + </description> + </method> + <method name="open"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="flags" type="int"> + </argument> + <description> + Open the file for writing or reading, depending on the flags. + </description> + </method> + <method name="open_compressed"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="mode_flags" type="int"> + </argument> + <argument index="2" name="compression_mode" type="int" default="0"> + </argument> + <description> + Open a compressed file for reading or writing. The compression_mode can be set as one of the COMPRESSION_* constants. + </description> + </method> + <method name="open_encrypted"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="mode_flags" type="int"> + </argument> + <argument index="2" name="key" type="PoolByteArray"> + </argument> + <description> + Open an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it. + </description> + </method> + <method name="open_encrypted_with_pass"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="mode_flags" type="int"> + </argument> + <argument index="2" name="pass" type="String"> + </argument> + <description> + Open an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it. + </description> + </method> + <method name="seek"> + <return type="void"> + </return> + <argument index="0" name="pos" type="int"> + </argument> + <description> + Change the file reading/writing cursor to the specified position (in bytes from the beginning of the file). + </description> + </method> + <method name="seek_end"> + <return type="void"> + </return> + <argument index="0" name="pos" type="int" default="0"> + </argument> + <description> + 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. + </description> + </method> + <method name="set_endian_swap"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set whether to swap the endianness of the file. Enable this if you're dealing with files written in big endian machines. + Note that this is about the file format, not CPU type. This is always reseted to [code]false[/code] whenever you open the file. + </description> + </method> + <method name="store_16"> + <return type="void"> + </return> + <argument index="0" name="value" type="int"> + </argument> + <description> + Store an integer as 16 bits in the file. + </description> + </method> + <method name="store_32"> + <return type="void"> + </return> + <argument index="0" name="value" type="int"> + </argument> + <description> + Store an integer as 32 bits in the file. + </description> + </method> + <method name="store_64"> + <return type="void"> + </return> + <argument index="0" name="value" type="int"> + </argument> + <description> + Store an integer as 64 bits in the file. + </description> + </method> + <method name="store_8"> + <return type="void"> + </return> + <argument index="0" name="value" type="int"> + </argument> + <description> + Store an integer as 8 bits in the file. + </description> + </method> + <method name="store_buffer"> + <return type="void"> + </return> + <argument index="0" name="buffer" type="PoolByteArray"> + </argument> + <description> + Store the given array of bytes in the file. + </description> + </method> + <method name="store_double"> + <return type="void"> + </return> + <argument index="0" name="value" type="float"> + </argument> + <description> + Store a floating point number as 64 bits in the file. + </description> + </method> + <method name="store_float"> + <return type="void"> + </return> + <argument index="0" name="value" type="float"> + </argument> + <description> + Store a floating point number as 32 bits in the file. + </description> + </method> + <method name="store_line"> + <return type="void"> + </return> + <argument index="0" name="line" type="String"> + </argument> + <description> + Store the given [String] as a line in the file. + </description> + </method> + <method name="store_pascal_string"> + <return type="void"> + </return> + <argument index="0" name="string" type="String"> + </argument> + <description> + Store the given [String] as a line in the file in Pascal format (i.e. also store the length of the string). + </description> + </method> + <method name="store_real"> + <return type="void"> + </return> + <argument index="0" name="value" type="float"> + </argument> + <description> + Store a floating point number in the file. + </description> + </method> + <method name="store_string"> + <return type="void"> + </return> + <argument index="0" name="string" type="String"> + </argument> + <description> + Store the given [String] in the file. + </description> + </method> + <method name="store_var"> + <return type="void"> + </return> + <argument index="0" name="value" type="Variant"> + </argument> + <description> + Store any Variant value in the file. + </description> + </method> + </methods> + <constants> + <constant name="READ" value="1"> + Open the file for reading. + </constant> + <constant name="WRITE" value="2"> + Open the file for writing. Create it if the file not exists and truncate if it exists. + </constant> + <constant name="READ_WRITE" value="3"> + Open the file for reading and writing, without truncating the file. + </constant> + <constant name="WRITE_READ" value="7"> + Open the file for reading and writing. Create it if the file not exists and truncate if it exists. + </constant> + <constant name="COMPRESSION_FASTLZ" value="0"> + Use the FastLZ compression method. + </constant> + <constant name="COMPRESSION_DEFLATE" value="1"> + Use the Deflate compression method. + </constant> + <constant name="COMPRESSION_ZSTD" value="2"> + Use the Zstd compression method. + </constant> + <constant name="COMPRESSION_GZIP" value="3"> + </constant> + </constants> +</class> diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml new file mode 100644 index 0000000000..d7a08368a5 --- /dev/null +++ b/doc/classes/FileDialog.xml @@ -0,0 +1,222 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="FileDialog" inherits="ConfirmationDialog" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Dialog for selecting files or directories in the filesystem. + </brief_description> + <description> + FileDialog is a preset dialog used to choose files and directories in the filesystem. It supports filter masks. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_filter"> + <return type="void"> + </return> + <argument index="0" name="filter" type="String"> + </argument> + <description> + Add a custom filter. Filter format is: "mask ; description", example (C++): dialog->add_filter("*.png ; PNG Images"); + </description> + </method> + <method name="clear_filters"> + <return type="void"> + </return> + <description> + Clear all the added filters in the dialog. + </description> + </method> + <method name="get_access" qualifiers="const"> + <return type="int" enum="FileDialog.Access"> + </return> + <description> + Return the file access permission of the dialog. + </description> + </method> + <method name="get_current_dir" qualifiers="const"> + <return type="String"> + </return> + <description> + Get the current working directory of the file dialog. + </description> + </method> + <method name="get_current_file" qualifiers="const"> + <return type="String"> + </return> + <description> + Get the current selected file of the file dialog (empty if none). + </description> + </method> + <method name="get_current_path" qualifiers="const"> + <return type="String"> + </return> + <description> + Get the current selected path (directory and file) of the file dialog (empty if none). + </description> + </method> + <method name="get_filters" qualifiers="const"> + <return type="PoolStringArray"> + </return> + <description> + </description> + </method> + <method name="get_mode" qualifiers="const"> + <return type="int" enum="FileDialog.Mode"> + </return> + <description> + Get the file dialog mode from the MODE_* enum. + </description> + </method> + <method name="get_vbox"> + <return type="VBoxContainer"> + </return> + <description> + Return the vertical box container of the dialog, custom controls can be added to it. + </description> + </method> + <method name="invalidate"> + <return type="void"> + </return> + <description> + Invalidate and update the current dialog content list. + </description> + </method> + <method name="is_showing_hidden_files" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if the diaog allows show hidden files. + </description> + </method> + <method name="set_access"> + <return type="void"> + </return> + <argument index="0" name="access" type="int" enum="FileDialog.Access"> + </argument> + <description> + Set the file access permission of the dialog(Must be one of [ACCESS_RESOURCES], [ACCESS_USERDATA] or [ACCESS_FILESYSTEM]). + </description> + </method> + <method name="set_current_dir"> + <return type="void"> + </return> + <argument index="0" name="dir" type="String"> + </argument> + <description> + Set the current working directory of the file dialog. + </description> + </method> + <method name="set_current_file"> + <return type="void"> + </return> + <argument index="0" name="file" type="String"> + </argument> + <description> + Set the current selected file name of the file dialog. + </description> + </method> + <method name="set_current_path"> + <return type="void"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + Set the current selected file path of the file dialog. + </description> + </method> + <method name="set_filters"> + <return type="void"> + </return> + <argument index="0" name="filters" type="PoolStringArray"> + </argument> + <description> + </description> + </method> + <method name="set_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="FileDialog.Mode"> + </argument> + <description> + Set the file dialog mode from the MODE_* enum. + </description> + </method> + <method name="set_show_hidden_files"> + <return type="void"> + </return> + <argument index="0" name="show" type="bool"> + </argument> + <description> + Set the dialog should show hidden files. + </description> + </method> + </methods> + <members> + <member name="access" type="int" setter="set_access" getter="get_access" enum="FileDialog.Access"> + </member> + <member name="filters" type="PoolStringArray" setter="set_filters" getter="get_filters"> + </member> + <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="FileDialog.Mode"> + </member> + <member name="show_hidden_files" type="bool" setter="set_show_hidden_files" getter="is_showing_hidden_files"> + </member> + </members> + <signals> + <signal name="dir_selected"> + <argument index="0" name="dir" type="String"> + </argument> + <description> + Event emitted when the user selects a directory. + </description> + </signal> + <signal name="file_selected"> + <argument index="0" name="path" type="String"> + </argument> + <description> + Event emitted when the user selects a file (double clicks it or presses the OK button). + </description> + </signal> + <signal name="files_selected"> + <argument index="0" name="paths" type="PoolStringArray"> + </argument> + <description> + Event emitted when the user selects multiple files. + </description> + </signal> + </signals> + <constants> + <constant name="MODE_OPEN_FILE" value="0"> + The dialog allows the selection of one, and only one file. + </constant> + <constant name="MODE_OPEN_FILES" value="1"> + The dialog allows the selection of multiple files. + </constant> + <constant name="MODE_OPEN_DIR" value="2"> + The dialog functions as a folder selector, disallowing the selection of any file. + </constant> + <constant name="MODE_OPEN_ANY" value="3"> + The dialog allows the selection of a file or a directory. + </constant> + <constant name="MODE_SAVE_FILE" value="4"> + The dialog will warn when a file exists. + </constant> + <constant name="ACCESS_RESOURCES" value="0"> + The dialog allows the selection of file and directory. + </constant> + <constant name="ACCESS_USERDATA" value="1"> + The dialog allows ascess files under [Resource] path(res://) . + </constant> + <constant name="ACCESS_FILESYSTEM" value="2"> + The dialog allows ascess files in whole file system. + </constant> + </constants> + <theme_items> + <theme_item name="files_disabled" type="Color"> + </theme_item> + <theme_item name="folder" type="Texture"> + </theme_item> + <theme_item name="reload" type="Texture"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/Font.xml b/doc/classes/Font.xml new file mode 100644 index 0000000000..420756975f --- /dev/null +++ b/doc/classes/Font.xml @@ -0,0 +1,94 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Font" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Internationalized font and text drawing support. + </brief_description> + <description> + Font contains a unicode compatible character set, as well as the ability to draw it with variable width, ascent, descent and kerning. For creating fonts from TTF files (or other font formats), see the editor support for fonts. TODO check wikipedia for graph of ascent/baseline/descent/height/etc. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="draw" qualifiers="const"> + <return type="void"> + </return> + <argument index="0" name="canvas_item" type="RID"> + </argument> + <argument index="1" name="pos" type="Vector2"> + </argument> + <argument index="2" name="string" type="String"> + </argument> + <argument index="3" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> + </argument> + <argument index="4" name="clip_w" type="int" default="-1"> + </argument> + <description> + 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, [i]ascent[/i] must be added to the Y axis. + </description> + </method> + <method name="draw_char" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="canvas_item" type="RID"> + </argument> + <argument index="1" name="pos" type="Vector2"> + </argument> + <argument index="2" name="char" type="int"> + </argument> + <argument index="3" name="next" type="int" default="-1"> + </argument> + <argument index="4" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> + </argument> + <description> + 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, [i]ascent[/i] 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. + </description> + </method> + <method name="get_ascent" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the font ascent (number of pixels above the baseline). + </description> + </method> + <method name="get_descent" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the font descent (number of pixels below the baseline). + </description> + </method> + <method name="get_height" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the total font height (ascent plus descent) in pixels. + </description> + </method> + <method name="get_string_size" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="string" type="String"> + </argument> + <description> + Return the size of a string, taking kerning and advance into account. + </description> + </method> + <method name="is_distance_field_hint" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="update_changes"> + <return type="void"> + </return> + <description> + After editing a font (changing size, ascent, char rects, etc.). Call this function to propagate changes to controls that might use it. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/FuncRef.xml b/doc/classes/FuncRef.xml new file mode 100644 index 0000000000..a7593dc2a1 --- /dev/null +++ b/doc/classes/FuncRef.xml @@ -0,0 +1,42 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="FuncRef" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Reference to a function in an object. + </brief_description> + <description> + In GDScript, functions are not [i]first-class objects[/i]. This means it is impossible to store them directly as variables, return them from another function, or pass them as arguments. + However, by creating a [FuncRef] using the [method @GDScript.funcref] function, a reference to a function in a given object can be created, passed around and called. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="call_func" qualifiers="vararg"> + <return type="Variant"> + </return> + <description> + </description> + </method> + <method name="set_function"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Set the name of the function to call on the object, without parentheses or any parameters. + </description> + </method> + <method name="set_instance"> + <return type="void"> + </return> + <argument index="0" name="instance" type="Object"> + </argument> + <description> + Set the object on which to call the referenced function. This object must be of a type actually inheriting from [Object], not a built-in type such as [int], [Vector2] or [Dictionary]. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/GDFunctionState.xml b/doc/classes/GDFunctionState.xml new file mode 100644 index 0000000000..801ca718e7 --- /dev/null +++ b/doc/classes/GDFunctionState.xml @@ -0,0 +1,46 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GDFunctionState" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + State of a function call after yielding. + </brief_description> + <description> + Calling [method @GDScript.yield] within a function will cause that function to yield and return its current state as an object of this type. The yielded function call can then be resumed later by calling [method resume] on this state object. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="is_valid" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="extended_check" type="bool" default="false"> + </argument> + <description> + Check whether the function call may be resumed. This is not the case if the function state was already resumed. + If [code]extended_check[/code] is enabled, it also checks if the associated script and object still exist. The extended check is done in debug mode as part of [method GDFunctionState.resume], but you can use this if you know you may be trying to resume without knowing for sure the object and/or script have survived up to that point. + </description> + </method> + <method name="resume"> + <return type="Variant"> + </return> + <argument index="0" name="arg" type="Variant" default="null"> + </argument> + <description> + Resume execution of the yielded function call. + If handed an argument, return the argument from the [method @GDScript.yield] call in the yielded function call. You can pass e.g. an [Array] to hand multiple arguments. + This function returns what the resumed function call returns, possibly another function state if yielded again. + </description> + </method> + </methods> + <signals> + <signal name="completed"> + <argument index="0" name="result" type="Nil"> + </argument> + <description> + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/GDNative.xml b/doc/classes/GDNative.xml new file mode 100644 index 0000000000..ba813c4564 --- /dev/null +++ b/doc/classes/GDNative.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GDNative" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="call_native"> + <return type="Variant"> + </return> + <argument index="0" name="procedure_name" type="String"> + </argument> + <argument index="1" name="arguments" type="String"> + </argument> + <argument index="2" name="arg2" type="Array"> + </argument> + <description> + </description> + </method> + <method name="get_library"> + <return type="GDNativeLibrary"> + </return> + <description> + </description> + </method> + <method name="initialize"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_library"> + <return type="void"> + </return> + <argument index="0" name="library" type="GDNativeLibrary"> + </argument> + <description> + </description> + </method> + <method name="terminate"> + <return type="bool"> + </return> + <description> + </description> + </method> + </methods> + <members> + <member name="library" type="GDNativeLibrary" setter="set_library" getter="get_library"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/GDNativeClass.xml b/doc/classes/GDNativeClass.xml new file mode 100644 index 0000000000..5a3f353720 --- /dev/null +++ b/doc/classes/GDNativeClass.xml @@ -0,0 +1,21 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GDNativeClass" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="new"> + <return type="Variant"> + </return> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/GDNativeLibrary.xml b/doc/classes/GDNativeLibrary.xml new file mode 100644 index 0000000000..c3561856cc --- /dev/null +++ b/doc/classes/GDNativeLibrary.xml @@ -0,0 +1,51 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GDNativeLibrary" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_library_path" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="platform" type="String"> + </argument> + <description> + </description> + </method> + <method name="is_singleton_gdnative" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_library_path"> + <return type="void"> + </return> + <argument index="0" name="platform" type="String"> + </argument> + <argument index="1" name="path" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_singleton_gdnative"> + <return type="void"> + </return> + <argument index="0" name="singleton" type="bool"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="singleton_gdnative" type="bool" setter="set_singleton_gdnative" getter="is_singleton_gdnative"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/GDScript.xml b/doc/classes/GDScript.xml new file mode 100644 index 0000000000..2faa0ff968 --- /dev/null +++ b/doc/classes/GDScript.xml @@ -0,0 +1,38 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GDScript" inherits="Script" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + A script implemented in the GDScript programming language. + </brief_description> + <description> + A script implemented in the GDScript programming language. The script exends the functionality of all objects that instance it. + [method new] creates a new instance of the script. [method Object.set_script] extends an existing object, if that object's class matches one of the script's base classes. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_as_byte_code" qualifiers="const"> + <return type="PoolByteArray"> + </return> + <description> + Returns byte code for the script source code. + </description> + </method> + <method name="new" qualifiers="vararg"> + <return type="Object"> + </return> + <description> + Returns a new instance of the script. + For example: + [codeblock] + var MyClass = load("myclass.gd") + var instance = MyClass.new() + assert(instance.get_script() == MyClass) + [/codeblock] + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/GIProbe.xml b/doc/classes/GIProbe.xml new file mode 100644 index 0000000000..9df0b80b35 --- /dev/null +++ b/doc/classes/GIProbe.xml @@ -0,0 +1,201 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GIProbe" inherits="VisualInstance" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="bake"> + <return type="void"> + </return> + <argument index="0" name="from_node" type="Node" default="null"> + </argument> + <argument index="1" name="create_visual_debug" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="debug_bake"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="get_bias" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_dynamic_range" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_energy" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_extents" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_normal_bias" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_probe_data" qualifiers="const"> + <return type="GIProbeData"> + </return> + <description> + </description> + </method> + <method name="get_propagation" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_subdiv" qualifiers="const"> + <return type="int" enum="GIProbe.Subdiv"> + </return> + <description> + </description> + </method> + <method name="is_compressed" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_interior" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_bias"> + <return type="void"> + </return> + <argument index="0" name="max" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_compress"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_dynamic_range"> + <return type="void"> + </return> + <argument index="0" name="max" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_energy"> + <return type="void"> + </return> + <argument index="0" name="max" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_extents"> + <return type="void"> + </return> + <argument index="0" name="extents" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="set_interior"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_normal_bias"> + <return type="void"> + </return> + <argument index="0" name="max" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_probe_data"> + <return type="void"> + </return> + <argument index="0" name="data" type="GIProbeData"> + </argument> + <description> + </description> + </method> + <method name="set_propagation"> + <return type="void"> + </return> + <argument index="0" name="max" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_subdiv"> + <return type="void"> + </return> + <argument index="0" name="subdiv" type="int" enum="GIProbe.Subdiv"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="bias" type="float" setter="set_bias" getter="get_bias"> + </member> + <member name="compress" type="bool" setter="set_compress" getter="is_compressed"> + </member> + <member name="data" type="GIProbeData" setter="set_probe_data" getter="get_probe_data"> + </member> + <member name="dynamic_range" type="int" setter="set_dynamic_range" getter="get_dynamic_range"> + </member> + <member name="energy" type="float" setter="set_energy" getter="get_energy"> + </member> + <member name="extents" type="Vector3" setter="set_extents" getter="get_extents"> + </member> + <member name="interior" type="bool" setter="set_interior" getter="is_interior"> + </member> + <member name="normal_bias" type="float" setter="set_normal_bias" getter="get_normal_bias"> + </member> + <member name="propagation" type="float" setter="set_propagation" getter="get_propagation"> + </member> + <member name="subdiv" type="int" setter="set_subdiv" getter="get_subdiv" enum="GIProbe.Subdiv"> + </member> + </members> + <constants> + <constant name="SUBDIV_64" value="0"> + </constant> + <constant name="SUBDIV_128" value="1"> + </constant> + <constant name="SUBDIV_256" value="2"> + </constant> + <constant name="SUBDIV_MAX" value="4"> + </constant> + </constants> +</class> diff --git a/doc/classes/GIProbeData.xml b/doc/classes/GIProbeData.xml new file mode 100644 index 0000000000..6d47daf985 --- /dev/null +++ b/doc/classes/GIProbeData.xml @@ -0,0 +1,193 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GIProbeData" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_bias" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_bounds" qualifiers="const"> + <return type="Rect3"> + </return> + <description> + </description> + </method> + <method name="get_cell_size" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_dynamic_data" qualifiers="const"> + <return type="PoolIntArray"> + </return> + <description> + </description> + </method> + <method name="get_dynamic_range" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_energy" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_normal_bias" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_propagation" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_to_cell_xform" qualifiers="const"> + <return type="Transform"> + </return> + <description> + </description> + </method> + <method name="is_compressed" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_interior" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_bias"> + <return type="void"> + </return> + <argument index="0" name="bias" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_bounds"> + <return type="void"> + </return> + <argument index="0" name="bounds" type="Rect3"> + </argument> + <description> + </description> + </method> + <method name="set_cell_size"> + <return type="void"> + </return> + <argument index="0" name="cell_size" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_compress"> + <return type="void"> + </return> + <argument index="0" name="compress" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_dynamic_data"> + <return type="void"> + </return> + <argument index="0" name="dynamic_data" type="PoolIntArray"> + </argument> + <description> + </description> + </method> + <method name="set_dynamic_range"> + <return type="void"> + </return> + <argument index="0" name="dynamic_range" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_energy"> + <return type="void"> + </return> + <argument index="0" name="energy" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_interior"> + <return type="void"> + </return> + <argument index="0" name="interior" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_normal_bias"> + <return type="void"> + </return> + <argument index="0" name="bias" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_propagation"> + <return type="void"> + </return> + <argument index="0" name="propagation" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_to_cell_xform"> + <return type="void"> + </return> + <argument index="0" name="to_cell_xform" type="Transform"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="bias" type="float" setter="set_bias" getter="get_bias"> + </member> + <member name="bounds" type="Rect3" setter="set_bounds" getter="get_bounds"> + </member> + <member name="cell_size" type="float" setter="set_cell_size" getter="get_cell_size"> + </member> + <member name="compress" type="bool" setter="set_compress" getter="is_compressed"> + </member> + <member name="dynamic_data" type="PoolIntArray" setter="set_dynamic_data" getter="get_dynamic_data"> + </member> + <member name="dynamic_range" type="int" setter="set_dynamic_range" getter="get_dynamic_range"> + </member> + <member name="energy" type="float" setter="set_energy" getter="get_energy"> + </member> + <member name="interior" type="bool" setter="set_interior" getter="is_interior"> + </member> + <member name="normal_bias" type="float" setter="set_normal_bias" getter="get_normal_bias"> + </member> + <member name="propagation" type="float" setter="set_propagation" getter="get_propagation"> + </member> + <member name="to_cell_xform" type="Transform" setter="set_to_cell_xform" getter="get_to_cell_xform"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Generic6DOFJoint.xml b/doc/classes/Generic6DOFJoint.xml new file mode 100644 index 0000000000..4b782e994a --- /dev/null +++ b/doc/classes/Generic6DOFJoint.xml @@ -0,0 +1,265 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Generic6DOFJoint" inherits="Joint" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_flag_x" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag"> + </argument> + <description> + </description> + </method> + <method name="get_flag_y" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag"> + </argument> + <description> + </description> + </method> + <method name="get_flag_z" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag"> + </argument> + <description> + </description> + </method> + <method name="get_param_x" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param"> + </argument> + <description> + </description> + </method> + <method name="get_param_y" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param"> + </argument> + <description> + </description> + </method> + <method name="get_param_z" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param"> + </argument> + <description> + </description> + </method> + <method name="set_flag_x"> + <return type="void"> + </return> + <argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_flag_y"> + <return type="void"> + </return> + <argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_flag_z"> + <return type="void"> + </return> + <argument index="0" name="flag" type="int" enum="Generic6DOFJoint.Flag"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_param_x"> + <return type="void"> + </return> + <argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param"> + </argument> + <argument index="1" name="value" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_param_y"> + <return type="void"> + </return> + <argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param"> + </argument> + <argument index="1" name="value" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_param_z"> + <return type="void"> + </return> + <argument index="0" name="param" type="int" enum="Generic6DOFJoint.Param"> + </argument> + <argument index="1" name="value" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="angular_limit_x/damping" type="float" setter="set_param_x" getter="get_param_x"> + </member> + <member name="angular_limit_x/enabled" type="bool" setter="set_flag_x" getter="get_flag_x"> + </member> + <member name="angular_limit_x/erp" type="float" setter="set_param_x" getter="get_param_x"> + </member> + <member name="angular_limit_x/force_limit" type="float" setter="set_param_x" getter="get_param_x"> + </member> + <member name="angular_limit_x/lower_angle" type="float" setter="_set_angular_lo_limit_x" getter="_get_angular_lo_limit_x"> + </member> + <member name="angular_limit_x/restitution" type="float" setter="set_param_x" getter="get_param_x"> + </member> + <member name="angular_limit_x/softness" type="float" setter="set_param_x" getter="get_param_x"> + </member> + <member name="angular_limit_x/upper_angle" type="float" setter="_set_angular_hi_limit_x" getter="_get_angular_hi_limit_x"> + </member> + <member name="angular_limit_y/damping" type="float" setter="set_param_y" getter="get_param_y"> + </member> + <member name="angular_limit_y/enabled" type="bool" setter="set_flag_y" getter="get_flag_y"> + </member> + <member name="angular_limit_y/erp" type="float" setter="set_param_y" getter="get_param_y"> + </member> + <member name="angular_limit_y/force_limit" type="float" setter="set_param_y" getter="get_param_y"> + </member> + <member name="angular_limit_y/lower_angle" type="float" setter="_set_angular_lo_limit_y" getter="_get_angular_lo_limit_y"> + </member> + <member name="angular_limit_y/restitution" type="float" setter="set_param_y" getter="get_param_y"> + </member> + <member name="angular_limit_y/softness" type="float" setter="set_param_y" getter="get_param_y"> + </member> + <member name="angular_limit_y/upper_angle" type="float" setter="_set_angular_hi_limit_y" getter="_get_angular_hi_limit_y"> + </member> + <member name="angular_limit_z/damping" type="float" setter="set_param_z" getter="get_param_z"> + </member> + <member name="angular_limit_z/enabled" type="bool" setter="set_flag_z" getter="get_flag_z"> + </member> + <member name="angular_limit_z/erp" type="float" setter="set_param_z" getter="get_param_z"> + </member> + <member name="angular_limit_z/force_limit" type="float" setter="set_param_z" getter="get_param_z"> + </member> + <member name="angular_limit_z/lower_angle" type="float" setter="_set_angular_lo_limit_z" getter="_get_angular_lo_limit_z"> + </member> + <member name="angular_limit_z/restitution" type="float" setter="set_param_z" getter="get_param_z"> + </member> + <member name="angular_limit_z/softness" type="float" setter="set_param_z" getter="get_param_z"> + </member> + <member name="angular_limit_z/upper_angle" type="float" setter="_set_angular_hi_limit_z" getter="_get_angular_hi_limit_z"> + </member> + <member name="angular_motor_x/enabled" type="bool" setter="set_flag_x" getter="get_flag_x"> + </member> + <member name="angular_motor_x/force_limit" type="float" setter="set_param_x" getter="get_param_x"> + </member> + <member name="angular_motor_x/target_velocity" type="float" setter="set_param_x" getter="get_param_x"> + </member> + <member name="angular_motor_y/enabled" type="bool" setter="set_flag_y" getter="get_flag_y"> + </member> + <member name="angular_motor_y/force_limit" type="float" setter="set_param_y" getter="get_param_y"> + </member> + <member name="angular_motor_y/target_velocity" type="float" setter="set_param_y" getter="get_param_y"> + </member> + <member name="angular_motor_z/enabled" type="bool" setter="set_flag_z" getter="get_flag_z"> + </member> + <member name="angular_motor_z/force_limit" type="float" setter="set_param_z" getter="get_param_z"> + </member> + <member name="angular_motor_z/target_velocity" type="float" setter="set_param_z" getter="get_param_z"> + </member> + <member name="linear_limit_x/damping" type="float" setter="set_param_x" getter="get_param_x"> + </member> + <member name="linear_limit_x/enabled" type="bool" setter="set_flag_x" getter="get_flag_x"> + </member> + <member name="linear_limit_x/lower_distance" type="float" setter="set_param_x" getter="get_param_x"> + </member> + <member name="linear_limit_x/restitution" type="float" setter="set_param_x" getter="get_param_x"> + </member> + <member name="linear_limit_x/softness" type="float" setter="set_param_x" getter="get_param_x"> + </member> + <member name="linear_limit_x/upper_distance" type="float" setter="set_param_x" getter="get_param_x"> + </member> + <member name="linear_limit_y/damping" type="float" setter="set_param_y" getter="get_param_y"> + </member> + <member name="linear_limit_y/enabled" type="bool" setter="set_flag_y" getter="get_flag_y"> + </member> + <member name="linear_limit_y/lower_distance" type="float" setter="set_param_y" getter="get_param_y"> + </member> + <member name="linear_limit_y/restitution" type="float" setter="set_param_y" getter="get_param_y"> + </member> + <member name="linear_limit_y/softness" type="float" setter="set_param_y" getter="get_param_y"> + </member> + <member name="linear_limit_y/upper_distance" type="float" setter="set_param_y" getter="get_param_y"> + </member> + <member name="linear_limit_z/damping" type="float" setter="set_param_z" getter="get_param_z"> + </member> + <member name="linear_limit_z/enabled" type="bool" setter="set_flag_z" getter="get_flag_z"> + </member> + <member name="linear_limit_z/lower_distance" type="float" setter="set_param_z" getter="get_param_z"> + </member> + <member name="linear_limit_z/restitution" type="float" setter="set_param_z" getter="get_param_z"> + </member> + <member name="linear_limit_z/softness" type="float" setter="set_param_z" getter="get_param_z"> + </member> + <member name="linear_limit_z/upper_distance" type="float" setter="set_param_z" getter="get_param_z"> + </member> + </members> + <constants> + <constant name="PARAM_LINEAR_LOWER_LIMIT" value="0"> + </constant> + <constant name="PARAM_LINEAR_UPPER_LIMIT" value="1"> + </constant> + <constant name="PARAM_LINEAR_LIMIT_SOFTNESS" value="2"> + </constant> + <constant name="PARAM_LINEAR_RESTITUTION" value="3"> + </constant> + <constant name="PARAM_LINEAR_DAMPING" value="4"> + </constant> + <constant name="PARAM_ANGULAR_LOWER_LIMIT" value="5"> + </constant> + <constant name="PARAM_ANGULAR_UPPER_LIMIT" value="6"> + </constant> + <constant name="PARAM_ANGULAR_LIMIT_SOFTNESS" value="7"> + </constant> + <constant name="PARAM_ANGULAR_DAMPING" value="8"> + </constant> + <constant name="PARAM_ANGULAR_RESTITUTION" value="9"> + </constant> + <constant name="PARAM_ANGULAR_FORCE_LIMIT" value="10"> + </constant> + <constant name="PARAM_ANGULAR_ERP" value="11"> + </constant> + <constant name="PARAM_ANGULAR_MOTOR_TARGET_VELOCITY" value="12"> + </constant> + <constant name="PARAM_ANGULAR_MOTOR_FORCE_LIMIT" value="13"> + </constant> + <constant name="PARAM_MAX" value="14"> + </constant> + <constant name="FLAG_ENABLE_LINEAR_LIMIT" value="0"> + </constant> + <constant name="FLAG_ENABLE_ANGULAR_LIMIT" value="1"> + </constant> + <constant name="FLAG_ENABLE_MOTOR" value="2"> + </constant> + <constant name="FLAG_MAX" value="3"> + </constant> + </constants> +</class> diff --git a/doc/classes/Geometry.xml b/doc/classes/Geometry.xml new file mode 100644 index 0000000000..6c301cb928 --- /dev/null +++ b/doc/classes/Geometry.xml @@ -0,0 +1,267 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Geometry" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="build_box_planes"> + <return type="Array"> + </return> + <argument index="0" name="extents" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="build_capsule_planes"> + <return type="Array"> + </return> + <argument index="0" name="radius" type="float"> + </argument> + <argument index="1" name="height" type="float"> + </argument> + <argument index="2" name="sides" type="int"> + </argument> + <argument index="3" name="lats" type="int"> + </argument> + <argument index="4" name="axis" type="int" enum="Vector3.Axis" default="2"> + </argument> + <description> + </description> + </method> + <method name="build_cylinder_planes"> + <return type="Array"> + </return> + <argument index="0" name="radius" type="float"> + </argument> + <argument index="1" name="height" type="float"> + </argument> + <argument index="2" name="sides" type="int"> + </argument> + <argument index="3" name="axis" type="int" enum="Vector3.Axis" default="2"> + </argument> + <description> + </description> + </method> + <method name="get_closest_point_to_segment"> + <return type="Vector3"> + </return> + <argument index="0" name="point" type="Vector3"> + </argument> + <argument index="1" name="s1" type="Vector3"> + </argument> + <argument index="2" name="s2" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="get_closest_point_to_segment_2d"> + <return type="Vector2"> + </return> + <argument index="0" name="point" type="Vector2"> + </argument> + <argument index="1" name="s1" type="Vector2"> + </argument> + <argument index="2" name="s2" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="get_closest_point_to_segment_uncapped"> + <return type="Vector3"> + </return> + <argument index="0" name="point" type="Vector3"> + </argument> + <argument index="1" name="s1" type="Vector3"> + </argument> + <argument index="2" name="s2" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="get_closest_point_to_segment_uncapped_2d"> + <return type="Vector2"> + </return> + <argument index="0" name="point" type="Vector2"> + </argument> + <argument index="1" name="s1" type="Vector2"> + </argument> + <argument index="2" name="s2" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="get_closest_points_between_segments"> + <return type="PoolVector3Array"> + </return> + <argument index="0" name="p1" type="Vector3"> + </argument> + <argument index="1" name="p2" type="Vector3"> + </argument> + <argument index="2" name="q1" type="Vector3"> + </argument> + <argument index="3" name="q2" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="get_closest_points_between_segments_2d"> + <return type="PoolVector2Array"> + </return> + <argument index="0" name="p1" type="Vector2"> + </argument> + <argument index="1" name="q1" type="Vector2"> + </argument> + <argument index="2" name="p2" type="Vector2"> + </argument> + <argument index="3" name="q2" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="get_uv84_normal_bit"> + <return type="int"> + </return> + <argument index="0" name="normal" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="make_atlas"> + <return type="Dictionary"> + </return> + <argument index="0" name="sizes" type="PoolVector2Array"> + </argument> + <description> + </description> + </method> + <method name="point_is_inside_triangle" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="point" type="Vector2"> + </argument> + <argument index="1" name="a" type="Vector2"> + </argument> + <argument index="2" name="b" type="Vector2"> + </argument> + <argument index="3" name="c" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="ray_intersects_triangle"> + <return type="Variant"> + </return> + <argument index="0" name="from" type="Vector3"> + </argument> + <argument index="1" name="dir" type="Vector3"> + </argument> + <argument index="2" name="a" type="Vector3"> + </argument> + <argument index="3" name="b" type="Vector3"> + </argument> + <argument index="4" name="c" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="segment_intersects_circle"> + <return type="float"> + </return> + <argument index="0" name="segment_from" type="Vector2"> + </argument> + <argument index="1" name="segment_to" type="Vector2"> + </argument> + <argument index="2" name="circle_pos" type="Vector2"> + </argument> + <argument index="3" name="circle_radius" type="float"> + </argument> + <description> + </description> + </method> + <method name="segment_intersects_convex"> + <return type="PoolVector3Array"> + </return> + <argument index="0" name="from" type="Vector3"> + </argument> + <argument index="1" name="to" type="Vector3"> + </argument> + <argument index="2" name="planes" type="Array"> + </argument> + <description> + </description> + </method> + <method name="segment_intersects_cylinder"> + <return type="PoolVector3Array"> + </return> + <argument index="0" name="from" type="Vector3"> + </argument> + <argument index="1" name="to" type="Vector3"> + </argument> + <argument index="2" name="height" type="float"> + </argument> + <argument index="3" name="radius" type="float"> + </argument> + <description> + </description> + </method> + <method name="segment_intersects_segment_2d"> + <return type="Variant"> + </return> + <argument index="0" name="from_a" type="Vector2"> + </argument> + <argument index="1" name="to_a" type="Vector2"> + </argument> + <argument index="2" name="from_b" type="Vector2"> + </argument> + <argument index="3" name="to_b" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="segment_intersects_sphere"> + <return type="PoolVector3Array"> + </return> + <argument index="0" name="from" type="Vector3"> + </argument> + <argument index="1" name="to" type="Vector3"> + </argument> + <argument index="2" name="spos" type="Vector3"> + </argument> + <argument index="3" name="sradius" type="float"> + </argument> + <description> + </description> + </method> + <method name="segment_intersects_triangle"> + <return type="Variant"> + </return> + <argument index="0" name="from" type="Vector3"> + </argument> + <argument index="1" name="to" type="Vector3"> + </argument> + <argument index="2" name="a" type="Vector3"> + </argument> + <argument index="3" name="b" type="Vector3"> + </argument> + <argument index="4" name="c" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="triangulate_polygon"> + <return type="PoolIntArray"> + </return> + <argument index="0" name="polygon" type="PoolVector2Array"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/GeometryInstance.xml b/doc/classes/GeometryInstance.xml new file mode 100644 index 0000000000..57aec8be41 --- /dev/null +++ b/doc/classes/GeometryInstance.xml @@ -0,0 +1,165 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GeometryInstance" inherits="VisualInstance" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base node for geometry based visual instances. + </brief_description> + <description> + Base node for geometry based visual instances. Shares some common functionality like visibility and custom materials. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_cast_shadows_setting" qualifiers="const"> + <return type="int" enum="GeometryInstance.ShadowCastingSetting"> + </return> + <description> + </description> + </method> + <method name="get_extra_cull_margin" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_flag" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="flag" type="int" enum="GeometryInstance.Flags"> + </argument> + <description> + </description> + </method> + <method name="get_lod_max_distance" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_lod_max_hysteresis" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_lod_min_distance" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_lod_min_hysteresis" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_material_override" qualifiers="const"> + <return type="Material"> + </return> + <description> + Return the material override for the whole geometry. + </description> + </method> + <method name="set_cast_shadows_setting"> + <return type="void"> + </return> + <argument index="0" name="shadow_casting_setting" type="int" enum="GeometryInstance.ShadowCastingSetting"> + </argument> + <description> + </description> + </method> + <method name="set_extra_cull_margin"> + <return type="void"> + </return> + <argument index="0" name="margin" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_flag"> + <return type="void"> + </return> + <argument index="0" name="flag" type="int" enum="GeometryInstance.Flags"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_lod_max_distance"> + <return type="void"> + </return> + <argument index="0" name="mode" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_lod_max_hysteresis"> + <return type="void"> + </return> + <argument index="0" name="mode" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_lod_min_distance"> + <return type="void"> + </return> + <argument index="0" name="mode" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_lod_min_hysteresis"> + <return type="void"> + </return> + <argument index="0" name="mode" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_material_override"> + <return type="void"> + </return> + <argument index="0" name="material" type="Material"> + </argument> + <description> + Set the material override for the whole geometry. + </description> + </method> + </methods> + <members> + <member name="cast_shadow" type="int" setter="set_cast_shadows_setting" getter="get_cast_shadows_setting" enum="GeometryInstance.ShadowCastingSetting"> + </member> + <member name="extra_cull_margin" type="float" setter="set_extra_cull_margin" getter="get_extra_cull_margin"> + </member> + <member name="lod_max_distance" type="float" setter="set_lod_max_distance" getter="get_lod_max_distance"> + </member> + <member name="lod_max_hysteresis" type="float" setter="set_lod_max_hysteresis" getter="get_lod_max_hysteresis"> + </member> + <member name="lod_min_distance" type="float" setter="set_lod_min_distance" getter="get_lod_min_distance"> + </member> + <member name="lod_min_hysteresis" type="float" setter="set_lod_min_hysteresis" getter="get_lod_min_hysteresis"> + </member> + <member name="material_override" type="Material" setter="set_material_override" getter="get_material_override"> + </member> + <member name="use_in_baked_light" type="bool" setter="set_flag" getter="get_flag"> + </member> + </members> + <constants> + <constant name="SHADOW_CASTING_SETTING_OFF" value="0"> + </constant> + <constant name="SHADOW_CASTING_SETTING_ON" value="1"> + </constant> + <constant name="SHADOW_CASTING_SETTING_DOUBLE_SIDED" value="2"> + </constant> + <constant name="SHADOW_CASTING_SETTING_SHADOWS_ONLY" value="3"> + </constant> + <constant name="FLAG_USE_BAKED_LIGHT" value="0"> + </constant> + <constant name="FLAG_MAX" value="1"> + </constant> + </constants> +</class> diff --git a/doc/classes/Gradient.xml b/doc/classes/Gradient.xml new file mode 100644 index 0000000000..f97908b0a2 --- /dev/null +++ b/doc/classes/Gradient.xml @@ -0,0 +1,131 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Gradient" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Color interpolator node + </brief_description> + <description> + Given a set of colors, this node will interpolate them in order, meaning, that if you have color 1, color 2 and color3, the ramp will interpolate (generate the colors between two colors) from color 1 to color 2 and from color 2 to color 3. Initially the ramp will have 2 colors (black and white), one (black) at ramp lower offset offset 0 and the other (white) at the ramp higher offset 1. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_point"> + <return type="void"> + </return> + <argument index="0" name="offset" type="float"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <description> + Adds the specified color to the end of the ramp, with the specified offset + </description> + </method> + <method name="get_color" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="point" type="int"> + </argument> + <description> + Returns the color of the ramp color at index [i]point[/i] + </description> + </method> + <method name="get_colors" qualifiers="const"> + <return type="PoolColorArray"> + </return> + <description> + Returns the colors in the ramp + </description> + </method> + <method name="get_offset" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="point" type="int"> + </argument> + <description> + Returns the offset of the ramp color at index [i]point[/i] + </description> + </method> + <method name="get_offsets" qualifiers="const"> + <return type="PoolRealArray"> + </return> + <description> + Returns the offsets for the colors in this ramp + </description> + </method> + <method name="get_point_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the number of colors in the ramp + </description> + </method> + <method name="interpolate"> + <return type="Color"> + </return> + <argument index="0" name="offset" type="float"> + </argument> + <description> + Returns the interpolated color specified by [i]offset[/i] + </description> + </method> + <method name="remove_point"> + <return type="void"> + </return> + <argument index="0" name="offset" type="int"> + </argument> + <description> + Removes the color at the index [i]offset[/i] + </description> + </method> + <method name="set_color"> + <return type="void"> + </return> + <argument index="0" name="point" type="int"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <description> + Sets the color of the ramp color at index [i]point[/i] + </description> + </method> + <method name="set_colors"> + <return type="void"> + </return> + <argument index="0" name="colors" type="PoolColorArray"> + </argument> + <description> + Sets the colors for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accommodate the new elements. + </description> + </method> + <method name="set_offset"> + <return type="void"> + </return> + <argument index="0" name="point" type="int"> + </argument> + <argument index="1" name="offset" type="float"> + </argument> + <description> + Sets the offset for the ramp color at index [i]point[/i] + </description> + </method> + <method name="set_offsets"> + <return type="void"> + </return> + <argument index="0" name="offsets" type="PoolRealArray"> + </argument> + <description> + Sets the offset for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accommodate the new elements, all new colors will be black by default. + </description> + </method> + </methods> + <members> + <member name="colors" type="PoolColorArray" setter="set_colors" getter="get_colors"> + </member> + <member name="offsets" type="PoolRealArray" setter="set_offsets" getter="get_offsets"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/GradientTexture.xml b/doc/classes/GradientTexture.xml new file mode 100644 index 0000000000..eab8ea77af --- /dev/null +++ b/doc/classes/GradientTexture.xml @@ -0,0 +1,47 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GradientTexture" inherits="Texture" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Gradient filled texture. + </brief_description> + <description> + Uses a [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 [method set_width]). + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_gradient" qualifiers="const"> + <return type="Gradient"> + </return> + <description> + </description> + </method> + <method name="set_gradient"> + <return type="void"> + </return> + <argument index="0" name="gradient" type="Gradient"> + </argument> + <description> + </description> + </method> + <method name="set_width"> + <return type="void"> + </return> + <argument index="0" name="width" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="gradient" type="Gradient" setter="set_gradient" getter="get_gradient"> + The [Gradient] that will be used to fill the texture. + </member> + <member name="width" type="int" setter="set_width" getter="get_width"> + The number of color samples that will be obtained from the [Gradient]. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/GraphEdit.xml b/doc/classes/GraphEdit.xml new file mode 100644 index 0000000000..bd594033ee --- /dev/null +++ b/doc/classes/GraphEdit.xml @@ -0,0 +1,250 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GraphEdit" inherits="Control" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + GraphEdit is an area capable of showing various GraphNodes. It manages connection events between them. + </brief_description> + <description> + GraphEdit manages the showing of GraphNodes it contains, as well as connections and disconnections between them. Signals are sent for each of these two events. Disconnection between GraphNodes slots is disabled by default. + It is greatly advised to enable low processor usage mode (see [method OS.set_low_processor_usage_mode]) when using GraphEdits. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="connect_node"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="from" type="String"> + </argument> + <argument index="1" name="from_port" type="int"> + </argument> + <argument index="2" name="to" type="String"> + </argument> + <argument index="3" name="to_port" type="int"> + </argument> + <description> + Create a connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode. If the connection already exists, no connection is created. + </description> + </method> + <method name="disconnect_node"> + <return type="void"> + </return> + <argument index="0" name="from" type="String"> + </argument> + <argument index="1" name="from_port" type="int"> + </argument> + <argument index="2" name="to" type="String"> + </argument> + <argument index="3" name="to_port" type="int"> + </argument> + <description> + Remove the connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode, if connection exists. + </description> + </method> + <method name="get_connection_list" qualifiers="const"> + <return type="Array"> + </return> + <description> + Return an Array containing the list of connections. A connection consists in a structure of the form {from_slot: 0, from: "GraphNode name 0", to_slot: 1, to: "GraphNode name 1" } + </description> + </method> + <method name="get_scroll_ofs" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the scroll offset. + </description> + </method> + <method name="get_snap" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_zoom" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the current zoom value. + </description> + </method> + <method name="is_node_connected"> + <return type="bool"> + </return> + <argument index="0" name="from" type="String"> + </argument> + <argument index="1" name="from_port" type="int"> + </argument> + <argument index="2" name="to" type="String"> + </argument> + <argument index="3" name="to_port" type="int"> + </argument> + <description> + Return true if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode. + </description> + </method> + <method name="is_right_disconnects_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true is the disconnection of connections is enable in the visual GraphEdit. False otherwise. + </description> + </method> + <method name="is_using_snap" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_right_disconnects"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Enable the disconnection of existing connections in the visual GraphEdit by left-clicking a connection and releasing into the void. + </description> + </method> + <method name="set_scroll_ofs"> + <return type="void"> + </return> + <argument index="0" name="ofs" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_selected"> + <return type="void"> + </return> + <argument index="0" name="node" type="Node"> + </argument> + <description> + </description> + </method> + <method name="set_snap"> + <return type="void"> + </return> + <argument index="0" name="pixels" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_use_snap"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_zoom"> + <return type="void"> + </return> + <argument index="0" name="p_zoom" type="float"> + </argument> + <description> + Set the zoom value of the GraphEdit. Zoom value is between [0.01; 1.728]. + </description> + </method> + </methods> + <signals> + <signal name="_begin_node_move"> + <description> + Signal sent at the beginning of a GraphNode movement. + </description> + </signal> + <signal name="_end_node_move"> + <description> + Signal sent at the end of a GraphNode movement. + </description> + </signal> + <signal name="connection_request"> + <argument index="0" name="from" type="String"> + </argument> + <argument index="1" name="from_slot" type="int"> + </argument> + <argument index="2" name="to" type="String"> + </argument> + <argument index="3" name="to_slot" type="int"> + </argument> + <description> + 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. + </description> + </signal> + <signal name="connection_to_empty"> + <argument index="0" name="from" type="String"> + </argument> + <argument index="1" name="from_slot" type="int"> + </argument> + <argument index="2" name="release_pos" type="Vector2"> + </argument> + <description> + </description> + </signal> + <signal name="delete_nodes_request"> + <description> + Signal sent when a GraphNode is attempted to be removed from the GraphEdit. + </description> + </signal> + <signal name="disconnection_request"> + <argument index="0" name="from" type="String"> + </argument> + <argument index="1" name="from_slot" type="int"> + </argument> + <argument index="2" name="to" type="String"> + </argument> + <argument index="3" name="to_slot" type="int"> + </argument> + <description> + Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be removed. + </description> + </signal> + <signal name="duplicate_nodes_request"> + <description> + Signal sent when a GraphNode is attempted to be duplicated in the GraphEdit. + </description> + </signal> + <signal name="node_selected"> + <argument index="0" name="node" type="Object"> + </argument> + <description> + </description> + </signal> + <signal name="popup_request"> + <argument index="0" name="p_position" type="Vector2"> + </argument> + <description> + Signal sent when a popup is requested. Happens on right-clicking in the GraphEdit. 'p_position' is the position of the mouse pointer when the signal is sent. + </description> + </signal> + <signal name="scroll_offset_changed"> + <argument index="0" name="ofs" type="Vector2"> + </argument> + <description> + </description> + </signal> + </signals> + <constants> + </constants> + <theme_items> + <theme_item name="bezier_len_neg" type="int"> + </theme_item> + <theme_item name="bezier_len_pos" type="int"> + </theme_item> + <theme_item name="bg" type="StyleBox"> + </theme_item> + <theme_item name="grid_major" type="Color"> + </theme_item> + <theme_item name="grid_minor" type="Color"> + </theme_item> + <theme_item name="minus" type="Texture"> + </theme_item> + <theme_item name="more" type="Texture"> + </theme_item> + <theme_item name="reset" type="Texture"> + </theme_item> + <theme_item name="snap" type="Texture"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/GraphNode.xml b/doc/classes/GraphNode.xml new file mode 100644 index 0000000000..de1d9c1194 --- /dev/null +++ b/doc/classes/GraphNode.xml @@ -0,0 +1,365 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GraphNode" inherits="Container" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + A GraphNode is a container with several input and output slots allowing connections between GraphNodes. Slots can have different, incompatible types. + </brief_description> + <description> + A GraphNode is a container defined by a title. It can have 1 or more input and output slots, which can be enabled (shown) or disabled (not shown) and have different (incompatible) types. Colors can also be assigned to slots. A tuple of input and output slots is defined for each GUI element included in the GraphNode. Input and output connections are left and right slots, but only enabled slots are counted as connections. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="clear_all_slots"> + <return type="void"> + </return> + <description> + Disable all input and output slots of the GraphNode. + </description> + </method> + <method name="clear_slot"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Disable input and output slot whose index is 'idx'. + </description> + </method> + <method name="get_connection_input_color"> + <return type="Color"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return the color of the input connection 'idx'. + </description> + </method> + <method name="get_connection_input_count"> + <return type="int"> + </return> + <description> + Return the number of enabled input slots (connections) to the GraphNode. + </description> + </method> + <method name="get_connection_input_pos"> + <return type="Vector2"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return the position of the input connection 'idx'. + </description> + </method> + <method name="get_connection_input_type"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return the type of the input connection 'idx'. + </description> + </method> + <method name="get_connection_output_color"> + <return type="Color"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return the color of the output connection 'idx'. + </description> + </method> + <method name="get_connection_output_count"> + <return type="int"> + </return> + <description> + Return the number of enabled output slots (connections) of the GraphNode. + </description> + </method> + <method name="get_connection_output_pos"> + <return type="Vector2"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return the position of the output connection 'idx'. + </description> + </method> + <method name="get_connection_output_type"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return the type of the output connection 'idx'. + </description> + </method> + <method name="get_offset" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the offset of the GraphNode. + </description> + </method> + <method name="get_overlay" qualifiers="const"> + <return type="int" enum="GraphNode.Overlay"> + </return> + <description> + </description> + </method> + <method name="get_slot_color_left" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return the color set to 'idx' left (input) slot. + </description> + </method> + <method name="get_slot_color_right" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return the color set to 'idx' right (output) slot. + </description> + </method> + <method name="get_slot_type_left" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return the (integer) type of left (input) 'idx' slot. + </description> + </method> + <method name="get_slot_type_right" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return the (integer) type of right (output) 'idx' slot. + </description> + </method> + <method name="get_title" qualifiers="const"> + <return type="String"> + </return> + <description> + Return the title of the GraphNode. + </description> + </method> + <method name="is_close_button_visible" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns true if the close button is shown. False otherwise. + </description> + </method> + <method name="is_comment" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_resizable" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_selected"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_slot_enabled_left" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return true if left (input) slot 'idx' is enabled. False otherwise. + </description> + </method> + <method name="is_slot_enabled_right" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return true if right (output) slot 'idx' is enabled. False otherwise. + </description> + </method> + <method name="set_comment"> + <return type="void"> + </return> + <argument index="0" name="comment" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_offset"> + <return type="void"> + </return> + <argument index="0" name="offset" type="Vector2"> + </argument> + <description> + Set the offset of the GraphNode. + </description> + </method> + <method name="set_overlay"> + <return type="void"> + </return> + <argument index="0" name="overlay" type="int" enum="GraphNode.Overlay"> + </argument> + <description> + </description> + </method> + <method name="set_resizable"> + <return type="void"> + </return> + <argument index="0" name="resizable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_selected"> + <return type="void"> + </return> + <argument index="0" name="selected" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_show_close_button"> + <return type="void"> + </return> + <argument index="0" name="show" type="bool"> + </argument> + <description> + Show the close button on the GraphNode if 'show' is true (disabled by default). If enabled, a connection on the signal close_request is needed for the close button to work. + </description> + </method> + <method name="set_slot"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="enable_left" type="bool"> + </argument> + <argument index="2" name="type_left" type="int"> + </argument> + <argument index="3" name="color_left" type="Color"> + </argument> + <argument index="4" name="enable_right" type="bool"> + </argument> + <argument index="5" name="type_right" type="int"> + </argument> + <argument index="6" name="color_right" type="Color"> + </argument> + <argument index="7" name="custom_left" type="Texture" default="null"> + </argument> + <argument index="8" name="custom_right" type="Texture" default="null"> + </argument> + <description> + </description> + </method> + <method name="set_title"> + <return type="void"> + </return> + <argument index="0" name="title" type="String"> + </argument> + <description> + Set the title of the GraphNode. + </description> + </method> + </methods> + <members> + <member name="resizable" type="bool" setter="set_resizable" getter="is_resizable"> + </member> + <member name="show_close" type="bool" setter="set_show_close_button" getter="is_close_button_visible"> + </member> + <member name="title" type="String" setter="set_title" getter="get_title"> + </member> + </members> + <signals> + <signal name="close_request"> + <description> + Signal sent on closing the GraphNode. + </description> + </signal> + <signal name="dragged"> + <argument index="0" name="from" type="Vector2"> + </argument> + <argument index="1" name="to" type="Vector2"> + </argument> + <description> + Signal sent when the GraphNode is dragged. + </description> + </signal> + <signal name="offset_changed"> + <description> + Signal sent when the GraphNode is moved. + </description> + </signal> + <signal name="raise_request"> + <description> + Signal sent when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode. + </description> + </signal> + <signal name="resize_request"> + <argument index="0" name="new_minsize" type="Vector2"> + </argument> + <description> + </description> + </signal> + </signals> + <constants> + <constant name="OVERLAY_DISABLED" value="0"> + </constant> + <constant name="OVERLAY_BREAKPOINT" value="1"> + </constant> + <constant name="OVERLAY_POSITION" value="2"> + </constant> + </constants> + <theme_items> + <theme_item name="breakpoint" type="StyleBox"> + </theme_item> + <theme_item name="close" type="Texture"> + </theme_item> + <theme_item name="close_offset" type="int"> + </theme_item> + <theme_item name="comment" type="StyleBox"> + </theme_item> + <theme_item name="commentfocus" type="StyleBox"> + </theme_item> + <theme_item name="defaultfocus" type="StyleBox"> + </theme_item> + <theme_item name="defaultframe" type="StyleBox"> + </theme_item> + <theme_item name="frame" type="StyleBox"> + </theme_item> + <theme_item name="port" type="Texture"> + </theme_item> + <theme_item name="port_offset" type="int"> + </theme_item> + <theme_item name="position" type="StyleBox"> + </theme_item> + <theme_item name="resizer" type="Texture"> + </theme_item> + <theme_item name="selectedframe" type="StyleBox"> + </theme_item> + <theme_item name="separation" type="int"> + </theme_item> + <theme_item name="title_color" type="Color"> + </theme_item> + <theme_item name="title_font" type="Font"> + </theme_item> + <theme_item name="title_offset" type="int"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/GridContainer.xml b/doc/classes/GridContainer.xml new file mode 100644 index 0000000000..ca7b868cd8 --- /dev/null +++ b/doc/classes/GridContainer.xml @@ -0,0 +1,43 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GridContainer" inherits="Container" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Grid container used to arrange elements in a grid like layout + </brief_description> + <description> + Grid container will arrange its children in a grid like structure, the grid columns are specified using the [method set_columns] method and the number of rows will be equal to the number of children in the container divided by the number of columns, for example: if the container has 5 children, and 2 columns, there will be 3 rows in the container. Notice that grid layout will preserve the columns and rows for every size of the container. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_columns" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the number of columns in this container + </description> + </method> + <method name="set_columns"> + <return type="void"> + </return> + <argument index="0" name="columns" type="int"> + </argument> + <description> + Sets the numbers of columns in the container, then reorder its children to accommodate the new layout + </description> + </method> + </methods> + <members> + <member name="columns" type="int" setter="set_columns" getter="get_columns"> + </member> + </members> + <constants> + </constants> + <theme_items> + <theme_item name="hseparation" type="int"> + </theme_item> + <theme_item name="vseparation" type="int"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/GrooveJoint2D.xml b/doc/classes/GrooveJoint2D.xml new file mode 100644 index 0000000000..3db2d9aee9 --- /dev/null +++ b/doc/classes/GrooveJoint2D.xml @@ -0,0 +1,55 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GrooveJoint2D" inherits="Joint2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Groove constraint for 2D physics. + </brief_description> + <description> + Groove constraint for 2D physics. This is useful for making a body "slide" through a segment placed in another. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_initial_offset" qualifiers="const"> + <return type="float"> + </return> + <description> + Set the final offset of the groove on body A. + </description> + </method> + <method name="get_length" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the length of the groove. + </description> + </method> + <method name="set_initial_offset"> + <return type="void"> + </return> + <argument index="0" name="offset" type="float"> + </argument> + <description> + Set the initial offset of the groove on body A. + </description> + </method> + <method name="set_length"> + <return type="void"> + </return> + <argument index="0" name="length" type="float"> + </argument> + <description> + Set the length of the groove. + </description> + </method> + </methods> + <members> + <member name="initial_offset" type="float" setter="set_initial_offset" getter="get_initial_offset"> + </member> + <member name="length" type="float" setter="set_length" getter="get_length"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/HBoxContainer.xml b/doc/classes/HBoxContainer.xml new file mode 100644 index 0000000000..2ffc2a8c57 --- /dev/null +++ b/doc/classes/HBoxContainer.xml @@ -0,0 +1,21 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="HBoxContainer" inherits="BoxContainer" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Horizontal box container. + </brief_description> + <description> + Horizontal box container. See [BoxContainer]. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> + <theme_items> + <theme_item name="separation" type="int"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/HScrollBar.xml b/doc/classes/HScrollBar.xml new file mode 100644 index 0000000000..188995527c --- /dev/null +++ b/doc/classes/HScrollBar.xml @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="HScrollBar" inherits="ScrollBar" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Horizontal scroll bar. + </brief_description> + <description> + Horizontal scroll bar. See [ScrollBar]. This one goes from left (min) to right (max). + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> + <theme_items> + <theme_item name="decrement" type="Texture"> + </theme_item> + <theme_item name="decrement_highlight" type="Texture"> + </theme_item> + <theme_item name="grabber" type="StyleBox"> + </theme_item> + <theme_item name="grabber_highlight" type="StyleBox"> + </theme_item> + <theme_item name="grabber_pressed" type="StyleBox"> + </theme_item> + <theme_item name="increment" type="Texture"> + </theme_item> + <theme_item name="increment_highlight" type="Texture"> + </theme_item> + <theme_item name="scroll" type="StyleBox"> + </theme_item> + <theme_item name="scroll_focus" type="StyleBox"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/HSeparator.xml b/doc/classes/HSeparator.xml new file mode 100644 index 0000000000..351eee7ee6 --- /dev/null +++ b/doc/classes/HSeparator.xml @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="HSeparator" inherits="Separator" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Horizontal separator. + </brief_description> + <description> + Horizontal separator. See [Separator]. It is used to separate objects vertically, though (but it looks horizontal!). + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> + <theme_items> + <theme_item name="separation" type="int"> + </theme_item> + <theme_item name="separator" type="StyleBox"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/HSlider.xml b/doc/classes/HSlider.xml new file mode 100644 index 0000000000..91f95d1548 --- /dev/null +++ b/doc/classes/HSlider.xml @@ -0,0 +1,35 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="HSlider" inherits="Slider" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Horizontal slider. + </brief_description> + <description> + Horizontal slider. See [Slider]. This one goes from left (min) to right (max). + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> + <theme_items> + <theme_item name="focus" type="StyleBox"> + </theme_item> + <theme_item name="grabber" type="Texture"> + </theme_item> + <theme_item name="grabber_disabled" type="Texture"> + </theme_item> + <theme_item name="grabber_disabled" type="StyleBox"> + </theme_item> + <theme_item name="grabber_highlight" type="Texture"> + </theme_item> + <theme_item name="grabber_highlight" type="StyleBox"> + </theme_item> + <theme_item name="slider" type="StyleBox"> + </theme_item> + <theme_item name="tick" type="Texture"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/HSplitContainer.xml b/doc/classes/HSplitContainer.xml new file mode 100644 index 0000000000..d7dc79a783 --- /dev/null +++ b/doc/classes/HSplitContainer.xml @@ -0,0 +1,27 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="HSplitContainer" inherits="SplitContainer" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Horizontal split container. + </brief_description> + <description> + Horizontal split container. See [SplitContainer]. This goes from left to right. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> + <theme_items> + <theme_item name="autohide" type="int"> + </theme_item> + <theme_item name="bg" type="StyleBox"> + </theme_item> + <theme_item name="grabber" type="Texture"> + </theme_item> + <theme_item name="separation" type="int"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/HTTPClient.xml b/doc/classes/HTTPClient.xml new file mode 100644 index 0000000000..cf48ec84f6 --- /dev/null +++ b/doc/classes/HTTPClient.xml @@ -0,0 +1,356 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="HTTPClient" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Hyper-text transfer protocol client. + </brief_description> + <description> + Hyper-text transfer protocol client. Supports SSL and SSL server certificate verification. + Can be reused to connect to different hosts and make many requests. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="close"> + <return type="void"> + </return> + <description> + Cloces the current connection, allows for reusal of [HTTPClient]. + </description> + </method> + <method name="connect_to_host"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="host" type="String"> + </argument> + <argument index="1" name="port" type="int"> + </argument> + <argument index="2" name="use_ssl" type="bool" default="false"> + </argument> + <argument index="3" name="verify_host" type="bool" default="true"> + </argument> + <description> + Connect to a host. This needs to be done before any requests are sent. + The host should not have http:// prepended but will strip the protocol identifier if provided. + verify_host will check the SSL identity of the host if set to true. + </description> + </method> + <method name="get_connection" qualifiers="const"> + <return type="StreamPeer"> + </return> + <description> + Return current connection. + </description> + </method> + <method name="get_response_body_length" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the response's body length. + </description> + </method> + <method name="get_response_code" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the HTTP status code of the response. + </description> + </method> + <method name="get_response_headers"> + <return type="PoolStringArray"> + </return> + <description> + Return the response headers. + </description> + </method> + <method name="get_response_headers_as_dictionary"> + <return type="Dictionary"> + </return> + <description> + Returns all response headers as dictionary where the case-sensitivity of the keys and values is kept like the server delivers it. A value is a simple String, this string can have more than one value where "; " is used as separator. + Structure: ("key":"value1; value2") + Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) + </description> + </method> + <method name="get_status" qualifiers="const"> + <return type="int" enum="HTTPClient.Status"> + </return> + <description> + Returns a STATUS_* enum constant. Need to call [method poll] in order to get status updates. + </description> + </method> + <method name="has_response" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether this [HTTPClient] has a response available. + </description> + </method> + <method name="is_blocking_mode_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether blocking mode is enabled. + </description> + </method> + <method name="is_response_chunked" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether this [HTTPClient] has a response that is chunked. + </description> + </method> + <method name="poll"> + <return type="int" enum="Error"> + </return> + <description> + This needs to be called in order to have any request processed. Check results with [method get_status] + </description> + </method> + <method name="query_string_from_dict"> + <return type="String"> + </return> + <argument index="0" name="fields" type="Dictionary"> + </argument> + <description> + Generates a GET/POST application/x-www-form-urlencoded style query string from a provided dictionary, e.g.: + [codeblock] + var fields = {"username": "user", "password": "pass"} + String queryString = httpClient.query_string_from_dict(fields) + returns:= "username=user&password=pass" + [/codeblock] + </description> + </method> + <method name="read_response_body_chunk"> + <return type="PoolByteArray"> + </return> + <description> + Reads one chunk from the response. + </description> + </method> + <method name="request"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="method" type="int" enum="HTTPClient.Method"> + </argument> + <argument index="1" name="url" type="String"> + </argument> + <argument index="2" name="headers" type="PoolStringArray"> + </argument> + <argument index="3" name="body" type="String" default=""""> + </argument> + <description> + Sends a request to the connected host. The url is what is normally behind the hostname, i.e. in [code]http://somehost.com/index.php[/code], url would be "index.php". + Headers are HTTP request headers. + To create a POST request with query strings to push to the server, do: + [codeblock] + var fields = {"username" : "user", "password" : "pass"} + var queryString = httpClient.query_string_from_dict(fields) + var headers = ["Content-Type: application/x-www-form-urlencoded", "Content-Length: " + str(queryString.length())] + var result = httpClient.request(httpClient.METHOD_POST, "index.php", headers, queryString) + [/codeblock] + </description> + </method> + <method name="request_raw"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="method" type="int" enum="HTTPClient.Method"> + </argument> + <argument index="1" name="url" type="String"> + </argument> + <argument index="2" name="headers" type="PoolStringArray"> + </argument> + <argument index="3" name="body" type="PoolByteArray"> + </argument> + <description> + Sends a raw request to the connected host. The url is what is normally behind the hostname, i.e. in [code]http://somehost.com/index.php[/code], url would be "index.php". + Headers are HTTP request headers. + Sends body raw, as a byte array, does not encode it in any way. + </description> + </method> + <method name="send_body_data"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="body" type="PoolByteArray"> + </argument> + <description> + Stub function + </description> + </method> + <method name="send_body_text"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="body" type="String"> + </argument> + <description> + Stub function + </description> + </method> + <method name="set_blocking_mode"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + If set to true, execution will block until all data is read from the response. + </description> + </method> + <method name="set_connection"> + <return type="void"> + </return> + <argument index="0" name="connection" type="StreamPeer"> + </argument> + <description> + Set connection to use, for this client. + </description> + </method> + <method name="set_read_chunk_size"> + <return type="void"> + </return> + <argument index="0" name="bytes" type="int"> + </argument> + <description> + Sets the size of the buffer used and maximum bytes to read per iteration. see [method read_response_body_chunk] + </description> + </method> + </methods> + <constants> + <constant name="METHOD_GET" value="0"> + </constant> + <constant name="METHOD_HEAD" value="1"> + </constant> + <constant name="METHOD_POST" value="2"> + </constant> + <constant name="METHOD_PUT" value="3"> + </constant> + <constant name="METHOD_DELETE" value="4"> + </constant> + <constant name="METHOD_OPTIONS" value="5"> + </constant> + <constant name="METHOD_TRACE" value="6"> + </constant> + <constant name="METHOD_CONNECT" value="7"> + </constant> + <constant name="METHOD_MAX" value="8"> + </constant> + <constant name="STATUS_DISCONNECTED" value="0"> + </constant> + <constant name="STATUS_RESOLVING" value="1"> + </constant> + <constant name="STATUS_CANT_RESOLVE" value="2"> + </constant> + <constant name="STATUS_CONNECTING" value="3"> + </constant> + <constant name="STATUS_CANT_CONNECT" value="4"> + </constant> + <constant name="STATUS_CONNECTED" value="5"> + </constant> + <constant name="STATUS_REQUESTING" value="6"> + </constant> + <constant name="STATUS_BODY" value="7"> + </constant> + <constant name="STATUS_CONNECTION_ERROR" value="8"> + </constant> + <constant name="STATUS_SSL_HANDSHAKE_ERROR" value="9"> + </constant> + <constant name="RESPONSE_CONTINUE" value="100"> + </constant> + <constant name="RESPONSE_SWITCHING_PROTOCOLS" value="101"> + </constant> + <constant name="RESPONSE_PROCESSING" value="102"> + </constant> + <constant name="RESPONSE_OK" value="200"> + </constant> + <constant name="RESPONSE_CREATED" value="201"> + </constant> + <constant name="RESPONSE_ACCEPTED" value="202"> + </constant> + <constant name="RESPONSE_NON_AUTHORITATIVE_INFORMATION" value="203"> + </constant> + <constant name="RESPONSE_NO_CONTENT" value="204"> + </constant> + <constant name="RESPONSE_RESET_CONTENT" value="205"> + </constant> + <constant name="RESPONSE_PARTIAL_CONTENT" value="206"> + </constant> + <constant name="RESPONSE_MULTI_STATUS" value="207"> + </constant> + <constant name="RESPONSE_IM_USED" value="226"> + </constant> + <constant name="RESPONSE_MULTIPLE_CHOICES" value="300"> + </constant> + <constant name="RESPONSE_MOVED_PERMANENTLY" value="301"> + </constant> + <constant name="RESPONSE_FOUND" value="302"> + </constant> + <constant name="RESPONSE_SEE_OTHER" value="303"> + </constant> + <constant name="RESPONSE_NOT_MODIFIED" value="304"> + </constant> + <constant name="RESPONSE_USE_PROXY" value="305"> + </constant> + <constant name="RESPONSE_TEMPORARY_REDIRECT" value="307"> + </constant> + <constant name="RESPONSE_BAD_REQUEST" value="400"> + </constant> + <constant name="RESPONSE_UNAUTHORIZED" value="401"> + </constant> + <constant name="RESPONSE_PAYMENT_REQUIRED" value="402"> + </constant> + <constant name="RESPONSE_FORBIDDEN" value="403"> + </constant> + <constant name="RESPONSE_NOT_FOUND" value="404"> + </constant> + <constant name="RESPONSE_METHOD_NOT_ALLOWED" value="405"> + </constant> + <constant name="RESPONSE_NOT_ACCEPTABLE" value="406"> + </constant> + <constant name="RESPONSE_PROXY_AUTHENTICATION_REQUIRED" value="407"> + </constant> + <constant name="RESPONSE_REQUEST_TIMEOUT" value="408"> + </constant> + <constant name="RESPONSE_CONFLICT" value="409"> + </constant> + <constant name="RESPONSE_GONE" value="410"> + </constant> + <constant name="RESPONSE_LENGTH_REQUIRED" value="411"> + </constant> + <constant name="RESPONSE_PRECONDITION_FAILED" value="412"> + </constant> + <constant name="RESPONSE_REQUEST_ENTITY_TOO_LARGE" value="413"> + </constant> + <constant name="RESPONSE_REQUEST_URI_TOO_LONG" value="414"> + </constant> + <constant name="RESPONSE_UNSUPPORTED_MEDIA_TYPE" value="415"> + </constant> + <constant name="RESPONSE_REQUESTED_RANGE_NOT_SATISFIABLE" value="416"> + </constant> + <constant name="RESPONSE_EXPECTATION_FAILED" value="417"> + </constant> + <constant name="RESPONSE_UNPROCESSABLE_ENTITY" value="422"> + </constant> + <constant name="RESPONSE_LOCKED" value="423"> + </constant> + <constant name="RESPONSE_FAILED_DEPENDENCY" value="424"> + </constant> + <constant name="RESPONSE_UPGRADE_REQUIRED" value="426"> + </constant> + <constant name="RESPONSE_INTERNAL_SERVER_ERROR" value="500"> + </constant> + <constant name="RESPONSE_NOT_IMPLEMENTED" value="501"> + </constant> + <constant name="RESPONSE_BAD_GATEWAY" value="502"> + </constant> + <constant name="RESPONSE_SERVICE_UNAVAILABLE" value="503"> + </constant> + <constant name="RESPONSE_GATEWAY_TIMEOUT" value="504"> + </constant> + <constant name="RESPONSE_HTTP_VERSION_NOT_SUPPORTED" value="505"> + </constant> + <constant name="RESPONSE_INSUFFICIENT_STORAGE" value="507"> + </constant> + <constant name="RESPONSE_NOT_EXTENDED" value="510"> + </constant> + </constants> +</class> diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml new file mode 100644 index 0000000000..c2839890cf --- /dev/null +++ b/doc/classes/HTTPRequest.xml @@ -0,0 +1,184 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="HTTPRequest" inherits="Node" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + A Node with the ability to send HTTP requests. + </brief_description> + <description> + A Node with the ability to send HTTP requests. Uses a [HTTPClient] internally, supports HTTPS. + Can be used to make HTTP requests or download files via HTTP. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="cancel_request"> + <return type="void"> + </return> + <description> + Cancel the current request. + </description> + </method> + <method name="get_body_size" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the response body length. + </description> + </method> + <method name="get_body_size_limit" qualifiers="const"> + <return type="int"> + </return> + <description> + Return current body size limit. + </description> + </method> + <method name="get_download_file" qualifiers="const"> + <return type="String"> + </return> + <description> + Return the file this request will download into. + </description> + </method> + <method name="get_downloaded_bytes" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the amount of bytes this HTTPRequest downloaded. + </description> + </method> + <method name="get_http_client_status" qualifiers="const"> + <return type="int" enum="HTTPClient.Status"> + </return> + <description> + Return the current status of the underlying [HTTPClient]. + </description> + </method> + <method name="get_max_redirects" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the maximum amount of redirects that will be followed. + </description> + </method> + <method name="is_using_threads" qualifiers="const"> + <return type="bool"> + </return> + <description> + Whether this request is using threads. + </description> + </method> + <method name="request"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="url" type="String"> + </argument> + <argument index="1" name="custom_headers" type="PoolStringArray" default="PoolStringArray( )"> + </argument> + <argument index="2" name="ssl_validate_domain" type="bool" default="true"> + </argument> + <argument index="3" name="method" type="int" enum="HTTPClient.Method" default="0"> + </argument> + <argument index="4" name="request_data" type="String" default=""""> + </argument> + <description> + </description> + </method> + <method name="set_body_size_limit"> + <return type="void"> + </return> + <argument index="0" name="bytes" type="int"> + </argument> + <description> + Set the response body size limit. + </description> + </method> + <method name="set_download_file"> + <return type="void"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + Set the file to download into. Outputs the response body into the file. + </description> + </method> + <method name="set_max_redirects"> + <return type="void"> + </return> + <argument index="0" name="amount" type="int"> + </argument> + <description> + Set the maximum amount of redirects the request will follow. + </description> + </method> + <method name="set_use_threads"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Make this HTTPRequest use threads. + </description> + </method> + </methods> + <members> + <member name="body_size_limit" type="int" setter="set_body_size_limit" getter="get_body_size_limit"> + </member> + <member name="max_redirects" type="int" setter="set_max_redirects" getter="get_max_redirects"> + </member> + <member name="use_threads" type="bool" setter="set_use_threads" getter="is_using_threads"> + </member> + </members> + <signals> + <signal name="request_completed"> + <argument index="0" name="result" type="int"> + </argument> + <argument index="1" name="response_code" type="int"> + </argument> + <argument index="2" name="headers" type="PoolStringArray"> + </argument> + <argument index="3" name="body" type="PoolByteArray"> + </argument> + <description> + This signal is emitted upon request completion. + </description> + </signal> + </signals> + <constants> + <constant name="RESULT_SUCCESS" value="0"> + Request successful. + </constant> + <constant name="RESULT_CHUNKED_BODY_SIZE_MISMATCH" value="1"> + </constant> + <constant name="RESULT_CANT_CONNECT" value="2"> + Request failed while connecting. + </constant> + <constant name="RESULT_CANT_RESOLVE" value="3"> + Request failed while resolving. + </constant> + <constant name="RESULT_CONNECTION_ERROR" value="4"> + Request failed due to connection(read/write) error. + </constant> + <constant name="RESULT_SSL_HANDSHAKE_ERROR" value="5"> + Request failed on SSL handshake. + </constant> + <constant name="RESULT_NO_RESPONSE" value="6"> + Request does not have a response(yet). + </constant> + <constant name="RESULT_BODY_SIZE_LIMIT_EXCEEDED" value="7"> + Request exceded its maximum size limit, see [method set_body_size_limit]. + </constant> + <constant name="RESULT_REQUEST_FAILED" value="8"> + Request failed. (unused) + </constant> + <constant name="RESULT_DOWNLOAD_FILE_CANT_OPEN" value="9"> + HTTPRequest couldn't open the download file. + </constant> + <constant name="RESULT_DOWNLOAD_FILE_WRITE_ERROR" value="10"> + HTTPRequest couldn't write to the download file. + </constant> + <constant name="RESULT_REDIRECT_LIMIT_REACHED" value="11"> + Request reached its maximum redirect limit, see [method set_max_redirects]. + </constant> + </constants> +</class> diff --git a/doc/classes/HingeJoint.xml b/doc/classes/HingeJoint.xml new file mode 100644 index 0000000000..ae3693c3a4 --- /dev/null +++ b/doc/classes/HingeJoint.xml @@ -0,0 +1,97 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="HingeJoint" inherits="Joint" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_flag" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="flag" type="int" enum="HingeJoint.Flag"> + </argument> + <description> + </description> + </method> + <method name="get_param" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="param" type="int" enum="HingeJoint.Param"> + </argument> + <description> + </description> + </method> + <method name="set_flag"> + <return type="void"> + </return> + <argument index="0" name="flag" type="int" enum="HingeJoint.Flag"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_param"> + <return type="void"> + </return> + <argument index="0" name="param" type="int" enum="HingeJoint.Param"> + </argument> + <argument index="1" name="value" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="angular_limit/bias" type="float" setter="set_param" getter="get_param"> + </member> + <member name="angular_limit/enable" type="bool" setter="set_flag" getter="get_flag"> + </member> + <member name="angular_limit/lower" type="float" setter="_set_lower_limit" getter="_get_lower_limit"> + </member> + <member name="angular_limit/relaxation" type="float" setter="set_param" getter="get_param"> + </member> + <member name="angular_limit/softness" type="float" setter="set_param" getter="get_param"> + </member> + <member name="angular_limit/upper" type="float" setter="_set_upper_limit" getter="_get_upper_limit"> + </member> + <member name="motor/enable" type="bool" setter="set_flag" getter="get_flag"> + </member> + <member name="motor/max_impulse" type="float" setter="set_param" getter="get_param"> + </member> + <member name="motor/target_velocity" type="float" setter="set_param" getter="get_param"> + </member> + <member name="params/bias" type="float" setter="set_param" getter="get_param"> + </member> + </members> + <constants> + <constant name="PARAM_BIAS" value="0"> + </constant> + <constant name="PARAM_LIMIT_UPPER" value="1"> + </constant> + <constant name="PARAM_LIMIT_LOWER" value="2"> + </constant> + <constant name="PARAM_LIMIT_BIAS" value="3"> + </constant> + <constant name="PARAM_LIMIT_SOFTNESS" value="4"> + </constant> + <constant name="PARAM_LIMIT_RELAXATION" value="5"> + </constant> + <constant name="PARAM_MOTOR_TARGET_VELOCITY" value="6"> + </constant> + <constant name="PARAM_MOTOR_MAX_IMPULSE" value="7"> + </constant> + <constant name="PARAM_MAX" value="8"> + </constant> + <constant name="FLAG_USE_LIMIT" value="0"> + </constant> + <constant name="FLAG_ENABLE_MOTOR" value="1"> + </constant> + <constant name="FLAG_MAX" value="2"> + </constant> + </constants> +</class> diff --git a/doc/classes/IP.xml b/doc/classes/IP.xml new file mode 100644 index 0000000000..fed7000df6 --- /dev/null +++ b/doc/classes/IP.xml @@ -0,0 +1,102 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="IP" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + IP Protocol support functions. + </brief_description> + <description> + IP contains support functions for the IPv4 protocol. TCP/IP support is in different classes (see [StreamPeerTCP] and [TCP_Server]). IP provides hostname resolution support, both blocking and threaded. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="clear_cache"> + <return type="void"> + </return> + <argument index="0" name="hostname" type="String" default=""""> + </argument> + <description> + Removes all of a "hostname"'s cached references. If no "hostname" is given then all cached IP addresses are removed. + </description> + </method> + <method name="erase_resolve_item"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + 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. + </description> + </method> + <method name="get_local_addresses" qualifiers="const"> + <return type="Array"> + </return> + <description> + Returns all of the user's current IPv4 and IPv6 addresses as an array. + </description> + </method> + <method name="get_resolve_item_address" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + 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 [method get_resolve_item_status]). + </description> + </method> + <method name="get_resolve_item_status" qualifiers="const"> + <return type="int" enum="IP.ResolverStatus"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + Returns a queued hostname's status as a RESOLVER_STATUS_* constant, given its queue "id". + </description> + </method> + <method name="resolve_hostname"> + <return type="String"> + </return> + <argument index="0" name="host" type="String"> + </argument> + <argument index="1" name="ip_type" type="int" enum="IP.Type" default="3"> + </argument> + <description> + 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". + </description> + </method> + <method name="resolve_hostname_queue_item"> + <return type="int"> + </return> + <argument index="0" name="host" type="String"> + </argument> + <argument index="1" name="ip_type" type="int" enum="IP.Type" default="3"> + </argument> + <description> + 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. + </description> + </method> + </methods> + <constants> + <constant name="RESOLVER_STATUS_NONE" value="0"> + </constant> + <constant name="RESOLVER_STATUS_WAITING" value="1"> + </constant> + <constant name="RESOLVER_STATUS_DONE" value="2"> + </constant> + <constant name="RESOLVER_STATUS_ERROR" value="3"> + </constant> + <constant name="RESOLVER_MAX_QUERIES" value="32" enum=""> + </constant> + <constant name="RESOLVER_INVALID_ID" value="-1" enum=""> + </constant> + <constant name="TYPE_NONE" value="0"> + </constant> + <constant name="TYPE_IPV4" value="1"> + </constant> + <constant name="TYPE_IPV6" value="2"> + </constant> + <constant name="TYPE_ANY" value="3"> + </constant> + </constants> +</class> diff --git a/doc/classes/IP_Unix.xml b/doc/classes/IP_Unix.xml new file mode 100644 index 0000000000..d30ad795a8 --- /dev/null +++ b/doc/classes/IP_Unix.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="IP_Unix" inherits="IP" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml new file mode 100644 index 0000000000..f4ea9d00ce --- /dev/null +++ b/doc/classes/Image.xml @@ -0,0 +1,485 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Image" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Image datatype. + </brief_description> + <description> + Native image datatype. Contains image data, which can be converted to a texture, and several functions to interact with it. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="blend_rect"> + <return type="void"> + </return> + <argument index="0" name="src" type="Image"> + </argument> + <argument index="1" name="src_rect" type="Rect2"> + </argument> + <argument index="2" name="dst" type="Vector2"> + </argument> + <description> + Alpha-blends a "src_rect" [Rect2] from "src" [Image] to this [Image] on coordinates "dest". + </description> + </method> + <method name="blend_rect_mask"> + <return type="void"> + </return> + <argument index="0" name="src" type="Image"> + </argument> + <argument index="1" name="mask" type="Image"> + </argument> + <argument index="2" name="src_rect" type="Rect2"> + </argument> + <argument index="3" name="dst" type="Vector2"> + </argument> + <description> + Alpha-blends a "src_rect" [Rect2] from "src" [Image] to this [Image] using a "mask" [Image] on coordinates "dest". Alpha channels are required for both "src" and "mask", dest pixels and src pixels will blend if the corresponding mask pixel's alpha value is not 0. "src" [Image] and "mask" [Image] *must* have the same size (width and height) but they can have different formats + </description> + </method> + <method name="blit_rect"> + <return type="void"> + </return> + <argument index="0" name="src" type="Image"> + </argument> + <argument index="1" name="src_rect" type="Rect2"> + </argument> + <argument index="2" name="dst" type="Vector2"> + </argument> + <description> + Copy a "src_rect" [Rect2] from "src" [Image] to this [Image] on coordinates "dest". + </description> + </method> + <method name="blit_rect_mask"> + <return type="void"> + </return> + <argument index="0" name="src" type="Image"> + </argument> + <argument index="1" name="mask" type="Image"> + </argument> + <argument index="2" name="src_rect" type="Rect2"> + </argument> + <argument index="3" name="dst" type="Vector2"> + </argument> + <description> + Blits a "src_rect" [Rect2] from "src" [Image] to this [Image] using a "mask" [Image] on coordinates "dest". Alpha channel is required for "mask", will copy src pixel onto dest if the corresponding mask pixel's alpha value is not 0. "src" [Image] and "mask" [Image] *must* have the same size (width and height) but they can have different formats + </description> + </method> + <method name="clear_mipmaps"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="compress"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="mode" type="int" enum="Image.CompressMode"> + </argument> + <argument index="1" name="source" type="int" enum="Image.CompressSource"> + </argument> + <argument index="2" name="lossy_quality" type="float"> + </argument> + <description> + </description> + </method> + <method name="convert"> + <return type="void"> + </return> + <argument index="0" name="format" type="int" enum="Image.Format"> + </argument> + <description> + </description> + </method> + <method name="copy_from"> + <return type="void"> + </return> + <argument index="0" name="src" type="Image"> + </argument> + <description> + </description> + </method> + <method name="create"> + <return type="void"> + </return> + <argument index="0" name="width" type="int"> + </argument> + <argument index="1" name="height" type="int"> + </argument> + <argument index="2" name="use_mipmaps" type="bool"> + </argument> + <argument index="3" name="format" type="int" enum="Image.Format"> + </argument> + <description> + Create an empty image of a specific size and format. + </description> + </method> + <method name="create_from_data"> + <return type="void"> + </return> + <argument index="0" name="width" type="int"> + </argument> + <argument index="1" name="height" type="int"> + </argument> + <argument index="2" name="use_mipmaps" type="bool"> + </argument> + <argument index="3" name="format" type="int" enum="Image.Format"> + </argument> + <argument index="4" name="data" type="PoolByteArray"> + </argument> + <description> + </description> + </method> + <method name="crop"> + <return type="void"> + </return> + <argument index="0" name="width" type="int"> + </argument> + <argument index="1" name="height" type="int"> + </argument> + <description> + </description> + </method> + <method name="decompress"> + <return type="int" enum="Error"> + </return> + <description> + </description> + </method> + <method name="detect_alpha" qualifiers="const"> + <return type="int" enum="Image.AlphaMode"> + </return> + <description> + </description> + </method> + <method name="expand_x2_hq2x"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="fill"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + Fills an [Image] with a specified [Color] + </description> + </method> + <method name="fix_alpha_edges"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="flip_x"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="flip_y"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="generate_mipmaps"> + <return type="int" enum="Error"> + </return> + <description> + </description> + </method> + <method name="get_data" qualifiers="const"> + <return type="PoolByteArray"> + </return> + <description> + Return the raw data of the [Image]. + </description> + </method> + <method name="get_format" qualifiers="const"> + <return type="int" enum="Image.Format"> + </return> + <description> + Return the format of the [Image], one of [Image].FORMAT_*. + </description> + </method> + <method name="get_height" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the height of the [Image]. + </description> + </method> + <method name="get_mipmap_offset" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="mipmap" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_pixel" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="x" type="int"> + </argument> + <argument index="1" name="y" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_rect" qualifiers="const"> + <return type="Image"> + </return> + <argument index="0" name="rect" type="Rect2"> + </argument> + <description> + Return a new [Image] that is a copy of "area" in this [Image]. + </description> + </method> + <method name="get_size" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_used_rect" qualifiers="const"> + <return type="Rect2"> + </return> + <description> + Return the area of this [Image] that is used/visibly colored/opaque. + </description> + </method> + <method name="get_width" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the width of the [Image]. + </description> + </method> + <method name="has_mipmaps" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_compressed" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_empty" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_invisible" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="load"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + Load an [Image]. + </description> + </method> + <method name="lock"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="normalmap_to_xy"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="premultiply_alpha"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="resize"> + <return type="void"> + </return> + <argument index="0" name="width" type="int"> + </argument> + <argument index="1" name="height" type="int"> + </argument> + <argument index="2" name="interpolation" type="int" enum="Image.Interpolation" default="1"> + </argument> + <description> + </description> + </method> + <method name="resize_to_po2"> + <return type="void"> + </return> + <argument index="0" name="square" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="save_png" qualifiers="const"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + Save this [Image] as a png. + </description> + </method> + <method name="set_pixel"> + <return type="void"> + </return> + <argument index="0" name="x" type="int"> + </argument> + <argument index="1" name="y" type="int"> + </argument> + <argument index="2" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="shrink_x2"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="srgb_to_linear"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="unlock"> + <return type="void"> + </return> + <description> + </description> + </method> + </methods> + <members> + <member name="data" type="Dictionary" setter="_set_data" getter="_get_data"> + </member> + </members> + <constants> + <constant name="FORMAT_L8" value="0"> + </constant> + <constant name="FORMAT_LA8" value="1"> + </constant> + <constant name="FORMAT_R8" value="2"> + </constant> + <constant name="FORMAT_RG8" value="3"> + </constant> + <constant name="FORMAT_RGB8" value="4"> + </constant> + <constant name="FORMAT_RGBA8" value="5"> + </constant> + <constant name="FORMAT_RGBA4444" value="6"> + </constant> + <constant name="FORMAT_RGBA5551" value="7"> + </constant> + <constant name="FORMAT_RF" value="8"> + </constant> + <constant name="FORMAT_RGF" value="9"> + </constant> + <constant name="FORMAT_RGBF" value="10"> + </constant> + <constant name="FORMAT_RGBAF" value="11"> + </constant> + <constant name="FORMAT_RH" value="12"> + </constant> + <constant name="FORMAT_RGH" value="13"> + </constant> + <constant name="FORMAT_RGBH" value="14"> + </constant> + <constant name="FORMAT_RGBAH" value="15"> + </constant> + <constant name="FORMAT_RGBE9995" value="16"> + </constant> + <constant name="FORMAT_DXT1" value="17"> + </constant> + <constant name="FORMAT_DXT3" value="18"> + </constant> + <constant name="FORMAT_DXT5" value="19"> + </constant> + <constant name="FORMAT_RGTC_R" value="20"> + </constant> + <constant name="FORMAT_RGTC_RG" value="21"> + </constant> + <constant name="FORMAT_BPTC_RGBA" value="22"> + </constant> + <constant name="FORMAT_BPTC_RGBF" value="23"> + </constant> + <constant name="FORMAT_BPTC_RGBFU" value="24"> + </constant> + <constant name="FORMAT_PVRTC2" value="25"> + </constant> + <constant name="FORMAT_PVRTC2A" value="26"> + </constant> + <constant name="FORMAT_PVRTC4" value="27"> + </constant> + <constant name="FORMAT_PVRTC4A" value="28"> + </constant> + <constant name="FORMAT_ETC" value="29"> + </constant> + <constant name="FORMAT_ETC2_R11" value="30"> + </constant> + <constant name="FORMAT_ETC2_R11S" value="31"> + </constant> + <constant name="FORMAT_ETC2_RG11" value="32"> + </constant> + <constant name="FORMAT_ETC2_RG11S" value="33"> + </constant> + <constant name="FORMAT_ETC2_RGB8" value="34"> + </constant> + <constant name="FORMAT_ETC2_RGBA8" value="35"> + </constant> + <constant name="FORMAT_ETC2_RGB8A1" value="36"> + </constant> + <constant name="FORMAT_MAX" value="37"> + </constant> + <constant name="INTERPOLATE_NEAREST" value="0"> + </constant> + <constant name="INTERPOLATE_BILINEAR" value="1"> + </constant> + <constant name="INTERPOLATE_CUBIC" value="2"> + </constant> + <constant name="ALPHA_NONE" value="0"> + </constant> + <constant name="ALPHA_BIT" value="1"> + </constant> + <constant name="ALPHA_BLEND" value="2"> + </constant> + <constant name="COMPRESS_S3TC" value="0"> + </constant> + <constant name="COMPRESS_PVRTC2" value="1"> + </constant> + <constant name="COMPRESS_PVRTC4" value="2"> + </constant> + <constant name="COMPRESS_ETC" value="3"> + </constant> + <constant name="COMPRESS_ETC2" value="4"> + </constant> + <constant name="COMPRESS_SOURCE_GENERIC" value="0"> + </constant> + <constant name="COMPRESS_SOURCE_SRGB" value="1"> + </constant> + <constant name="COMPRESS_SOURCE_NORMAL" value="2"> + </constant> + </constants> +</class> diff --git a/doc/classes/ImageTexture.xml b/doc/classes/ImageTexture.xml new file mode 100644 index 0000000000..2b74a15fd5 --- /dev/null +++ b/doc/classes/ImageTexture.xml @@ -0,0 +1,119 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ImageTexture" inherits="Texture" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + A [Texture] based on an [Image]. + </brief_description> + <description> + A [Texture] based on an [Image]. Can be created from an [Image]. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="create"> + <return type="void"> + </return> + <argument index="0" name="width" type="int"> + </argument> + <argument index="1" name="height" type="int"> + </argument> + <argument index="2" name="format" type="int" enum="Image.Format"> + </argument> + <argument index="3" name="flags" type="int" default="7"> + </argument> + <description> + Create a new [ImageTexture] with "width" and "height". + "format" one of [Image].FORMAT_*. + "flags" one or more of [Texture].FLAG_*. + </description> + </method> + <method name="create_from_image"> + <return type="void"> + </return> + <argument index="0" name="image" type="Image"> + </argument> + <argument index="1" name="flags" type="int" default="7"> + </argument> + <description> + Create a new [ImageTexture] from an [Image] with "flags" from [Texture].FLAG_*. + </description> + </method> + <method name="get_format" qualifiers="const"> + <return type="int" enum="Image.Format"> + </return> + <description> + Return the format of the [ImageTexture], one of [Image].FORMAT_*. + </description> + </method> + <method name="get_lossy_storage_quality" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the storage quality for [ImageTexture].STORAGE_COMPRESS_LOSSY. + </description> + </method> + <method name="get_storage" qualifiers="const"> + <return type="int" enum="ImageTexture.Storage"> + </return> + <description> + Return the storage type. One of [ImageTexture].STORAGE_*. + </description> + </method> + <method name="load"> + <return type="void"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + Load an [ImageTexure]. + </description> + </method> + <method name="set_data"> + <return type="void"> + </return> + <argument index="0" name="image" type="Image"> + </argument> + <description> + Set the [Image] of this [ImageTexture]. + </description> + </method> + <method name="set_lossy_storage_quality"> + <return type="void"> + </return> + <argument index="0" name="quality" type="float"> + </argument> + <description> + Set the storage quality in case of [ImageTexture].STORAGE_COMPRESS_LOSSY. + </description> + </method> + <method name="set_size_override"> + <return type="void"> + </return> + <argument index="0" name="size" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_storage"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="ImageTexture.Storage"> + </argument> + <description> + Set the storage type. One of [ImageTexture].STORAGE_*. + </description> + </method> + </methods> + <constants> + <constant name="STORAGE_RAW" value="0"> + [Image] data is stored raw and unaltered. + </constant> + <constant name="STORAGE_COMPRESS_LOSSY" value="1"> + [Image] data is compressed with a lossy algorithm. You can set the storage quality with [method set_lossy_storage_quality]. + </constant> + <constant name="STORAGE_COMPRESS_LOSSLESS" value="2"> + [Image] data is compressed with a lossless algorithm. + </constant> + </constants> +</class> diff --git a/doc/classes/ImmediateGeometry.xml b/doc/classes/ImmediateGeometry.xml new file mode 100644 index 0000000000..7b45c0c678 --- /dev/null +++ b/doc/classes/ImmediateGeometry.xml @@ -0,0 +1,111 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ImmediateGeometry" inherits="GeometryInstance" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Node to draw simple geometry from code, ala OpenGL 1.x + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_sphere"> + <return type="void"> + </return> + <argument index="0" name="lats" type="int"> + </argument> + <argument index="1" name="lons" type="int"> + </argument> + <argument index="2" name="radius" type="float"> + </argument> + <argument index="3" name="add_uv" type="bool" default="true"> + </argument> + <description> + Simple helper to draw a uvsphere, with given latitudes, longitude and radius. + </description> + </method> + <method name="add_vertex"> + <return type="void"> + </return> + <argument index="0" name="pos" type="Vector3"> + </argument> + <description> + Add a vertex with the currently set color/uv/etc. + </description> + </method> + <method name="begin"> + <return type="void"> + </return> + <argument index="0" name="primitive" type="int" enum="Mesh.PrimitiveType"> + </argument> + <argument index="1" name="texture" type="Texture" default="null"> + </argument> + <description> + Begin drawing (And optionally pass a texture override). When done call end(). For more information on how this works, search for glBegin() glEnd() references. + For the type of primitive, use the [Mesh].PRIMITIVE_* enumerations. + </description> + </method> + <method name="clear"> + <return type="void"> + </return> + <description> + Clear everything that was drawn using begin/end. + </description> + </method> + <method name="end"> + <return type="void"> + </return> + <description> + Call this when done adding a batch of geometry, otherwise it can't be displayed. + </description> + </method> + <method name="set_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + Set the color that the next vertex will use to be drawn. + </description> + </method> + <method name="set_normal"> + <return type="void"> + </return> + <argument index="0" name="normal" type="Vector3"> + </argument> + <description> + Set the normal that the next vertex will use to be drawn. + </description> + </method> + <method name="set_tangent"> + <return type="void"> + </return> + <argument index="0" name="tangent" type="Plane"> + </argument> + <description> + Set the tangent (and binormal facing) that the next vertex will use to be drawn. + </description> + </method> + <method name="set_uv"> + <return type="void"> + </return> + <argument index="0" name="uv" type="Vector2"> + </argument> + <description> + Set the UV that the next vertex will use to be drawn. + </description> + </method> + <method name="set_uv2"> + <return type="void"> + </return> + <argument index="0" name="uv" type="Vector2"> + </argument> + <description> + Set the second layer of UV that the next vertex will use to be drawn. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml new file mode 100644 index 0000000000..f636000242 --- /dev/null +++ b/doc/classes/Input.xml @@ -0,0 +1,335 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Input" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + A Singleton that deals with inputs. + </brief_description> + <description> + A Singleton that deals with inputs. This includes key presses, mouse buttons and movement, joypads, and input actions. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="action_press"> + <return type="void"> + </return> + <argument index="0" name="action" type="String"> + </argument> + <description> + This will simulate pressing the specificed action. + </description> + </method> + <method name="action_release"> + <return type="void"> + </return> + <argument index="0" name="action" type="String"> + </argument> + <description> + If the specified action is already pressed, this will release it. + </description> + </method> + <method name="add_joy_mapping"> + <return type="void"> + </return> + <argument index="0" name="mapping" type="String"> + </argument> + <argument index="1" name="update_existing" type="bool" default="false"> + </argument> + <description> + Add a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices. + </description> + </method> + <method name="get_accelerometer" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + If the device has an accelerometer, this will return the movement. + </description> + </method> + <method name="get_connected_joypads"> + <return type="Array"> + </return> + <description> + Returns an [Array] containing the device IDs of all currently connected joypads. + </description> + </method> + <method name="get_gravity" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_gyroscope" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + If the device has a gyroscope, this will return the rate of rotation in rad/s around a device's x, y, and z axis. + </description> + </method> + <method name="get_joy_axis" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="device" type="int"> + </argument> + <argument index="1" name="axis" type="int"> + </argument> + <description> + Returns the current value of the joypad axis at given index (see JOY_* constants in [@Global Scope]) + </description> + </method> + <method name="get_joy_axis_index_from_string"> + <return type="int"> + </return> + <argument index="0" name="axis" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_joy_axis_string"> + <return type="String"> + </return> + <argument index="0" name="axis_index" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_joy_button_index_from_string"> + <return type="int"> + </return> + <argument index="0" name="button" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_joy_button_string"> + <return type="String"> + </return> + <argument index="0" name="button_index" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_joy_guid" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="device" type="int"> + </argument> + <description> + Returns a SDL2 compatible device guid on platforms that use gamepad remapping. Returns "Default Gamepad" otherwise. + </description> + </method> + <method name="get_joy_name"> + <return type="String"> + </return> + <argument index="0" name="device" type="int"> + </argument> + <description> + Returns the name of the joypad at the specified device index + </description> + </method> + <method name="get_joy_vibration_duration"> + <return type="float"> + </return> + <argument index="0" name="device" type="int"> + </argument> + <description> + Returns the duration of the current vibration effect in seconds. + </description> + </method> + <method name="get_joy_vibration_strength"> + <return type="Vector2"> + </return> + <argument index="0" name="device" type="int"> + </argument> + <description> + Returns the strength of the joypad vibration: x is the strength of the weak motor, and y is the strength of the strong motor. + </description> + </method> + <method name="get_last_mouse_speed" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Returns the mouse speed for the last time the cursor was moved, and this until the next frame where the mouse moves. This means that even if the mouse is not moving, this function will still return the value of the last motion. + </description> + </method> + <method name="get_magnetometer" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + If the device has a magnetometer, this will return the magnetic field strength in micro-Tesla for all axes. + </description> + </method> + <method name="get_mouse_button_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the same time the bits are added together. + </description> + </method> + <method name="get_mouse_mode" qualifiers="const"> + <return type="int" enum="Input.MouseMode"> + </return> + <description> + Return the mouse mode. See the constants for more information. + </description> + </method> + <method name="is_action_just_pressed" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="action" type="String"> + </argument> + <description> + </description> + </method> + <method name="is_action_just_released" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="action" type="String"> + </argument> + <description> + </description> + </method> + <method name="is_action_pressed" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="action" type="String"> + </argument> + <description> + Returns true or false depending on whether the action event is pressed. Actions and their events can be set in the Project Settings / Input Map tab. Or be set with [InputMap]. + </description> + </method> + <method name="is_joy_button_pressed" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="device" type="int"> + </argument> + <argument index="1" name="button" type="int"> + </argument> + <description> + Returns if the joypad button at the given index is currently pressed. (see JOY_* constants in [@Global Scope]) + </description> + </method> + <method name="is_joy_known"> + <return type="bool"> + </return> + <argument index="0" name="device" type="int"> + </argument> + <description> + Returns if the specified device is known by the system. This means that it sets all button and axis indices exactly as defined in the JOY_* constants (see [@Global Scope]). Unknown joypads are not expected to match these constants, but you can still retrieve events from them. + </description> + </method> + <method name="is_key_pressed" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="scancode" type="int"> + </argument> + <description> + Returns true or false depending on whether the key is pressed or not. You can pass KEY_*, which are pre-defined constants listed in [@Global Scope]. + </description> + </method> + <method name="is_mouse_button_pressed" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="button" type="int"> + </argument> + <description> + Returns true or false depending on whether mouse button is pressed or not. You can pass BUTTON_*, which are pre-defined constants listed in [@Global Scope]. + </description> + </method> + <method name="parse_input_event"> + <return type="void"> + </return> + <argument index="0" name="event" type="InputEvent"> + </argument> + <description> + </description> + </method> + <method name="remove_joy_mapping"> + <return type="void"> + </return> + <argument index="0" name="guid" type="String"> + </argument> + <description> + Removes all mappings from the internal db that match the given uid. + </description> + </method> + <method name="set_custom_mouse_cursor"> + <return type="void"> + </return> + <argument index="0" name="image" type="Resource"> + </argument> + <argument index="1" name="hotspot" type="Vector2" default="Vector2( 0, 0 )"> + </argument> + <description> + </description> + </method> + <method name="set_mouse_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="Input.MouseMode"> + </argument> + <description> + Set the mouse mode. See the constants for more information. + </description> + </method> + <method name="start_joy_vibration"> + <return type="void"> + </return> + <argument index="0" name="device" type="int"> + </argument> + <argument index="1" name="weak_magnitude" type="float"> + </argument> + <argument index="2" name="strong_magnitude" type="float"> + </argument> + <argument index="3" name="duration" type="float" default="0"> + </argument> + <description> + Starts to vibrate the joypad. Joypads usually come with two rumble motors, a strong and a weak one. weak_magnitude is the strength of the weak motor (between 0 and 1) and strong_magnitude is the strength of the strong motor (between 0 and 1). duration is the duration of the effect in seconds (a duration of 0 will try to play the vibration indefinitely). + Note that not every hardware is compatible with long effect durations, it is recommended to restart an effect if in need to play it for more than a few seconds. + </description> + </method> + <method name="stop_joy_vibration"> + <return type="void"> + </return> + <argument index="0" name="device" type="int"> + </argument> + <description> + Stops the vibration of the joypad. + </description> + </method> + <method name="warp_mouse_pos"> + <return type="void"> + </return> + <argument index="0" name="to" type="Vector2"> + </argument> + <description> + Sets the mouse position to the specified vector. + </description> + </method> + </methods> + <signals> + <signal name="joy_connection_changed"> + <argument index="0" name="index" type="int"> + </argument> + <argument index="1" name="connected" type="bool"> + </argument> + <description> + Emitted when a joypad device has been connected or disconnected + </description> + </signal> + </signals> + <constants> + <constant name="MOUSE_MODE_VISIBLE" value="0"> + Makes the mouse cursor visible if it is hidden. + </constant> + <constant name="MOUSE_MODE_HIDDEN" value="1"> + Makes the mouse cursor hidden if it is visible. + </constant> + <constant name="MOUSE_MODE_CAPTURED" value="2"> + Captures the mouse. The mouse will be hidden and unable to leave the game window. But it will still register movement and mouse button presses. + </constant> + <constant name="MOUSE_MODE_CONFINED" value="3"> + </constant> + </constants> +</class> diff --git a/doc/classes/InputDefault.xml b/doc/classes/InputDefault.xml new file mode 100644 index 0000000000..cb8ad6b823 --- /dev/null +++ b/doc/classes/InputDefault.xml @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="InputDefault" inherits="Input" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Default implementation of the [Input] class. + </brief_description> + <description> + Default implementation of the [Input] class, used internally by the editor and games for default input management. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/InputEvent.xml b/doc/classes/InputEvent.xml new file mode 100644 index 0000000000..392ee25ad6 --- /dev/null +++ b/doc/classes/InputEvent.xml @@ -0,0 +1,131 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="InputEvent" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Generic input event + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="action_match" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="event" type="InputEvent"> + </argument> + <description> + Returns true if this input event matches the event passed. + </description> + </method> + <method name="as_text" qualifiers="const"> + <return type="String"> + </return> + <description> + Returns a [String] representation of the event. + </description> + </method> + <method name="get_device" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the id of the device that generated the event. + </description> + </method> + <method name="get_id" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the id of the event. + </description> + </method> + <method name="is_action" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="action" type="String"> + </argument> + <description> + Returns true if this input event matches a pre-defined action, no matter the type. + </description> + </method> + <method name="is_action_pressed" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="action" type="String"> + </argument> + <description> + Returns true if the given action is being pressed (and is not an echo event for KEY events). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. + </description> + </method> + <method name="is_action_released" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="action" type="String"> + </argument> + <description> + Returns true if the given action is released (i.e. not pressed). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. + </description> + </method> + <method name="is_action_type" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_echo" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns true if this input event is an echo event (only for events of type KEY, it will return false for other types). + </description> + </method> + <method name="is_pressed" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns true if this input event is pressed. Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. + </description> + </method> + <method name="set_device"> + <return type="void"> + </return> + <argument index="0" name="device" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_id"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="shortcut_match" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="event" type="InputEvent"> + </argument> + <description> + </description> + </method> + <method name="xformed_by" qualifiers="const"> + <return type="InputEvent"> + </return> + <argument index="0" name="xform" type="Transform2D"> + </argument> + <argument index="1" name="local_ofs" type="Vector2" default="Vector2( 0, 0 )"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="device" type="int" setter="set_device" getter="get_device"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/InputEventAction.xml b/doc/classes/InputEventAction.xml new file mode 100644 index 0000000000..2617ea4dfa --- /dev/null +++ b/doc/classes/InputEventAction.xml @@ -0,0 +1,44 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="InputEventAction" inherits="InputEvent" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Input event type for actions. + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_action" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="set_action"> + <return type="void"> + </return> + <argument index="0" name="action" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_pressed"> + <return type="void"> + </return> + <argument index="0" name="pressed" type="bool"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="action" type="String" setter="set_action" getter="get_action"> + </member> + <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/InputEventJoypadButton.xml b/doc/classes/InputEventJoypadButton.xml new file mode 100644 index 0000000000..2784b06442 --- /dev/null +++ b/doc/classes/InputEventJoypadButton.xml @@ -0,0 +1,63 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="InputEventJoypadButton" inherits="InputEvent" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Input event type for joypad button events. + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_button_index" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_pressure" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="set_button_index"> + <return type="void"> + </return> + <argument index="0" name="button_index" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_pressed"> + <return type="void"> + </return> + <argument index="0" name="pressed" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_pressure"> + <return type="void"> + </return> + <argument index="0" name="pressure" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="button_index" type="int" setter="set_button_index" getter="get_button_index"> + Joypad button identifier, one of the JOY_BUTTON_* constants in [@Global Scope]. + </member> + <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed"> + Pressed state of the joypad button. + </member> + <member name="pressure" type="float" setter="set_pressure" getter="get_pressure"> + Intensity of the button pressure, ranges from 0 to 1.0. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/InputEventJoypadMotion.xml b/doc/classes/InputEventJoypadMotion.xml new file mode 100644 index 0000000000..8a26007fc1 --- /dev/null +++ b/doc/classes/InputEventJoypadMotion.xml @@ -0,0 +1,52 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="InputEventJoypadMotion" inherits="InputEvent" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Input event type for joypad motion/axis events. + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_axis" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_axis_value" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="set_axis"> + <return type="void"> + </return> + <argument index="0" name="axis" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_axis_value"> + <return type="void"> + </return> + <argument index="0" name="axis_value" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="axis" type="int" setter="set_axis" getter="get_axis"> + Joypad axis identifier, one of the JOY_AXIS_* constants in [@Global Scope]. + </member> + <member name="axis_value" type="float" setter="set_axis_value" getter="get_axis_value"> + Position of the axis, ranging from -1.0 to 1.0. A value of 0 means that the axis is in its neutral position. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/InputEventKey.xml b/doc/classes/InputEventKey.xml new file mode 100644 index 0000000000..151e19d25d --- /dev/null +++ b/doc/classes/InputEventKey.xml @@ -0,0 +1,80 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="InputEventKey" inherits="InputEventWithModifiers" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Input event type for keyboard events. + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_scancode" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_scancode_with_modifiers" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_unicode" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_echo"> + <return type="void"> + </return> + <argument index="0" name="echo" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_pressed"> + <return type="void"> + </return> + <argument index="0" name="pressed" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_scancode"> + <return type="void"> + </return> + <argument index="0" name="scancode" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_unicode"> + <return type="void"> + </return> + <argument index="0" name="unicode" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="echo" type="bool" setter="set_echo" getter="is_echo"> + Echo state of the key, i.e. whether it's a repeat event or not. + </member> + <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed"> + Pressed state of the key. + </member> + <member name="scancode" type="int" setter="set_scancode" getter="get_scancode"> + Scancode of the key, one of the KEY_* constants in [@Global Scope]. + </member> + <member name="unicode" type="int" setter="set_unicode" getter="get_unicode"> + Unicode identifier of the key (when relevant). + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/InputEventMouse.xml b/doc/classes/InputEventMouse.xml new file mode 100644 index 0000000000..57f0acbf30 --- /dev/null +++ b/doc/classes/InputEventMouse.xml @@ -0,0 +1,69 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="InputEventMouse" inherits="InputEventWithModifiers" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base input event type for mouse events. + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_button_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_global_position" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_position" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="set_button_mask"> + <return type="void"> + </return> + <argument index="0" name="button_mask" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_global_position"> + <return type="void"> + </return> + <argument index="0" name="global_position" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_position"> + <return type="void"> + </return> + <argument index="0" name="position" type="Vector2"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="button_mask" type="int" setter="set_button_mask" getter="get_button_mask"> + Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK_* constants in [@Global Scope]. + </member> + <member name="global_position" type="Vector2" setter="set_global_position" getter="get_global_position"> + Global position of the mouse click. + </member> + <member name="position" type="Vector2" setter="set_position" getter="get_position"> + Local position of the mouse click. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/InputEventMouseButton.xml b/doc/classes/InputEventMouseButton.xml new file mode 100644 index 0000000000..63e31eb61c --- /dev/null +++ b/doc/classes/InputEventMouseButton.xml @@ -0,0 +1,79 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="InputEventMouseButton" inherits="InputEventMouse" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Input event type for mouse button events. + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_button_index" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_factor"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="is_doubleclick" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_button_index"> + <return type="void"> + </return> + <argument index="0" name="button_index" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_doubleclick"> + <return type="void"> + </return> + <argument index="0" name="doubleclick" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_factor"> + <return type="void"> + </return> + <argument index="0" name="factor" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_pressed"> + <return type="void"> + </return> + <argument index="0" name="pressed" type="bool"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="button_index" type="int" setter="set_button_index" getter="get_button_index"> + Mouse button identifier, one of the BUTTON_* or BUTTON_WHEEL_* constants in [@Global Scope]. + </member> + <member name="doubleclick" type="bool" setter="set_doubleclick" getter="is_doubleclick"> + Whether the event is a double-click. + </member> + <member name="factor" type="float" setter="set_factor" getter="get_factor"> + </member> + <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed"> + Pressed state of the mouse button. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/InputEventMouseMotion.xml b/doc/classes/InputEventMouseMotion.xml new file mode 100644 index 0000000000..59fe8d2e58 --- /dev/null +++ b/doc/classes/InputEventMouseMotion.xml @@ -0,0 +1,52 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="InputEventMouseMotion" inherits="InputEventMouse" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Input event type for mouse motion events. + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_relative" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_speed" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="set_relative"> + <return type="void"> + </return> + <argument index="0" name="relative" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_speed"> + <return type="void"> + </return> + <argument index="0" name="speed" type="Vector2"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="relative" type="Vector2" setter="set_relative" getter="get_relative"> + Position of the mouse pointer relative to the previous mouse position. + </member> + <member name="speed" type="Vector2" setter="set_speed" getter="get_speed"> + Speed of the mouse pointer. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/InputEventScreenDrag.xml b/doc/classes/InputEventScreenDrag.xml new file mode 100644 index 0000000000..0b0ecc17bc --- /dev/null +++ b/doc/classes/InputEventScreenDrag.xml @@ -0,0 +1,86 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="InputEventScreenDrag" inherits="InputEvent" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Input event type for screen drag events. + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_index" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_position" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_relative" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_speed" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="set_index"> + <return type="void"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_position"> + <return type="void"> + </return> + <argument index="0" name="position" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_relative"> + <return type="void"> + </return> + <argument index="0" name="relative" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_speed"> + <return type="void"> + </return> + <argument index="0" name="speed" type="Vector2"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="index" type="int" setter="set_index" getter="get_index"> + Drag event index in the case of a multi-drag event. + </member> + <member name="position" type="Vector2" setter="set_position" getter="get_position"> + Position of the drag event. + </member> + <member name="relative" type="Vector2" setter="set_relative" getter="get_relative"> + Position of the drag event relative to its start position. + </member> + <member name="speed" type="Vector2" setter="set_speed" getter="get_speed"> + Speed of the drag event. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/InputEventScreenTouch.xml b/doc/classes/InputEventScreenTouch.xml new file mode 100644 index 0000000000..97c3537364 --- /dev/null +++ b/doc/classes/InputEventScreenTouch.xml @@ -0,0 +1,63 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="InputEventScreenTouch" inherits="InputEvent" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Input event type for screen touch events. + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_index" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_position" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="set_index"> + <return type="void"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_position"> + <return type="void"> + </return> + <argument index="0" name="pos" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_pressed"> + <return type="void"> + </return> + <argument index="0" name="pressed" type="bool"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="index" type="int" setter="set_index" getter="get_index"> + Touch event index in the case of a multi-touch event. + </member> + <member name="position" type="Vector2" setter="set_position" getter="get_position"> + Position of the touch event. + </member> + <member name="pressed" type="bool" setter="set_pressed" getter="is_pressed"> + Pressed state of the touch event. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/InputEventWithModifiers.xml b/doc/classes/InputEventWithModifiers.xml new file mode 100644 index 0000000000..7bbdf0a441 --- /dev/null +++ b/doc/classes/InputEventWithModifiers.xml @@ -0,0 +1,103 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="InputEventWithModifiers" inherits="InputEvent" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base class for input events with modifiers. + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_alt" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_command" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_control" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_metakey" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_shift" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_alt"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_command"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_control"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_metakey"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_shift"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="alt" type="bool" setter="set_alt" getter="get_alt"> + State of the Alt modifier. + </member> + <member name="command" type="bool" setter="set_command" getter="get_command"> + State of the Command modifier. + </member> + <member name="control" type="bool" setter="set_control" getter="get_control"> + State of the Ctrl modifier. + </member> + <member name="meta" type="bool" setter="set_metakey" getter="get_metakey"> + State of the Meta modifier. + </member> + <member name="shift" type="bool" setter="set_shift" getter="get_shift"> + State of the Shift modifier. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/InputMap.xml b/doc/classes/InputMap.xml new file mode 100644 index 0000000000..bf72ba05e7 --- /dev/null +++ b/doc/classes/InputMap.xml @@ -0,0 +1,110 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="InputMap" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Singleton that manages actions. + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="action_add_event"> + <return type="void"> + </return> + <argument index="0" name="action" type="String"> + </argument> + <argument index="1" name="event" type="InputEvent"> + </argument> + <description> + Add an [InputEvent] to an action. This [InputEvent] will trigger the action. + </description> + </method> + <method name="action_erase_event"> + <return type="void"> + </return> + <argument index="0" name="action" type="String"> + </argument> + <argument index="1" name="event" type="InputEvent"> + </argument> + <description> + Remove an [InputEvent] from an action. + </description> + </method> + <method name="action_has_event"> + <return type="bool"> + </return> + <argument index="0" name="action" type="String"> + </argument> + <argument index="1" name="event" type="InputEvent"> + </argument> + <description> + Whether an action has an [InputEvent] associated with it. + </description> + </method> + <method name="add_action"> + <return type="void"> + </return> + <argument index="0" name="action" type="String"> + </argument> + <description> + Add an (empty) action to the [InputMap]. An [InputEvent] can then be added to this action with [method action_add_event]. + </description> + </method> + <method name="erase_action"> + <return type="void"> + </return> + <argument index="0" name="action" type="String"> + </argument> + <description> + Remove an action from the [InputMap]. + </description> + </method> + <method name="event_is_action" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="event" type="InputEvent"> + </argument> + <argument index="1" name="action" type="String"> + </argument> + <description> + Return whether the given event is part of an existing action. This method ignores keyboard modifiers if the given [InputEvent] is not pressed (for proper release detection). See [method action_has_event] if you don't want this behavior. + </description> + </method> + <method name="get_action_list"> + <return type="Array"> + </return> + <argument index="0" name="action" type="String"> + </argument> + <description> + Return an array of InputEvents associated with a given action. + </description> + </method> + <method name="get_actions"> + <return type="Array"> + </return> + <description> + Return an array of all actions in the [InputMap]. + </description> + </method> + <method name="has_action" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="action" type="String"> + </argument> + <description> + Whether this InputMap has a registered action with the given name. + </description> + </method> + <method name="load_from_globals"> + <return type="void"> + </return> + <description> + Clear the [InputMap] and load it anew from [ProjectSettings]. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/InstancePlaceholder.xml b/doc/classes/InstancePlaceholder.xml new file mode 100644 index 0000000000..e962192f81 --- /dev/null +++ b/doc/classes/InstancePlaceholder.xml @@ -0,0 +1,42 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="InstancePlaceholder" inherits="Node" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Placeholder for the root [Node] of a [PackedScene]. + </brief_description> + <description> + Turning on the option [b]Load As Placeholder[/b] for an instanced scene in the editor causes it to be replaced by an InstacePlaceholder when running the game. This makes it possible to delay actually loading the scene until calling [method replace_by_instance]. This is useful to avoid loading large scenes all at once by loading parts of it selectively. + The InstancePlaceholder does not have a transform. This causes any child nodes to be positioned relatively to the Viewport from point (0,0), rather than their parent as displayed in the editor. Replacing the placeholder with a scene with a transform will transform children relatively to their parent again. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_instance_path" qualifiers="const"> + <return type="String"> + </return> + <description> + Retrieve the path to the [PackedScene] resource file that is loaded by default when calling [method replace_by_instance]. + </description> + </method> + <method name="get_stored_values"> + <return type="Dictionary"> + </return> + <argument index="0" name="with_order" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="replace_by_instance"> + <return type="void"> + </return> + <argument index="0" name="custom_scene" type="PackedScene" default="null"> + </argument> + <description> + Replace this placeholder by the scene handed as an argument, or the original scene if no argument is given. As for all resources, the scene is loaded only if it's not loaded already. By manually loading the scene beforehand, delays caused by this function can be avoided. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/InterpolatedCamera.xml b/doc/classes/InterpolatedCamera.xml new file mode 100644 index 0000000000..5e5ce59a8b --- /dev/null +++ b/doc/classes/InterpolatedCamera.xml @@ -0,0 +1,73 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="InterpolatedCamera" inherits="Camera" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_speed" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_target_path" qualifiers="const"> + <return type="NodePath"> + </return> + <description> + </description> + </method> + <method name="is_interpolation_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_interpolation_enabled"> + <return type="void"> + </return> + <argument index="0" name="target_path" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_speed"> + <return type="void"> + </return> + <argument index="0" name="speed" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_target"> + <return type="void"> + </return> + <argument index="0" name="target" type="Object"> + </argument> + <description> + </description> + </method> + <method name="set_target_path"> + <return type="void"> + </return> + <argument index="0" name="target_path" type="NodePath"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="enabled" type="bool" setter="set_interpolation_enabled" getter="is_interpolation_enabled"> + </member> + <member name="speed" type="float" setter="set_speed" getter="get_speed"> + </member> + <member name="target" type="NodePath" setter="set_target_path" getter="get_target_path"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml new file mode 100644 index 0000000000..3423b8fb9c --- /dev/null +++ b/doc/classes/ItemList.xml @@ -0,0 +1,558 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ItemList" inherits="Control" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Control that provides a list of selectable items (and/or icons) in a single column, or optionally in multiple columns. + </brief_description> + <description> + This control provides a selectable list of items that may be in a single (or multiple columns) with option of text, icons, + or both text and icon. Tooltips are supported and may be different for every item in the list. Selectable items in the list + may be selected or deselected and multiple selection may be enabled. Selection with right mouse button may also be enabled + to allow use of popup context menus. Items may also be 'activated' with a double click (or Enter key). + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_icon_item"> + <return type="void"> + </return> + <argument index="0" name="icon" type="Texture"> + </argument> + <argument index="1" name="selectable" type="bool" default="true"> + </argument> + <description> + Adds an item to the item list with no text, only an icon. + </description> + </method> + <method name="add_item"> + <return type="void"> + </return> + <argument index="0" name="text" type="String"> + </argument> + <argument index="1" name="icon" type="Texture" default="null"> + </argument> + <argument index="2" name="selectable" type="bool" default="true"> + </argument> + <description> + Adds an item to the item list with specified text. Specify an icon of null for a list item with no icon. + If selectable is true the list item will be selectable. + </description> + </method> + <method name="clear"> + <return type="void"> + </return> + <description> + Remove all items from the list. + </description> + </method> + <method name="ensure_current_is_visible"> + <return type="void"> + </return> + <description> + Ensure selection is visible, adjusting the scroll position as necessary. + </description> + </method> + <method name="get_allow_rmb_select" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether or not items may be selected via right mouse clicking. + </description> + </method> + <method name="get_fixed_column_width" qualifiers="const"> + <return type="int"> + </return> + <description> + If column size has been fixed to a value, return that value. + </description> + </method> + <method name="get_fixed_icon_size" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_icon_mode" qualifiers="const"> + <return type="int" enum="ItemList.IconMode"> + </return> + <description> + </description> + </method> + <method name="get_icon_scale" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_item_at_pos" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="pos" type="Vector2"> + </argument> + <argument index="1" name="exact" type="bool" default="false"> + </argument> + <description> + Given a position within the control return the item (if any) at that point. + </description> + </method> + <method name="get_item_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Return count of items currently in the item list. + </description> + </method> + <method name="get_item_custom_bg_color" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_item_icon" qualifiers="const"> + <return type="Texture"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_item_icon_region" qualifiers="const"> + <return type="Rect2"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_item_metadata" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_item_text" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return the text for specified item index. + </description> + </method> + <method name="get_item_tooltip" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return tooltip hint for specified item index. + </description> + </method> + <method name="get_max_columns" qualifiers="const"> + <return type="int"> + </return> + <description> + Return total number of columns in use by the list. + </description> + </method> + <method name="get_max_text_lines" qualifiers="const"> + <return type="int"> + </return> + <description> + Return total number of lines currently in use by the list. + </description> + </method> + <method name="get_select_mode" qualifiers="const"> + <return type="int" enum="ItemList.SelectMode"> + </return> + <description> + </description> + </method> + <method name="get_selected_items"> + <return type="PoolIntArray"> + </return> + <description> + Returns the list of selected indexes. + </description> + </method> + <method name="get_v_scroll"> + <return type="VScrollBar"> + </return> + <description> + Returns the current vertical scroll bar for the List. + </description> + </method> + <method name="has_auto_height" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_item_disabled" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Returns whether or not the item at the specified index is disabled + </description> + </method> + <method name="is_item_selectable" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Returns whether or not the item at the specified index is selectable. + </description> + </method> + <method name="is_item_tooltip_enabled" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Returns whether the tooptip is enabled for specified item index. + </description> + </method> + <method name="is_same_column_width" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns whether or not all columns of the list are of the same size. + </description> + </method> + <method name="is_selected" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Returns whether or not item at the specified index is currently selected. + </description> + </method> + <method name="remove_item"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Remove item at specified index from the list. + </description> + </method> + <method name="select"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="single" type="bool" default="true"> + </argument> + <description> + Select the item at the specified index. + Note: This method does not trigger the item selection signal. + </description> + </method> + <method name="set_allow_rmb_select"> + <return type="void"> + </return> + <argument index="0" name="allow" type="bool"> + </argument> + <description> + Allow (or disallow) selection of (selectable) items in the list using right mouse button. + </description> + </method> + <method name="set_auto_height"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_fixed_column_width"> + <return type="void"> + </return> + <argument index="0" name="width" type="int"> + </argument> + <description> + Set the size (width) all columns in the list are to use. + </description> + </method> + <method name="set_fixed_icon_size"> + <return type="void"> + </return> + <argument index="0" name="size" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_icon_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="ItemList.IconMode"> + </argument> + <description> + </description> + </method> + <method name="set_icon_scale"> + <return type="void"> + </return> + <argument index="0" name="scale" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_item_custom_bg_color"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="custom_bg_color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_item_disabled"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="disabled" type="bool"> + </argument> + <description> + Disable (or enable) item at specified index. + Disabled items are not be selectable and do not fire activation (Enter or double-click) signals. + </description> + </method> + <method name="set_item_icon"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="icon" type="Texture"> + </argument> + <description> + Set (or replace) icon of the item at the specified index. + </description> + </method> + <method name="set_item_icon_region"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="rect" type="Rect2"> + </argument> + <description> + </description> + </method> + <method name="set_item_metadata"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="metadata" type="Variant"> + </argument> + <description> + Sets a value (of any type) to be stored with the item at the specified index. + </description> + </method> + <method name="set_item_selectable"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="selectable" type="bool"> + </argument> + <description> + Allow or disallow selection of the item at the specified index. + </description> + </method> + <method name="set_item_text"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="text" type="String"> + </argument> + <description> + Sets text of item at specified index. + </description> + </method> + <method name="set_item_tooltip"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="tooltip" type="String"> + </argument> + <description> + Sets tooltip hint for item at specified index. + </description> + </method> + <method name="set_item_tooltip_enabled"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> + <description> + Sets whether the tooltip is enabled for specified item index. + </description> + </method> + <method name="set_max_columns"> + <return type="void"> + </return> + <argument index="0" name="amount" type="int"> + </argument> + <description> + Set maximum number of columns to use for the list. + </description> + </method> + <method name="set_max_text_lines"> + <return type="void"> + </return> + <argument index="0" name="lines" type="int"> + </argument> + <description> + Set maximum number of lines to use for the list. + </description> + </method> + <method name="set_same_column_width"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Sets a fixed size (width) to use for all columns of the list. + </description> + </method> + <method name="set_select_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="ItemList.SelectMode"> + </argument> + <description> + </description> + </method> + <method name="sort_items_by_text"> + <return type="void"> + </return> + <description> + Sorts items in the list by their text. + </description> + </method> + <method name="unselect"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Ensure item at specified index is not selected. + </description> + </method> + </methods> + <members> + <member name="allow_rmb_select" type="bool" setter="set_allow_rmb_select" getter="get_allow_rmb_select"> + </member> + <member name="auto_height" type="bool" setter="set_auto_height" getter="has_auto_height"> + </member> + <member name="fixed_column_width" type="int" setter="set_fixed_column_width" getter="get_fixed_column_width"> + </member> + <member name="icon_mode" type="int" setter="set_icon_mode" getter="get_icon_mode" enum="ItemList.IconMode"> + </member> + <member name="icon_scale" type="float" setter="set_icon_scale" getter="get_icon_scale"> + </member> + <member name="items" type="Array" setter="_set_items" getter="_get_items"> + </member> + <member name="max_columns" type="int" setter="set_max_columns" getter="get_max_columns"> + </member> + <member name="max_text_lines" type="int" setter="set_max_text_lines" getter="get_max_text_lines"> + </member> + <member name="same_column_width" type="bool" setter="set_same_column_width" getter="is_same_column_width"> + </member> + <member name="select_mode" type="int" setter="set_select_mode" getter="get_select_mode" enum="ItemList.SelectMode"> + </member> + </members> + <signals> + <signal name="item_activated"> + <argument index="0" name="index" type="int"> + </argument> + <description> + Fired when specified list item is activated via double click or Enter. + </description> + </signal> + <signal name="item_rmb_selected"> + <argument index="0" name="index" type="int"> + </argument> + <argument index="1" name="atpos" type="Vector2"> + </argument> + <description> + Fired when specified list item has been selected via right mouse clicking. + The click position is also provided to allow appropriate popup of context menus + at the correct location. + </description> + </signal> + <signal name="item_selected"> + <argument index="0" name="index" type="int"> + </argument> + <description> + Fired when specified item has been selected. + </description> + </signal> + <signal name="multi_selected"> + <argument index="0" name="index" type="int"> + </argument> + <argument index="1" name="selected" type="bool"> + </argument> + <description> + Fired when a multiple selection is altered on a list allowing mutliple selection. + </description> + </signal> + </signals> + <constants> + <constant name="ICON_MODE_TOP" value="0"> + </constant> + <constant name="ICON_MODE_LEFT" value="1"> + </constant> + <constant name="SELECT_SINGLE" value="0"> + </constant> + <constant name="SELECT_MULTI" value="1"> + </constant> + </constants> + <theme_items> + <theme_item name="bg" type="StyleBox"> + </theme_item> + <theme_item name="bg_focus" type="StyleBox"> + </theme_item> + <theme_item name="cursor" type="StyleBox"> + </theme_item> + <theme_item name="cursor_unfocused" type="StyleBox"> + </theme_item> + <theme_item name="font" type="Font"> + </theme_item> + <theme_item name="font_color" type="Color"> + </theme_item> + <theme_item name="font_color_selected" type="Color"> + </theme_item> + <theme_item name="guide_color" type="Color"> + </theme_item> + <theme_item name="hseparation" type="int"> + </theme_item> + <theme_item name="icon_margin" type="int"> + </theme_item> + <theme_item name="line_separation" type="int"> + </theme_item> + <theme_item name="selected" type="StyleBox"> + </theme_item> + <theme_item name="selected_focus" type="StyleBox"> + </theme_item> + <theme_item name="vseparation" type="int"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/JSON.xml b/doc/classes/JSON.xml new file mode 100644 index 0000000000..a38b2f61cf --- /dev/null +++ b/doc/classes/JSON.xml @@ -0,0 +1,31 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="JSON" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="parse"> + <return type="JSONParseResult"> + </return> + <argument index="0" name="json" type="String"> + </argument> + <description> + </description> + </method> + <method name="print"> + <return type="String"> + </return> + <argument index="0" name="value" type="Variant"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/JSONParseResult.xml b/doc/classes/JSONParseResult.xml new file mode 100644 index 0000000000..6aeb614508 --- /dev/null +++ b/doc/classes/JSONParseResult.xml @@ -0,0 +1,81 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="JSONParseResult" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_error" qualifiers="const"> + <return type="int" enum="Error"> + </return> + <description> + </description> + </method> + <method name="get_error_line" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_error_string" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_result" qualifiers="const"> + <return type="Variant"> + </return> + <description> + </description> + </method> + <method name="set_error"> + <return type="void"> + </return> + <argument index="0" name="error" type="int" enum="Error"> + </argument> + <description> + </description> + </method> + <method name="set_error_line"> + <return type="void"> + </return> + <argument index="0" name="error_line" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_error_string"> + <return type="void"> + </return> + <argument index="0" name="error_string" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_result"> + <return type="void"> + </return> + <argument index="0" name="result" type="Variant"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="error" type="int" setter="set_error" getter="get_error" enum="Error"> + </member> + <member name="error_line" type="int" setter="set_error_line" getter="get_error_line"> + </member> + <member name="error_string" type="String" setter="set_error_string" getter="get_error_string"> + </member> + <member name="result" type="Variant" setter="set_result" getter="get_result"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Joint.xml b/doc/classes/Joint.xml new file mode 100644 index 0000000000..2e7d24aac1 --- /dev/null +++ b/doc/classes/Joint.xml @@ -0,0 +1,81 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Joint" inherits="Spatial" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_exclude_nodes_from_collision" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_node_a" qualifiers="const"> + <return type="NodePath"> + </return> + <description> + </description> + </method> + <method name="get_node_b" qualifiers="const"> + <return type="NodePath"> + </return> + <description> + </description> + </method> + <method name="get_solver_priority" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_exclude_nodes_from_collision"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_node_a"> + <return type="void"> + </return> + <argument index="0" name="node" type="NodePath"> + </argument> + <description> + </description> + </method> + <method name="set_node_b"> + <return type="void"> + </return> + <argument index="0" name="node" type="NodePath"> + </argument> + <description> + </description> + </method> + <method name="set_solver_priority"> + <return type="void"> + </return> + <argument index="0" name="priority" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="collision/exclude_nodes" type="bool" setter="set_exclude_nodes_from_collision" getter="get_exclude_nodes_from_collision"> + </member> + <member name="nodes/node_a" type="NodePath" setter="set_node_a" getter="get_node_a"> + </member> + <member name="nodes/node_b" type="NodePath" setter="set_node_b" getter="get_node_b"> + </member> + <member name="solver/priority" type="int" setter="set_solver_priority" getter="get_solver_priority"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Joint2D.xml b/doc/classes/Joint2D.xml new file mode 100644 index 0000000000..e6c2f6d157 --- /dev/null +++ b/doc/classes/Joint2D.xml @@ -0,0 +1,87 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Joint2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base node for all joint constraints in 2D physics. + </brief_description> + <description> + Base node for all joint constraints in 2D physics. Joints take 2 bodies and apply a custom constraint. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_bias" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_exclude_nodes_from_collision" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_node_a" qualifiers="const"> + <return type="NodePath"> + </return> + <description> + Return the path to the A node for the joint. + </description> + </method> + <method name="get_node_b" qualifiers="const"> + <return type="NodePath"> + </return> + <description> + Return the path to the B node for the joint. + </description> + </method> + <method name="set_bias"> + <return type="void"> + </return> + <argument index="0" name="bias" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_exclude_nodes_from_collision"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_node_a"> + <return type="void"> + </return> + <argument index="0" name="node" type="NodePath"> + </argument> + <description> + Set the path to the A node for the joint. Must be of type [PhysicsBody2D]. + </description> + </method> + <method name="set_node_b"> + <return type="void"> + </return> + <argument index="0" name="node" type="NodePath"> + </argument> + <description> + Set the path to the B node for the joint. Must be of type [PhysicsBody2D]. + </description> + </method> + </methods> + <members> + <member name="bias" type="float" setter="set_bias" getter="get_bias"> + </member> + <member name="disable_collision" type="bool" setter="set_exclude_nodes_from_collision" getter="get_exclude_nodes_from_collision"> + </member> + <member name="node_a" type="NodePath" setter="set_node_a" getter="get_node_a"> + </member> + <member name="node_b" type="NodePath" setter="set_node_b" getter="get_node_b"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/KinematicBody.xml b/doc/classes/KinematicBody.xml new file mode 100644 index 0000000000..8f242c5187 --- /dev/null +++ b/doc/classes/KinematicBody.xml @@ -0,0 +1,109 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="KinematicBody" inherits="PhysicsBody" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Kinematic body 3D node. + </brief_description> + <description> + Kinematic bodies are special types of bodies that are meant to be user-controlled. They are not affected by physics at all (to other types of bodies, such a character or a rigid body, these are the same as a static body). They have however, two main uses: + Simulated Motion: When these bodies are moved manually, either from code or from an AnimationPlayer (with process mode set to fixed), the physics will automatically compute an estimate of their linear and angular velocity. This makes them very useful for moving platforms or other AnimationPlayer-controlled objects (like a door, a bridge that opens, etc). + Kinematic Characters: KinematicBody also has an api for moving objects (the [method move] method) while performing collision tests. This makes them really useful to implement characters that collide against a world, but that don't require advanced physics. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_floor_velocity" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_safe_margin" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_slide_collision"> + <return type="KinematicCollision"> + </return> + <argument index="0" name="slide_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_slide_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="is_on_ceiling" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_on_floor" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_on_wall" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="move_and_collide"> + <return type="KinematicCollision"> + </return> + <argument index="0" name="rel_vec" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="move_and_slide"> + <return type="Vector3"> + </return> + <argument index="0" name="linear_velocity" type="Vector3"> + </argument> + <argument index="1" name="floor_normal" type="Vector3" default="Vector3( 0, 0, 0 )"> + </argument> + <argument index="2" name="slope_stop_min_velocity" type="float" default="0.05"> + </argument> + <argument index="3" name="max_slides" type="int" default="4"> + </argument> + <argument index="4" name="floor_max_angle" type="float" default="0.785398"> + </argument> + <description> + </description> + </method> + <method name="set_safe_margin"> + <return type="void"> + </return> + <argument index="0" name="pixels" type="float"> + </argument> + <description> + </description> + </method> + <method name="test_move"> + <return type="bool"> + </return> + <argument index="0" name="from" type="Transform"> + </argument> + <argument index="1" name="rel_vec" type="Vector3"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="collision/safe_margin" type="float" setter="set_safe_margin" getter="get_safe_margin"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/KinematicBody2D.xml b/doc/classes/KinematicBody2D.xml new file mode 100644 index 0000000000..dddae2c0fc --- /dev/null +++ b/doc/classes/KinematicBody2D.xml @@ -0,0 +1,111 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="KinematicBody2D" inherits="PhysicsBody2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Kinematic body 2D node. + </brief_description> + <description> + Kinematic bodies are special types of bodies that are meant to be user-controlled. They are not affected by physics at all (to other types of bodies, such a character or a rigid body, these are the same as a static body). They have however, two main uses: + Simulated Motion: When these bodies are moved manually, either from code or from an AnimationPlayer (with process mode set to fixed), the physics will automatically compute an estimate of their linear and angular velocity. This makes them very useful for moving platforms or other AnimationPlayer-controlled objects (like a door, a bridge that opens, etc). + Kinematic Characters: KinematicBody2D also has an api for moving objects (the [method move] method) while performing collision tests. This makes them really useful to implement characters that collide against a world, but that don't require advanced physics. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_floor_velocity" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_safe_margin" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_slide_collision"> + <return type="KinematicCollision2D"> + </return> + <argument index="0" name="slide_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_slide_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="is_on_ceiling" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_on_floor" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_on_wall" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="move_and_collide"> + <return type="KinematicCollision2D"> + </return> + <argument index="0" name="rel_vec" type="Vector2"> + </argument> + <description> + Moves the body along the given vector. The body will stop if it collides. Returns a [KinematicCollision2D], which contains information about the colliding body. + </description> + </method> + <method name="move_and_slide"> + <return type="Vector2"> + </return> + <argument index="0" name="linear_velocity" type="Vector2"> + </argument> + <argument index="1" name="floor_normal" type="Vector2" default="Vector2( 0, 0 )"> + </argument> + <argument index="2" name="slope_stop_min_velocity" type="float" default="5"> + </argument> + <argument index="3" name="max_bounces" type="int" default="4"> + </argument> + <argument index="4" name="floor_max_angle" type="float" default="0.785398"> + </argument> + <description> + </description> + </method> + <method name="set_safe_margin"> + <return type="void"> + </return> + <argument index="0" name="pixels" type="float"> + </argument> + <description> + </description> + </method> + <method name="test_move"> + <return type="bool"> + </return> + <argument index="0" name="from" type="Transform2D"> + </argument> + <argument index="1" name="rel_vec" type="Vector2"> + </argument> + <description> + Returns true if there would be a collision if the body moved from the given point in the given direction. + </description> + </method> + </methods> + <members> + <member name="collision/safe_margin" type="float" setter="set_safe_margin" getter="get_safe_margin"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/KinematicCollision.xml b/doc/classes/KinematicCollision.xml new file mode 100644 index 0000000000..b7269a646e --- /dev/null +++ b/doc/classes/KinematicCollision.xml @@ -0,0 +1,119 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="KinematicCollision" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Collision data for KinematicBody2D collisions. + </brief_description> + <description> + Contains collision data for KinematicBody collisions. When a [KinematicBody] is moved using [method 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. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_collider" qualifiers="const"> + <return type="Object"> + </return> + <description> + </description> + </method> + <method name="get_collider_id" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_collider_metadata" qualifiers="const"> + <return type="Variant"> + </return> + <description> + </description> + </method> + <method name="get_collider_shape" qualifiers="const"> + <return type="Object"> + </return> + <description> + </description> + </method> + <method name="get_collider_shape_index" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_collider_velocity" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_local_shape" qualifiers="const"> + <return type="Object"> + </return> + <description> + </description> + </method> + <method name="get_normal" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_position" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_remainder" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_travel" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + </methods> + <members> + <member name="collider" type="Object" setter="" getter="get_collider"> + The colliding body. + </member> + <member name="collider_id" type="int" setter="" getter="get_collider_id"> + The colliding body's unique [RID]. + </member> + <member name="collider_metadata" type="Variant" setter="" getter="get_collider_metadata"> + The colliding body's metadata. See [Object]. + </member> + <member name="collider_shape" type="Object" setter="" getter="get_collider_shape"> + The colliding body's shape. + </member> + <member name="collider_shape_index" type="int" setter="" getter="get_collider_shape_index"> + The colliding shape's index. See [CollisionObject]. + </member> + <member name="collider_velocity" type="Vector3" setter="" getter="get_collider_velocity"> + The colliding object's velocity. + </member> + <member name="local_shape" type="Object" setter="" getter="get_local_shape"> + The moving object's colliding shape. + </member> + <member name="normal" type="Vector3" setter="" getter="get_normal"> + The colliding body's shape's normal at the point of collision. + </member> + <member name="position" type="Vector3" setter="" getter="get_position"> + The point of collision. + </member> + <member name="remainder" type="Vector3" setter="" getter="get_remainder"> + The moving object's remaining movement vector. + </member> + <member name="travel" type="Vector3" setter="" getter="get_travel"> + The distance the moving object traveled before collision. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/KinematicCollision2D.xml b/doc/classes/KinematicCollision2D.xml new file mode 100644 index 0000000000..7a40a39292 --- /dev/null +++ b/doc/classes/KinematicCollision2D.xml @@ -0,0 +1,119 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="KinematicCollision2D" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Collision data for KinematicBody2D collisions. + </brief_description> + <description> + Contains collision data for KinematicBody2D collisions. When a [KinematicBody2D] is moved using [method 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. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_collider" qualifiers="const"> + <return type="Object"> + </return> + <description> + </description> + </method> + <method name="get_collider_id" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_collider_metadata" qualifiers="const"> + <return type="Variant"> + </return> + <description> + </description> + </method> + <method name="get_collider_shape" qualifiers="const"> + <return type="Object"> + </return> + <description> + </description> + </method> + <method name="get_collider_shape_index" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_collider_velocity" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_local_shape" qualifiers="const"> + <return type="Object"> + </return> + <description> + </description> + </method> + <method name="get_normal" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_position" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_remainder" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_travel" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + </methods> + <members> + <member name="collider" type="Object" setter="" getter="get_collider"> + The colliding body. + </member> + <member name="collider_id" type="int" setter="" getter="get_collider_id"> + The colliding body's unique [RID]. + </member> + <member name="collider_metadata" type="Variant" setter="" getter="get_collider_metadata"> + The colliding body's metadata. See [Object]. + </member> + <member name="collider_shape" type="Object" setter="" getter="get_collider_shape"> + The colliding body's shape. + </member> + <member name="collider_shape_index" type="int" setter="" getter="get_collider_shape_index"> + The colliding shape's index. See [CollisionObject2D]. + </member> + <member name="collider_velocity" type="Vector2" setter="" getter="get_collider_velocity"> + The colliding object's velocity. + </member> + <member name="local_shape" type="Object" setter="" getter="get_local_shape"> + The moving object's colliding shape. + </member> + <member name="normal" type="Vector2" setter="" getter="get_normal"> + The colliding body's shape's normal at the point of collision. + </member> + <member name="position" type="Vector2" setter="" getter="get_position"> + The point of collision. + </member> + <member name="remainder" type="Vector2" setter="" getter="get_remainder"> + The moving object's remaining movement vector. + </member> + <member name="travel" type="Vector2" setter="" getter="get_travel"> + The distance the moving object traveled before collision. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Label.xml b/doc/classes/Label.xml new file mode 100644 index 0000000000..8c5e69b407 --- /dev/null +++ b/doc/classes/Label.xml @@ -0,0 +1,275 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Label" inherits="Control" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Displays plain text in a line or wrapped inside a rectangle. For formatted text, use [RichTextLabel]. + </brief_description> + <description> + Label displays plain text on the screen. It gives you control over the horizontal and vertical alignment, and can wrap the text inside the node's bounding rectangle. It doesn't support bold, italics or other formatting. For that, use [RichTextLabel] instead. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_align" qualifiers="const"> + <return type="int" enum="Label.Align"> + </return> + <description> + Return the alignment mode (any of the ALIGN_* enumeration values). + </description> + </method> + <method name="get_line_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the amount of lines of text the Label has. + </description> + </method> + <method name="get_line_height" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the font size in pixels. + </description> + </method> + <method name="get_lines_skipped" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the the number of lines to skipped before displaying. + </description> + </method> + <method name="get_max_lines_visible" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the restricted number of lines to display. Returns -1 if unrestricted. + </description> + </method> + <method name="get_percent_visible" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the restricted number of characters to display (as a percentage of the total text). + </description> + </method> + <method name="get_text" qualifiers="const"> + <return type="String"> + </return> + <description> + Return the label text. Text can contain newlines. + </description> + </method> + <method name="get_total_character_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the total length of the text. + </description> + </method> + <method name="get_valign" qualifiers="const"> + <return type="int" enum="Label.VAlign"> + </return> + <description> + Return the vertical alignment mode (any of the VALIGN_* enumeration values). + </description> + </method> + <method name="get_visible_characters" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the restricted number of characters to display. Returns -1 if unrestricted. + </description> + </method> + <method name="get_visible_line_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="has_autowrap" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return the state of the [i]autowrap[/i] mode (see [method set_autowrap]). + </description> + </method> + <method name="is_clipping_text" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return [code]true[/code] if text would be cut off if it is too wide. + </description> + </method> + <method name="is_uppercase" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return [code]true[/code] if text is displayed in all capitals. + </description> + </method> + <method name="set_align"> + <return type="void"> + </return> + <argument index="0" name="align" type="int" enum="Label.Align"> + </argument> + <description> + Sets the alignment mode to any of the ALIGN_* enumeration values. + </description> + </method> + <method name="set_autowrap"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set [i]autowrap[/i] mode. When enabled, autowrap will fit text to the control width, breaking sentences when they exceed the available horizontal space. When disabled, the label minimum width becomes the width of the longest row, and the minimum height large enough to fit all rows. + </description> + </method> + <method name="set_clip_text"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Cuts off the rest of the text if it is too wide. + </description> + </method> + <method name="set_lines_skipped"> + <return type="void"> + </return> + <argument index="0" name="lines_skipped" type="int"> + </argument> + <description> + Sets the number of lines to skip before displaying. Useful for scrolling text. + </description> + </method> + <method name="set_max_lines_visible"> + <return type="void"> + </return> + <argument index="0" name="lines_visible" type="int"> + </argument> + <description> + Restricts the number of lines to display. Set to -1 to disable. + </description> + </method> + <method name="set_percent_visible"> + <return type="void"> + </return> + <argument index="0" name="percent_visible" type="float"> + </argument> + <description> + Restricts the number of characters to display (as a percentage of the total text). + </description> + </method> + <method name="set_text"> + <return type="void"> + </return> + <argument index="0" name="text" type="String"> + </argument> + <description> + Set the label text. Text can contain newlines. + </description> + </method> + <method name="set_uppercase"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Display text in all capitals. + </description> + </method> + <method name="set_valign"> + <return type="void"> + </return> + <argument index="0" name="valign" type="int" enum="Label.VAlign"> + </argument> + <description> + Sets the vertical alignment mode to any of the VALIGN_* enumeration values. + </description> + </method> + <method name="set_visible_characters"> + <return type="void"> + </return> + <argument index="0" name="amount" type="int"> + </argument> + <description> + Restricts the number of characters to display. Set to -1 to disable. + </description> + </method> + </methods> + <members> + <member name="align" type="int" setter="set_align" getter="get_align" enum="Label.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. + </member> + <member name="autowrap" type="bool" setter="set_autowrap" getter="has_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. + </member> + <member name="clip_text" type="bool" setter="set_clip_text" getter="is_clipping_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. + </member> + <member name="lines_skipped" type="int" setter="set_lines_skipped" getter="get_lines_skipped"> + The node ignores the first [code]lines_skipped[/code] lines before it starts to display text. + </member> + <member name="max_lines_visible" type="int" setter="set_max_lines_visible" getter="get_max_lines_visible"> + Limits the lines of text the node shows on screen. + </member> + <member name="percent_visible" type="float" setter="set_percent_visible" getter="get_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. + </member> + <member name="text" type="String" setter="set_text" getter="get_text"> + The text to display on screen. + </member> + <member name="uppercase" type="bool" setter="set_uppercase" getter="is_uppercase"> + If [code]true[/code], all the text displays as UPPERCASE. + </member> + <member name="valign" type="int" setter="set_valign" getter="get_valign" enum="Label.VAlign"> + Controls the text's vertical align. Supports top, center, bottom, and fill. Set it to one of the [code]VALIGN_*[/code] constants. + </member> + </members> + <constants> + <constant name="ALIGN_LEFT" value="0"> + Align rows to the left (default). + </constant> + <constant name="ALIGN_CENTER" value="1"> + Align rows centered. + </constant> + <constant name="ALIGN_RIGHT" value="2"> + Align rows to the right (default). + </constant> + <constant name="ALIGN_FILL" value="3"> + Expand row whitespaces to fit the width. + </constant> + <constant name="VALIGN_TOP" value="0"> + Align the whole text to the top. + </constant> + <constant name="VALIGN_CENTER" value="1"> + Align the whole text to the center. + </constant> + <constant name="VALIGN_BOTTOM" value="2"> + Align the whole text to the bottom. + </constant> + <constant name="VALIGN_FILL" value="3"> + Align the whole text by spreading the rows. + </constant> + </constants> + <theme_items> + <theme_item name="font" type="Font"> + </theme_item> + <theme_item name="font_color" type="Color"> + </theme_item> + <theme_item name="font_color_shadow" type="Color"> + </theme_item> + <theme_item name="line_spacing" type="int"> + </theme_item> + <theme_item name="normal" type="StyleBox"> + </theme_item> + <theme_item name="shadow_as_outline" type="int"> + </theme_item> + <theme_item name="shadow_offset_x" type="int"> + </theme_item> + <theme_item name="shadow_offset_y" type="int"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/LargeTexture.xml b/doc/classes/LargeTexture.xml new file mode 100644 index 0000000000..e4cabdc556 --- /dev/null +++ b/doc/classes/LargeTexture.xml @@ -0,0 +1,96 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="LargeTexture" inherits="Texture" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + A Texture capable of storing many smaller Textures with offsets. + </brief_description> + <description> + A Texture capable of storing many smaller Textures with offsets. + You can dynamically add pieces(Textures) to this fLargeTexture] using different offsets. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_piece"> + <return type="int"> + </return> + <argument index="0" name="ofs" type="Vector2"> + </argument> + <argument index="1" name="texture" type="Texture"> + </argument> + <description> + Add another [Texture] to this [LargeTexture], starting on offset "ofs". + </description> + </method> + <method name="clear"> + <return type="void"> + </return> + <description> + Clear the [LargeTexture]. + </description> + </method> + <method name="get_piece_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the number of pieces currently in this [LargeTexture]. + </description> + </method> + <method name="get_piece_offset" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return the offset of the piece with index "idx". + </description> + </method> + <method name="get_piece_texture" qualifiers="const"> + <return type="Texture"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return the [Texture] of the piece with index "idx". + </description> + </method> + <method name="set_piece_offset"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="ofs" type="Vector2"> + </argument> + <description> + Set the offset of the piece with index "idx" to "ofs". + </description> + </method> + <method name="set_piece_texture"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="texture" type="Texture"> + </argument> + <description> + Set the [Texture] of the piece with index "idx" to "ofs". + </description> + </method> + <method name="set_size"> + <return type="void"> + </return> + <argument index="0" name="size" type="Vector2"> + </argument> + <description> + Set the size of this [LargeTexture]. + </description> + </method> + </methods> + <members> + <member name="_data" type="Array" setter="_set_data" getter="_get_data"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Light.xml b/doc/classes/Light.xml new file mode 100644 index 0000000000..11eee135cb --- /dev/null +++ b/doc/classes/Light.xml @@ -0,0 +1,185 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Light" inherits="VisualInstance" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Provides a base class for different kinds of light nodes. + </brief_description> + <description> + Light is the abstract base class for light nodes, so it shouldn't be used directly (It can't be instanced). Other types of light nodes inherit from it. Light contains the common variables and parameters used for lighting. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_cull_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_param" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="param" type="int" enum="Light.Param"> + </argument> + <description> + </description> + </method> + <method name="get_shadow_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_shadow_reverse_cull_face" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="has_shadow" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_editor_only" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_negative" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_cull_mask"> + <return type="void"> + </return> + <argument index="0" name="cull_mask" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_editor_only"> + <return type="void"> + </return> + <argument index="0" name="editor_only" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_negative"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_param"> + <return type="void"> + </return> + <argument index="0" name="param" type="int" enum="Light.Param"> + </argument> + <argument index="1" name="value" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_shadow"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_shadow_color"> + <return type="void"> + </return> + <argument index="0" name="shadow_color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_shadow_reverse_cull_face"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="editor_only" type="bool" setter="set_editor_only" getter="is_editor_only"> + </member> + <member name="light_color" type="Color" setter="set_color" getter="get_color"> + </member> + <member name="light_cull_mask" type="int" setter="set_cull_mask" getter="get_cull_mask"> + </member> + <member name="light_energy" type="float" setter="set_param" getter="get_param"> + </member> + <member name="light_negative" type="bool" setter="set_negative" getter="is_negative"> + </member> + <member name="light_specular" type="float" setter="set_param" getter="get_param"> + </member> + <member name="shadow_bias" type="float" setter="set_param" getter="get_param"> + </member> + <member name="shadow_color" type="Color" setter="set_shadow_color" getter="get_shadow_color"> + </member> + <member name="shadow_contact" type="float" setter="set_param" getter="get_param"> + </member> + <member name="shadow_enabled" type="bool" setter="set_shadow" getter="has_shadow"> + </member> + <member name="shadow_reverse_cull_face" type="bool" setter="set_shadow_reverse_cull_face" getter="get_shadow_reverse_cull_face"> + </member> + </members> + <constants> + <constant name="PARAM_ENERGY" value="0"> + </constant> + <constant name="PARAM_SPECULAR" value="1"> + </constant> + <constant name="PARAM_RANGE" value="2"> + </constant> + <constant name="PARAM_ATTENUATION" value="3"> + </constant> + <constant name="PARAM_SPOT_ANGLE" value="4"> + </constant> + <constant name="PARAM_SPOT_ATTENUATION" value="5"> + </constant> + <constant name="PARAM_CONTACT_SHADOW_SIZE" value="6"> + </constant> + <constant name="PARAM_SHADOW_MAX_DISTANCE" value="7"> + </constant> + <constant name="PARAM_SHADOW_SPLIT_1_OFFSET" value="8"> + </constant> + <constant name="PARAM_SHADOW_SPLIT_2_OFFSET" value="9"> + </constant> + <constant name="PARAM_SHADOW_SPLIT_3_OFFSET" value="10"> + </constant> + <constant name="PARAM_SHADOW_NORMAL_BIAS" value="11"> + </constant> + <constant name="PARAM_SHADOW_BIAS" value="12"> + </constant> + <constant name="PARAM_MAX" value="14"> + </constant> + </constants> +</class> diff --git a/doc/classes/Light2D.xml b/doc/classes/Light2D.xml new file mode 100644 index 0000000000..7ce7cef7c1 --- /dev/null +++ b/doc/classes/Light2D.xml @@ -0,0 +1,432 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Light2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Node that casts light in a 2D environment. + </brief_description> + <description> + Node that casts light in a 2D environment. Light is defined by a (usually grayscale) texture, a color, an energy value, a mode (see constants), and various other parameters (range and shadows-related). Note that Light2D can be used as a mask. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + Return the color of the Light2D. + </description> + </method> + <method name="get_energy" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the energy value of the Light2D. + </description> + </method> + <method name="get_height" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the height of the Light2D. Used with 2D normalmapping. + </description> + </method> + <method name="get_item_cull_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_item_shadow_cull_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_layer_range_max" qualifiers="const"> + <return type="int"> + </return> + <description> + Set the maximum layer value of objects of the scene that are affected by the Light2D. + </description> + </method> + <method name="get_layer_range_min" qualifiers="const"> + <return type="int"> + </return> + <description> + Get the minimum layer value of objects of the scene that are affected by the Light2D. + </description> + </method> + <method name="get_mode" qualifiers="const"> + <return type="int" enum="Light2D.Mode"> + </return> + <description> + Return the current mode set to the Light2D. + </description> + </method> + <method name="get_shadow_buffer_size" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the shadow buffer size. + </description> + </method> + <method name="get_shadow_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + Return the color of casted shadows for this Light2D. + </description> + </method> + <method name="get_shadow_filter" qualifiers="const"> + <return type="int" enum="Light2D.ShadowFilter"> + </return> + <description> + </description> + </method> + <method name="get_shadow_gradient_length" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_shadow_smooth" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_texture" qualifiers="const"> + <return type="Texture"> + </return> + <description> + Return the texture of the Light2D. + </description> + </method> + <method name="get_texture_offset" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the offset of the light texture. + </description> + </method> + <method name="get_texture_scale" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the scale value of the light texture. + </description> + </method> + <method name="get_z_range_max" qualifiers="const"> + <return type="int"> + </return> + <description> + Get the maximum Z value that objects of the scene can be in order to be affected by the Light2D. + </description> + </method> + <method name="get_z_range_min" qualifiers="const"> + <return type="int"> + </return> + <description> + Get the minimum Z value that objects of the scene have to be in order to be affected by the Light2D. + </description> + </method> + <method name="is_editor_only" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if the Light2D is enabled, false if it is not. + </description> + </method> + <method name="is_shadow_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if shadow casting is enabled for this Light2D, else return false. + </description> + </method> + <method name="set_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + Set the color of the Light2D. + </description> + </method> + <method name="set_editor_only"> + <return type="void"> + </return> + <argument index="0" name="editor_only" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_enabled"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Switches the Light2D on or off, depending on the 'enabled' parameter. + </description> + </method> + <method name="set_energy"> + <return type="void"> + </return> + <argument index="0" name="energy" type="float"> + </argument> + <description> + Set the energy value of the Light2D. The bigger the value, the stronger the light. + </description> + </method> + <method name="set_height"> + <return type="void"> + </return> + <argument index="0" name="height" type="float"> + </argument> + <description> + Set the height of the Light2D. Used with 2D normalmapping. + </description> + </method> + <method name="set_item_cull_mask"> + <return type="void"> + </return> + <argument index="0" name="item_cull_mask" type="int"> + </argument> + <description> + Set the item mask of the Light2D to 'item_mask' value. + </description> + </method> + <method name="set_item_shadow_cull_mask"> + <return type="void"> + </return> + <argument index="0" name="item_shadow_cull_mask" type="int"> + </argument> + <description> + Set the item shadow mask to 'item_shadow_mask' value. + </description> + </method> + <method name="set_layer_range_max"> + <return type="void"> + </return> + <argument index="0" name="layer" type="int"> + </argument> + <description> + Set the maximum layer value of objects of the scene that are affected by the Light2D. + </description> + </method> + <method name="set_layer_range_min"> + <return type="void"> + </return> + <argument index="0" name="layer" type="int"> + </argument> + <description> + Set the minimum layer value of objects of the scene that are affected by the Light2D. + </description> + </method> + <method name="set_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="Light2D.Mode"> + </argument> + <description> + Set the behaviour mode of the Light2D. Use constants defined in the constants section. + </description> + </method> + <method name="set_shadow_buffer_size"> + <return type="void"> + </return> + <argument index="0" name="size" type="int"> + </argument> + <description> + Set the shadow buffer size. + </description> + </method> + <method name="set_shadow_color"> + <return type="void"> + </return> + <argument index="0" name="shadow_color" type="Color"> + </argument> + <description> + Set the color of casted shadows for this Light2D. + </description> + </method> + <method name="set_shadow_enabled"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Enable or disable shadows casting from this Light2D according to the 'enabled' parameter. + </description> + </method> + <method name="set_shadow_filter"> + <return type="void"> + </return> + <argument index="0" name="filter" type="int" enum="Light2D.ShadowFilter"> + </argument> + <description> + </description> + </method> + <method name="set_shadow_gradient_length"> + <return type="void"> + </return> + <argument index="0" name="multiplier" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_shadow_smooth"> + <return type="void"> + </return> + <argument index="0" name="smooth" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_texture"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <description> + Set the texture of the Light2D. + </description> + </method> + <method name="set_texture_offset"> + <return type="void"> + </return> + <argument index="0" name="texture_offset" type="Vector2"> + </argument> + <description> + Set the offset of the light texture. + </description> + </method> + <method name="set_texture_scale"> + <return type="void"> + </return> + <argument index="0" name="texture_scale" type="float"> + </argument> + <description> + Set the scale value of the light texture. + </description> + </method> + <method name="set_z_range_max"> + <return type="void"> + </return> + <argument index="0" name="z" type="int"> + </argument> + <description> + Set the maximum Z value that objects of the scene can be in order to be affected by the Light2D. + </description> + </method> + <method name="set_z_range_min"> + <return type="void"> + </return> + <argument index="0" name="z" type="int"> + </argument> + <description> + Set the minimum Z value that objects of the scene have to be in order to be affected by the Light2D. + </description> + </method> + </methods> + <members> + <member name="color" type="Color" setter="set_color" getter="get_color"> + The Light2D's [Color]. + </member> + <member name="editor_only" type="bool" setter="set_editor_only" getter="is_editor_only"> + If [code]true[/code] Light2D will only appear when editing the scene. Default value: [code]false[/code]. + </member> + <member name="enabled" type="bool" setter="set_enabled" getter="is_enabled"> + If [code]true[/code] Light2D will emit light. Default value: [code]true[/code]. + </member> + <member name="energy" type="float" setter="set_energy" getter="get_energy"> + The Light2D's energy value. The larger the value, the stronger the light. + </member> + <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="Light2D.Mode"> + The Light2D's mode. See MODE_* constants for values. + </member> + <member name="offset" type="Vector2" setter="set_texture_offset" getter="get_texture_offset"> + The offset of the Light2D's [code]texture[/code]. + </member> + <member name="range_height" type="float" setter="set_height" getter="get_height"> + The height of the Light2D. Used with 2D normal mapping. + </member> + <member name="range_item_cull_mask" type="int" setter="set_item_cull_mask" getter="get_item_cull_mask"> + The layer mask. Only objects with a matching mask will be affected by the Light2D. + </member> + <member name="range_layer_max" type="int" setter="set_layer_range_max" getter="get_layer_range_max"> + Maximum layer value of objects that are affected by the Light2D. Default value: [code]0[/code]. + </member> + <member name="range_layer_min" type="int" setter="set_layer_range_min" getter="get_layer_range_min"> + Minimum layer value of objects that are affected by the Light2D. Default value: [code]0[/code]. + </member> + <member name="range_z_max" type="int" setter="set_z_range_max" getter="get_z_range_max"> + Maximum [code]Z[/code] value of objects that are affected by the Light2D. Default value: [code]1024[/code]. + </member> + <member name="range_z_min" type="int" setter="set_z_range_min" getter="get_z_range_min"> + Minimum [code]z[/code] value of objects that are affected by the Light2D. Default value: [code]-1024[/code]. + </member> + <member name="shadow_buffer_size" type="int" setter="set_shadow_buffer_size" getter="get_shadow_buffer_size"> + Shadow buffer size. Default value: [code]2048[/code]. + </member> + <member name="shadow_color" type="Color" setter="set_shadow_color" getter="get_shadow_color"> + [Color] of shadows cast by the Light2D. + </member> + <member name="shadow_enabled" type="bool" setter="set_shadow_enabled" getter="is_shadow_enabled"> + If [code]true[/code] the Light2D will cast shadows. Default value: [code]false[/code]. + </member> + <member name="shadow_filter" type="int" setter="set_shadow_filter" getter="get_shadow_filter" enum="Light2D.ShadowFilter"> + Shadow filter type. May be one of [code][None, PCF5, PCF9, PCF13][/code]. Default value: [code]None[/code]. + </member> + <member name="shadow_filter_smooth" type="float" setter="set_shadow_smooth" getter="get_shadow_smooth"> + Smoothing value for shadows. + </member> + <member name="shadow_gradient_length" type="float" setter="set_shadow_gradient_length" getter="get_shadow_gradient_length"> + Smooth shadow gradient length. + </member> + <member name="shadow_item_cull_mask" type="int" setter="set_item_shadow_cull_mask" getter="get_item_shadow_cull_mask"> + The shadow mask. Used with [LightOccluder2D] to cast shadows. Only occluders with a matching shadow mask will cast shadows. + </member> + <member name="texture" type="Texture" setter="set_texture" getter="get_texture"> + [Texture] used for the Light2D's appearance. + </member> + <member name="texture_scale" type="float" setter="set_texture_scale" getter="get_texture_scale"> + The [code]texture[/code]'s scale factor. + </member> + </members> + <constants> + <constant name="MODE_ADD" value="0"> + Adds the value of pixels corresponding to the Light2D to the values of pixels under it. This is the common behaviour of a light. + </constant> + <constant name="MODE_SUB" value="1"> + Subtract the value of pixels corresponding to the Light2D to the values of pixels under it, resulting in inversed light effect. + </constant> + <constant name="MODE_MIX" value="2"> + Mix the value of pixels corresponding to the Light2D to the values of pixels under it by linear interpolation. + </constant> + <constant name="MODE_MASK" value="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. + </constant> + <constant name="SHADOW_FILTER_NONE" value="0"> + </constant> + <constant name="SHADOW_FILTER_PCF3" value="1"> + </constant> + <constant name="SHADOW_FILTER_PCF5" value="2"> + </constant> + <constant name="SHADOW_FILTER_PCF7" value="3"> + </constant> + <constant name="SHADOW_FILTER_PCF9" value="4"> + </constant> + <constant name="SHADOW_FILTER_PCF13" value="5"> + </constant> + </constants> +</class> diff --git a/doc/classes/LightOccluder2D.xml b/doc/classes/LightOccluder2D.xml new file mode 100644 index 0000000000..babcf31c08 --- /dev/null +++ b/doc/classes/LightOccluder2D.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="LightOccluder2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Occludes light cast by a Light2D, casting shadows. + </brief_description> + <description> + Occludes light cast by a Light2D, casting shadows. The LightOccluder2D must be provided with an [OccluderPolygon2D] in order for the shadow to be computed. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_occluder_light_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the light mask of the LightOccluder2D. + </description> + </method> + <method name="get_occluder_polygon" qualifiers="const"> + <return type="OccluderPolygon2D"> + </return> + <description> + Return the OccluderPolygon2D that defines the LightOccluder2D. + </description> + </method> + <method name="set_occluder_light_mask"> + <return type="void"> + </return> + <argument index="0" name="mask" type="int"> + </argument> + <description> + Set the LightOccluder2D light mask. The LightOccluder2D will cast shadows only from Light2Ds that belong to the same light mask(s). + </description> + </method> + <method name="set_occluder_polygon"> + <return type="void"> + </return> + <argument index="0" name="polygon" type="OccluderPolygon2D"> + </argument> + <description> + Set the OccluderPolygon2D that defines the LightOccluder2D. + </description> + </method> + </methods> + <members> + <member name="light_mask" type="int" setter="set_occluder_light_mask" getter="get_occluder_light_mask"> + The LightOccluder2D's light mask. The LightOccluder2D will cast shadows only from Light2D(s) that have the same light mask(s). + </member> + <member name="occluder" type="OccluderPolygon2D" setter="set_occluder_polygon" getter="get_occluder_polygon"> + The [OccluderPolygon2D] used to compute the shadow. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Line2D.xml b/doc/classes/Line2D.xml new file mode 100644 index 0000000000..81fd255781 --- /dev/null +++ b/doc/classes/Line2D.xml @@ -0,0 +1,253 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Line2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + A 2D line. + </brief_description> + <description> + A line through several points in 2D space. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_point"> + <return type="void"> + </return> + <argument index="0" name="pos" type="Vector2"> + </argument> + <description> + Add a point at the x/y position in the supplied [Vector2] + </description> + </method> + <method name="get_begin_cap_mode" qualifiers="const"> + <return type="int" enum="Line2D.LineCapMode"> + </return> + <description> + </description> + </method> + <method name="get_default_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_end_cap_mode" qualifiers="const"> + <return type="int" enum="Line2D.LineCapMode"> + </return> + <description> + </description> + </method> + <method name="get_gradient" qualifiers="const"> + <return type="Gradient"> + </return> + <description> + </description> + </method> + <method name="get_joint_mode" qualifiers="const"> + <return type="int" enum="Line2D.LineJointMode"> + </return> + <description> + </description> + </method> + <method name="get_point_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_point_pos" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="i" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_points" qualifiers="const"> + <return type="PoolVector2Array"> + </return> + <description> + </description> + </method> + <method name="get_round_precision" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_sharp_limit" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_texture" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="get_texture_mode" qualifiers="const"> + <return type="int" enum="Line2D.LineTextureMode"> + </return> + <description> + </description> + </method> + <method name="get_width" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="remove_point"> + <return type="void"> + </return> + <argument index="0" name="i" type="int"> + </argument> + <description> + Remove the point at index 'i' from the line. + </description> + </method> + <method name="set_begin_cap_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="Line2D.LineCapMode"> + </argument> + <description> + </description> + </method> + <method name="set_default_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_end_cap_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="Line2D.LineCapMode"> + </argument> + <description> + </description> + </method> + <method name="set_gradient"> + <return type="void"> + </return> + <argument index="0" name="color" type="Gradient"> + </argument> + <description> + </description> + </method> + <method name="set_joint_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="Line2D.LineJointMode"> + </argument> + <description> + </description> + </method> + <method name="set_point_pos"> + <return type="void"> + </return> + <argument index="0" name="i" type="int"> + </argument> + <argument index="1" name="pos" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_points"> + <return type="void"> + </return> + <argument index="0" name="points" type="PoolVector2Array"> + </argument> + <description> + </description> + </method> + <method name="set_round_precision"> + <return type="void"> + </return> + <argument index="0" name="precision" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_sharp_limit"> + <return type="void"> + </return> + <argument index="0" name="limit" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_texture"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_texture_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="Line2D.LineTextureMode"> + </argument> + <description> + </description> + </method> + <method name="set_width"> + <return type="void"> + </return> + <argument index="0" name="width" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="begin_cap_mode" type="int" setter="set_begin_cap_mode" getter="get_begin_cap_mode" enum="Line2D.LineCapMode"> + </member> + <member name="default_color" type="Color" setter="set_default_color" getter="get_default_color"> + </member> + <member name="end_cap_mode" type="int" setter="set_end_cap_mode" getter="get_end_cap_mode" enum="Line2D.LineCapMode"> + </member> + <member name="gradient" type="Gradient" setter="set_gradient" getter="get_gradient"> + </member> + <member name="joint_mode" type="int" setter="set_joint_mode" getter="get_joint_mode" enum="Line2D.LineJointMode"> + </member> + <member name="points" type="PoolVector2Array" setter="set_points" getter="get_points"> + </member> + <member name="round_precision" type="int" setter="set_round_precision" getter="get_round_precision"> + </member> + <member name="sharp_limit" type="float" setter="set_sharp_limit" getter="get_sharp_limit"> + </member> + <member name="texture" type="Texture" setter="set_texture" getter="get_texture"> + </member> + <member name="texture_mode" type="int" setter="set_texture_mode" getter="get_texture_mode" enum="Line2D.LineTextureMode"> + </member> + <member name="width" type="float" setter="set_width" getter="get_width"> + </member> + </members> + <constants> + <constant name="LINE_JOINT_SHARP" value="0"> + </constant> + <constant name="LINE_JOINT_BEVEL" value="1"> + </constant> + <constant name="LINE_JOINT_ROUND" value="2"> + </constant> + <constant name="LINE_CAP_NONE" value="0"> + </constant> + <constant name="LINE_CAP_BOX" value="1"> + </constant> + <constant name="LINE_CAP_ROUND" value="2"> + </constant> + <constant name="LINE_TEXTURE_NONE" value="0"> + </constant> + <constant name="LINE_TEXTURE_TILE" value="1"> + </constant> + </constants> +</class> diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml new file mode 100644 index 0000000000..0577e1ba37 --- /dev/null +++ b/doc/classes/LineEdit.xml @@ -0,0 +1,338 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="LineEdit" inherits="Control" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Control that provides single line string editing. + </brief_description> + <description> + LineEdit provides a single line string editor, used for text fields. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="append_at_cursor"> + <return type="void"> + </return> + <argument index="0" name="text" type="String"> + </argument> + <description> + Append text at cursor, scrolling the [LineEdit] when needed. + </description> + </method> + <method name="clear"> + <return type="void"> + </return> + <description> + Clear the [LineEdit] text. + </description> + </method> + <method name="cursor_get_blink_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + Gets whether the line edit caret is blinking. + </description> + </method> + <method name="cursor_get_blink_speed" qualifiers="const"> + <return type="float"> + </return> + <description> + Gets the line edit caret blink speed. + </description> + </method> + <method name="cursor_set_blink_enabled"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Set the line edit caret to blink. + </description> + </method> + <method name="cursor_set_blink_speed"> + <return type="void"> + </return> + <argument index="0" name="blink_speed" type="float"> + </argument> + <description> + Set the line edit caret blink speed. Cannot be less then or equal to 0. + </description> + </method> + <method name="get_align" qualifiers="const"> + <return type="int" enum="LineEdit.Align"> + </return> + <description> + Return the align mode of the [LineEdit]. + </description> + </method> + <method name="get_cursor_pos" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the cursor position inside the [LineEdit]. + </description> + </method> + <method name="get_expand_to_text_length" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_max_length" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the maximum amount of characters the [LineEdit] can edit. If 0 is returned, no limit exists. + </description> + </method> + <method name="get_menu" qualifiers="const"> + <return type="PopupMenu"> + </return> + <description> + Return the [PopupMenu] of this [LineEdit]. + </description> + </method> + <method name="get_placeholder" qualifiers="const"> + <return type="String"> + </return> + <description> + Return the placeholder text. + </description> + </method> + <method name="get_placeholder_alpha" qualifiers="const"> + <return type="float"> + </return> + <description> + Return transparency of the placeholder text. + </description> + </method> + <method name="get_text" qualifiers="const"> + <return type="String"> + </return> + <description> + Return the text in the [LineEdit]. + </description> + </method> + <method name="is_editable" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return the [i]editable[/i] status of the [LineEdit] (see [method set_editable]). + </description> + </method> + <method name="is_secret" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return the [i]secret[/i] status of the [LineEdit] (see [method set_secret]). + </description> + </method> + <method name="menu_option"> + <return type="void"> + </return> + <argument index="0" name="option" type="int"> + </argument> + <description> + Execute a given action as defined in the MENU_* enum. + </description> + </method> + <method name="select"> + <return type="void"> + </return> + <argument index="0" name="from" type="int" default="0"> + </argument> + <argument index="1" name="to" type="int" default="-1"> + </argument> + <description> + Select the text inside [LineEdit] by the given character positions. [code]from[/code] is default to the beginning. [code]to[/code] is default to the end. + [codeblock] + select() # select all + select(5) # select from the fifth character to the end. + select(2, 5) # select from the second to the fifth character. + [/codeblock] + </description> + </method> + <method name="select_all"> + <return type="void"> + </return> + <description> + Select the whole string. + </description> + </method> + <method name="set_align"> + <return type="void"> + </return> + <argument index="0" name="align" type="int" enum="LineEdit.Align"> + </argument> + <description> + Set text alignment of the [LineEdit]. + </description> + </method> + <method name="set_cursor_pos"> + <return type="void"> + </return> + <argument index="0" name="pos" type="int"> + </argument> + <description> + Set the cursor position inside the [LineEdit], causing it to scroll if needed. + </description> + </method> + <method name="set_editable"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Set the [i]editable[/i] status of the [LineEdit]. When disabled, existing text can't be modified and new text can't be added. + </description> + </method> + <method name="set_expand_to_text_length"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_max_length"> + <return type="void"> + </return> + <argument index="0" name="chars" type="int"> + </argument> + <description> + Set the maximum amount of characters the [LineEdit] can edit, and cropping existing text in case it exceeds that limit. Setting 0 removes the limit. + </description> + </method> + <method name="set_placeholder"> + <return type="void"> + </return> + <argument index="0" name="text" type="String"> + </argument> + <description> + Set the placeholder text. + </description> + </method> + <method name="set_placeholder_alpha"> + <return type="void"> + </return> + <argument index="0" name="alpha" type="float"> + </argument> + <description> + Set transparency of the placeholder text. + </description> + </method> + <method name="set_secret"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Set the [i]secret[/i] status of the [LineEdit]. When enabled, every character is displayed as "*". + </description> + </method> + <method name="set_text"> + <return type="void"> + </return> + <argument index="0" name="text" type="String"> + </argument> + <description> + Set the text in the [LineEdit], clearing the existing one and the selection. + </description> + </method> + </methods> + <members> + <member name="align" type="int" setter="set_align" getter="get_align" enum="LineEdit.Align"> + </member> + <member name="caret_blink" type="bool" setter="cursor_set_blink_enabled" getter="cursor_get_blink_enabled"> + </member> + <member name="caret_blink_speed" type="float" setter="cursor_set_blink_speed" getter="cursor_get_blink_speed"> + </member> + <member name="editable" type="bool" setter="set_editable" getter="is_editable"> + </member> + <member name="expand_to_len" type="bool" setter="set_expand_to_text_length" getter="get_expand_to_text_length"> + </member> + <member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" enum="Control.FocusMode"> + </member> + <member name="max_length" type="int" setter="set_max_length" getter="get_max_length"> + </member> + <member name="placeholder_alpha" type="float" setter="set_placeholder_alpha" getter="get_placeholder_alpha"> + </member> + <member name="placeholder_text" type="String" setter="set_placeholder" getter="get_placeholder"> + </member> + <member name="secret" type="bool" setter="set_secret" getter="is_secret"> + </member> + <member name="text" type="String" setter="set_text" getter="get_text"> + </member> + </members> + <signals> + <signal name="text_changed"> + <argument index="0" name="text" type="String"> + </argument> + <description> + When the text changes, this signal is emitted. + </description> + </signal> + <signal name="text_entered"> + <argument index="0" name="text" type="String"> + </argument> + <description> + This signal is emitted when the user presses KEY_ENTER on the [LineEdit]. This signal is often used as an alternate confirmation mechanism in dialogs. + </description> + </signal> + </signals> + <constants> + <constant name="ALIGN_LEFT" value="0"> + Align left. + </constant> + <constant name="ALIGN_CENTER" value="1"> + Align center. + </constant> + <constant name="ALIGN_RIGHT" value="2"> + Align right. + </constant> + <constant name="ALIGN_FILL" value="3"> + Align fill. + </constant> + <constant name="MENU_CUT" value="0"> + Cut (Copy and clear). + </constant> + <constant name="MENU_COPY" value="1"> + Copy the selected text. + </constant> + <constant name="MENU_PASTE" value="2"> + Paste the clipboard text over the selected text. + </constant> + <constant name="MENU_CLEAR" value="3"> + Clear the text. + </constant> + <constant name="MENU_SELECT_ALL" value="4"> + Select all text. + </constant> + <constant name="MENU_UNDO" value="5"> + Undo an action. + </constant> + <constant name="MENU_MAX" value="6"> + </constant> + </constants> + <theme_items> + <theme_item name="cursor_color" type="Color"> + </theme_item> + <theme_item name="focus" type="StyleBox"> + </theme_item> + <theme_item name="font" type="Font"> + </theme_item> + <theme_item name="font_color" type="Color"> + </theme_item> + <theme_item name="font_color_selected" type="Color"> + </theme_item> + <theme_item name="minimum_spaces" type="int"> + </theme_item> + <theme_item name="normal" type="StyleBox"> + </theme_item> + <theme_item name="read_only" type="StyleBox"> + </theme_item> + <theme_item name="selection_color" type="Color"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/LineShape2D.xml b/doc/classes/LineShape2D.xml new file mode 100644 index 0000000000..5596c48162 --- /dev/null +++ b/doc/classes/LineShape2D.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="LineShape2D" inherits="Shape2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Line shape for 2D collisions. + </brief_description> + <description> + Line shape for 2D collisions. It works like a 2D plane and will not allow any body to go to the negative side. Not recommended for rigid bodies, and usually not recommended for static bodies either because it forces checks against it on every frame. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_d" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the line distance from the origin. + </description> + </method> + <method name="get_normal" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the line normal. + </description> + </method> + <method name="set_d"> + <return type="void"> + </return> + <argument index="0" name="d" type="float"> + </argument> + <description> + Set the line distance from the origin. + </description> + </method> + <method name="set_normal"> + <return type="void"> + </return> + <argument index="0" name="normal" type="Vector2"> + </argument> + <description> + Set the line normal. + </description> + </method> + </methods> + <members> + <member name="d" type="float" setter="set_d" getter="get_d"> + The line's distance from the origin. + </member> + <member name="normal" type="Vector2" setter="set_normal" getter="get_normal"> + The line's normal. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/LinkButton.xml b/doc/classes/LinkButton.xml new file mode 100644 index 0000000000..d9598daf16 --- /dev/null +++ b/doc/classes/LinkButton.xml @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="LinkButton" inherits="BaseButton" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Simple button used to represent a link to some resource + </brief_description> + <description> + This kind of buttons are primarily used when the interaction with the button causes a context change (like linking to a web page). + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_text" qualifiers="const"> + <return type="String"> + </return> + <description> + Returns the text of the button. + </description> + </method> + <method name="get_underline_mode" qualifiers="const"> + <return type="int" enum="LinkButton.UnderlineMode"> + </return> + <description> + Returns the underline mode for this button. + </description> + </method> + <method name="set_text"> + <return type="void"> + </return> + <argument index="0" name="text" type="String"> + </argument> + <description> + Sets the text of the button. + </description> + </method> + <method name="set_underline_mode"> + <return type="void"> + </return> + <argument index="0" name="underline_mode" type="int" enum="LinkButton.UnderlineMode"> + </argument> + <description> + Sets the underline mode for this button, the argument must be one of the [LinkButton] constants (see constants section). + </description> + </method> + </methods> + <members> + <member name="text" type="String" setter="set_text" getter="get_text"> + </member> + <member name="underline" type="int" setter="set_underline_mode" getter="get_underline_mode" enum="LinkButton.UnderlineMode"> + </member> + </members> + <constants> + <constant name="UNDERLINE_MODE_ALWAYS" value="0"> + The LinkButton will always show an underline at the bottom of its text + </constant> + <constant name="UNDERLINE_MODE_ON_HOVER" value="1"> + The LinkButton will show an underline at the bottom of its text when the mouse cursor is over it. + </constant> + <constant name="UNDERLINE_MODE_NEVER" value="2"> + The LinkButton will never show an underline at the bottom of its text. + </constant> + </constants> + <theme_items> + <theme_item name="font" type="Font"> + </theme_item> + <theme_item name="font_color" type="Color"> + </theme_item> + <theme_item name="font_color_hover" type="Color"> + </theme_item> + <theme_item name="font_color_pressed" type="Color"> + </theme_item> + <theme_item name="underline_spacing" type="int"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/Listener.xml b/doc/classes/Listener.xml new file mode 100644 index 0000000000..176369cccb --- /dev/null +++ b/doc/classes/Listener.xml @@ -0,0 +1,39 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Listener" inherits="Spatial" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="clear_current"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="get_listener_transform" qualifiers="const"> + <return type="Transform"> + </return> + <description> + </description> + </method> + <method name="is_current" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="make_current"> + <return type="void"> + </return> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/MainLoop.xml b/doc/classes/MainLoop.xml new file mode 100644 index 0000000000..e6f9e40dfe --- /dev/null +++ b/doc/classes/MainLoop.xml @@ -0,0 +1,136 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="MainLoop" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Main loop is the abstract main loop base class. + </brief_description> + <description> + Main loop is the abstract main loop base class. All other main loop classes are derived from it. Upon application start, a [MainLoop] has to be provided to OS, else the application will exit. This happens automatically (and a [SceneTree] is created), unless a main [Script] is supplied, which may or not create and return a [MainLoop]. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="_drop_files" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="files" type="PoolStringArray"> + </argument> + <argument index="1" name="screen" type="int"> + </argument> + <description> + </description> + </method> + <method name="_finalize" qualifiers="virtual"> + <return type="void"> + </return> + <description> + Called before the program exits. + </description> + </method> + <method name="_idle" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="delta" type="float"> + </argument> + <description> + Called each idle frame with time since last call as an only argument. + </description> + </method> + <method name="_initialize" qualifiers="virtual"> + <return type="void"> + </return> + <description> + Called once during initialization. + </description> + </method> + <method name="_input_event" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="ev" type="InputEvent"> + </argument> + <description> + </description> + </method> + <method name="_input_text" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="text" type="String"> + </argument> + <description> + </description> + </method> + <method name="_iteration" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="delta" type="float"> + </argument> + <description> + </description> + </method> + <method name="finish"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="idle"> + <return type="bool"> + </return> + <argument index="0" name="delta" type="float"> + </argument> + <description> + </description> + </method> + <method name="init"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="input_event"> + <return type="void"> + </return> + <argument index="0" name="ev" type="InputEvent"> + </argument> + <description> + </description> + </method> + <method name="input_text"> + <return type="void"> + </return> + <argument index="0" name="text" type="String"> + </argument> + <description> + </description> + </method> + <method name="iteration"> + <return type="bool"> + </return> + <argument index="0" name="delta" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + <constant name="NOTIFICATION_WM_MOUSE_ENTER" value="2" enum=""> + </constant> + <constant name="NOTIFICATION_WM_MOUSE_EXIT" value="3" enum=""> + </constant> + <constant name="NOTIFICATION_WM_FOCUS_IN" value="4" enum=""> + </constant> + <constant name="NOTIFICATION_WM_FOCUS_OUT" value="5" enum=""> + </constant> + <constant name="NOTIFICATION_WM_QUIT_REQUEST" value="6" enum=""> + </constant> + <constant name="NOTIFICATION_WM_UNFOCUS_REQUEST" value="8" enum=""> + </constant> + <constant name="NOTIFICATION_OS_MEMORY_WARNING" value="9" enum=""> + </constant> + <constant name="NOTIFICATION_TRANSLATION_CHANGED" value="90" enum=""> + </constant> + <constant name="NOTIFICATION_WM_ABOUT" value="91" enum=""> + </constant> + </constants> +</class> diff --git a/doc/classes/MarginContainer.xml b/doc/classes/MarginContainer.xml new file mode 100644 index 0000000000..d4b9b01f63 --- /dev/null +++ b/doc/classes/MarginContainer.xml @@ -0,0 +1,27 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="MarginContainer" inherits="Container" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Simple margin container. + </brief_description> + <description> + Simple margin container. Adds a left margin to anything contained. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> + <theme_items> + <theme_item name="margin_bottom" type="int"> + </theme_item> + <theme_item name="margin_left" type="int"> + </theme_item> + <theme_item name="margin_right" type="int"> + </theme_item> + <theme_item name="margin_top" type="int"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/Marshalls.xml b/doc/classes/Marshalls.xml new file mode 100644 index 0000000000..b443d03108 --- /dev/null +++ b/doc/classes/Marshalls.xml @@ -0,0 +1,71 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Marshalls" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Data transformation (marshalling) and encoding helpers. + </brief_description> + <description> + Provides data transformation and encoding utility functions. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="base64_to_raw"> + <return type="PoolByteArray"> + </return> + <argument index="0" name="base64_str" type="String"> + </argument> + <description> + Return [PoolByteArray] of a given base64 encoded String. + </description> + </method> + <method name="base64_to_utf8"> + <return type="String"> + </return> + <argument index="0" name="base64_str" type="String"> + </argument> + <description> + Return utf8 String of a given base64 encoded String. + </description> + </method> + <method name="base64_to_variant"> + <return type="Variant"> + </return> + <argument index="0" name="base64_str" type="String"> + </argument> + <description> + Return [Variant] of a given base64 encoded String. + </description> + </method> + <method name="raw_to_base64"> + <return type="String"> + </return> + <argument index="0" name="array" type="PoolByteArray"> + </argument> + <description> + Return base64 encoded String of a given [PoolByteArray]. + </description> + </method> + <method name="utf8_to_base64"> + <return type="String"> + </return> + <argument index="0" name="utf8_str" type="String"> + </argument> + <description> + Return base64 encoded String of a given utf8 String. + </description> + </method> + <method name="variant_to_base64"> + <return type="String"> + </return> + <argument index="0" name="variant" type="Variant"> + </argument> + <description> + Return base64 encoded String of a given [Variant]. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Material.xml b/doc/classes/Material.xml new file mode 100644 index 0000000000..88b35ac6b5 --- /dev/null +++ b/doc/classes/Material.xml @@ -0,0 +1,55 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Material" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Abstract base [Resource] for coloring and shading geometry. + </brief_description> + <description> + Material is a base [Resource] used for coloring and shading geometry. All materials inherit from it and almost all [VisualInstance] derived nodes carry a Material. A few flags and parameters are shared between all material types and are configured here. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_next_pass" qualifiers="const"> + <return type="Material"> + </return> + <description> + </description> + </method> + <method name="get_render_priority" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_next_pass"> + <return type="void"> + </return> + <argument index="0" name="next_pass" type="Material"> + </argument> + <description> + </description> + </method> + <method name="set_render_priority"> + <return type="void"> + </return> + <argument index="0" name="priority" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="next_pass" type="Material" setter="set_next_pass" getter="get_next_pass"> + </member> + <member name="render_priority" type="int" setter="set_render_priority" getter="get_render_priority"> + </member> + </members> + <constants> + <constant name="RENDER_PRIORITY_MAX" value="127" enum=""> + </constant> + <constant name="RENDER_PRIORITY_MIN" value="-128" enum=""> + </constant> + </constants> +</class> diff --git a/doc/classes/MenuButton.xml b/doc/classes/MenuButton.xml new file mode 100644 index 0000000000..f1ab74d00e --- /dev/null +++ b/doc/classes/MenuButton.xml @@ -0,0 +1,59 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="MenuButton" inherits="Button" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Special button that brings up a [PopupMenu] when clicked. + </brief_description> + <description> + Special button that brings up a [PopupMenu] when clicked. That's pretty much all it does, as it's just a helper class when building GUIs. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_popup"> + <return type="PopupMenu"> + </return> + <description> + Return the [PopupMenu] contained in this button. + </description> + </method> + </methods> + <members> + <member name="items" type="Array" setter="_set_items" getter="_get_items"> + </member> + </members> + <signals> + <signal name="about_to_show"> + <description> + Emitted when [PopupMenu] of this MenuButton is about to show. + </description> + </signal> + </signals> + <constants> + </constants> + <theme_items> + <theme_item name="disabled" type="StyleBox"> + </theme_item> + <theme_item name="focus" type="StyleBox"> + </theme_item> + <theme_item name="font" type="Font"> + </theme_item> + <theme_item name="font_color" type="Color"> + </theme_item> + <theme_item name="font_color_disabled" type="Color"> + </theme_item> + <theme_item name="font_color_hover" type="Color"> + </theme_item> + <theme_item name="font_color_pressed" type="Color"> + </theme_item> + <theme_item name="hover" type="StyleBox"> + </theme_item> + <theme_item name="hseparation" type="int"> + </theme_item> + <theme_item name="normal" type="StyleBox"> + </theme_item> + <theme_item name="pressed" type="StyleBox"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/Mesh.xml b/doc/classes/Mesh.xml new file mode 100644 index 0000000000..658265d242 --- /dev/null +++ b/doc/classes/Mesh.xml @@ -0,0 +1,143 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Mesh" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + A [Resource] that contains vertex-array based geometry. + </brief_description> + <description> + Mesh is a type of [Resource] that contains vertex-array based geometry, divided in [i]surfaces[/i]. Each surface contains a completely separate array and a material used to draw it. Design wise, a mesh with multiple surfaces is preferred to a single surface, because objects created in 3D editing software commonly contain multiple materials. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="create_convex_shape" qualifiers="const"> + <return type="Shape"> + </return> + <description> + Calculate a [ConvexPolygonShape] from the mesh. + </description> + </method> + <method name="create_outline" qualifiers="const"> + <return type="Mesh"> + </return> + <argument index="0" name="margin" type="float"> + </argument> + <description> + 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). + </description> + </method> + <method name="create_trimesh_shape" qualifiers="const"> + <return type="Shape"> + </return> + <description> + Calculate a [ConcavePolygonShape] from the mesh. + </description> + </method> + <method name="generate_triangle_mesh" qualifiers="const"> + <return type="TriangleMesh"> + </return> + <description> + Generate a [TriangleMesh] from the mesh. + </description> + </method> + <method name="get_faces" qualifiers="const"> + <return type="PoolVector3Array"> + </return> + <description> + Returns all the vertices that make up the faces of the mesh. Each three vertices represent one triangle. + </description> + </method> + </methods> + <constants> + <constant name="PRIMITIVE_POINTS" value="0"> + Render array as points (one vertex equals one point). + </constant> + <constant name="PRIMITIVE_LINES" value="1"> + Render array as lines (every two vertices a line is created). + </constant> + <constant name="PRIMITIVE_LINE_STRIP" value="2"> + Render array as line strip. + </constant> + <constant name="PRIMITIVE_LINE_LOOP" value="3"> + Render array as line loop (like line strip, but closed). + </constant> + <constant name="PRIMITIVE_TRIANGLES" value="4"> + Render array as triangles (every three vertices a triangle is created). + </constant> + <constant name="PRIMITIVE_TRIANGLE_STRIP" value="5"> + Render array as triangle strips. + </constant> + <constant name="PRIMITIVE_TRIANGLE_FAN" value="6"> + Render array as triangle fans. + </constant> + <constant name="BLEND_SHAPE_MODE_NORMALIZED" value="0"> + </constant> + <constant name="BLEND_SHAPE_MODE_RELATIVE" value="1"> + </constant> + <constant name="ARRAY_FORMAT_VERTEX" value="1"> + </constant> + <constant name="ARRAY_FORMAT_NORMAL" value="2"> + </constant> + <constant name="ARRAY_FORMAT_TANGENT" value="4"> + </constant> + <constant name="ARRAY_FORMAT_COLOR" value="8"> + </constant> + <constant name="ARRAY_FORMAT_TEX_UV" value="16"> + </constant> + <constant name="ARRAY_FORMAT_TEX_UV2" value="32"> + </constant> + <constant name="ARRAY_FORMAT_BONES" value="64"> + </constant> + <constant name="ARRAY_FORMAT_WEIGHTS" value="128"> + </constant> + <constant name="ARRAY_FORMAT_INDEX" value="256"> + </constant> + <constant name="ARRAY_COMPRESS_BASE" value="9"> + </constant> + <constant name="ARRAY_COMPRESS_VERTEX" value="512"> + </constant> + <constant name="ARRAY_COMPRESS_NORMAL" value="1024"> + </constant> + <constant name="ARRAY_COMPRESS_TANGENT" value="2048"> + </constant> + <constant name="ARRAY_COMPRESS_COLOR" value="4096"> + </constant> + <constant name="ARRAY_COMPRESS_TEX_UV" value="8192"> + </constant> + <constant name="ARRAY_COMPRESS_TEX_UV2" value="16384"> + </constant> + <constant name="ARRAY_COMPRESS_BONES" value="32768"> + </constant> + <constant name="ARRAY_COMPRESS_WEIGHTS" value="65536"> + </constant> + <constant name="ARRAY_COMPRESS_INDEX" value="131072"> + </constant> + <constant name="ARRAY_FLAG_USE_2D_VERTICES" value="262144"> + </constant> + <constant name="ARRAY_FLAG_USE_16_BIT_BONES" value="524288"> + </constant> + <constant name="ARRAY_COMPRESS_DEFAULT" value="97792"> + </constant> + <constant name="ARRAY_VERTEX" value="0"> + </constant> + <constant name="ARRAY_NORMAL" value="1"> + </constant> + <constant name="ARRAY_TANGENT" value="2"> + </constant> + <constant name="ARRAY_COLOR" value="3"> + </constant> + <constant name="ARRAY_TEX_UV" value="4"> + </constant> + <constant name="ARRAY_TEX_UV2" value="5"> + </constant> + <constant name="ARRAY_BONES" value="6"> + </constant> + <constant name="ARRAY_WEIGHTS" value="7"> + </constant> + <constant name="ARRAY_INDEX" value="8"> + </constant> + <constant name="ARRAY_MAX" value="9"> + </constant> + </constants> +</class> diff --git a/doc/classes/MeshDataTool.xml b/doc/classes/MeshDataTool.xml new file mode 100644 index 0000000000..6088d30013 --- /dev/null +++ b/doc/classes/MeshDataTool.xml @@ -0,0 +1,337 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="MeshDataTool" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="clear"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="commit_to_surface"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="mesh" type="ArrayMesh"> + </argument> + <description> + </description> + </method> + <method name="create_from_surface"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="mesh" type="ArrayMesh"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_edge_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_edge_faces" qualifiers="const"> + <return type="PoolIntArray"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_edge_meta" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_edge_vertex" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="vertex" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_face_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_face_edge" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="edge" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_face_meta" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_face_normal" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_face_vertex" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="vertex" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_format" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_material" qualifiers="const"> + <return type="Material"> + </return> + <description> + </description> + </method> + <method name="get_vertex" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_vertex_bones" qualifiers="const"> + <return type="PoolIntArray"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_vertex_color" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_vertex_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_vertex_edges" qualifiers="const"> + <return type="PoolIntArray"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_vertex_faces" qualifiers="const"> + <return type="PoolIntArray"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_vertex_meta" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_vertex_normal" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_vertex_tangent" qualifiers="const"> + <return type="Plane"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_vertex_uv" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_vertex_uv2" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_vertex_weights" qualifiers="const"> + <return type="PoolRealArray"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_edge_meta"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="meta" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="set_face_meta"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="meta" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="set_material"> + <return type="void"> + </return> + <argument index="0" name="material" type="Material"> + </argument> + <description> + </description> + </method> + <method name="set_vertex"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="vertex" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="set_vertex_bones"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="bones" type="PoolIntArray"> + </argument> + <description> + </description> + </method> + <method name="set_vertex_color"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_vertex_meta"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="meta" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="set_vertex_normal"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="normal" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="set_vertex_tangent"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="tangent" type="Plane"> + </argument> + <description> + </description> + </method> + <method name="set_vertex_uv"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="uv" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_vertex_uv2"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="uv2" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_vertex_weights"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="weights" type="PoolRealArray"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/MeshInstance.xml b/doc/classes/MeshInstance.xml new file mode 100644 index 0000000000..56b446cac1 --- /dev/null +++ b/doc/classes/MeshInstance.xml @@ -0,0 +1,94 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="MeshInstance" inherits="GeometryInstance" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Node that instances meshes into a scenario. + </brief_description> + <description> + MeshInstance is a [Node] that takes a [Mesh] resource and adds it to the current scenario by creating an instance of it. This is the class most often used to get 3D geometry rendered and can be used to instance a single [Mesh] in many places. This allows to reuse geometry and save on resources. When a [Mesh] has to be instanced more than thousands of times at close proximity, consider using a [MultiMesh] in a [MultiMeshInstance] instead. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="create_convex_collision"> + <return type="void"> + </return> + <description> + This helper creates a [StaticBody] child [Node] with a [ConvexPolygonShape] [CollisionShape] calculated from the mesh geometry. It's mainly used for testing. + </description> + </method> + <method name="create_debug_tangents"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="create_trimesh_collision"> + <return type="void"> + </return> + <description> + This helper creates a [StaticBody] child [Node] with a [ConcavePolygonShape] [CollisionShape] calculated from the mesh geometry. It's mainly used for testing. + </description> + </method> + <method name="get_mesh" qualifiers="const"> + <return type="Mesh"> + </return> + <description> + Returns the current [Mesh] resource for the instance. + </description> + </method> + <method name="get_skeleton_path"> + <return type="NodePath"> + </return> + <description> + </description> + </method> + <method name="get_surface_material" qualifiers="const"> + <return type="Material"> + </return> + <argument index="0" name="surface" type="int"> + </argument> + <description> + Returns the [Material] for a surface of the [Mesh] resource. + </description> + </method> + <method name="set_mesh"> + <return type="void"> + </return> + <argument index="0" name="mesh" type="Mesh"> + </argument> + <description> + </description> + </method> + <method name="set_skeleton_path"> + <return type="void"> + </return> + <argument index="0" name="skeleton_path" type="NodePath"> + </argument> + <description> + </description> + </method> + <method name="set_surface_material"> + <return type="void"> + </return> + <argument index="0" name="surface" type="int"> + </argument> + <argument index="1" name="material" type="Material"> + </argument> + <description> + Sets the [Material] for a surface of the [Mesh] resource. + </description> + </method> + </methods> + <members> + <member name="mesh" type="Mesh" setter="set_mesh" getter="get_mesh"> + The [Mesh] resource for the instance. + </member> + <member name="skeleton" type="NodePath" setter="set_skeleton_path" getter="get_skeleton_path"> + [NodePath] to the [Skeleton] associated with the instance. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/MeshLibrary.xml b/doc/classes/MeshLibrary.xml new file mode 100644 index 0000000000..5636db23b5 --- /dev/null +++ b/doc/classes/MeshLibrary.xml @@ -0,0 +1,158 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="MeshLibrary" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Library of meshes. + </brief_description> + <description> + Library of meshes. Contains a list of [Mesh] resources, each with name and ID. Useful for GridMap or painting Terrain. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="clear"> + <return type="void"> + </return> + <description> + Clear the library. + </description> + </method> + <method name="create_item"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + Create a new item in the library, supplied an id. + </description> + </method> + <method name="find_item_by_name" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_item_list" qualifiers="const"> + <return type="PoolIntArray"> + </return> + <description> + Return the list of items. + </description> + </method> + <method name="get_item_mesh" qualifiers="const"> + <return type="Mesh"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + Return the mesh of the item. + </description> + </method> + <method name="get_item_name" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + Return the name of the item. + </description> + </method> + <method name="get_item_navmesh" qualifiers="const"> + <return type="NavigationMesh"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_item_preview" qualifiers="const"> + <return type="Texture"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_item_shapes" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_last_unused_item_id" qualifiers="const"> + <return type="int"> + </return> + <description> + Get an unused id for a new item. + </description> + </method> + <method name="remove_item"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + Remove the item. + </description> + </method> + <method name="set_item_mesh"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="mesh" type="Mesh"> + </argument> + <description> + Set the mesh of the item. + </description> + </method> + <method name="set_item_name"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="name" type="String"> + </argument> + <description> + Set the name of the item. + </description> + </method> + <method name="set_item_navmesh"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="navmesh" type="NavigationMesh"> + </argument> + <description> + </description> + </method> + <method name="set_item_preview"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="texture" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_item_shapes"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="shapes" type="Array"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/MultiMesh.xml b/doc/classes/MultiMesh.xml new file mode 100644 index 0000000000..6df9689ada --- /dev/null +++ b/doc/classes/MultiMesh.xml @@ -0,0 +1,151 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="MultiMesh" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Provides high performance mesh instancing. + </brief_description> + <description> + MultiMesh provides low level mesh instancing. If the amount of [Mesh] instances needed goes from hundreds to thousands (and most need to be visible at close proximity) creating such a large amount of [MeshInstance] nodes may affect performance by using too much CPU or video memory. + For this case a MultiMesh becomes very useful, as it can draw thousands of instances with little API overhead. + As a drawback, if the instances are too far away of each other, performance may be reduced as every single instance will always rendered (they are spatially indexed as one, for the whole object). + Since instances may have any behavior, the Rect3 used for visibility must be provided by the user. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_aabb" qualifiers="const"> + <return type="Rect3"> + </return> + <description> + Return the visibility Rect3. + </description> + </method> + <method name="get_color_format" qualifiers="const"> + <return type="int" enum="MultiMesh.ColorFormat"> + </return> + <description> + </description> + </method> + <method name="get_instance_color" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="instance" type="int"> + </argument> + <description> + Get the color of a specific instance. + </description> + </method> + <method name="get_instance_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the amount of instances that is going to be drawn. + </description> + </method> + <method name="get_instance_transform" qualifiers="const"> + <return type="Transform"> + </return> + <argument index="0" name="instance" type="int"> + </argument> + <description> + Return the transform of a specific instance. + </description> + </method> + <method name="get_mesh" qualifiers="const"> + <return type="Mesh"> + </return> + <description> + Return the [Mesh] resource drawn as multiple instances. + </description> + </method> + <method name="get_transform_format" qualifiers="const"> + <return type="int" enum="MultiMesh.TransformFormat"> + </return> + <description> + </description> + </method> + <method name="set_color_format"> + <return type="void"> + </return> + <argument index="0" name="format" type="int" enum="MultiMesh.ColorFormat"> + </argument> + <description> + </description> + </method> + <method name="set_instance_color"> + <return type="void"> + </return> + <argument index="0" name="instance" type="int"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <description> + Set the color of a specific instance. + </description> + </method> + <method name="set_instance_count"> + <return type="void"> + </return> + <argument index="0" name="count" type="int"> + </argument> + <description> + Set the amount of instances that is going to be drawn. Changing this number will erase all the existing instance transform and color data. + </description> + </method> + <method name="set_instance_transform"> + <return type="void"> + </return> + <argument index="0" name="instance" type="int"> + </argument> + <argument index="1" name="transform" type="Transform"> + </argument> + <description> + Set the transform for a specific instance. + </description> + </method> + <method name="set_mesh"> + <return type="void"> + </return> + <argument index="0" name="mesh" type="Mesh"> + </argument> + <description> + Set the [Mesh] resource to be drawn in multiple instances. + </description> + </method> + <method name="set_transform_format"> + <return type="void"> + </return> + <argument index="0" name="format" type="int" enum="MultiMesh.TransformFormat"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="color_array" type="PoolColorArray" setter="_set_color_array" getter="_get_color_array"> + </member> + <member name="color_format" type="int" setter="set_color_format" getter="get_color_format" enum="MultiMesh.ColorFormat"> + </member> + <member name="instance_count" type="int" setter="set_instance_count" getter="get_instance_count"> + </member> + <member name="mesh" type="Mesh" setter="set_mesh" getter="get_mesh"> + </member> + <member name="transform_array" type="PoolVector3Array" setter="_set_transform_array" getter="_get_transform_array"> + </member> + <member name="transform_format" type="int" setter="set_transform_format" getter="get_transform_format" enum="MultiMesh.TransformFormat"> + </member> + </members> + <constants> + <constant name="TRANSFORM_2D" value="0"> + </constant> + <constant name="TRANSFORM_3D" value="1"> + </constant> + <constant name="COLOR_NONE" value="0"> + </constant> + <constant name="COLOR_8BIT" value="1"> + </constant> + <constant name="COLOR_FLOAT" value="2"> + </constant> + </constants> +</class> diff --git a/doc/classes/MultiMeshInstance.xml b/doc/classes/MultiMeshInstance.xml new file mode 100644 index 0000000000..06454e3cdc --- /dev/null +++ b/doc/classes/MultiMeshInstance.xml @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="MultiMeshInstance" inherits="GeometryInstance" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Node that instances a [MultiMesh]. + </brief_description> + <description> + MultiMeshInstance is a [Node] that takes a [MultiMesh] resource and adds it to the current scenario by creating an instance of it (yes, this is an instance of instances). + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_multimesh" qualifiers="const"> + <return type="MultiMesh"> + </return> + <description> + Return the [MultiMesh] that is used for instancing. + </description> + </method> + <method name="set_multimesh"> + <return type="void"> + </return> + <argument index="0" name="multimesh" type="MultiMesh"> + </argument> + <description> + Set the [MultiMesh] to be instanced. + </description> + </method> + </methods> + <members> + <member name="multimesh" type="MultiMesh" setter="set_multimesh" getter="get_multimesh"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Mutex.xml b/doc/classes/Mutex.xml new file mode 100644 index 0000000000..ef3aeb9e07 --- /dev/null +++ b/doc/classes/Mutex.xml @@ -0,0 +1,38 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Mutex" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + A synchronization Mutex. + </brief_description> + <description> + A synchronization Mutex. Element used in multi-threadding. Basically a binary [Semaphore]. Guarantees that only one thread has this lock, can be used to protect a critical section. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="lock"> + <return type="void"> + </return> + <description> + Lock this [Mutex], blocks until it is unlocked by the current owner. + </description> + </method> + <method name="try_lock"> + <return type="int" enum="Error"> + </return> + <description> + Try locking this [Mutex], does not block. Returns [OK] on success else [ERR_BUSY]. + </description> + </method> + <method name="unlock"> + <return type="void"> + </return> + <description> + Unlock this [Mutex], leaving it to others threads. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/NativeScript.xml b/doc/classes/NativeScript.xml new file mode 100644 index 0000000000..b040cfd966 --- /dev/null +++ b/doc/classes/NativeScript.xml @@ -0,0 +1,55 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="NativeScript" inherits="Script" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_class_name" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_library" qualifiers="const"> + <return type="GDNativeLibrary"> + </return> + <description> + </description> + </method> + <method name="new" qualifiers="vararg"> + <return type="Object"> + </return> + <description> + </description> + </method> + <method name="set_class_name"> + <return type="void"> + </return> + <argument index="0" name="class_name" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_library"> + <return type="void"> + </return> + <argument index="0" name="library" type="GDNativeLibrary"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="class_name" type="String" setter="set_class_name" getter="get_class_name"> + </member> + <member name="library" type="GDNativeLibrary" setter="set_library" getter="get_library"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Navigation.xml b/doc/classes/Navigation.xml new file mode 100644 index 0000000000..3e063f6a82 --- /dev/null +++ b/doc/classes/Navigation.xml @@ -0,0 +1,111 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Navigation" inherits="Spatial" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_closest_point"> + <return type="Vector3"> + </return> + <argument index="0" name="to_point" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="get_closest_point_normal"> + <return type="Vector3"> + </return> + <argument index="0" name="to_point" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="get_closest_point_owner"> + <return type="Object"> + </return> + <argument index="0" name="to_point" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="get_closest_point_to_segment"> + <return type="Vector3"> + </return> + <argument index="0" name="start" type="Vector3"> + </argument> + <argument index="1" name="end" type="Vector3"> + </argument> + <argument index="2" name="use_collision" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="get_simple_path"> + <return type="PoolVector3Array"> + </return> + <argument index="0" name="start" type="Vector3"> + </argument> + <argument index="1" name="end" type="Vector3"> + </argument> + <argument index="2" name="optimize" type="bool" default="true"> + </argument> + <description> + </description> + </method> + <method name="get_up_vector" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="navmesh_create"> + <return type="int"> + </return> + <argument index="0" name="mesh" type="NavigationMesh"> + </argument> + <argument index="1" name="xform" type="Transform"> + </argument> + <argument index="2" name="owner" type="Object" default="null"> + </argument> + <description> + </description> + </method> + <method name="navmesh_remove"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="navmesh_set_transform"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="xform" type="Transform"> + </argument> + <description> + </description> + </method> + <method name="set_up_vector"> + <return type="void"> + </return> + <argument index="0" name="up" type="Vector3"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="up_vector" type="Vector3" setter="set_up_vector" getter="get_up_vector"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Navigation2D.xml b/doc/classes/Navigation2D.xml new file mode 100644 index 0000000000..ab10463a5d --- /dev/null +++ b/doc/classes/Navigation2D.xml @@ -0,0 +1,73 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Navigation2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_closest_point"> + <return type="Vector2"> + </return> + <argument index="0" name="to_point" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="get_closest_point_owner"> + <return type="Object"> + </return> + <argument index="0" name="to_point" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="get_simple_path"> + <return type="PoolVector2Array"> + </return> + <argument index="0" name="start" type="Vector2"> + </argument> + <argument index="1" name="end" type="Vector2"> + </argument> + <argument index="2" name="optimize" type="bool" default="true"> + </argument> + <description> + </description> + </method> + <method name="navpoly_create"> + <return type="int"> + </return> + <argument index="0" name="mesh" type="NavigationPolygon"> + </argument> + <argument index="1" name="xform" type="Transform2D"> + </argument> + <argument index="2" name="owner" type="Object" default="null"> + </argument> + <description> + </description> + </method> + <method name="navpoly_remove"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="navpoly_set_transform"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="xform" type="Transform2D"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/NavigationMesh.xml b/doc/classes/NavigationMesh.xml new file mode 100644 index 0000000000..788fadfd77 --- /dev/null +++ b/doc/classes/NavigationMesh.xml @@ -0,0 +1,349 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="NavigationMesh" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_polygon"> + <return type="void"> + </return> + <argument index="0" name="polygon" type="PoolIntArray"> + </argument> + <description> + </description> + </method> + <method name="clear_polygons"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="create_from_mesh"> + <return type="void"> + </return> + <argument index="0" name="mesh" type="Mesh"> + </argument> + <description> + </description> + </method> + <method name="get_agent_height" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_agent_max_climb" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_agent_max_slope" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_agent_radius"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_cell_height" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_cell_size" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_detail_sample_distance" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_detail_sample_max_error" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_edge_max_error" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_edge_max_length" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_filter_ledge_spans" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_filter_low_hanging_obstacles" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_filter_walkable_low_height_spans" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_polygon"> + <return type="PoolIntArray"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_polygon_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_region_merge_size" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_region_min_size" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_sample_partition_type" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_vertices" qualifiers="const"> + <return type="PoolVector3Array"> + </return> + <description> + </description> + </method> + <method name="get_verts_per_poly" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="set_agent_height"> + <return type="void"> + </return> + <argument index="0" name="agent_height" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_agent_max_climb"> + <return type="void"> + </return> + <argument index="0" name="agent_max_climb" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_agent_max_slope"> + <return type="void"> + </return> + <argument index="0" name="agent_max_slope" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_agent_radius"> + <return type="void"> + </return> + <argument index="0" name="agent_radius" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_cell_height"> + <return type="void"> + </return> + <argument index="0" name="cell_height" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_cell_size"> + <return type="void"> + </return> + <argument index="0" name="cell_size" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_detail_sample_distance"> + <return type="void"> + </return> + <argument index="0" name="detail_sample_dist" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_detail_sample_max_error"> + <return type="void"> + </return> + <argument index="0" name="detail_sample_max_error" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_edge_max_error"> + <return type="void"> + </return> + <argument index="0" name="edge_max_error" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_edge_max_length"> + <return type="void"> + </return> + <argument index="0" name="edge_max_length" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_filter_ledge_spans"> + <return type="void"> + </return> + <argument index="0" name="filter_ledge_spans" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_filter_low_hanging_obstacles"> + <return type="void"> + </return> + <argument index="0" name="filter_low_hanging_obstacles" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_filter_walkable_low_height_spans"> + <return type="void"> + </return> + <argument index="0" name="filter_walkable_low_height_spans" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_region_merge_size"> + <return type="void"> + </return> + <argument index="0" name="region_merge_size" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_region_min_size"> + <return type="void"> + </return> + <argument index="0" name="region_min_size" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_sample_partition_type"> + <return type="void"> + </return> + <argument index="0" name="sample_partition_type" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_vertices"> + <return type="void"> + </return> + <argument index="0" name="vertices" type="PoolVector3Array"> + </argument> + <description> + </description> + </method> + <method name="set_verts_per_poly"> + <return type="void"> + </return> + <argument index="0" name="verts_per_poly" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="agent/height" type="float" setter="set_agent_height" getter="get_agent_height"> + </member> + <member name="agent/max_climb" type="float" setter="set_agent_max_climb" getter="get_agent_max_climb"> + </member> + <member name="agent/max_slope" type="float" setter="set_agent_max_slope" getter="get_agent_max_slope"> + </member> + <member name="agent/radius" type="float" setter="set_agent_radius" getter="get_agent_radius"> + </member> + <member name="cell/height" type="float" setter="set_cell_height" getter="get_cell_height"> + </member> + <member name="cell/size" type="float" setter="set_cell_size" getter="get_cell_size"> + </member> + <member name="detail/sample_distance" type="float" setter="set_detail_sample_distance" getter="get_detail_sample_distance"> + </member> + <member name="detail/sample_max_error" type="float" setter="set_detail_sample_max_error" getter="get_detail_sample_max_error"> + </member> + <member name="edge/max_error" type="float" setter="set_edge_max_error" getter="get_edge_max_error"> + </member> + <member name="edge/max_length" type="float" setter="set_edge_max_length" getter="get_edge_max_length"> + </member> + <member name="filter/filter_walkable_low_height_spans" type="bool" setter="set_filter_walkable_low_height_spans" getter="get_filter_walkable_low_height_spans"> + </member> + <member name="filter/ledge_spans" type="bool" setter="set_filter_ledge_spans" getter="get_filter_ledge_spans"> + </member> + <member name="filter/low_hanging_obstacles" type="bool" setter="set_filter_low_hanging_obstacles" getter="get_filter_low_hanging_obstacles"> + </member> + <member name="polygon/verts_per_poly" type="float" setter="set_verts_per_poly" getter="get_verts_per_poly"> + </member> + <member name="polygons" type="Array" setter="_set_polygons" getter="_get_polygons"> + </member> + <member name="region/merge_size" type="float" setter="set_region_merge_size" getter="get_region_merge_size"> + </member> + <member name="region/min_size" type="float" setter="set_region_min_size" getter="get_region_min_size"> + </member> + <member name="sample_partition_type/sample_partition_type" type="int" setter="set_sample_partition_type" getter="get_sample_partition_type"> + </member> + <member name="vertices" type="PoolVector3Array" setter="set_vertices" getter="get_vertices"> + </member> + </members> + <constants> + <constant name="SAMPLE_PARTITION_WATERSHED" value="0" enum=""> + </constant> + <constant name="SAMPLE_PARTITION_MONOTONE" value="1" enum=""> + </constant> + <constant name="SAMPLE_PARTITION_LAYERS" value="2" enum=""> + </constant> + </constants> +</class> diff --git a/doc/classes/NavigationMeshInstance.xml b/doc/classes/NavigationMeshInstance.xml new file mode 100644 index 0000000000..6d3a81a939 --- /dev/null +++ b/doc/classes/NavigationMeshInstance.xml @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="NavigationMeshInstance" inherits="Spatial" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_navigation_mesh" qualifiers="const"> + <return type="NavigationMesh"> + </return> + <description> + </description> + </method> + <method name="is_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_enabled"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_navigation_mesh"> + <return type="void"> + </return> + <argument index="0" name="navmesh" type="NavigationMesh"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="enabled" type="bool" setter="set_enabled" getter="is_enabled"> + </member> + <member name="navmesh" type="NavigationMesh" setter="set_navigation_mesh" getter="get_navigation_mesh"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/NavigationPolygon.xml b/doc/classes/NavigationPolygon.xml new file mode 100644 index 0000000000..07eb4afb8d --- /dev/null +++ b/doc/classes/NavigationPolygon.xml @@ -0,0 +1,127 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="NavigationPolygon" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_outline"> + <return type="void"> + </return> + <argument index="0" name="outline" type="PoolVector2Array"> + </argument> + <description> + </description> + </method> + <method name="add_outline_at_index"> + <return type="void"> + </return> + <argument index="0" name="outline" type="PoolVector2Array"> + </argument> + <argument index="1" name="index" type="int"> + </argument> + <description> + </description> + </method> + <method name="add_polygon"> + <return type="void"> + </return> + <argument index="0" name="polygon" type="PoolIntArray"> + </argument> + <description> + </description> + </method> + <method name="clear_outlines"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="clear_polygons"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="get_outline" qualifiers="const"> + <return type="PoolVector2Array"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_outline_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_polygon"> + <return type="PoolIntArray"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_polygon_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_vertices" qualifiers="const"> + <return type="PoolVector2Array"> + </return> + <description> + </description> + </method> + <method name="make_polygons_from_outlines"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="remove_outline"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_outline"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="outline" type="PoolVector2Array"> + </argument> + <description> + </description> + </method> + <method name="set_vertices"> + <return type="void"> + </return> + <argument index="0" name="vertices" type="PoolVector2Array"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="outlines" type="Array" setter="_set_outlines" getter="_get_outlines"> + </member> + <member name="polygons" type="Array" setter="_set_polygons" getter="_get_polygons"> + </member> + <member name="vertices" type="PoolVector2Array" setter="set_vertices" getter="get_vertices"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/NavigationPolygonInstance.xml b/doc/classes/NavigationPolygonInstance.xml new file mode 100644 index 0000000000..a6d70d5b4b --- /dev/null +++ b/doc/classes/NavigationPolygonInstance.xml @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="NavigationPolygonInstance" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_navigation_polygon" qualifiers="const"> + <return type="NavigationPolygon"> + </return> + <description> + </description> + </method> + <method name="is_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_enabled"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_navigation_polygon"> + <return type="void"> + </return> + <argument index="0" name="navpoly" type="NavigationPolygon"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="enabled" type="bool" setter="set_enabled" getter="is_enabled"> + </member> + <member name="navpoly" type="NavigationPolygon" setter="set_navigation_polygon" getter="get_navigation_polygon"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/NetworkedMultiplayerENet.xml b/doc/classes/NetworkedMultiplayerENet.xml new file mode 100644 index 0000000000..02c919bd83 --- /dev/null +++ b/doc/classes/NetworkedMultiplayerENet.xml @@ -0,0 +1,85 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="NetworkedMultiplayerENet" inherits="NetworkedMultiplayerPeer" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + PacketPeer implementation using the ENet library. + </brief_description> + <description> + A connection (or a listening server) that should be passed to [method SceneTree.set_network_peer]. Socket events can be handled by connecting to [SceneTree] signals. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="close_connection"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="create_client"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="ip" type="String"> + </argument> + <argument index="1" name="port" type="int"> + </argument> + <argument index="2" name="in_bandwidth" type="int" default="0"> + </argument> + <argument index="3" name="out_bandwidth" type="int" default="0"> + </argument> + <description> + Create client that connects to a server at address [code]ip[/code] using specified [code]port[/code]. + </description> + </method> + <method name="create_server"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="port" type="int"> + </argument> + <argument index="1" name="max_clients" type="int" default="32"> + </argument> + <argument index="2" name="in_bandwidth" type="int" default="0"> + </argument> + <argument index="3" name="out_bandwidth" type="int" default="0"> + </argument> + <description> + Create server that listens to connections via [code]port[/code]. + </description> + </method> + <method name="get_compression_mode" qualifiers="const"> + <return type="int" enum="NetworkedMultiplayerENet.CompressionMode"> + </return> + <description> + </description> + </method> + <method name="set_bind_ip"> + <return type="void"> + </return> + <argument index="0" name="ip" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_compression_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="NetworkedMultiplayerENet.CompressionMode"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + <constant name="COMPRESS_NONE" value="0"> + </constant> + <constant name="COMPRESS_RANGE_CODER" value="1"> + </constant> + <constant name="COMPRESS_FASTLZ" value="2"> + </constant> + <constant name="COMPRESS_ZLIB" value="3"> + </constant> + <constant name="COMPRESS_ZSTD" value="4"> + </constant> + </constants> +</class> diff --git a/doc/classes/NetworkedMultiplayerPeer.xml b/doc/classes/NetworkedMultiplayerPeer.xml new file mode 100644 index 0000000000..c1d8c5ad91 --- /dev/null +++ b/doc/classes/NetworkedMultiplayerPeer.xml @@ -0,0 +1,118 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="NetworkedMultiplayerPeer" inherits="PacketPeer" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_connection_status" qualifiers="const"> + <return type="int" enum="NetworkedMultiplayerPeer.ConnectionStatus"> + </return> + <description> + </description> + </method> + <method name="get_packet_peer" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_unique_id" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="is_refusing_new_connections" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether this [NetworkedMultiplayerPeer] is refusing new connections. + </description> + </method> + <method name="poll"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="set_refuse_new_connections"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + If [code]endable[/code] is true, this [NetworkedMultiplayerPeer] will refuse new connections. + </description> + </method> + <method name="set_target_peer"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_transfer_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="NetworkedMultiplayerPeer.TransferMode"> + </argument> + <description> + </description> + </method> + </methods> + <signals> + <signal name="connection_failed"> + <description> + Emitted when failed to connect to server. + </description> + </signal> + <signal name="connection_succeeded"> + <description> + Emitted when successfully connected to server. + </description> + </signal> + <signal name="peer_connected"> + <argument index="0" name="id" type="int"> + </argument> + <description> + Emitted by the server when a client is connected. + </description> + </signal> + <signal name="peer_disconnected"> + <argument index="0" name="id" type="int"> + </argument> + <description> + Emitted by the server when a client is disconnected. + </description> + </signal> + <signal name="server_disconnected"> + <description> + Emitted by clients when server is disconnected. + </description> + </signal> + </signals> + <constants> + <constant name="TRANSFER_MODE_UNRELIABLE" value="0"> + </constant> + <constant name="TRANSFER_MODE_UNRELIABLE_ORDERED" value="1"> + </constant> + <constant name="TRANSFER_MODE_RELIABLE" value="2"> + </constant> + <constant name="CONNECTION_DISCONNECTED" value="0"> + </constant> + <constant name="CONNECTION_CONNECTING" value="1"> + </constant> + <constant name="CONNECTION_CONNECTED" value="2"> + </constant> + <constant name="TARGET_PEER_BROADCAST" value="0" enum=""> + </constant> + <constant name="TARGET_PEER_SERVER" value="1" enum=""> + </constant> + </constants> +</class> diff --git a/doc/classes/Nil.xml b/doc/classes/Nil.xml new file mode 100644 index 0000000000..de12ad1261 --- /dev/null +++ b/doc/classes/Nil.xml @@ -0,0 +1,171 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Nil" category="Built-In Types" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="Nil"> + <argument index="0" name="from" type="PoolColorArray"> + </argument> + <description> + </description> + </method> + <method name="Nil"> + <argument index="0" name="from" type="PoolVector3Array"> + </argument> + <description> + </description> + </method> + <method name="Nil"> + <argument index="0" name="from" type="PoolVector2Array"> + </argument> + <description> + </description> + </method> + <method name="Nil"> + <argument index="0" name="from" type="PoolStringArray"> + </argument> + <description> + </description> + </method> + <method name="Nil"> + <argument index="0" name="from" type="PoolRealArray"> + </argument> + <description> + </description> + </method> + <method name="Nil"> + <argument index="0" name="from" type="PoolIntArray"> + </argument> + <description> + </description> + </method> + <method name="Nil"> + <argument index="0" name="from" type="PoolByteArray"> + </argument> + <description> + </description> + </method> + <method name="Nil"> + <argument index="0" name="from" type="Array"> + </argument> + <description> + </description> + </method> + <method name="Nil"> + <argument index="0" name="from" type="Dictionary"> + </argument> + <description> + </description> + </method> + <method name="Nil"> + <argument index="0" name="from" type="Object"> + </argument> + <description> + </description> + </method> + <method name="Nil"> + <argument index="0" name="from" type="RID"> + </argument> + <description> + </description> + </method> + <method name="Nil"> + <argument index="0" name="from" type="NodePath"> + </argument> + <description> + </description> + </method> + <method name="Nil"> + <argument index="0" name="from" type="Color"> + </argument> + <description> + </description> + </method> + <method name="Nil"> + <argument index="0" name="from" type="Transform"> + </argument> + <description> + </description> + </method> + <method name="Nil"> + <argument index="0" name="from" type="Basis"> + </argument> + <description> + </description> + </method> + <method name="Nil"> + <argument index="0" name="from" type="Rect3"> + </argument> + <description> + </description> + </method> + <method name="Nil"> + <argument index="0" name="from" type="Quat"> + </argument> + <description> + </description> + </method> + <method name="Nil"> + <argument index="0" name="from" type="Plane"> + </argument> + <description> + </description> + </method> + <method name="Nil"> + <argument index="0" name="from" type="Transform2D"> + </argument> + <description> + </description> + </method> + <method name="Nil"> + <argument index="0" name="from" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="Nil"> + <argument index="0" name="from" type="Rect2"> + </argument> + <description> + </description> + </method> + <method name="Nil"> + <argument index="0" name="from" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="Nil"> + <argument index="0" name="from" type="String"> + </argument> + <description> + </description> + </method> + <method name="Nil"> + <argument index="0" name="from" type="float"> + </argument> + <description> + </description> + </method> + <method name="Nil"> + <argument index="0" name="from" type="int"> + </argument> + <description> + </description> + </method> + <method name="Nil"> + <argument index="0" name="from" type="bool"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/NinePatchRect.xml b/doc/classes/NinePatchRect.xml new file mode 100644 index 0000000000..6829b36e14 --- /dev/null +++ b/doc/classes/NinePatchRect.xml @@ -0,0 +1,150 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="NinePatchRect" inherits="Control" category="Core" version="3.0.alpha.custom_build"> + <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. + </brief_description> + <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. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_h_axis_stretch_mode" qualifiers="const"> + <return type="int" enum="NinePatchRect.AxisStretchMode"> + </return> + <description> + </description> + </method> + <method name="get_patch_margin" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <description> + </description> + </method> + <method name="get_region_rect" qualifiers="const"> + <return type="Rect2"> + </return> + <description> + </description> + </method> + <method name="get_texture" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="get_v_axis_stretch_mode" qualifiers="const"> + <return type="int" enum="NinePatchRect.AxisStretchMode"> + </return> + <description> + </description> + </method> + <method name="is_draw_center_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_draw_center"> + <return type="void"> + </return> + <argument index="0" name="draw_center" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_h_axis_stretch_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="NinePatchRect.AxisStretchMode"> + </argument> + <description> + </description> + </method> + <method name="set_patch_margin"> + <return type="void"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <argument index="1" name="value" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_region_rect"> + <return type="void"> + </return> + <argument index="0" name="rect" type="Rect2"> + </argument> + <description> + </description> + </method> + <method name="set_texture"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_v_axis_stretch_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="NinePatchRect.AxisStretchMode"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="axis_stretch_horizontal" type="int" setter="set_h_axis_stretch_mode" getter="get_h_axis_stretch_mode" enum="NinePatchRect.AxisStretchMode"> + Doesn't do anything at the time of writing. + </member> + <member name="axis_stretch_vertical" type="int" setter="set_v_axis_stretch_mode" getter="get_v_axis_stretch_mode" enum="NinePatchRect.AxisStretchMode"> + Doesn't do anything at the time of writing. + </member> + <member name="draw_center" type="bool" setter="set_draw_center" getter="is_draw_center_enabled"> + If [code]true[/code], draw the panel's center. Else, only draw the 9-slice's borders. Default value: [code]true[/code] + </member> + <member name="patch_margin_bottom" type="int" setter="set_patch_margin" getter="get_patch_margin"> + 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. + </member> + <member name="patch_margin_left" type="int" setter="set_patch_margin" getter="get_patch_margin"> + The height of the 9-slice's left column. + </member> + <member name="patch_margin_right" type="int" setter="set_patch_margin" getter="get_patch_margin"> + The height of the 9-slice's right column. + </member> + <member name="patch_margin_top" type="int" setter="set_patch_margin" getter="get_patch_margin"> + The height of the 9-slice's top row. + </member> + <member name="region_rect" type="Rect2" setter="set_region_rect" getter="get_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. + </member> + <member name="texture" type="Texture" setter="set_texture" getter="get_texture"> + The node's texture resource. + </member> + </members> + <signals> + <signal name="texture_changed"> + <description> + Fired when the node's texture changes. + </description> + </signal> + </signals> + <constants> + <constant name="AXIS_STRETCH_MODE_STRETCH" value="0"> + Doesn't do anything at the time of writing. Default value for [code]axis_stretch_horizontal[/code] and [code]axis_stretch_vertical[/code]. + </constant> + <constant name="AXIS_STRETCH_MODE_TILE" value="1"> + Doesn't do anything at the time of writing. + </constant> + <constant name="AXIS_STRETCH_MODE_TILE_FIT" value="2"> + Doesn't do anything at the time of writing. + </constant> + </constants> +</class> diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml new file mode 100644 index 0000000000..5a99263f1e --- /dev/null +++ b/doc/classes/Node.xml @@ -0,0 +1,870 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Node" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base class for all the [i]scene[/i] elements. + </brief_description> + <description> + Nodes are the base bricks with which Godot games are developed. They can be set as children of other nodes, resulting in a tree arrangement. A given node can contain any number of nodes as children (but there is only one scene tree root node) with the requirement that all siblings (direct children of a node) should have unique names. + Any tree of nodes is called a [i]scene[/i]. Scenes can be saved to the disk and then instanced into other scenes. This allows for very high flexibility in the architecture and data model of the projects. Nodes can optionally be added to groups. This makes it easy to reach a number of nodes from the code (for example an "enemies" group) to perform grouped actions. + [b]Scene tree:[/b] The [SceneTree] contains the active tree of nodes. When a node is added to the scene tree, it receives the NOTIFICATION_ENTER_TREE notification and its [method _enter_tree] callback is triggered. Children nodes are always added [i]after[/i] their parent node, i.e. the [method _enter_tree] callback of a parent node will be triggered before its child's. + Once all nodes have been added in the scene tree, they receive the NOTIFICATION_READY notification and their respective [method _ready] callbacks are triggered. For groups of nodes, the [method _ready] callback is called in reverse order, from the children up to the parent nodes. + It means that when adding a scene to the scene tree, the following order will be used for the callbacks: [method _enter_tree] of the parent, [method _enter_tree] of the children, [method _ready] of the children and finally [method _ready] of the parent (and that recursively for the whole scene). + [b]Processing:[/b] Nodes can be set to the "process" state, so that they receive a callback on each frame requesting them to process (do something). Normal processing (callback [method _process], toggled with [method set_process]) happens as fast as possible and is dependent on the frame rate, so the processing time [i]delta[/i] is variable. Fixed processing (callback [method _fixed_process], toggled with [method set_fixed_process]) happens a fixed amount of times per second (by default 60) and is useful to link itself to the physics. + Nodes can also process input events. When set, the [method _input] function will be called for each input that the program receives. In many cases, this can be overkill (unless used for simple projects), and the [method _unhandled_input] function might be preferred; it is called when the input event was not handled by anyone else (typically, GUI [Control] nodes), ensuring that the node only receives the events that were meant for it. + To keep track of the scene hierarchy (especially when instancing scenes into other scenes), an "owner" can be set for the node with [method set_owner]. This keeps track of who instanced what. This is mostly useful when writing editors and tools, though. + Finally, when a node is freed with [method free] or [method queue_free], it will also free all its children. + [b]Networking with nodes:[/b] After connecting to a server (or making one, see [NetworkedMultiplayerENet]) it is possible to use the built-in RPC (remote procedure call) system to easily communicate over the network. By calling [method rpc] with a method name, it will be called locally, and in all connected peers (peers = clients and the server that accepts connections), with behaviour varying depending on the network mode ([method set_network_mode]) on the receiving peer. To identify which [Node] receives the RPC call Godot will use its [NodePath] (make sure node names are the same on all peers). + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="_enter_tree" qualifiers="virtual"> + <return type="void"> + </return> + <description> + Called when the node enters the [SceneTree] (e.g. upon instancing, scene changing or after calling [method add_child] in a script). If the node has children, its [method _enter_tree] callback will be called first, and then that of the children. + Corresponds to the NOTIFICATION_ENTER_TREE notification in [method Object._notification]. + </description> + </method> + <method name="_exit_tree" qualifiers="virtual"> + <return type="void"> + </return> + <description> + Called when the node leaves the [SceneTree] (e.g. upon freeing, scene changing or after calling [method remove_child] in a script). If the node has children, its [method _exit_tree] callback will be called last, after all its children have left the tree. + Corresponds to the NOTIFICATION_EXIT_TREE notification in [method Object._notification]. + </description> + </method> + <method name="_fixed_process" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="delta" type="float"> + </argument> + <description> + Called during the fixed processing step of the main loop. Fixed processing means that the frame rate is synced to the physics, i.e. the [code]delta[/code] variable should be constant. + It is only called if fixed processing has been enabled with [method set_fixed_process]. + Corresponds to the NOTIFICATION_FIXED_PROCESS notification in [method Object._notification]. + </description> + </method> + <method name="_input" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="event" type="InputEvent"> + </argument> + <description> + Called when there is a change to input devices. Propagated through the node tree until a Node consumes it. + </description> + </method> + <method name="_process" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="delta" type="float"> + </argument> + <description> + Called during the processing step of the main loop. Processing happens at every frame and as fast as possible, so the [code]delta[/code] time since the previous frame is not constant. + It is only called if processing has been enabled with [method set_process]. + Corresponds to the NOTIFICATION_PROCESS notification in [method Object._notification]. + </description> + </method> + <method name="_ready" qualifiers="virtual"> + <return type="void"> + </return> + <description> + Called when the node is "ready", i.e. when both the node and its children have entered the scene tree. If the node has children, their [method _ready] callback gets triggered first, and the node will receive the ready notification only afterwards. + Corresponds to the NOTIFICATION_READY notification in [method Object._notification]. + </description> + </method> + <method name="_unhandled_input" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="event" type="InputEvent"> + </argument> + <description> + Propagated to all nodes when the previous InputEvent is not consumed by any nodes. + </description> + </method> + <method name="_unhandled_key_input" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="event" type="InputEventKey"> + </argument> + <description> + </description> + </method> + <method name="add_child"> + <return type="void"> + </return> + <argument index="0" name="node" type="Node"> + </argument> + <argument index="1" name="legible_unique_name" type="bool" default="false"> + </argument> + <description> + Add a child [Node]. Nodes can have as many children as they want, but every child must have a unique name. Children nodes are automatically deleted when the parent node is deleted, so deleting a whole scene is performed by deleting its topmost node. + 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. + </description> + </method> + <method name="add_child_below_node"> + <return type="void"> + </return> + <argument index="0" name="node" type="Node"> + </argument> + <argument index="1" name="child_node" type="Node"> + </argument> + <argument index="2" name="legible_unique_name" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="add_to_group"> + <return type="void"> + </return> + <argument index="0" name="group" type="String"> + </argument> + <argument index="1" name="persistent" type="bool" default="false"> + </argument> + <description> + Add a node to a group. Groups are helpers to name and organize a subset of nodes, like for example "enemies" or "collectables". A [Node] can be in any number of groups. Nodes can be assigned a group at any time, but will not be added to it until they are inside the scene tree (see [method is_inside_tree]). + </description> + </method> + <method name="can_process" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if the node can process, i.e. whether its pause mode allows processing while the scene tree is paused (see [method set_pause_mode]). Always returns true if the scene tree is not paused, and false if the node is not in the tree. FIXME: Why FAIL_COND? + </description> + </method> + <method name="duplicate" qualifiers="const"> + <return type="Node"> + </return> + <argument index="0" name="flags" type="int" default="15"> + </argument> + <description> + Duplicate the node, returning a new [Node]. + You can fine-tune the behavior using the [code]flags[/code], which are based on the DUPLICATE_* constants. + </description> + </method> + <method name="find_node" qualifiers="const"> + <return type="Node"> + </return> + <argument index="0" name="mask" type="String"> + </argument> + <argument index="1" name="recursive" type="bool" default="true"> + </argument> + <argument index="2" name="owned" type="bool" default="true"> + </argument> + <description> + Find a descendant of this node whose name matches [code]mask[/code] as in [method String.match] (i.e. case sensitive, but '*' matches zero or more characters and '?' matches any single character except '.'). Note that it does not match against the full path, just against individual node names. + </description> + </method> + <method name="get_child" qualifiers="const"> + <return type="Node"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return a child node by its index (see [method get_child_count]). This method is often used for iterating all children of a node. + </description> + </method> + <method name="get_child_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the amount of child nodes. + </description> + </method> + <method name="get_children" qualifiers="const"> + <return type="Array"> + </return> + <description> + Return an array of references ([Node]) to the child nodes. + </description> + </method> + <method name="get_filename" qualifiers="const"> + <return type="String"> + </return> + <description> + Return a filename that may be contained by the node. When a scene is instanced from a file, it topmost node contains the filename from where it was loaded (see [method set_filename]). + </description> + </method> + <method name="get_fixed_process_delta_time" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the time elapsed since the last fixed frame (see [method _fixed_process]). This is always the same in fixed processing unless the frames per second is changed in [OS]. + </description> + </method> + <method name="get_groups" qualifiers="const"> + <return type="Array"> + </return> + <description> + Return an array listing the groups that the node is part of. + </description> + </method> + <method name="get_index" qualifiers="const"> + <return type="int"> + </return> + <description> + Get the node index, i.e. its position among the siblings of its parent. + </description> + </method> + <method name="get_name" qualifiers="const"> + <return type="String"> + </return> + <description> + Return the name of the node. This name is unique among the siblings (other child nodes from the same parent). + </description> + </method> + <method name="get_network_master" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_node" qualifiers="const"> + <return type="Node"> + </return> + <argument index="0" name="path" type="NodePath"> + </argument> + <description> + Fetch a node. The [NodePath] must be valid (or else an error will be raised) and can be either the path to child node, a relative path (from the current node to another node), or an absolute path to a node. + Note: fetching absolute paths only works when the node is inside the scene tree (see [method is_inside_tree]). + [i]Example:[/i] Assume your current node is Character and the following tree: + [codeblock] + /root + /root/Character + /root/Character/Sword + /root/Character/Backpack/Dagger + /root/MyGame + /root/Swamp/Alligator + /root/Swamp/Mosquito + /root/Swamp/Goblin + [/codeblock] + Possible paths are: + [codeblock] + get_node("Sword") + get_node("Backpack/Dagger") + get_node("../Swamp/Alligator") + get_node("/root/MyGame") + [/codeblock] + </description> + </method> + <method name="get_node_and_resource"> + <return type="Array"> + </return> + <argument index="0" name="path" type="NodePath"> + </argument> + <description> + </description> + </method> + <method name="get_owner" qualifiers="const"> + <return type="Node"> + </return> + <description> + Get the node owner (see [method set_owner]). + </description> + </method> + <method name="get_parent" qualifiers="const"> + <return type="Node"> + </return> + <description> + Return the parent node of the current node, or an empty [Node] if the node lacks a parent. + </description> + </method> + <method name="get_path" qualifiers="const"> + <return type="NodePath"> + </return> + <description> + Return the absolute path of the current node. This only works if the current node is inside the scene tree (see [method is_inside_tree]). + </description> + </method> + <method name="get_path_to" qualifiers="const"> + <return type="NodePath"> + </return> + <argument index="0" name="node" type="Node"> + </argument> + <description> + Return the relative path from the current node to the specified node in "node" argument. Both nodes must be in the same scene, or else the function will fail. + </description> + </method> + <method name="get_pause_mode" qualifiers="const"> + <return type="int" enum="Node.PauseMode"> + </return> + <description> + Return the pause mode (PAUSE_MODE_*) of this Node. + </description> + </method> + <method name="get_position_in_parent" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the order in the node tree branch, i.e. if called by the first child Node, return 0. + </description> + </method> + <method name="get_process_delta_time" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the time elapsed (in seconds) since the last process callback. This is almost always different each time. + </description> + </method> + <method name="get_scene_instance_load_placeholder" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_tree" qualifiers="const"> + <return type="SceneTree"> + </return> + <description> + Return a [SceneTree] that this node is inside. + </description> + </method> + <method name="get_viewport" qualifiers="const"> + <return type="Viewport"> + </return> + <description> + </description> + </method> + <method name="has_node" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="path" type="NodePath"> + </argument> + <description> + Return whether the node that a given [NodePath] points too exists. + </description> + </method> + <method name="has_node_and_resource" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="path" type="NodePath"> + </argument> + <description> + </description> + </method> + <method name="is_a_parent_of" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="node" type="Node"> + </argument> + <description> + Return [i]true[/i] if the "node" argument is a direct or indirect child of the current node, otherwise return [i]false[/i]. + </description> + </method> + <method name="is_displayed_folded" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_fixed_processing" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if fixed processing is enabled (see [method set_fixed_process]). + </description> + </method> + <method name="is_fixed_processing_internal" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_greater_than" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="node" type="Node"> + </argument> + <description> + Return [i]true[/i] if "node" occurs later in the scene hierarchy than the current node, otherwise return [i]false[/i]. + </description> + </method> + <method name="is_in_group" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="group" type="String"> + </argument> + <description> + Return whether this Node is in the specified group. + </description> + </method> + <method name="is_inside_tree" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether this Node is inside a [SceneTree]. + </description> + </method> + <method name="is_network_master" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_processing" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether processing is enabled in the current node (see [method set_process]). + </description> + </method> + <method name="is_processing_input" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if the node is processing input (see [method set_process_input]). + </description> + </method> + <method name="is_processing_internal" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_processing_unhandled_input" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if the node is processing unhandled input (see [method set_process_unhandled_input]). + </description> + </method> + <method name="is_processing_unhandled_key_input" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="move_child"> + <return type="void"> + </return> + <argument index="0" name="child_node" type="Node"> + </argument> + <argument index="1" name="to_pos" type="int"> + </argument> + <description> + 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. + </description> + </method> + <method name="print_stray_nodes"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="print_tree"> + <return type="void"> + </return> + <description> + Print the scene to stdout. Used mainly for debugging purposes. + </description> + </method> + <method name="propagate_call"> + <return type="void"> + </return> + <argument index="0" name="method" type="String"> + </argument> + <argument index="1" name="args" type="Array" default="[ ]"> + </argument> + <argument index="2" name="parent_first" type="bool" default="false"> + </argument> + <description> + Calls the method (if present) with the arguments given in "args" on this Node and recursively on all children. If the parent_first argument is true then the method will be called on the current [Node] first, then on all children. If it is false then the children will get called first. + </description> + </method> + <method name="propagate_notification"> + <return type="void"> + </return> + <argument index="0" name="what" type="int"> + </argument> + <description> + Notify the current node and all its children recursively by calling notification() in all of them. + </description> + </method> + <method name="queue_free"> + <return type="void"> + </return> + <description> + 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 [method Object.free]. Use [method Object.is_queued_for_deletion] to know whether a node will be deleted at the end of the frame. + </description> + </method> + <method name="raise"> + <return type="void"> + </return> + <description> + Move this node to the top of the array of nodes of the parent node. This is often useful on GUIs ([Control]), because their order of drawing fully depends on their order in the tree. + </description> + </method> + <method name="remove_and_skip"> + <return type="void"> + </return> + <description> + Remove a node and set all its children as children of the parent node (if exists). All even subscriptions that pass by the removed node will be unsubscribed. + </description> + </method> + <method name="remove_child"> + <return type="void"> + </return> + <argument index="0" name="node" type="Node"> + </argument> + <description> + Remove a child [Node]. Node is NOT deleted and will have to be deleted manually. + </description> + </method> + <method name="remove_from_group"> + <return type="void"> + </return> + <argument index="0" name="group" type="String"> + </argument> + <description> + Remove a node from a group. + </description> + </method> + <method name="replace_by"> + <return type="void"> + </return> + <argument index="0" name="node" type="Node"> + </argument> + <argument index="1" name="keep_data" type="bool" default="false"> + </argument> + <description> + Replace a node in a scene by a given one. Subscriptions that pass through this node will be lost. + </description> + </method> + <method name="request_ready"> + <return type="void"> + </return> + <description> + Request that [code]_ready[/code] be called again. + </description> + </method> + <method name="rpc" qualifiers="vararg"> + <return type="Variant"> + </return> + <argument index="0" name="method" type="String"> + </argument> + <description> + Send a remote procedure call request to all peers on the network (and locally), optionally sending additional data as arguments. Call request will be received by nodes with the same [NodePath]. + </description> + </method> + <method name="rpc_config"> + <return type="void"> + </return> + <argument index="0" name="method" type="String"> + </argument> + <argument index="1" name="mode" type="int" enum="Node.RPCMode"> + </argument> + <description> + Change the method's RPC mode (one of RPC_MODE_* constants). + </description> + </method> + <method name="rpc_id" qualifiers="vararg"> + <return type="Variant"> + </return> + <argument index="0" name="peer_id" type="int"> + </argument> + <argument index="1" name="method" type="String"> + </argument> + <description> + Send a [method rpc] to a specific peer identified by [i]peer_id[/i]. + </description> + </method> + <method name="rpc_unreliable" qualifiers="vararg"> + <return type="Variant"> + </return> + <argument index="0" name="method" type="String"> + </argument> + <description> + Send a [method rpc] using an unreliable protocol. + </description> + </method> + <method name="rpc_unreliable_id" qualifiers="vararg"> + <return type="Variant"> + </return> + <argument index="0" name="peer_id" type="int"> + </argument> + <argument index="1" name="method" type="String"> + </argument> + <description> + Send a [method rpc] to a specific peer identified by [i]peer_id[/i] using an unreliable protocol. + </description> + </method> + <method name="rset"> + <return type="void"> + </return> + <argument index="0" name="property" type="String"> + </argument> + <argument index="1" name="value" type="Variant"> + </argument> + <description> + Remotely change property's value on other peers (and locally). + </description> + </method> + <method name="rset_config"> + <return type="void"> + </return> + <argument index="0" name="property" type="String"> + </argument> + <argument index="1" name="mode" type="int" enum="Node.RPCMode"> + </argument> + <description> + Change the property's RPC mode (one of RPC_MODE_* constants). + </description> + </method> + <method name="rset_id"> + <return type="void"> + </return> + <argument index="0" name="peer_id" type="int"> + </argument> + <argument index="1" name="property" type="String"> + </argument> + <argument index="2" name="value" type="Variant"> + </argument> + <description> + Remotely change property's value on a specific peer identified by [i]peer_id[/i]. + </description> + </method> + <method name="rset_unreliable"> + <return type="void"> + </return> + <argument index="0" name="property" type="String"> + </argument> + <argument index="1" name="value" type="Variant"> + </argument> + <description> + Remotely change property's value on other peers (and locally) using an unreliable protocol. + </description> + </method> + <method name="rset_unreliable_id"> + <return type="void"> + </return> + <argument index="0" name="peer_id" type="int"> + </argument> + <argument index="1" name="property" type="String"> + </argument> + <argument index="2" name="value" type="Variant"> + </argument> + <description> + Remotely change property's value on a specific peer identified by [i]peer_id[/i] using an unreliable protocol. + </description> + </method> + <method name="set_display_folded"> + <return type="void"> + </return> + <argument index="0" name="fold" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_filename"> + <return type="void"> + </return> + <argument index="0" name="filename" type="String"> + </argument> + <description> + A node can contain a filename. This filename should not be changed by the user, unless writing editors and tools. When a scene is instanced from a file, it topmost node contains the filename from where it was loaded. + </description> + </method> + <method name="set_fixed_process"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Enables or disables node fixed framerate processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS at a fixed (usually 60 fps, check [OS] to change that) interval (and the [method _fixed_process] callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling [method get_fixed_process_delta_time]. + </description> + </method> + <method name="set_fixed_process_internal"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_name"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Set the name of the [Node]. Name must be unique within parent, and setting an already existing name will cause for the node to be automatically renamed. + </description> + </method> + <method name="set_network_master"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="recursive" type="bool" default="true"> + </argument> + <description> + </description> + </method> + <method name="set_owner"> + <return type="void"> + </return> + <argument index="0" name="owner" type="Node"> + </argument> + <description> + Set the node owner. A node can have any other node as owner (as long as a valid parent, grandparent, etc ascending in the tree). When saving a node (using SceneSaver) all the nodes it owns will be saved with it. This allows to create complex SceneTrees, with instancing and subinstancing. + </description> + </method> + <method name="set_pause_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="Node.PauseMode"> + </argument> + <description> + Set pause mode (PAUSE_MODE_*) of this Node. + </description> + </method> + <method name="set_process"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Enables or disables node processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS on every drawn frame (and the [method _process] callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling [method get_process_delta_time]. + </description> + </method> + <method name="set_process_input"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Enable input processing for node. This is not required for GUI controls! It hooks up the node to receive all input (see [method _input]). + </description> + </method> + <method name="set_process_internal"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_process_unhandled_input"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Enable unhandled input processing for node. This is not required for GUI controls! It hooks up the node to receive all input that was not previously handled before (usually by a [Control]). (see [method _unhandled_input]). + </description> + </method> + <method name="set_process_unhandled_key_input"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_scene_instance_load_placeholder"> + <return type="void"> + </return> + <argument index="0" name="load_placeholder" type="bool"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="_import_path" type="NodePath" setter="_set_import_path" getter="_get_import_path"> + </member> + <member name="editor/display_folded" type="bool" setter="set_display_folded" getter="is_displayed_folded"> + </member> + <member name="pause_mode" type="int" setter="set_pause_mode" getter="get_pause_mode" enum="Node.PauseMode"> + </member> + </members> + <signals> + <signal name="renamed"> + <description> + Emitted when the node is renamed. + </description> + </signal> + <signal name="tree_entered"> + <description> + Emitted when Node enters the tree. + </description> + </signal> + <signal name="tree_exited"> + <description> + Emitted when Node exits the tree. + </description> + </signal> + </signals> + <constants> + <constant name="NOTIFICATION_ENTER_TREE" value="10" enum=""> + </constant> + <constant name="NOTIFICATION_EXIT_TREE" value="11" enum=""> + </constant> + <constant name="NOTIFICATION_MOVED_IN_PARENT" value="12" enum=""> + </constant> + <constant name="NOTIFICATION_READY" value="13" enum=""> + </constant> + <constant name="NOTIFICATION_FIXED_PROCESS" value="16" enum=""> + </constant> + <constant name="NOTIFICATION_PROCESS" value="17" enum=""> + Notification received every frame when the process flag is set (see [method set_process]). + </constant> + <constant name="NOTIFICATION_PARENTED" value="18" enum=""> + Notification received when a node is set as a child of another node. Note that this doesn't mean that a node entered the Scene Tree. + </constant> + <constant name="NOTIFICATION_UNPARENTED" value="19" enum=""> + Notification received when a node is unparented (parent removed it from the list of children). + </constant> + <constant name="NOTIFICATION_PAUSED" value="14" enum=""> + </constant> + <constant name="NOTIFICATION_UNPAUSED" value="15" enum=""> + </constant> + <constant name="NOTIFICATION_INSTANCED" value="20" enum=""> + </constant> + <constant name="NOTIFICATION_DRAG_BEGIN" value="21" enum=""> + </constant> + <constant name="NOTIFICATION_DRAG_END" value="22" enum=""> + </constant> + <constant name="NOTIFICATION_PATH_CHANGED" value="23" enum=""> + </constant> + <constant name="NOTIFICATION_TRANSLATION_CHANGED" value="24" enum=""> + </constant> + <constant name="NOTIFICATION_INTERNAL_PROCESS" value="25" enum=""> + </constant> + <constant name="NOTIFICATION_INTERNAL_FIXED_PROCESS" value="26" enum=""> + </constant> + <constant name="RPC_MODE_DISABLED" value="0"> + </constant> + <constant name="RPC_MODE_REMOTE" value="1"> + Call a method remotely. + </constant> + <constant name="RPC_MODE_SYNC" value="2"> + Call a method both remotely and locally. + </constant> + <constant name="RPC_MODE_MASTER" value="3"> + Call a method if the Node is Master. + </constant> + <constant name="RPC_MODE_SLAVE" value="4"> + Call a method if the Node is Slave. + </constant> + <constant name="PAUSE_MODE_INHERIT" value="0"> + Inherits pause mode from parent. For root node, it is equivalent to PAUSE_MODE_STOP. + </constant> + <constant name="PAUSE_MODE_STOP" value="1"> + Stop processing when SceneTree is paused. + </constant> + <constant name="PAUSE_MODE_PROCESS" value="2"> + Continue to process regardless of SceneTree pause state. + </constant> + <constant name="DUPLICATE_SIGNALS" value="1"> + </constant> + <constant name="DUPLICATE_GROUPS" value="2"> + </constant> + <constant name="DUPLICATE_SCRIPTS" value="4"> + </constant> + <constant name="DUPLICATE_USE_INSTANCING" value="8"> + </constant> + </constants> +</class> diff --git a/doc/classes/Node2D.xml b/doc/classes/Node2D.xml new file mode 100644 index 0000000000..2ba312b301 --- /dev/null +++ b/doc/classes/Node2D.xml @@ -0,0 +1,343 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Node2D" inherits="CanvasItem" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + A 2D game object, parent of all 2D related nodes. Has a position, rotation, scale and Z-index. + </brief_description> + <description> + 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. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="apply_scale"> + <return type="void"> + </return> + <argument index="0" name="ratio" type="Vector2"> + </argument> + <description> + Multiplies the current scale by the 'ratio' vector. + </description> + </method> + <method name="edit_set_pivot"> + <return type="void"> + </return> + <argument index="0" name="pivot" type="Vector2"> + </argument> + <description> + Set the pivot position of the 2D node to 'pivot' value. Only some Node2Ds implement this method. + </description> + </method> + <method name="get_angle_to" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="point" type="Vector2"> + </argument> + <description> + Returns the angle between the node and the 'point' in radians. + </description> + </method> + <method name="get_global_position" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Returns the node's global position. + </description> + </method> + <method name="get_global_rotation" qualifiers="const"> + <return type="float"> + </return> + <description> + Returns the node's global rotation in radians. + </description> + </method> + <method name="get_global_rotation_in_degrees" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the node's global rotation in degrees. + </description> + </method> + <method name="get_global_scale" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Returns the node's global scale. + </description> + </method> + <method name="get_position" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Returns the node's position. + </description> + </method> + <method name="get_relative_transform_to_parent" qualifiers="const"> + <return type="Transform2D"> + </return> + <argument index="0" name="parent" type="Node"> + </argument> + <description> + Returns the [Transform2D] relative to this node's parent. + </description> + </method> + <method name="get_rotation" qualifiers="const"> + <return type="float"> + </return> + <description> + Returns the node's rotation in radians. + </description> + </method> + <method name="get_rotation_in_degrees" qualifiers="const"> + <return type="float"> + </return> + <description> + Returns the node's rotation in degrees. + </description> + </method> + <method name="get_scale" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Returns the node's scale. + </description> + </method> + <method name="get_z" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the node's Z-index. + </description> + </method> + <method name="global_translate"> + <return type="void"> + </return> + <argument index="0" name="offset" type="Vector2"> + </argument> + <description> + Adds the 'offset' vector to the node's global position. + </description> + </method> + <method name="is_z_relative" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns true if this node's Z-index is relative to its parent's. Else, returns false. + </description> + </method> + <method name="look_at"> + <return type="void"> + </return> + <argument index="0" name="point" type="Vector2"> + </argument> + <description> + Rotates the node so it points towards the 'point'. + </description> + </method> + <method name="move_local_x"> + <return type="void"> + </return> + <argument index="0" name="delta" type="float"> + </argument> + <argument index="1" name="scaled" type="bool" default="false"> + </argument> + <description> + Apply a local translation on the node's X axis based on the process's 'delta'. If 'scaled' is false, normalizes the movement. + </description> + </method> + <method name="move_local_y"> + <return type="void"> + </return> + <argument index="0" name="delta" type="float"> + </argument> + <argument index="1" name="scaled" type="bool" default="false"> + </argument> + <description> + Apply a local translation on the node's Y axis based on the process's 'delta'. If 'scaled' is false, normalizes the movement. + </description> + </method> + <method name="rotate"> + <return type="void"> + </return> + <argument index="0" name="radians" type="float"> + </argument> + <description> + Apply a rotation to the node, in radians, starting from its current rotation. + </description> + </method> + <method name="set_global_position"> + <return type="void"> + </return> + <argument index="0" name="pos" type="Vector2"> + </argument> + <description> + Set the node's global position. + </description> + </method> + <method name="set_global_rotation"> + <return type="void"> + </return> + <argument index="0" name="radians" type="float"> + </argument> + <description> + Set the node's global rotation in radians. + </description> + </method> + <method name="set_global_rotation_in_degrees"> + <return type="void"> + </return> + <argument index="0" name="degrees" type="float"> + </argument> + <description> + Set the node's global rotation in degrees. + </description> + </method> + <method name="set_global_scale"> + <return type="void"> + </return> + <argument index="0" name="scale" type="Vector2"> + </argument> + <description> + Set the node's global scale. + </description> + </method> + <method name="set_global_transform"> + <return type="void"> + </return> + <argument index="0" name="xform" type="Transform2D"> + </argument> + <description> + Set the node's global [Transform2D]. + </description> + </method> + <method name="set_position"> + <return type="void"> + </return> + <argument index="0" name="pos" type="Vector2"> + </argument> + <description> + Set the node's position. + </description> + </method> + <method name="set_rotation"> + <return type="void"> + </return> + <argument index="0" name="radians" type="float"> + </argument> + <description> + Set the node's rotation in radians. + </description> + </method> + <method name="set_rotation_in_degrees"> + <return type="void"> + </return> + <argument index="0" name="degrees" type="float"> + </argument> + <description> + Set the node's rotation in degrees. + </description> + </method> + <method name="set_scale"> + <return type="void"> + </return> + <argument index="0" name="scale" type="Vector2"> + </argument> + <description> + Set the node's scale. + </description> + </method> + <method name="set_transform"> + <return type="void"> + </return> + <argument index="0" name="xform" type="Transform2D"> + </argument> + <description> + Set the node's local [Transform2D]. + </description> + </method> + <method name="set_z"> + <return type="void"> + </return> + <argument index="0" name="z" type="int"> + </argument> + <description> + Set the node's Z-index. + </description> + </method> + <method name="set_z_as_relative"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + 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> + </method> + <method name="to_global" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="local_point" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="to_local" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="global_point" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="translate"> + <return type="void"> + </return> + <argument index="0" name="offset" type="Vector2"> + </argument> + <description> + Translate the node locally by the 'offset' vector, starting from its current local position. + </description> + </method> + </methods> + <members> + <member name="global_position" type="Vector2" setter="set_global_position" getter="get_global_position"> + Global position. + </member> + <member name="global_rotation" type="float" setter="set_global_rotation" getter="get_global_rotation"> + Global rotation in radians. + </member> + <member name="global_rotation_deg" type="float" setter="set_global_rotation_in_degrees" getter="get_global_rotation_in_degrees"> + Global rotation in degrees. + </member> + <member name="global_scale" type="Vector2" setter="set_global_scale" getter="get_global_scale"> + Global scale. + </member> + <member name="global_transform" type="Transform2D" setter="set_global_transform" getter="get_global_transform"> + Global [Transform2D]. + </member> + <member name="position" type="Vector2" setter="set_position" getter="get_position"> + Position, relative to the node's parent. + </member> + <member name="rotation" type="float" setter="set_rotation" getter="get_rotation"> + Rotation in radians. + </member> + <member name="rotation_deg" type="float" setter="set_rotation_in_degrees" getter="get_rotation_in_degrees"> + Rotation in degrees. + </member> + <member name="scale" type="Vector2" setter="set_scale" getter="get_scale"> + Rotation in degrees. + </member> + <member name="transform" type="Transform2D" setter="set_transform" getter="get_transform"> + Local [Transform2D]. + </member> + <member name="z" type="int" setter="set_z" getter="get_z"> + Z-index. Controls the order in which the nodes render. A node with a higher Z-index will display in front of others. + </member> + <member name="z_as_relative" type="bool" setter="set_z_as_relative" getter="is_z_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. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/NodePath.xml b/doc/classes/NodePath.xml new file mode 100644 index 0000000000..9aa9572b80 --- /dev/null +++ b/doc/classes/NodePath.xml @@ -0,0 +1,81 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="NodePath" category="Built-In Types" version="3.0.alpha.custom_build"> + <brief_description> + Pre-parsed scene tree path. + </brief_description> + <description> + A pre-parsed relative or absolute path in a scene tree, for use with [method Node.get_node] and similar functions. It can reference a node, a resource within a node, or a property of a node or resource. For instance, [code]"Path2D/PathFollow2D/Sprite:texture:size"[/code] would refer to the size property of the texture resource on the node named "Sprite" which is a child of the other named nodes in the path. Note that if you want to get a resource, you must end the path with a colon, otherwise the last element will be used as a property name. + You will usually just pass a string to [method Node.get_node] and it will be automatically converted, but you may occasionally want to parse a path ahead of time with [NodePath] or the literal syntax [code]@"path"[/code]. Exporting a [NodePath] variable will give you a node selection widget in the properties panel of the editor, which can often be useful. + A [NodePath] is made up of a list of node names, a list of "subnode" (resource) names, and the name of a property in the final node or resource. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="NodePath"> + <return type="NodePath"> + </return> + <argument index="0" name="from" type="String"> + </argument> + <description> + Create a NodePath from a string, e.g. "Path2D/PathFollow2D/Sprite:texture:size". A path is absolute if it starts with a slash. Absolute paths are only valid in the global scene tree, not within individual scenes. In a relative path, [code]"."[/code] and [code]".."[/code] indicate the current node and its parent. + </description> + </method> + <method name="get_name"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Get the node name indicated by [code]idx[/code] (0 to [method get_name_count]) + </description> + </method> + <method name="get_name_count"> + <return type="int"> + </return> + <description> + Get the number of node names which make up the path. + </description> + </method> + <method name="get_property"> + <return type="String"> + </return> + <description> + Get the path's property name, or an empty string if the path doesn't have a property. + </description> + </method> + <method name="get_subname"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Get the resource name indicated by [code]idx[/code] (0 to [method get_subname_count]) + </description> + </method> + <method name="get_subname_count"> + <return type="int"> + </return> + <description> + Get the number of resource names in the path. + </description> + </method> + <method name="is_absolute"> + <return type="bool"> + </return> + <description> + Return true if the node path is absolute (not relative). + </description> + </method> + <method name="is_empty"> + <return type="bool"> + </return> + <description> + Return true if the node path is empty. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml new file mode 100644 index 0000000000..65200c4769 --- /dev/null +++ b/doc/classes/OS.xml @@ -0,0 +1,854 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="OS" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Operating System functions. + </brief_description> + <description> + Operating System functions. OS Wraps the most common functionality to communicate with the host Operating System, such as: mouse grabbing, mouse cursors, clipboard, video mode, date and time, timers, environment variables, execution of binaries, command line, etc. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="alert"> + <return type="void"> + </return> + <argument index="0" name="text" type="String"> + </argument> + <argument index="1" name="title" type="String" default=""Alert!""> + </argument> + <description> + Displays a modal dialog box utilizing the host OS. + </description> + </method> + <method name="can_draw" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if the host OS allows drawing. + </description> + </method> + <method name="can_use_threads" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns if the current host platform is using multiple threads. + </description> + </method> + <method name="delay_msec" qualifiers="const"> + <return type="void"> + </return> + <argument index="0" name="msec" type="int"> + </argument> + <description> + Delay executing of the current thread by given milliseconds. + </description> + </method> + <method name="delay_usec" qualifiers="const"> + <return type="void"> + </return> + <argument index="0" name="usec" type="int"> + </argument> + <description> + Delay executing of the current thread by given microseconds. + </description> + </method> + <method name="dump_memory_to_file"> + <return type="void"> + </return> + <argument index="0" name="file" type="String"> + </argument> + <description> + Dumps the memory allocation ringlist to a file (only works in debug). + Entry format per line: "Address - Size - Description" + </description> + </method> + <method name="dump_resources_to_file"> + <return type="void"> + </return> + <argument index="0" name="file" type="String"> + </argument> + <description> + Dumps all used resources to file (only works in debug). + Entry format per line: "Resource Type : Resource Location" + At the end of the file is a statistic of all used Resource Types. + </description> + </method> + <method name="execute"> + <return type="int"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="arguments" type="PoolStringArray"> + </argument> + <argument index="2" name="blocking" type="bool"> + </argument> + <argument index="3" name="output" type="Array" default="[ ]"> + </argument> + <description> + Execute the binary file in given path, optionally blocking until it returns. A process ID is returned. + </description> + </method> + <method name="find_scancode_from_string" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="string" type="String"> + </argument> + <description> + Returns the scancode of the given string (e.g. "Escape") + </description> + </method> + <method name="get_borderless_window" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns true if the current window is borderless. + </description> + </method> + <method name="get_clipboard" qualifiers="const"> + <return type="String"> + </return> + <description> + Get clipboard from the host OS. + </description> + </method> + <method name="get_cmdline_args"> + <return type="PoolStringArray"> + </return> + <description> + Return the commandline passed to the engine. + </description> + </method> + <method name="get_current_screen" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the current screen index (0 padded). + </description> + </method> + <method name="get_data_dir" qualifiers="const"> + <return type="String"> + </return> + <description> + Return the absolute directory path of user data path([user://]). + </description> + </method> + <method name="get_date" qualifiers="const"> + <return type="Dictionary"> + </return> + <argument index="0" name="utc" type="bool" default="false"> + </argument> + <description> + Returns current date as a dictionary of keys: year, month, day, weekday, dst (daylight savings time). + </description> + </method> + <method name="get_datetime" qualifiers="const"> + <return type="Dictionary"> + </return> + <argument index="0" name="utc" type="bool" default="false"> + </argument> + <description> + Returns current datetime as a dictionary of keys: year, month, day, weekday, dst (daylight savings time), hour, minute, second. + </description> + </method> + <method name="get_datetime_from_unix_time" qualifiers="const"> + <return type="Dictionary"> + </return> + <argument index="0" name="unix_time_val" type="int"> + </argument> + <description> + Get a dictionary of time values when given epoch time. + Dictionary Time values will be a union of values from [method get_time] and [method get_date] dictionaries (with the exception of dst = day light standard time, as it cannot be determined from epoch). + </description> + </method> + <method name="get_dynamic_memory_usage" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the total amount of dynamic memory used (only works in debug). + </description> + </method> + <method name="get_environment" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="environment" type="String"> + </argument> + <description> + Return an environment variable. + </description> + </method> + <method name="get_executable_path" qualifiers="const"> + <return type="String"> + </return> + <description> + Return the path to the current engine executable. + </description> + </method> + <method name="get_exit_code" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_latin_keyboard_variant" qualifiers="const"> + <return type="String"> + </return> + <description> + Returns the current latin keyboard variant as a String. + Possible return values are: "QWERTY", "AZERTY", "QZERTY", "DVORAK", "NEO" or "ERROR" + </description> + </method> + <method name="get_locale" qualifiers="const"> + <return type="String"> + </return> + <description> + Return the host OS locale. + </description> + </method> + <method name="get_model_name" qualifiers="const"> + <return type="String"> + </return> + <description> + Returns the model name of the current device. + </description> + </method> + <method name="get_name" qualifiers="const"> + <return type="String"> + </return> + <description> + Return the name of the host OS. Possible values are: "Android", "Haiku", "iOS", "HTML5", "OSX", "Server", "Windows", "UWP", "X11". + </description> + </method> + <method name="get_power_percent_left"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_power_seconds_left"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_power_state"> + <return type="int" enum="OS.PowerState"> + </return> + <description> + </description> + </method> + <method name="get_process_id" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the game process ID + </description> + </method> + <method name="get_processor_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the number of cores available in the host machine. + </description> + </method> + <method name="get_scancode_string" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="code" type="int"> + </argument> + <description> + Returns the given scancode as a string (e.g. Return values: "Escape", "Shift+Escape"). + </description> + </method> + <method name="get_screen_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the number of displays attached to the host machine + </description> + </method> + <method name="get_screen_dpi" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="screen" type="int" default="-1"> + </argument> + <description> + Returns the dots per inch density of the specified screen. + + On Android Devices, the actual screen densities are grouped into six generalized densities: + ldpi - 120 dpi + mdpi - 160 dpi + hdpi - 240 dpi + xhdpi - 320 dpi + xxhdpi - 480 dpi + xxxhdpi - 640 dpi + </description> + </method> + <method name="get_screen_orientation" qualifiers="const"> + <return type="int" enum="OS.ScreenOrientation"> + </return> + <description> + Returns the current screen orientation, the return value will be one of the SCREEN_ORIENTATION constants in this class. + </description> + </method> + <method name="get_screen_position" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="screen" type="int" default="-1"> + </argument> + <description> + </description> + </method> + <method name="get_screen_size" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="screen" type="int" default="-1"> + </argument> + <description> + Returns the dimensions in pixels of the specified screen. + </description> + </method> + <method name="get_splash_tick_msec" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_static_memory_peak_usage" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the max amount of static memory used (only works in debug). + </description> + </method> + <method name="get_static_memory_usage" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_system_dir" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="dir" type="int" enum="OS.SystemDir"> + </argument> + <description> + </description> + </method> + <method name="get_system_time_secs" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_ticks_msec" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the amount of time passed in milliseconds since the engine started. + </description> + </method> + <method name="get_time" qualifiers="const"> + <return type="Dictionary"> + </return> + <argument index="0" name="utc" type="bool" default="false"> + </argument> + <description> + Returns current time as a dictionary of keys: hour, minute, second + </description> + </method> + <method name="get_time_zone_info" qualifiers="const"> + <return type="Dictionary"> + </return> + <description> + </description> + </method> + <method name="get_unique_id" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_unix_time" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the current unix timestamp. + </description> + </method> + <method name="get_unix_time_from_datetime" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="datetime" type="Dictionary"> + </argument> + <description> + Get an epoch time value from a dictionary of time values. + [code]datetime[/code] must be populated with the following keys: year, month, day, hour, minute, second. + You can pass the output from [method get_datetime_from_unix_time] directly into this function. Daylight savings time (dst), if present, is ignored. + </description> + </method> + <method name="get_window_position" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Returns the window position relative to the screen, the origin is the top left corner, +Y axis goes to the bottom and +X axis goes to the right. + </description> + </method> + <method name="get_window_size" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Returns the size of the window (without counting window manager decorations). + </description> + </method> + <method name="has_environment" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="environment" type="String"> + </argument> + <description> + Return true if an environment variable exists. + </description> + </method> + <method name="has_touchscreen_ui_hint" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="has_virtual_keyboard" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns true if the platform has a virtual keyboard, false otherwise. + </description> + </method> + <method name="hide_virtual_keyboard"> + <return type="void"> + </return> + <description> + Hides the virtual keyboard if it is shown, does nothing otherwise. + </description> + </method> + <method name="is_debug_build" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_in_low_processor_usage_mode" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if low cpu usage mode is enabled. + </description> + </method> + <method name="is_keep_screen_on" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns whether the screen is being kept on or not. + </description> + </method> + <method name="is_ok_left_and_cancel_right" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_scancode_unicode" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="code" type="int"> + </argument> + <description> + </description> + </method> + <method name="is_stdout_verbose" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if the engine was executed with -v (verbose stdout). + </description> + </method> + <method name="is_vsync_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_window_fullscreen" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns whether the window is in fullscreen mode or not. + </description> + </method> + <method name="is_window_maximized" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if the window is maximized. + </description> + </method> + <method name="is_window_minimized" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if the window is minimized. + </description> + </method> + <method name="is_window_resizable" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns whether the window is resizable or not. + </description> + </method> + <method name="kill"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="pid" type="int"> + </argument> + <description> + Kill a process ID (this method can be used to kill processes that were not spawned by the game). + </description> + </method> + <method name="native_video_is_playing"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="native_video_pause"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="native_video_play"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="volume" type="float"> + </argument> + <argument index="2" name="audio_track" type="String"> + </argument> + <argument index="3" name="subtitle_track" type="String"> + </argument> + <description> + </description> + </method> + <method name="native_video_stop"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="native_video_unpause"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="print_all_resources"> + <return type="void"> + </return> + <argument index="0" name="tofile" type="String" default=""""> + </argument> + <description> + </description> + </method> + <method name="print_all_textures_by_size"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="print_resources_by_type"> + <return type="void"> + </return> + <argument index="0" name="types" type="PoolStringArray"> + </argument> + <description> + </description> + </method> + <method name="print_resources_in_use"> + <return type="void"> + </return> + <argument index="0" name="short" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="request_attention"> + <return type="void"> + </return> + <description> + Request the user attention to the window. It'll flash the taskbar button on Windows or bounce the dock icon on OSX. + </description> + </method> + <method name="set_borderless_window"> + <return type="void"> + </return> + <argument index="0" name="borderless" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_clipboard"> + <return type="void"> + </return> + <argument index="0" name="clipboard" type="String"> + </argument> + <description> + Set clipboard to the OS. + </description> + </method> + <method name="set_current_screen"> + <return type="void"> + </return> + <argument index="0" name="screen" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_exit_code"> + <return type="void"> + </return> + <argument index="0" name="code" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_icon"> + <return type="void"> + </return> + <argument index="0" name="icon" type="Image"> + </argument> + <description> + </description> + </method> + <method name="set_ime_position"> + <return type="void"> + </return> + <argument index="0" name="position" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_keep_screen_on"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Set keep screen on if true, or goes to sleep by device setting if false. (for Android/iOS) + </description> + </method> + <method name="set_low_processor_usage_mode"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set to true to enable the low cpu usage mode. In this mode, the screen only redraws when there are changes, and a considerable sleep time is inserted between frames. This way, editors using the engine UI only use very little cpu. + </description> + </method> + <method name="set_screen_orientation"> + <return type="void"> + </return> + <argument index="0" name="orientation" type="int" enum="OS.ScreenOrientation"> + </argument> + <description> + Sets the current screen orientation, the argument value must be one of the SCREEN_ORIENTATION constants in this class. + </description> + </method> + <method name="set_thread_name"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_use_file_access_save_and_swap"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_use_vsync"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_window_fullscreen"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Sets window fullscreen mode to the [i]enabled[/i] argument, [i]enabled[/i] is a toggle for the fullscreen mode, calling the function with [i]enabled[/i] true when the screen is not on fullscreen mode will cause the screen to go to fullscreen mode, calling the function with [i]enabled[/i] false when the screen is in fullscreen mode will cause the window to exit the fullscreen mode. + </description> + </method> + <method name="set_window_maximized"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Set the window size to maximized. + </description> + </method> + <method name="set_window_minimized"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Set whether the window is minimized. + </description> + </method> + <method name="set_window_position"> + <return type="void"> + </return> + <argument index="0" name="position" type="Vector2"> + </argument> + <description> + Sets the position of the window to the specified position (this function could be restricted by the window manager, meaning that there could be some unreachable areas of the screen). + </description> + </method> + <method name="set_window_resizable"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Set the window resizable state, if the window is not resizable it will preserve the dimensions specified in the project settings. + </description> + </method> + <method name="set_window_size"> + <return type="void"> + </return> + <argument index="0" name="size" type="Vector2"> + </argument> + <description> + Sets the window size to the specified size. + </description> + </method> + <method name="set_window_title"> + <return type="void"> + </return> + <argument index="0" name="title" type="String"> + </argument> + <description> + Sets the window title to the specified string. + </description> + </method> + <method name="shell_open"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="uri" type="String"> + </argument> + <description> + </description> + </method> + <method name="show_virtual_keyboard"> + <return type="void"> + </return> + <argument index="0" name="existing_text" type="String" default=""""> + </argument> + <description> + Shows the virtual keyboard if the platform has one. The [i]existing_text[/i] parameter is useful for implementing your own LineEdit, as it tells the virtual keyboard what text has already been typed (the virtual keyboard uses it for auto-correct and predictions). + </description> + </method> + </methods> + <constants> + <constant name="DAY_SUNDAY" value="0"> + </constant> + <constant name="DAY_MONDAY" value="1"> + </constant> + <constant name="DAY_TUESDAY" value="2"> + </constant> + <constant name="DAY_WEDNESDAY" value="3"> + </constant> + <constant name="DAY_THURSDAY" value="4"> + </constant> + <constant name="DAY_FRIDAY" value="5"> + </constant> + <constant name="DAY_SATURDAY" value="6"> + </constant> + <constant name="MONTH_JANUARY" value="1"> + </constant> + <constant name="MONTH_FEBRUARY" value="2"> + </constant> + <constant name="MONTH_MARCH" value="3"> + </constant> + <constant name="MONTH_APRIL" value="4"> + </constant> + <constant name="MONTH_MAY" value="5"> + </constant> + <constant name="MONTH_JUNE" value="6"> + </constant> + <constant name="MONTH_JULY" value="7"> + </constant> + <constant name="MONTH_AUGUST" value="8"> + </constant> + <constant name="MONTH_SEPTEMBER" value="9"> + </constant> + <constant name="MONTH_OCTOBER" value="10"> + </constant> + <constant name="MONTH_NOVEMBER" value="11"> + </constant> + <constant name="MONTH_DECEMBER" value="12"> + </constant> + <constant name="SCREEN_ORIENTATION_LANDSCAPE" value="0"> + </constant> + <constant name="SCREEN_ORIENTATION_PORTRAIT" value="1"> + </constant> + <constant name="SCREEN_ORIENTATION_REVERSE_LANDSCAPE" value="2"> + </constant> + <constant name="SCREEN_ORIENTATION_REVERSE_PORTRAIT" value="3"> + </constant> + <constant name="SCREEN_ORIENTATION_SENSOR_LANDSCAPE" value="4"> + </constant> + <constant name="SCREEN_ORIENTATION_SENSOR_PORTRAIT" value="5"> + </constant> + <constant name="SCREEN_ORIENTATION_SENSOR" value="6"> + </constant> + <constant name="SYSTEM_DIR_DESKTOP" value="0"> + </constant> + <constant name="SYSTEM_DIR_DCIM" value="1"> + </constant> + <constant name="SYSTEM_DIR_DOCUMENTS" value="2"> + </constant> + <constant name="SYSTEM_DIR_DOWNLOADS" value="3"> + </constant> + <constant name="SYSTEM_DIR_MOVIES" value="4"> + </constant> + <constant name="SYSTEM_DIR_MUSIC" value="5"> + </constant> + <constant name="SYSTEM_DIR_PICTURES" value="6"> + </constant> + <constant name="SYSTEM_DIR_RINGTONES" value="7"> + </constant> + <constant name="POWERSTATE_UNKNOWN" value="0"> + </constant> + <constant name="POWERSTATE_ON_BATTERY" value="1"> + </constant> + <constant name="POWERSTATE_NO_BATTERY" value="2"> + </constant> + <constant name="POWERSTATE_CHARGING" value="3"> + </constant> + <constant name="POWERSTATE_CHARGED" value="4"> + </constant> + </constants> +</class> diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml new file mode 100644 index 0000000000..67421487f1 --- /dev/null +++ b/doc/classes/Object.xml @@ -0,0 +1,392 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base class for all non built-in types. + </brief_description> + <description> + Base class for all non built-in types. Everything not a built-in type starts the inheritance chain from this class. + Objects do not manage memory, if inheriting from one the object will most likely have to be deleted manually (call the [method free] function from the script or delete from C++). + Some derivates add memory management, such as [Reference] (which keeps a reference count and deletes itself automatically when no longer referenced) and [Node], which deletes the children tree when deleted. + Objects export properties, which are mainly useful for storage and editing, but not really so much in programming. Properties are exported in [method _get_property_list] and handled in [method _get] and [method _set]. However, scripting languages and C++ have simpler means to export them. + Objects also receive notifications ([method _notification]). Notifications are a simple way to notify the object about simple events, so they can all be handled together. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="_get" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="property" type="String"> + </argument> + <description> + Return a property, return null if the property does not exist. + </description> + </method> + <method name="_get_property_list" qualifiers="virtual"> + <return type="Array"> + </return> + <description> + Return the property list, array of dictionaries, dictionaries must contain: name:String, type:int (see TYPE_* enum in [@Global Scope]) and optionally: hint:int (see PROPERTY_HINT_* in [@Global Scope]), hint_string:String, usage:int (see PROPERTY_USAGE_* in [@Global Scope]). + </description> + </method> + <method name="_init" qualifiers="virtual"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="_notification" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="what" type="int"> + </argument> + <description> + Notification request, the notification id is received. + </description> + </method> + <method name="_set" qualifiers="virtual"> + <return type="bool"> + </return> + <argument index="0" name="property" type="String"> + </argument> + <argument index="1" name="value" type="Variant"> + </argument> + <description> + Set a property. Return true if the property was found. + </description> + </method> + <method name="add_user_signal"> + <return type="void"> + </return> + <argument index="0" name="signal" type="String"> + </argument> + <argument index="1" name="arguments" type="Array" default="[ ]"> + </argument> + <description> + Add a user signal (can be added anytime). Arguments are optional, but can be added as an array of dictionaries, each containing "name" and "type" (from [@Global Scope] TYPE_*). + </description> + </method> + <method name="call" qualifiers="vararg"> + <return type="Variant"> + </return> + <argument index="0" name="method" type="String"> + </argument> + <description> + </description> + </method> + <method name="call_deferred" qualifiers="vararg"> + <return type="Variant"> + </return> + <argument index="0" name="method" type="String"> + </argument> + <description> + </description> + </method> + <method name="callv"> + <return type="Variant"> + </return> + <argument index="0" name="method" type="String"> + </argument> + <argument index="1" name="arg_array" type="Array"> + </argument> + <description> + </description> + </method> + <method name="can_translate_messages" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if this object can translate strings. + </description> + </method> + <method name="connect"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="signal" type="String"> + </argument> + <argument index="1" name="target" type="Object"> + </argument> + <argument index="2" name="method" type="String"> + </argument> + <argument index="3" name="binds" type="Array" default="[ ]"> + </argument> + <argument index="4" name="flags" type="int" default="0"> + </argument> + <description> + Connect a signal to a method at a target (member function). Binds are optional and are passed as extra arguments to the call. Flags specify optional deferred or one shot connections, see enum CONNECT_*. A signal can only be connected once to a method, and it will throw an error if already connected. If you want to avoid this, use [method is_connected] to check. + </description> + </method> + <method name="disconnect"> + <return type="void"> + </return> + <argument index="0" name="signal" type="String"> + </argument> + <argument index="1" name="target" type="Object"> + </argument> + <argument index="2" name="method" type="String"> + </argument> + <description> + Disconnect a signal from a method. + </description> + </method> + <method name="emit_signal" qualifiers="vararg"> + <return type="Variant"> + </return> + <argument index="0" name="signal" type="String"> + </argument> + <description> + </description> + </method> + <method name="free"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="get" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="property" type="String"> + </argument> + <description> + Get a property from the object. + </description> + </method> + <method name="get_class" qualifiers="const"> + <return type="String"> + </return> + <description> + Return the class of the object as a string. + </description> + </method> + <method name="get_incoming_connections" qualifiers="const"> + <return type="Array"> + </return> + <description> + Returns an [Array] of dictionaries with informations about signals that are connected to this object. + Inside each [Dictionary] there are 3 fields: + - "source" is a reference to signal emitter. + - "signal_name" is name of connected signal. + - "method_name" is a name of method to which signal is connected. + </description> + </method> + <method name="get_instance_id" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the instance ID. All objects have a unique instance ID. + </description> + </method> + <method name="get_meta" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Return a metadata from the object. + </description> + </method> + <method name="get_meta_list" qualifiers="const"> + <return type="PoolStringArray"> + </return> + <description> + Return the list of metadata in the object. + </description> + </method> + <method name="get_method_list" qualifiers="const"> + <return type="Array"> + </return> + <description> + </description> + </method> + <method name="get_property_list" qualifiers="const"> + <return type="Array"> + </return> + <description> + Return the list of properties as an array of dictionaries, dictionaries contain: name:String, type:int (see TYPE_* enum in [@Global Scope]) and optionally: hint:int (see PROPERTY_HINT_* in [@Global Scope]), hint_string:String, usage:int (see PROPERTY_USAGE_* in [@Global Scope]). + </description> + </method> + <method name="get_script" qualifiers="const"> + <return type="Reference"> + </return> + <description> + Return the object script (or null if it doesn't have one). + </description> + </method> + <method name="get_signal_connection_list" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="signal" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_signal_list" qualifiers="const"> + <return type="Array"> + </return> + <description> + Return the list of signals as an array of dictionaries. + </description> + </method> + <method name="has_meta" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Return true if a metadata is found with the requested name. + </description> + </method> + <method name="has_method" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="method" type="String"> + </argument> + <description> + </description> + </method> + <method name="has_user_signal" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="signal" type="String"> + </argument> + <description> + </description> + </method> + <method name="is_blocking_signals" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if signal emission blocking is enabled. + </description> + </method> + <method name="is_class" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="type" type="String"> + </argument> + <description> + Check the class of the object against a string (including inheritance). + </description> + </method> + <method name="is_connected" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="signal" type="String"> + </argument> + <argument index="1" name="target" type="Object"> + </argument> + <argument index="2" name="method" type="String"> + </argument> + <description> + Return true if a connection exists for a given signal and target/method. + </description> + </method> + <method name="is_queued_for_deletion" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="notification"> + <return type="void"> + </return> + <argument index="0" name="what" type="int"> + </argument> + <argument index="1" name="reversed" type="bool" default="false"> + </argument> + <description> + Notify the object of something. + </description> + </method> + <method name="property_list_changed_notify"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="set"> + <return type="void"> + </return> + <argument index="0" name="property" type="String"> + </argument> + <argument index="1" name="value" type="Variant"> + </argument> + <description> + Set property into the object. + </description> + </method> + <method name="set_block_signals"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + If set to true, signal emission is blocked. + </description> + </method> + <method name="set_message_translation"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Define whether this object can translate strings (with calls to [method tr]). Default is true. + </description> + </method> + <method name="set_meta"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="value" type="Variant"> + </argument> + <description> + Set a metadata into the object. Metadata is serialized. Metadata can be [i]anything[/i]. + </description> + </method> + <method name="set_script"> + <return type="void"> + </return> + <argument index="0" name="script" type="Reference"> + </argument> + <description> + Set a script into the object, scripts extend the object functionality. + </description> + </method> + <method name="tr" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="message" type="String"> + </argument> + <description> + Translate a message. Only works if message translation is enabled (which it is by default). See [method set_message_translation]. + </description> + </method> + </methods> + <signals> + <signal name="script_changed"> + <description> + </description> + </signal> + </signals> + <constants> + <constant name="NOTIFICATION_POSTINITIALIZE" value="0" enum=""> + Called right when the object is initialized. Not available in script. + </constant> + <constant name="NOTIFICATION_PREDELETE" value="1" enum=""> + Called before the object is about to be deleted. + </constant> + <constant name="CONNECT_DEFERRED" value="1"> + Connect a signal in deferred mode. This way, signal emissions are stored in a queue, then set on idle time. + </constant> + <constant name="CONNECT_PERSIST" value="2"> + Persisting connections are saved when the object is serialized to file. + </constant> + <constant name="CONNECT_ONESHOT" value="4"> + One shot connections disconnect themselves after emission. + </constant> + </constants> +</class> diff --git a/doc/classes/OccluderPolygon2D.xml b/doc/classes/OccluderPolygon2D.xml new file mode 100644 index 0000000000..99c1536ddf --- /dev/null +++ b/doc/classes/OccluderPolygon2D.xml @@ -0,0 +1,71 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="OccluderPolygon2D" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_cull_mode" qualifiers="const"> + <return type="int" enum="OccluderPolygon2D.CullMode"> + </return> + <description> + </description> + </method> + <method name="get_polygon" qualifiers="const"> + <return type="PoolVector2Array"> + </return> + <description> + </description> + </method> + <method name="is_closed" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_closed"> + <return type="void"> + </return> + <argument index="0" name="closed" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_cull_mode"> + <return type="void"> + </return> + <argument index="0" name="cull_mode" type="int" enum="OccluderPolygon2D.CullMode"> + </argument> + <description> + </description> + </method> + <method name="set_polygon"> + <return type="void"> + </return> + <argument index="0" name="polygon" type="PoolVector2Array"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="closed" type="bool" setter="set_closed" getter="is_closed"> + </member> + <member name="cull_mode" type="int" setter="set_cull_mode" getter="get_cull_mode" enum="OccluderPolygon2D.CullMode"> + </member> + <member name="polygon" type="PoolVector2Array" setter="set_polygon" getter="get_polygon"> + </member> + </members> + <constants> + <constant name="CULL_DISABLED" value="0"> + </constant> + <constant name="CULL_CLOCKWISE" value="1"> + </constant> + <constant name="CULL_COUNTER_CLOCKWISE" value="2"> + </constant> + </constants> +</class> diff --git a/doc/classes/OmniLight.xml b/doc/classes/OmniLight.xml new file mode 100644 index 0000000000..cb8e756a4c --- /dev/null +++ b/doc/classes/OmniLight.xml @@ -0,0 +1,63 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="OmniLight" inherits="Light" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + OmniDirectional Light, such as a light bulb or a candle. + </brief_description> + <description> + An OmniDirectional light is a type of [Light] node that emits lights in all directions. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of [Light]. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_shadow_detail" qualifiers="const"> + <return type="int" enum="OmniLight.ShadowDetail"> + </return> + <description> + </description> + </method> + <method name="get_shadow_mode" qualifiers="const"> + <return type="int" enum="OmniLight.ShadowMode"> + </return> + <description> + </description> + </method> + <method name="set_shadow_detail"> + <return type="void"> + </return> + <argument index="0" name="detail" type="int" enum="OmniLight.ShadowDetail"> + </argument> + <description> + </description> + </method> + <method name="set_shadow_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="OmniLight.ShadowMode"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="omni_attenuation" type="float" setter="set_param" getter="get_param"> + </member> + <member name="omni_range" type="float" setter="set_param" getter="get_param"> + </member> + <member name="omni_shadow_detail" type="int" setter="set_shadow_detail" getter="get_shadow_detail" enum="OmniLight.ShadowDetail"> + </member> + <member name="omni_shadow_mode" type="int" setter="set_shadow_mode" getter="get_shadow_mode" enum="OmniLight.ShadowMode"> + </member> + </members> + <constants> + <constant name="SHADOW_DUAL_PARABOLOID" value="0"> + </constant> + <constant name="SHADOW_CUBE" value="1"> + </constant> + <constant name="SHADOW_DETAIL_VERTICAL" value="0"> + </constant> + <constant name="SHADOW_DETAIL_HORIZONTAL" value="1"> + </constant> + </constants> +</class> diff --git a/doc/classes/OptionButton.xml b/doc/classes/OptionButton.xml new file mode 100644 index 0000000000..abb0dc4f2d --- /dev/null +++ b/doc/classes/OptionButton.xml @@ -0,0 +1,237 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="OptionButton" inherits="Button" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Button control that provides selectable options when pressed. + </brief_description> + <description> + OptionButton is a type button that provides a selectable list of items when pressed. The item selected becomes the "current" item and is displayed as the button text. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_icon_item"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <argument index="1" name="label" type="String"> + </argument> + <argument index="2" name="id" type="int"> + </argument> + <description> + Add an item, with a "texture" icon, text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end. + </description> + </method> + <method name="add_item"> + <return type="void"> + </return> + <argument index="0" name="label" type="String"> + </argument> + <argument index="1" name="id" type="int" default="-1"> + </argument> + <description> + Add an item, with text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end. + </description> + </method> + <method name="add_separator"> + <return type="void"> + </return> + <description> + Add a separator to the list of items. Separators help to group items. Separator also takes up an index and is appended at the end. + </description> + </method> + <method name="clear"> + <return type="void"> + </return> + <description> + Clear all the items in the [OptionButton]. + </description> + </method> + <method name="get_item_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the amount of items in the OptionButton. + </description> + </method> + <method name="get_item_icon" qualifiers="const"> + <return type="Texture"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return the icon of the item at index "idx". + </description> + </method> + <method name="get_item_id" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return the ID of the item at index "idx". + </description> + </method> + <method name="get_item_metadata" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_item_text" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return the text of the item at index "idx". + </description> + </method> + <method name="get_selected" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the current item index + </description> + </method> + <method name="get_selected_id" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_selected_metadata" qualifiers="const"> + <return type="Variant"> + </return> + <description> + </description> + </method> + <method name="is_item_disabled" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="remove_item"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="select"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Select an item by index and make it the current item. + </description> + </method> + <method name="set_item_disabled"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="disabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_item_icon"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="texture" type="Texture"> + </argument> + <description> + Set the icon of an item at index "idx". + </description> + </method> + <method name="set_item_id"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="id" type="int"> + </argument> + <description> + Set the ID of an item at index "idx". + </description> + </method> + <method name="set_item_metadata"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="metadata" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="set_item_text"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="text" type="String"> + </argument> + <description> + Set the text of an item at index "idx". + </description> + </method> + </methods> + <members> + <member name="items" type="Array" setter="_set_items" getter="_get_items"> + </member> + <member name="selected" type="int" setter="_select_int" getter="get_selected"> + </member> + </members> + <signals> + <signal name="item_selected"> + <argument index="0" name="ID" type="int"> + </argument> + <description> + This signal is emitted when the current item was changed by the user. ID of the item selected is passed as argument (if no IDs were added, ID will be just the item index). + </description> + </signal> + </signals> + <constants> + </constants> + <theme_items> + <theme_item name="arrow" type="Texture"> + </theme_item> + <theme_item name="arrow_margin" type="int"> + </theme_item> + <theme_item name="disabled" type="StyleBox"> + </theme_item> + <theme_item name="focus" type="StyleBox"> + </theme_item> + <theme_item name="font" type="Font"> + </theme_item> + <theme_item name="font_color" type="Color"> + </theme_item> + <theme_item name="font_color_disabled" type="Color"> + </theme_item> + <theme_item name="font_color_hover" type="Color"> + </theme_item> + <theme_item name="font_color_pressed" type="Color"> + </theme_item> + <theme_item name="hover" type="StyleBox"> + </theme_item> + <theme_item name="hseparation" type="int"> + </theme_item> + <theme_item name="normal" type="StyleBox"> + </theme_item> + <theme_item name="pressed" type="StyleBox"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/PCKPacker.xml b/doc/classes/PCKPacker.xml new file mode 100644 index 0000000000..cf8efdf6be --- /dev/null +++ b/doc/classes/PCKPacker.xml @@ -0,0 +1,43 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PCKPacker" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_file"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="pck_path" type="String"> + </argument> + <argument index="1" name="source_path" type="String"> + </argument> + <description> + </description> + </method> + <method name="flush"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="verbose" type="bool"> + </argument> + <description> + </description> + </method> + <method name="pck_start"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="pck_name" type="String"> + </argument> + <argument index="1" name="alignment" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/PHashTranslation.xml b/doc/classes/PHashTranslation.xml new file mode 100644 index 0000000000..b25ddcbf22 --- /dev/null +++ b/doc/classes/PHashTranslation.xml @@ -0,0 +1,25 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PHashTranslation" inherits="Translation" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Optimized translation. + </brief_description> + <description> + Optimized translation. Uses real-time compressed translations, which results in very small dictionaries. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="generate"> + <return type="void"> + </return> + <argument index="0" name="from" type="Translation"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/PackedDataContainer.xml b/doc/classes/PackedDataContainer.xml new file mode 100644 index 0000000000..660a39f210 --- /dev/null +++ b/doc/classes/PackedDataContainer.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PackedDataContainer" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="pack"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="value" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="size" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + </methods> + <members> + <member name="__data__" type="PoolByteArray" setter="_set_data" getter="_get_data"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/PackedDataContainerRef.xml b/doc/classes/PackedDataContainerRef.xml new file mode 100644 index 0000000000..413cd4468b --- /dev/null +++ b/doc/classes/PackedDataContainerRef.xml @@ -0,0 +1,21 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PackedDataContainerRef" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="size" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/PackedScene.xml b/doc/classes/PackedScene.xml new file mode 100644 index 0000000000..b40207229c --- /dev/null +++ b/doc/classes/PackedScene.xml @@ -0,0 +1,55 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PackedScene" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + TODO: explain ownership, and that node does not need to own itself + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="can_instance" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_state"> + <return type="SceneState"> + </return> + <description> + </description> + </method> + <method name="instance" qualifiers="const"> + <return type="Node"> + </return> + <argument index="0" name="edit_state" type="int" enum="PackedScene.GenEditState" default="0"> + </argument> + <description> + </description> + </method> + <method name="pack"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="path" type="Node"> + </argument> + <description> + Pack will ignore any sub-nodes not owned by given node. See [method Node.set_owner]. + </description> + </method> + </methods> + <members> + <member name="_bundled" type="Dictionary" setter="_set_bundled_scene" getter="_get_bundled_scene"> + </member> + </members> + <constants> + <constant name="GEN_EDIT_STATE_DISABLED" value="0"> + </constant> + <constant name="GEN_EDIT_STATE_INSTANCE" value="1"> + </constant> + <constant name="GEN_EDIT_STATE_MAIN" value="2"> + </constant> + </constants> +</class> diff --git a/doc/classes/PacketPeer.xml b/doc/classes/PacketPeer.xml new file mode 100644 index 0000000000..bc15e5fc0c --- /dev/null +++ b/doc/classes/PacketPeer.xml @@ -0,0 +1,77 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PacketPeer" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Abstraction and base class for packet-based protocols. + </brief_description> + <description> + PacketPeer is an abstraction and base class for packet-based protocols (such as UDP). It provides an API for sending and receiving packets both as raw data or variables. This makes it easy to transfer data over a protocol, without having to encode data as low level bytes or having to worry about network ordering. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_available_packet_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the number of packets currently available in the ring-buffer. + </description> + </method> + <method name="get_packet" qualifiers="const"> + <return type="PoolByteArray"> + </return> + <description> + Get a raw packet. + </description> + </method> + <method name="get_packet_error" qualifiers="const"> + <return type="int" enum="Error"> + </return> + <description> + Return the error state of the last packet received (via [method get_packet] and [method get_var]). + </description> + </method> + <method name="get_var" qualifiers="const"> + <return type="Variant"> + </return> + <description> + Get a Variant. + </description> + </method> + <method name="is_object_decoding_allowed" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="put_packet"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="buffer" type="PoolByteArray"> + </argument> + <description> + Send a raw packet. + </description> + </method> + <method name="put_var"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="var" type="Variant"> + </argument> + <description> + Send a Variant as a packet. + </description> + </method> + <method name="set_allow_object_decoding"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/PacketPeerStream.xml b/doc/classes/PacketPeerStream.xml new file mode 100644 index 0000000000..531046a4ba --- /dev/null +++ b/doc/classes/PacketPeerStream.xml @@ -0,0 +1,54 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PacketPeerStream" inherits="PacketPeer" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Wrapper to use a PacketPeer over a StreamPeer. + </brief_description> + <description> + PacketStreamPeer provides a wrapper for working using packets over a stream. This allows for using packet based code with StreamPeers. PacketPeerStream implements a custom protocol over the StreamPeer, so the user should not read or write to the wrapped StreamPeer directly. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_input_buffer_max_size" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_output_buffer_max_size" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_input_buffer_max_size"> + <return type="void"> + </return> + <argument index="0" name="max_size_bytes" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_output_buffer_max_size"> + <return type="void"> + </return> + <argument index="0" name="max_size_bytes" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_stream_peer"> + <return type="void"> + </return> + <argument index="0" name="peer" type="Reference"> + </argument> + <description> + Set the [StreamPeer] object to be wrapped. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/PacketPeerUDP.xml b/doc/classes/PacketPeerUDP.xml new file mode 100644 index 0000000000..9bff0c9b5e --- /dev/null +++ b/doc/classes/PacketPeerUDP.xml @@ -0,0 +1,79 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PacketPeerUDP" inherits="PacketPeer" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + UDP packet peer. + </brief_description> + <description> + UDP packet peer. Can be used to send raw UDP packets as well as [Variant]\ s. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="close"> + <return type="void"> + </return> + <description> + Close the UDP socket the [PacketPeerUDP] is currently listening on. + </description> + </method> + <method name="get_packet_ip" qualifiers="const"> + <return type="String"> + </return> + <description> + Return the IP of the remote peer that sent the last packet(that was received with [method get_packet] or [method get_var]). + </description> + </method> + <method name="get_packet_port" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the port of the remote peer that sent the last packet(that was received with [method get_packet] or [method get_var]). + </description> + </method> + <method name="is_listening" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether this [PacketPeerUDP] is listening. + </description> + </method> + <method name="listen"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="port" type="int"> + </argument> + <argument index="1" name="bind_address" type="String" default=""*""> + </argument> + <argument index="2" name="recv_buf_size" type="int" default="65536"> + </argument> + <description> + Make this [PacketPeerUDP] listen on the "port" binding to "bind_address" with a buffer size "recv_buf_size". + If "bind_address" is set as "*" (default), the peer will listen on all available addresses (both IPv4 and IPv6). + If "bind_address" is set as "0.0.0.0" (for IPv4) or "::" (for IPv6), the peer will listen on all available addresses matching that IP type. + If "bind_address" is set to any valid address (e.g. "192.168.1.101", "::1", etc), the peer will only listen on the interface with that addresses (or fail if no interface with the given address exists). + </description> + </method> + <method name="set_dest_address"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="host" type="String"> + </argument> + <argument index="1" name="port" type="int"> + </argument> + <description> + Set the destination address and port for sending packets and variables, a hostname will be resolved using if valid. + </description> + </method> + <method name="wait"> + <return type="int" enum="Error"> + </return> + <description> + Wait for a packet to arrive on the listening port, see [method listen]. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Panel.xml b/doc/classes/Panel.xml new file mode 100644 index 0000000000..8a57659c0c --- /dev/null +++ b/doc/classes/Panel.xml @@ -0,0 +1,25 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Panel" inherits="Control" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Provides an opaque background for [Control] children. + </brief_description> + <description> + Panel is a [Control] that displays an opaque background. It's commonly used as a parent and container for other types of [Control] nodes. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> + <theme_items> + <theme_item name="panel" type="StyleBox"> + </theme_item> + <theme_item name="panelf" type="StyleBox"> + </theme_item> + <theme_item name="panelnc" type="StyleBox"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/PanelContainer.xml b/doc/classes/PanelContainer.xml new file mode 100644 index 0000000000..29d5169b9e --- /dev/null +++ b/doc/classes/PanelContainer.xml @@ -0,0 +1,21 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PanelContainer" inherits="Container" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Panel container type. + </brief_description> + <description> + Panel container type. This container fits controls inside of the delimited area of a stylebox. It's useful for giving controls an outline. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> + <theme_items> + <theme_item name="panel" type="StyleBox"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/PanoramaSky.xml b/doc/classes/PanoramaSky.xml new file mode 100644 index 0000000000..81f358461e --- /dev/null +++ b/doc/classes/PanoramaSky.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PanoramaSky" inherits="Sky" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_panorama" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="set_panorama"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="panorama" type="Texture" setter="set_panorama" getter="get_panorama"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/ParallaxBackground.xml b/doc/classes/ParallaxBackground.xml new file mode 100644 index 0000000000..a7d616129a --- /dev/null +++ b/doc/classes/ParallaxBackground.xml @@ -0,0 +1,125 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ParallaxBackground" inherits="CanvasLayer" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + A node used to create a parallax scrolling background. + </brief_description> + <description> + A ParallaxBackground will use one or more [ParallaxLayer] nodes to create a parallax scrolling background. Each [ParallaxLayer] can be set to move at different speeds relative to the camera movement, this can be used to create an illusion of depth in a 2D game. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_limit_begin" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the beginning limit. + </description> + </method> + <method name="get_limit_end" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the ending limit. + </description> + </method> + <method name="get_scroll_base_offset" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the base offset. + </description> + </method> + <method name="get_scroll_base_scale" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the base motion scale. + </description> + </method> + <method name="get_scroll_offset" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="is_ignore_camera_zoom"> + <return type="bool"> + </return> + <description> + Return ignoring camera zoom. + </description> + </method> + <method name="set_ignore_camera_zoom"> + <return type="void"> + </return> + <argument index="0" name="ignore" type="bool"> + </argument> + <description> + Set to true for all child [ParallaxLayer] nodes to not be affected by the zoom level of the camera. + </description> + </method> + <method name="set_limit_begin"> + <return type="void"> + </return> + <argument index="0" name="ofs" type="Vector2"> + </argument> + <description> + Set the left and top limits in pixels for scrolling to begin. If the camera is outside of this limit the background will not continue to scroll. If an axis is greater than or equal to the corresponding axis of limit_end, then it will not limit scrolling for that axis. + </description> + </method> + <method name="set_limit_end"> + <return type="void"> + </return> + <argument index="0" name="ofs" type="Vector2"> + </argument> + <description> + Set the right and bottom limits in pixels for scrolling to end. If the camera is outside of this limit the background will not continue to scroll. If an axis is less than or equal to the corresponding axis of limit_begin, then it will not limit scrolling for that axis. + </description> + </method> + <method name="set_scroll_base_offset"> + <return type="void"> + </return> + <argument index="0" name="ofs" type="Vector2"> + </argument> + <description> + Set the base offset in pixels of all children [ParallaxLayer] nodes. + </description> + </method> + <method name="set_scroll_base_scale"> + <return type="void"> + </return> + <argument index="0" name="scale" type="Vector2"> + </argument> + <description> + Set the base motion scale of all children [ParallaxLayer] nodes. + </description> + </method> + <method name="set_scroll_offset"> + <return type="void"> + </return> + <argument index="0" name="ofs" type="Vector2"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="scroll_base_offset" type="Vector2" setter="set_scroll_base_offset" getter="get_scroll_base_offset"> + </member> + <member name="scroll_base_scale" type="Vector2" setter="set_scroll_base_scale" getter="get_scroll_base_scale"> + </member> + <member name="scroll_ignore_camera_zoom" type="bool" setter="set_ignore_camera_zoom" getter="is_ignore_camera_zoom"> + </member> + <member name="scroll_limit_begin" type="Vector2" setter="set_limit_begin" getter="get_limit_begin"> + </member> + <member name="scroll_limit_end" type="Vector2" setter="set_limit_end" getter="get_limit_end"> + </member> + <member name="scroll_offset" type="Vector2" setter="set_scroll_offset" getter="get_scroll_offset"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/ParallaxLayer.xml b/doc/classes/ParallaxLayer.xml new file mode 100644 index 0000000000..6cf5549c8f --- /dev/null +++ b/doc/classes/ParallaxLayer.xml @@ -0,0 +1,71 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ParallaxLayer" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + A parallax scrolling layer to be used with [ParallaxBackground]. + </brief_description> + <description> + A ParallaxLayer must be the child of a [ParallaxBackground] node. All child nodes will be affected by the parallax scrolling of this layer. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_mirroring" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the mirroring of the ParallaxLayer. + </description> + </method> + <method name="get_motion_offset" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_motion_scale" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the motion scale of the ParallaxLayer. + </description> + </method> + <method name="set_mirroring"> + <return type="void"> + </return> + <argument index="0" name="mirror" type="Vector2"> + </argument> + <description> + Set the mirroring of the ParallaxLayer. If an axis is set to 0 then that axis will have no mirroring. + </description> + </method> + <method name="set_motion_offset"> + <return type="void"> + </return> + <argument index="0" name="offset" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_motion_scale"> + <return type="void"> + </return> + <argument index="0" name="scale" type="Vector2"> + </argument> + <description> + Set the motion scale of the ParallaxLayer. If an axis is set to 0 then it will not move at all, it will stick with the camera. + </description> + </method> + </methods> + <members> + <member name="motion_mirroring" type="Vector2" setter="set_mirroring" getter="get_mirroring"> + </member> + <member name="motion_offset" type="Vector2" setter="set_motion_offset" getter="get_motion_offset"> + </member> + <member name="motion_scale" type="Vector2" setter="set_motion_scale" getter="get_motion_scale"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Particles.xml b/doc/classes/Particles.xml new file mode 100644 index 0000000000..e17e60f2bc --- /dev/null +++ b/doc/classes/Particles.xml @@ -0,0 +1,303 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Particles" inherits="GeometryInstance" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="capture_aabb" qualifiers="const"> + <return type="Rect3"> + </return> + <description> + </description> + </method> + <method name="get_amount" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_draw_order" qualifiers="const"> + <return type="int" enum="Particles.DrawOrder"> + </return> + <description> + </description> + </method> + <method name="get_draw_pass_mesh" qualifiers="const"> + <return type="Mesh"> + </return> + <argument index="0" name="pass" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_draw_passes" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_explosiveness_ratio" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_fixed_fps" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_fractional_delta" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_lifetime" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_one_shot" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_pre_process_time" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_process_material" qualifiers="const"> + <return type="Material"> + </return> + <description> + </description> + </method> + <method name="get_randomness_ratio" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_speed_scale" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_use_local_coordinates" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_visibility_aabb" qualifiers="const"> + <return type="Rect3"> + </return> + <description> + </description> + </method> + <method name="is_emitting" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="restart"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="set_amount"> + <return type="void"> + </return> + <argument index="0" name="amount" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_draw_order"> + <return type="void"> + </return> + <argument index="0" name="order" type="int" enum="Particles.DrawOrder"> + </argument> + <description> + </description> + </method> + <method name="set_draw_pass_mesh"> + <return type="void"> + </return> + <argument index="0" name="pass" type="int"> + </argument> + <argument index="1" name="mesh" type="Mesh"> + </argument> + <description> + </description> + </method> + <method name="set_draw_passes"> + <return type="void"> + </return> + <argument index="0" name="passes" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_emitting"> + <return type="void"> + </return> + <argument index="0" name="emitting" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_explosiveness_ratio"> + <return type="void"> + </return> + <argument index="0" name="ratio" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_fixed_fps"> + <return type="void"> + </return> + <argument index="0" name="fps" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_fractional_delta"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_lifetime"> + <return type="void"> + </return> + <argument index="0" name="secs" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_one_shot"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_pre_process_time"> + <return type="void"> + </return> + <argument index="0" name="secs" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_process_material"> + <return type="void"> + </return> + <argument index="0" name="material" type="Material"> + </argument> + <description> + </description> + </method> + <method name="set_randomness_ratio"> + <return type="void"> + </return> + <argument index="0" name="ratio" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_speed_scale"> + <return type="void"> + </return> + <argument index="0" name="scale" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_use_local_coordinates"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_visibility_aabb"> + <return type="void"> + </return> + <argument index="0" name="aabb" type="Rect3"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="amount" type="int" setter="set_amount" getter="get_amount"> + </member> + <member name="draw_order" type="int" setter="set_draw_order" getter="get_draw_order" enum="Particles.DrawOrder"> + </member> + <member name="draw_pass_1" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh"> + </member> + <member name="draw_pass_2" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh"> + </member> + <member name="draw_pass_3" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh"> + </member> + <member name="draw_pass_4" type="Mesh" setter="set_draw_pass_mesh" getter="get_draw_pass_mesh"> + </member> + <member name="draw_passes" type="int" setter="set_draw_passes" getter="get_draw_passes"> + </member> + <member name="emitting" type="bool" setter="set_emitting" getter="is_emitting"> + </member> + <member name="explosiveness" type="float" setter="set_explosiveness_ratio" getter="get_explosiveness_ratio"> + </member> + <member name="fixed_fps" type="int" setter="set_fixed_fps" getter="get_fixed_fps"> + </member> + <member name="fract_delta" type="bool" setter="set_fractional_delta" getter="get_fractional_delta"> + </member> + <member name="lifetime" type="float" setter="set_lifetime" getter="get_lifetime"> + </member> + <member name="local_coords" type="bool" setter="set_use_local_coordinates" getter="get_use_local_coordinates"> + </member> + <member name="one_shot" type="bool" setter="set_one_shot" getter="get_one_shot"> + </member> + <member name="preprocess" type="float" setter="set_pre_process_time" getter="get_pre_process_time"> + </member> + <member name="process_material" type="Material" setter="set_process_material" getter="get_process_material"> + </member> + <member name="randomness" type="float" setter="set_randomness_ratio" getter="get_randomness_ratio"> + </member> + <member name="speed_scale" type="float" setter="set_speed_scale" getter="get_speed_scale"> + </member> + <member name="visibility_aabb" type="Rect3" setter="set_visibility_aabb" getter="get_visibility_aabb"> + </member> + </members> + <constants> + <constant name="DRAW_ORDER_INDEX" value="0"> + </constant> + <constant name="DRAW_ORDER_LIFETIME" value="1"> + </constant> + <constant name="DRAW_ORDER_VIEW_DEPTH" value="2"> + </constant> + <constant name="MAX_DRAW_PASSES" value="4" enum=""> + </constant> + </constants> +</class> diff --git a/doc/classes/Particles2D.xml b/doc/classes/Particles2D.xml new file mode 100644 index 0000000000..d837d6eb62 --- /dev/null +++ b/doc/classes/Particles2D.xml @@ -0,0 +1,330 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Particles2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + 2D Particle emitter + </brief_description> + <description> + Particles2D is a particle system 2D [Node] that is used to simulate several types of particle effects, such as explosions, rain, snow, fireflies, or other magical-like shinny sparkles. Particles are drawn using impostors, and given their dynamic behavior, the user must provide a visibility bounding box (although helpers to create one automatically exist). + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="capture_rect" qualifiers="const"> + <return type="Rect2"> + </return> + <description> + </description> + </method> + <method name="get_amount" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the amount of particles spawned at each emission + </description> + </method> + <method name="get_draw_order" qualifiers="const"> + <return type="int" enum="Particles2D.DrawOrder"> + </return> + <description> + </description> + </method> + <method name="get_explosiveness_ratio" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_fixed_fps" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_fractional_delta" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_h_frames" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_lifetime" qualifiers="const"> + <return type="float"> + </return> + <description> + Gets the amount of seconds that each particle will be visible. + </description> + </method> + <method name="get_normal_map" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="get_one_shot" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_pre_process_time" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_process_material" qualifiers="const"> + <return type="Material"> + </return> + <description> + </description> + </method> + <method name="get_randomness_ratio" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_speed_scale" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_texture" qualifiers="const"> + <return type="Texture"> + </return> + <description> + Returns the texture for emitted particles + </description> + </method> + <method name="get_use_local_coordinates" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_v_frames" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_visibility_rect" qualifiers="const"> + <return type="Rect2"> + </return> + <description> + </description> + </method> + <method name="is_emitting" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns whether this emitter is currently emitting or not + </description> + </method> + <method name="restart"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="set_amount"> + <return type="void"> + </return> + <argument index="0" name="amount" type="int"> + </argument> + <description> + Sets the amount of particles spawned at each emission + </description> + </method> + <method name="set_draw_order"> + <return type="void"> + </return> + <argument index="0" name="order" type="int" enum="Particles2D.DrawOrder"> + </argument> + <description> + </description> + </method> + <method name="set_emitting"> + <return type="void"> + </return> + <argument index="0" name="emitting" type="bool"> + </argument> + <description> + If this is set to true then the particle emitter will emit particles, if its false it will not. + </description> + </method> + <method name="set_explosiveness_ratio"> + <return type="void"> + </return> + <argument index="0" name="ratio" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_fixed_fps"> + <return type="void"> + </return> + <argument index="0" name="fps" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_fractional_delta"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_h_frames"> + <return type="void"> + </return> + <argument index="0" name="frames" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_lifetime"> + <return type="void"> + </return> + <argument index="0" name="secs" type="float"> + </argument> + <description> + Sets the amount of seconds that each particle will be visible. + </description> + </method> + <method name="set_normal_map"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_one_shot"> + <return type="void"> + </return> + <argument index="0" name="secs" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_pre_process_time"> + <return type="void"> + </return> + <argument index="0" name="secs" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_process_material"> + <return type="void"> + </return> + <argument index="0" name="material" type="Material"> + </argument> + <description> + </description> + </method> + <method name="set_randomness_ratio"> + <return type="void"> + </return> + <argument index="0" name="ratio" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_speed_scale"> + <return type="void"> + </return> + <argument index="0" name="scale" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_texture"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_use_local_coordinates"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_v_frames"> + <return type="void"> + </return> + <argument index="0" name="frames" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_visibility_rect"> + <return type="void"> + </return> + <argument index="0" name="aabb" type="Rect2"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="amount" type="int" setter="set_amount" getter="get_amount"> + </member> + <member name="draw_order" type="int" setter="set_draw_order" getter="get_draw_order" enum="Particles2D.DrawOrder"> + </member> + <member name="emitting" type="bool" setter="set_emitting" getter="is_emitting"> + </member> + <member name="explosiveness" type="float" setter="set_explosiveness_ratio" getter="get_explosiveness_ratio"> + </member> + <member name="fixed_fps" type="int" setter="set_fixed_fps" getter="get_fixed_fps"> + </member> + <member name="fract_delta" type="bool" setter="set_fractional_delta" getter="get_fractional_delta"> + </member> + <member name="h_frames" type="int" setter="set_h_frames" getter="get_h_frames"> + </member> + <member name="lifetime" type="float" setter="set_lifetime" getter="get_lifetime"> + </member> + <member name="local_coords" type="bool" setter="set_use_local_coordinates" getter="get_use_local_coordinates"> + </member> + <member name="normal_map" type="Texture" setter="set_normal_map" getter="get_normal_map"> + </member> + <member name="one_shot" type="bool" setter="set_one_shot" getter="get_one_shot"> + </member> + <member name="preprocess" type="float" setter="set_pre_process_time" getter="get_pre_process_time"> + </member> + <member name="process_material" type="Material" setter="set_process_material" getter="get_process_material"> + </member> + <member name="randomness" type="float" setter="set_randomness_ratio" getter="get_randomness_ratio"> + </member> + <member name="speed_scale" type="float" setter="set_speed_scale" getter="get_speed_scale"> + </member> + <member name="texture" type="Texture" setter="set_texture" getter="get_texture"> + </member> + <member name="v_frames" type="int" setter="set_v_frames" getter="get_v_frames"> + </member> + <member name="visibility_rect" type="Rect2" setter="set_visibility_rect" getter="get_visibility_rect"> + </member> + </members> + <constants> + <constant name="DRAW_ORDER_INDEX" value="0"> + </constant> + <constant name="DRAW_ORDER_LIFETIME" value="1"> + </constant> + </constants> +</class> diff --git a/doc/classes/ParticlesMaterial.xml b/doc/classes/ParticlesMaterial.xml new file mode 100644 index 0000000000..1767a19a9f --- /dev/null +++ b/doc/classes/ParticlesMaterial.xml @@ -0,0 +1,449 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ParticlesMaterial" inherits="Material" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_color_ramp" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="get_emission_box_extents" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_emission_color_texture" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="get_emission_normal_texture" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="get_emission_point_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_emission_point_texture" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="get_emission_shape" qualifiers="const"> + <return type="int" enum="ParticlesMaterial.EmissionShape"> + </return> + <description> + </description> + </method> + <method name="get_emission_sphere_radius" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_flag" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="flag" type="int" enum="ParticlesMaterial.Flags"> + </argument> + <description> + </description> + </method> + <method name="get_flatness" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_gravity" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_param" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter"> + </argument> + <description> + </description> + </method> + <method name="get_param_randomness" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter"> + </argument> + <description> + </description> + </method> + <method name="get_param_texture" qualifiers="const"> + <return type="Texture"> + </return> + <argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter"> + </argument> + <description> + </description> + </method> + <method name="get_spread" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_trail_color_modifier" qualifiers="const"> + <return type="GradientTexture"> + </return> + <description> + </description> + </method> + <method name="get_trail_divisor" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_trail_size_modifier" qualifiers="const"> + <return type="CurveTexture"> + </return> + <description> + </description> + </method> + <method name="set_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_color_ramp"> + <return type="void"> + </return> + <argument index="0" name="ramp" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_emission_box_extents"> + <return type="void"> + </return> + <argument index="0" name="extents" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="set_emission_color_texture"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_emission_normal_texture"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_emission_point_count"> + <return type="void"> + </return> + <argument index="0" name="point_count" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_emission_point_texture"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_emission_shape"> + <return type="void"> + </return> + <argument index="0" name="shape" type="int" enum="ParticlesMaterial.EmissionShape"> + </argument> + <description> + </description> + </method> + <method name="set_emission_sphere_radius"> + <return type="void"> + </return> + <argument index="0" name="radius" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_flag"> + <return type="void"> + </return> + <argument index="0" name="flag" type="int" enum="ParticlesMaterial.Flags"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_flatness"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_gravity"> + <return type="void"> + </return> + <argument index="0" name="accel_vec" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="set_param"> + <return type="void"> + </return> + <argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter"> + </argument> + <argument index="1" name="value" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_param_randomness"> + <return type="void"> + </return> + <argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter"> + </argument> + <argument index="1" name="randomness" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_param_texture"> + <return type="void"> + </return> + <argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter"> + </argument> + <argument index="1" name="texture" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_spread"> + <return type="void"> + </return> + <argument index="0" name="degrees" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_trail_color_modifier"> + <return type="void"> + </return> + <argument index="0" name="texture" type="GradientTexture"> + </argument> + <description> + </description> + </method> + <method name="set_trail_divisor"> + <return type="void"> + </return> + <argument index="0" name="divisor" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_trail_size_modifier"> + <return type="void"> + </return> + <argument index="0" name="texture" type="CurveTexture"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="angle" type="float" setter="set_param" getter="get_param"> + </member> + <member name="angle_curve" type="Texture" setter="set_param_texture" getter="get_param_texture"> + </member> + <member name="angle_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + </member> + <member name="angular_velocity" type="float" setter="set_param" getter="get_param"> + </member> + <member name="angular_velocity_curve" type="Texture" setter="set_param_texture" getter="get_param_texture"> + </member> + <member name="angular_velocity_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + </member> + <member name="anim_loop" type="bool" setter="set_flag" getter="get_flag"> + </member> + <member name="anim_offset" type="float" setter="set_param" getter="get_param"> + </member> + <member name="anim_offset_curve" type="Texture" setter="set_param_texture" getter="get_param_texture"> + </member> + <member name="anim_offset_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + </member> + <member name="anim_speed" type="float" setter="set_param" getter="get_param"> + </member> + <member name="anim_speed_curve" type="Texture" setter="set_param_texture" getter="get_param_texture"> + </member> + <member name="anim_speed_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + </member> + <member name="color" type="Color" setter="set_color" getter="get_color"> + </member> + <member name="color_ramp" type="Texture" setter="set_color_ramp" getter="get_color_ramp"> + </member> + <member name="damping" type="float" setter="set_param" getter="get_param"> + </member> + <member name="damping_curve" type="Texture" setter="set_param_texture" getter="get_param_texture"> + </member> + <member name="damping_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + </member> + <member name="emission_box_extents" type="Vector3" setter="set_emission_box_extents" getter="get_emission_box_extents"> + </member> + <member name="emission_color_texture" type="Texture" setter="set_emission_color_texture" getter="get_emission_color_texture"> + </member> + <member name="emission_normal_texture" type="Texture" setter="set_emission_normal_texture" getter="get_emission_normal_texture"> + </member> + <member name="emission_point_count" type="int" setter="set_emission_point_count" getter="get_emission_point_count"> + </member> + <member name="emission_point_texture" type="Texture" setter="set_emission_point_texture" getter="get_emission_point_texture"> + </member> + <member name="emission_shape" type="int" setter="set_emission_shape" getter="get_emission_shape" enum="ParticlesMaterial.EmissionShape"> + </member> + <member name="emission_sphere_radius" type="float" setter="set_emission_sphere_radius" getter="get_emission_sphere_radius"> + </member> + <member name="flag_align_y" type="bool" setter="set_flag" getter="get_flag"> + </member> + <member name="flag_disable_z" type="bool" setter="set_flag" getter="get_flag"> + </member> + <member name="flag_rotate_y" type="bool" setter="set_flag" getter="get_flag"> + </member> + <member name="flatness" type="float" setter="set_flatness" getter="get_flatness"> + </member> + <member name="gravity" type="Vector3" setter="set_gravity" getter="get_gravity"> + </member> + <member name="hue_variation" type="float" setter="set_param" getter="get_param"> + </member> + <member name="hue_variation_curve" type="Texture" setter="set_param_texture" getter="get_param_texture"> + </member> + <member name="hue_variation_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + </member> + <member name="initial_velocity" type="float" setter="set_param" getter="get_param"> + </member> + <member name="initial_velocity_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + </member> + <member name="linear_accel" type="float" setter="set_param" getter="get_param"> + </member> + <member name="linear_accel_curve" type="Texture" setter="set_param_texture" getter="get_param_texture"> + </member> + <member name="linear_accel_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + </member> + <member name="orbit_velocity" type="float" setter="set_param" getter="get_param"> + </member> + <member name="orbit_velocity_curve" type="Texture" setter="set_param_texture" getter="get_param_texture"> + </member> + <member name="orbit_velocity_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + </member> + <member name="radial_accel" type="float" setter="set_param" getter="get_param"> + </member> + <member name="radial_accel_curve" type="Texture" setter="set_param_texture" getter="get_param_texture"> + </member> + <member name="radial_accel_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + </member> + <member name="scale" type="float" setter="set_param" getter="get_param"> + </member> + <member name="scale_curve" type="Texture" setter="set_param_texture" getter="get_param_texture"> + </member> + <member name="scale_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + </member> + <member name="spread" type="float" setter="set_spread" getter="get_spread"> + </member> + <member name="tangential_accel" type="float" setter="set_param" getter="get_param"> + </member> + <member name="tangential_accel_curve" type="Texture" setter="set_param_texture" getter="get_param_texture"> + </member> + <member name="tangential_accel_random" type="float" setter="set_param_randomness" getter="get_param_randomness"> + </member> + <member name="trail_color_modifier" type="GradientTexture" setter="set_trail_color_modifier" getter="get_trail_color_modifier"> + </member> + <member name="trail_divisor" type="int" setter="set_trail_divisor" getter="get_trail_divisor"> + </member> + <member name="trail_size_modifier" type="CurveTexture" setter="set_trail_size_modifier" getter="get_trail_size_modifier"> + </member> + </members> + <constants> + <constant name="PARAM_INITIAL_LINEAR_VELOCITY" value="0"> + </constant> + <constant name="PARAM_ANGULAR_VELOCITY" value="1"> + </constant> + <constant name="PARAM_ORBIT_VELOCITY" value="2"> + </constant> + <constant name="PARAM_LINEAR_ACCEL" value="3"> + </constant> + <constant name="PARAM_RADIAL_ACCEL" value="4"> + </constant> + <constant name="PARAM_TANGENTIAL_ACCEL" value="5"> + </constant> + <constant name="PARAM_DAMPING" value="6"> + </constant> + <constant name="PARAM_ANGLE" value="7"> + </constant> + <constant name="PARAM_SCALE" value="8"> + </constant> + <constant name="PARAM_HUE_VARIATION" value="9"> + </constant> + <constant name="PARAM_ANIM_SPEED" value="10"> + </constant> + <constant name="PARAM_ANIM_OFFSET" value="11"> + </constant> + <constant name="PARAM_MAX" value="12"> + </constant> + <constant name="FLAG_ALIGN_Y_TO_VELOCITY" value="0"> + </constant> + <constant name="FLAG_ROTATE_Y" value="1"> + </constant> + <constant name="FLAG_MAX" value="4"> + </constant> + <constant name="EMISSION_SHAPE_POINT" value="0"> + </constant> + <constant name="EMISSION_SHAPE_SPHERE" value="1"> + </constant> + <constant name="EMISSION_SHAPE_BOX" value="2"> + </constant> + <constant name="EMISSION_SHAPE_POINTS" value="3"> + </constant> + <constant name="EMISSION_SHAPE_DIRECTED_POINTS" value="4"> + </constant> + </constants> +</class> diff --git a/doc/classes/Path.xml b/doc/classes/Path.xml new file mode 100644 index 0000000000..97543418b9 --- /dev/null +++ b/doc/classes/Path.xml @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Path" inherits="Spatial" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Container for a [Curve3D]. + </brief_description> + <description> + This class is a container/Node-ification of a [Curve3D], so it can have [Spatial] properties and [Node] info. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_curve" qualifiers="const"> + <return type="Curve3D"> + </return> + <description> + Returns the [Curve3D] contained. + </description> + </method> + <method name="set_curve"> + <return type="void"> + </return> + <argument index="0" name="curve" type="Curve3D"> + </argument> + <description> + Sets the [Curve3D]. + </description> + </method> + </methods> + <members> + <member name="curve" type="Curve3D" setter="set_curve" getter="get_curve"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Path2D.xml b/doc/classes/Path2D.xml new file mode 100644 index 0000000000..839e617375 --- /dev/null +++ b/doc/classes/Path2D.xml @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Path2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Container for a [Curve2D]. + </brief_description> + <description> + This class is a container/Node-ification of a [Curve2D], so it can have [Node2D] properties and [Node] info. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_curve" qualifiers="const"> + <return type="Curve2D"> + </return> + <description> + Returns the [Curve2D] contained. + </description> + </method> + <method name="set_curve"> + <return type="void"> + </return> + <argument index="0" name="curve" type="Curve2D"> + </argument> + <description> + Sets the [Curve2D]. + </description> + </method> + </methods> + <members> + <member name="curve" type="Curve2D" setter="set_curve" getter="get_curve"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/PathFollow.xml b/doc/classes/PathFollow.xml new file mode 100644 index 0000000000..86f55a2aaf --- /dev/null +++ b/doc/classes/PathFollow.xml @@ -0,0 +1,145 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PathFollow" inherits="Spatial" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Point sampler for a [Path]. + </brief_description> + <description> + This node takes its parent [Path], and returns the coordinates of a point within it, given a distance from the first vertex. + It is useful for making other nodes follow a path, without coding the movement pattern. For that, the nodes must be descendants of this node. Then, when setting an offset in this node, the descendant nodes will move accordingly. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_cubic_interpolation" qualifiers="const"> + <return type="bool"> + </return> + <description> + This method returns whether the position between two cached points (see [method set_cubic_interpolation]) is interpolated linearly, or cubicly. + </description> + </method> + <method name="get_h_offset" qualifiers="const"> + <return type="float"> + </return> + <description> + Returns the X displacement this node has from its parent [Path]. + </description> + </method> + <method name="get_offset" qualifiers="const"> + <return type="float"> + </return> + <description> + Returns the distance along the path in 3D units. + </description> + </method> + <method name="get_rotation_mode" qualifiers="const"> + <return type="int" enum="PathFollow.RotationMode"> + </return> + <description> + Returns the rotation mode. The constants below list which axes are allowed to rotate for each mode. + </description> + </method> + <method name="get_unit_offset" qualifiers="const"> + <return type="float"> + </return> + <description> + Returns the distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last). + </description> + </method> + <method name="get_v_offset" qualifiers="const"> + <return type="float"> + </return> + <description> + Returns the Y displacement this node has from its parent [Path]. + </description> + </method> + <method name="has_loop" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns whether this node wraps its offsets around, or truncates them to the path ends. + </description> + </method> + <method name="set_cubic_interpolation"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + The points along the [Curve3D] of the [Path] are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. + There are two answers to this problem: Either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations. + This method controls whether the position between two cached points is interpolated linearly, or cubicly. + </description> + </method> + <method name="set_h_offset"> + <return type="void"> + </return> + <argument index="0" name="h_offset" type="float"> + </argument> + <description> + Moves this node in the X axis. As this node's position will be set every time its offset is set, this allows many PathFollow to share the same curve (and thus the same movement pattern), yet not return the same position for a given path offset. + A similar effect may be achieved moving the this node's descendants. + </description> + </method> + <method name="set_loop"> + <return type="void"> + </return> + <argument index="0" name="loop" type="bool"> + </argument> + <description> + If set, any offset outside the path's length (whether set by [method set_offset] or [method set_unit_offset] will wrap around, instead of stopping at the ends. Set it for cyclic paths. + </description> + </method> + <method name="set_offset"> + <return type="void"> + </return> + <argument index="0" name="offset" type="float"> + </argument> + <description> + Sets the distance from the first vertex, measured in 3D units along the path. This sets this node's position to a point within the path. + </description> + </method> + <method name="set_rotation_mode"> + <return type="void"> + </return> + <argument index="0" name="rotation_mode" type="int" enum="PathFollow.RotationMode"> + </argument> + <description> + Allows or forbids rotation on one or more axes, per the constants below. + </description> + </method> + <method name="set_unit_offset"> + <return type="void"> + </return> + <argument index="0" name="unit_offset" type="float"> + </argument> + <description> + Sets the distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length. + </description> + </method> + <method name="set_v_offset"> + <return type="void"> + </return> + <argument index="0" name="v_offset" type="float"> + </argument> + <description> + Moves this node in the Y axis, for the same reasons of [method set_h_offset]. + </description> + </method> + </methods> + <constants> + <constant name="ROTATION_NONE" value="0"> + Forbids the PathFollow to rotate. + </constant> + <constant name="ROTATION_Y" value="1"> + Allows the PathFollow to rotate in the Y axis only. + </constant> + <constant name="ROTATION_XY" value="2"> + Allows the PathFollow to rotate in both the X, and Y axes. + </constant> + <constant name="ROTATION_XYZ" value="3"> + Allows the PathFollow to rotate in any axis. + </constant> + </constants> +</class> diff --git a/doc/classes/PathFollow2D.xml b/doc/classes/PathFollow2D.xml new file mode 100644 index 0000000000..850b81c046 --- /dev/null +++ b/doc/classes/PathFollow2D.xml @@ -0,0 +1,133 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PathFollow2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Point sampler for a [Path2D]. + </brief_description> + <description> + This node takes its parent [Path2D], and returns the coordinates of a point within it, given a distance from the first vertex. + It is useful for making other nodes follow a path, without coding the movement pattern. For that, the nodes must be descendants of this node. Then, when setting an offset in this node, the descendant nodes will move accordingly. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_cubic_interpolation" qualifiers="const"> + <return type="bool"> + </return> + <description> + This method returns whether the position between two cached points (see [method set_cubic_interpolation]) is interpolated linearly, or cubicly. + </description> + </method> + <method name="get_h_offset" qualifiers="const"> + <return type="float"> + </return> + <description> + Returns the horizontal displacement this node has from its parent [Path2D]. + </description> + </method> + <method name="get_offset" qualifiers="const"> + <return type="float"> + </return> + <description> + Returns the distance along the path in pixels. + </description> + </method> + <method name="get_unit_offset" qualifiers="const"> + <return type="float"> + </return> + <description> + Returns the distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last). + </description> + </method> + <method name="get_v_offset" qualifiers="const"> + <return type="float"> + </return> + <description> + Returns the vertical displacement this node has from its parent [Path2D]. + </description> + </method> + <method name="has_loop" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns whether this node wraps its offsets around, or truncates them to the path ends. + </description> + </method> + <method name="is_rotating" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns whether this node rotates to follow the path. + </description> + </method> + <method name="set_cubic_interpolation"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + The points along the [Curve2D] of the [Path2D] are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. + There are two answers to this problem: Either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations. + This method controls whether the position between two cached points is interpolated linearly, or cubicly. + </description> + </method> + <method name="set_h_offset"> + <return type="void"> + </return> + <argument index="0" name="h_offset" type="float"> + </argument> + <description> + Moves this node horizontally. As this node's position will be set every time its offset is set, this allows many PathFollow2D to share the same curve (and thus the same movement pattern), yet not return the same position for a given path offset. + A similar effect may be achieved moving this node's descendants. + </description> + </method> + <method name="set_loop"> + <return type="void"> + </return> + <argument index="0" name="loop" type="bool"> + </argument> + <description> + If set, any offset outside the path's length (whether set by [method set_offset] or [method set_unit_offset] will wrap around, instead of stopping at the ends. Set it for cyclic paths. + </description> + </method> + <method name="set_offset"> + <return type="void"> + </return> + <argument index="0" name="offset" type="float"> + </argument> + <description> + Sets the distance from the first vertex, measured in pixels along the path. This sets this node's position to a point within the path. + </description> + </method> + <method name="set_rotate"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + If set, this node rotates to follow the path, making its descendants rotate. + </description> + </method> + <method name="set_unit_offset"> + <return type="void"> + </return> + <argument index="0" name="unit_offset" type="float"> + </argument> + <description> + Sets the distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length. + </description> + </method> + <method name="set_v_offset"> + <return type="void"> + </return> + <argument index="0" name="v_offset" type="float"> + </argument> + <description> + Moves the PathFollow2D vertically, for the same reasons of [method set_h_offset]. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Performance.xml b/doc/classes/Performance.xml new file mode 100644 index 0000000000..71987ace9e --- /dev/null +++ b/doc/classes/Performance.xml @@ -0,0 +1,79 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Performance" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_monitor" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="monitor" type="int" enum="Performance.Monitor"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + <constant name="TIME_FPS" value="0"> + </constant> + <constant name="TIME_PROCESS" value="1"> + </constant> + <constant name="TIME_FIXED_PROCESS" value="2"> + </constant> + <constant name="MEMORY_STATIC" value="3"> + </constant> + <constant name="MEMORY_DYNAMIC" value="4"> + </constant> + <constant name="MEMORY_STATIC_MAX" value="5"> + </constant> + <constant name="MEMORY_DYNAMIC_MAX" value="6"> + </constant> + <constant name="MEMORY_MESSAGE_BUFFER_MAX" value="7"> + </constant> + <constant name="OBJECT_COUNT" value="8"> + </constant> + <constant name="OBJECT_RESOURCE_COUNT" value="9"> + </constant> + <constant name="OBJECT_NODE_COUNT" value="10"> + </constant> + <constant name="RENDER_OBJECTS_IN_FRAME" value="11"> + </constant> + <constant name="RENDER_VERTICES_IN_FRAME" value="12"> + </constant> + <constant name="RENDER_MATERIAL_CHANGES_IN_FRAME" value="13"> + </constant> + <constant name="RENDER_SHADER_CHANGES_IN_FRAME" value="14"> + </constant> + <constant name="RENDER_SURFACE_CHANGES_IN_FRAME" value="15"> + </constant> + <constant name="RENDER_DRAW_CALLS_IN_FRAME" value="16"> + </constant> + <constant name="RENDER_USAGE_VIDEO_MEM_TOTAL" value="20"> + </constant> + <constant name="RENDER_VIDEO_MEM_USED" value="17"> + </constant> + <constant name="RENDER_TEXTURE_MEM_USED" value="18"> + </constant> + <constant name="RENDER_VERTEX_MEM_USED" value="19"> + </constant> + <constant name="PHYSICS_2D_ACTIVE_OBJECTS" value="21"> + </constant> + <constant name="PHYSICS_2D_COLLISION_PAIRS" value="22"> + </constant> + <constant name="PHYSICS_2D_ISLAND_COUNT" value="23"> + </constant> + <constant name="PHYSICS_3D_ACTIVE_OBJECTS" value="24"> + </constant> + <constant name="PHYSICS_3D_COLLISION_PAIRS" value="25"> + </constant> + <constant name="PHYSICS_3D_ISLAND_COUNT" value="26"> + </constant> + <constant name="MONITOR_MAX" value="27"> + </constant> + </constants> +</class> diff --git a/doc/classes/Physics2DDirectBodyState.xml b/doc/classes/Physics2DDirectBodyState.xml new file mode 100644 index 0000000000..9b6fe69b4a --- /dev/null +++ b/doc/classes/Physics2DDirectBodyState.xml @@ -0,0 +1,234 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Physics2DDirectBodyState" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Direct access object to a physics body in the [Physics2DServer]. + </brief_description> + <description> + Direct access object to a physics body in the [Physics2DServer]. This object is passed via the direct state callback of rigid/character bodies, and is intended for changing the direct state of that body. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_angular_velocity" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the angular velocity of the body. + </description> + </method> + <method name="get_contact_collider" qualifiers="const"> + <return type="RID"> + </return> + <argument index="0" name="contact_idx" type="int"> + </argument> + <description> + Return the [RID] of the collider. + </description> + </method> + <method name="get_contact_collider_id" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="contact_idx" type="int"> + </argument> + <description> + Return the object id of the collider. + </description> + </method> + <method name="get_contact_collider_object" qualifiers="const"> + <return type="Object"> + </return> + <argument index="0" name="contact_idx" type="int"> + </argument> + <description> + Return the collider object, this depends on how it was created (will return a scene node if such was used to create it). + </description> + </method> + <method name="get_contact_collider_pos" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="contact_idx" type="int"> + </argument> + <description> + Return the contact position in the collider. + </description> + </method> + <method name="get_contact_collider_shape" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="contact_idx" type="int"> + </argument> + <description> + Return the collider shape index. + </description> + </method> + <method name="get_contact_collider_shape_metadata" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="contact_idx" type="int"> + </argument> + <description> + Return the metadata of the collided shape. This metadata is different from [method Object.get_meta], and is set with [method Physics2DServer.shape_set_data]. + </description> + </method> + <method name="get_contact_collider_velocity_at_pos" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="contact_idx" type="int"> + </argument> + <description> + Return the linear velocity vector at contact point of the collider. + </description> + </method> + <method name="get_contact_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the amount of contacts this body has with other bodies. Note that by default this returns 0 unless bodies are configured to log contacts. + </description> + </method> + <method name="get_contact_local_normal" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="contact_idx" type="int"> + </argument> + <description> + Return the local normal (of this body) of the contact point. + </description> + </method> + <method name="get_contact_local_pos" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="contact_idx" type="int"> + </argument> + <description> + Return the local position (of this body) of the contact point. + </description> + </method> + <method name="get_contact_local_shape" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="contact_idx" type="int"> + </argument> + <description> + Return the local shape index of the collision. + </description> + </method> + <method name="get_inverse_inertia" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the inverse of the inertia of the body. + </description> + </method> + <method name="get_inverse_mass" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the inverse of the mass of the body. + </description> + </method> + <method name="get_linear_velocity" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the current linear velocity of the body. + </description> + </method> + <method name="get_space_state"> + <return type="Physics2DDirectSpaceState"> + </return> + <description> + Return the current state of space, useful for queries. + </description> + </method> + <method name="get_step" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the timestep (delta) used for the simulation. + </description> + </method> + <method name="get_total_angular_damp" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the rate at which the body stops rotating, if there are not any other forces moving it. + </description> + </method> + <method name="get_total_gravity" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the total gravity vector being currently applied to this body. + </description> + </method> + <method name="get_total_linear_damp" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the rate at which the body stops moving, if there are not any other forces moving it. + </description> + </method> + <method name="get_transform" qualifiers="const"> + <return type="Transform2D"> + </return> + <description> + Return the transform matrix of the body. + </description> + </method> + <method name="integrate_forces"> + <return type="void"> + </return> + <description> + Call the built-in force integration code. + </description> + </method> + <method name="is_sleeping" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if this body is currently sleeping (not active). + </description> + </method> + <method name="set_angular_velocity"> + <return type="void"> + </return> + <argument index="0" name="velocity" type="float"> + </argument> + <description> + Change the angular velocity of the body. + </description> + </method> + <method name="set_linear_velocity"> + <return type="void"> + </return> + <argument index="0" name="velocity" type="Vector2"> + </argument> + <description> + Change the linear velocity of the body. + </description> + </method> + <method name="set_sleep_state"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Set the sleeping state of the body, only affects character/rigid bodies. + </description> + </method> + <method name="set_transform"> + <return type="void"> + </return> + <argument index="0" name="transform" type="Transform2D"> + </argument> + <description> + Change the transform matrix of the body. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Physics2DDirectBodyStateSW.xml b/doc/classes/Physics2DDirectBodyStateSW.xml new file mode 100644 index 0000000000..c2444d4795 --- /dev/null +++ b/doc/classes/Physics2DDirectBodyStateSW.xml @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Physics2DDirectBodyStateSW" inherits="Physics2DDirectBodyState" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Software implementation of [Physics2DDirectBodyState]. + </brief_description> + <description> + Software implementation of [Physics2DDirectBodyState]. This object exposes no new methods or properties and should not be used, as [Physics2DDirectBodyState] selects the best implementation available. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Physics2DDirectSpaceState.xml b/doc/classes/Physics2DDirectSpaceState.xml new file mode 100644 index 0000000000..9399227d27 --- /dev/null +++ b/doc/classes/Physics2DDirectSpaceState.xml @@ -0,0 +1,140 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Physics2DDirectSpaceState" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Direct access object to a space in the [Physics2DServer]. + </brief_description> + <description> + Direct access object to a space in the [Physics2DServer]. It's used mainly to do queries against objects and areas residing in a given space. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="cast_motion"> + <return type="Array"> + </return> + <argument index="0" name="shape" type="Physics2DShapeQueryParameters"> + </argument> + <description> + Check whether the shape can travel to a point. If it can, the method will return an array with two floats: The first is the distance the shape can move in that direction without colliding, and the second is the distance at which it will collide. + If the shape can not move, the array will be empty. + </description> + </method> + <method name="collide_shape"> + <return type="Array"> + </return> + <argument index="0" name="shape" type="Physics2DShapeQueryParameters"> + </argument> + <argument index="1" name="max_results" type="int" default="32"> + </argument> + <description> + Check the intersections of a shape, given through a [Physics2DShapeQueryParameters] object, against the space. The resulting array contains a list of points where the shape intersects another. Like with [method intersect_shape], the number of returned results can be limited to save processing time. + </description> + </method> + <method name="get_rest_info"> + <return type="Dictionary"> + </return> + <argument index="0" name="shape" type="Physics2DShapeQueryParameters"> + </argument> + <description> + Check the intersections of a shape, given through a [Physics2DShapeQueryParameters] object, against the space. If it collides with more than a shape, the nearest one is selected. The returned object is a dictionary containing the following fields: + pointo: Place where the shapes intersect. + normal: Normal of the object at the point where the shapes intersect. + shape: Shape index within the object against which the shape intersected. + metadata: Metadata of the shape against which the shape intersected. This metadata is different from [method Object.get_meta], and is set with [method Physics2DServer.shape_set_data]. + collider_id: Id of the object against which the shape intersected. + collider: Object against which the shape intersected. + rid: [RID] of the object against which the shape intersected. + linear_velocity: The movement vector of the object the shape intersected, if it was a body. If it was an area, it is (0,0). + If the shape did not intersect anything, then an empty dictionary (dir.empty()==true) is returned instead. + </description> + </method> + <method name="intersect_point"> + <return type="Array"> + </return> + <argument index="0" name="point" type="Vector2"> + </argument> + <argument index="1" name="max_results" type="int" default="32"> + </argument> + <argument index="2" name="exclude" type="Array" default="[ ]"> + </argument> + <argument index="3" name="collision_layer" type="int" default="2147483647"> + </argument> + <argument index="4" name="type_mask" type="int" default="15"> + </argument> + <description> + Check whether a point is inside any shape. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: + shape: Shape index within the object the point is in. + metadata: Metadata of the shape the point is in. This metadata is different from [method Object.get_meta], and is set with [method Physics2DServer.shape_set_data]. + collider_id: Id of the object the point is in. + collider: Object the point is inside of. + rid: [RID] of the object the point is in. + Additionally, the method can take an array of objects or [RID]\ s that are to be excluded from collisions, a bitmask representing the physics layers to check in, and another bitmask for the types of objects to check (see TYPE_MASK_* constants). + </description> + </method> + <method name="intersect_ray"> + <return type="Dictionary"> + </return> + <argument index="0" name="from" type="Vector2"> + </argument> + <argument index="1" name="to" type="Vector2"> + </argument> + <argument index="2" name="exclude" type="Array" default="[ ]"> + </argument> + <argument index="3" name="collision_layer" type="int" default="2147483647"> + </argument> + <argument index="4" name="type_mask" type="int" default="15"> + </argument> + <description> + Intersect a ray in a given space. The returned object is a dictionary with the following fields: + position: Place where ray is stopped. + normal: Normal of the object at the point where the ray was stopped. + shape: Shape index within the object against which the ray was stopped. + metadata: Metadata of the shape against which the ray was stopped. This metadata is different from [method Object.get_meta], and is set with [method Physics2DServer.shape_set_data]. + collider_id: Id of the object against which the ray was stopped. + collider: Object against which the ray was stopped. + rid: [RID] of the object against which the ray was stopped. + If the ray did not intersect anything, then an empty dictionary (dir.empty()==true) is returned instead. + Additionally, the method can take an array of objects or [RID]\ s that are to be excluded from collisions, a bitmask representing the physics layers to check in, and another bitmask for the types of objects to check (see TYPE_MASK_* constants). + </description> + </method> + <method name="intersect_shape"> + <return type="Array"> + </return> + <argument index="0" name="shape" type="Physics2DShapeQueryParameters"> + </argument> + <argument index="1" name="max_results" type="int" default="32"> + </argument> + <description> + Check the intersections of a shape, given through a [Physics2DShapeQueryParameters] object, against the space. The intersected shapes are returned in an array containing dictionaries with the following fields: + shape: Shape index within the object the shape intersected. + metadata: Metadata of the shape intersected by the shape given through the [Physics2DShapeQueryParameters]. This metadata is different from [method Object.get_meta], and is set with [method Physics2DServer.shape_set_data]. + collider_id: Id of the object the shape intersected. + collider: Object the shape intersected. + rid: [RID] of the object the shape intersected. + The number of intersections can be limited with the second parameter, to reduce the processing time. + </description> + </method> + </methods> + <constants> + <constant name="TYPE_MASK_STATIC_BODY" value="1"> + Check for collisions with static bodies. + </constant> + <constant name="TYPE_MASK_KINEMATIC_BODY" value="2"> + Check for collisions with kinematic bodies. + </constant> + <constant name="TYPE_MASK_RIGID_BODY" value="4"> + Check for collisions with rigid bodies. + </constant> + <constant name="TYPE_MASK_CHARACTER_BODY" value="8"> + Check for collisions with rigid bodies in character mode. + </constant> + <constant name="TYPE_MASK_AREA" value="16"> + Check for collisions with areas. + </constant> + <constant name="TYPE_MASK_COLLISION" value="15"> + Check for collisions with any kind of bodies (but not areas). + </constant> + </constants> +</class> diff --git a/doc/classes/Physics2DServer.xml b/doc/classes/Physics2DServer.xml new file mode 100644 index 0000000000..ab63089691 --- /dev/null +++ b/doc/classes/Physics2DServer.xml @@ -0,0 +1,1121 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Physics2DServer" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Physics 2D Server. + </brief_description> + <description> + Physics 2D Server is the server responsible for all 2D physics. It can create many kinds of physics objects, but does not insert them on the node tree. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="area_add_shape"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="shape" type="RID"> + </argument> + <argument index="2" name="transform" type="Transform2D" default="Transform2D( 1, 0, 0, 1, 0, 0 )"> + </argument> + <description> + Add a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. + </description> + </method> + <method name="area_attach_object_instance_id"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="id" type="int"> + </argument> + <description> + Assign the area to a descendant of [Object], so it can exist in the node tree. + </description> + </method> + <method name="area_clear_shapes"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <description> + Remove all shapes from an area. It does not delete the shapes, so they can be reassigned later. + </description> + </method> + <method name="area_create"> + <return type="RID"> + </return> + <description> + Create an [Area2D]. + </description> + </method> + <method name="area_get_object_instance_id" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <description> + Get the instance ID of the object the area is assigned to. + </description> + </method> + <method name="area_get_param" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="param" type="int" enum="Physics2DServer.AreaParameter"> + </argument> + <description> + Return an area parameter value. + </description> + </method> + <method name="area_get_shape" qualifiers="const"> + <return type="RID"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="shape_idx" type="int"> + </argument> + <description> + Return the [RID] of the nth shape of an area. + </description> + </method> + <method name="area_get_shape_count" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <description> + Return the number of shapes assigned to an area. + </description> + </method> + <method name="area_get_shape_transform" qualifiers="const"> + <return type="Transform2D"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="shape_idx" type="int"> + </argument> + <description> + Return the transform matrix of a shape within an area. + </description> + </method> + <method name="area_get_space" qualifiers="const"> + <return type="RID"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <description> + Return the space assigned to the area. + </description> + </method> + <method name="area_get_space_override_mode" qualifiers="const"> + <return type="int" enum="Physics2DServer.AreaSpaceOverrideMode"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <description> + Return the space override mode for the area. + </description> + </method> + <method name="area_get_transform" qualifiers="const"> + <return type="Transform2D"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <description> + Return the transform matrix for an area. + </description> + </method> + <method name="area_remove_shape"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="shape_idx" type="int"> + </argument> + <description> + Remove a shape from an area. It does not delete the shape, so it can be reassigned later. + </description> + </method> + <method name="area_set_collision_layer"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="layer" type="int"> + </argument> + <description> + Assign the area to one or many physics layers. + </description> + </method> + <method name="area_set_collision_mask"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="mask" type="int"> + </argument> + <description> + Set which physics layers the area will monitor. + </description> + </method> + <method name="area_set_monitor_callback"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="receiver" type="Object"> + </argument> + <argument index="2" name="method" type="String"> + </argument> + <description> + Set the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters: + 1: AREA_BODY_ADDED or AREA_BODY_REMOVED, depending on whether the object entered or exited the area. + 2: [RID] of the object that entered/exited the area. + 3: Instance ID of the object that entered/exited the area. + 4: The shape index of the object that entered/exited the area. + 5: The shape index of the area where the object entered/exited. + </description> + </method> + <method name="area_set_param"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="param" type="int" enum="Physics2DServer.AreaParameter"> + </argument> + <argument index="2" name="value" type="Variant"> + </argument> + <description> + Set the value for an area parameter. A list of available parameters is on the AREA_PARAM_* constants. + </description> + </method> + <method name="area_set_shape"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="shape_idx" type="int"> + </argument> + <argument index="2" name="shape" type="RID"> + </argument> + <description> + Substitute a given area shape by another. The old shape is selected by its index, the new one by its [RID]. + </description> + </method> + <method name="area_set_shape_disabled"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="shape_idx" type="int"> + </argument> + <argument index="2" name="disable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="area_set_shape_transform"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="shape_idx" type="int"> + </argument> + <argument index="2" name="transform" type="Transform2D"> + </argument> + <description> + Set the transform matrix for an area shape. + </description> + </method> + <method name="area_set_space"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="space" type="RID"> + </argument> + <description> + Assign a space to the area. + </description> + </method> + <method name="area_set_space_override_mode"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="mode" type="int" enum="Physics2DServer.AreaSpaceOverrideMode"> + </argument> + <description> + Set the space override mode for the area. The modes are described in the constants AREA_SPACE_OVERRIDE_*. + </description> + </method> + <method name="area_set_transform"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="transform" type="Transform2D"> + </argument> + <description> + Set the transform matrix for an area. + </description> + </method> + <method name="body_add_collision_exception"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="excepted_body" type="RID"> + </argument> + <description> + Add a body to the list of bodies exempt from collisions. + </description> + </method> + <method name="body_add_force"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="offset" type="Vector2"> + </argument> + <argument index="2" name="force" type="Vector2"> + </argument> + <description> + Add a positioned force to the applied force and torque. As with [method body_apply_impulse], both the force and the offset from the body origin are in global coordinates. A force differs from an impulse in that, while the two are forces, the impulse clears itself after being applied. + </description> + </method> + <method name="body_add_shape"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="shape" type="RID"> + </argument> + <argument index="2" name="transform" type="Transform2D" default="Transform2D( 1, 0, 0, 1, 0, 0 )"> + </argument> + <description> + Add a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. + </description> + </method> + <method name="body_apply_impulse"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="pos" type="Vector2"> + </argument> + <argument index="2" name="impulse" type="Vector2"> + </argument> + <description> + Add a positioned impulse to the applied force and torque. Both the force and the offset from the body origin are in global coordinates. + </description> + </method> + <method name="body_attach_object_instance_id"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="id" type="int"> + </argument> + <description> + Assign the area to a descendant of [Object], so it can exist in the node tree. + </description> + </method> + <method name="body_clear_shapes"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <description> + Remove all shapes from a body. + </description> + </method> + <method name="body_create"> + <return type="RID"> + </return> + <argument index="0" name="mode" type="int" enum="Physics2DServer.BodyMode" default="2"> + </argument> + <argument index="1" name="init_sleeping" type="bool" default="false"> + </argument> + <description> + Create a physics body. The first parameter can be any value from constants BODY_MODE*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time. + </description> + </method> + <method name="body_get_collision_layer" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <description> + Return the physics layer or layers a body belongs to. + </description> + </method> + <method name="body_get_collision_mask" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <description> + Return the physics layer or layers a body can collide with. + </description> + </method> + <method name="body_get_continuous_collision_detection_mode" qualifiers="const"> + <return type="int" enum="Physics2DServer.CCDMode"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <description> + Return the continuous collision detection mode. + </description> + </method> + <method name="body_get_max_contacts_reported" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <description> + Return the maximum contacts that can be reported. See [method body_set_max_contacts_reported]. + </description> + </method> + <method name="body_get_mode" qualifiers="const"> + <return type="int" enum="Physics2DServer.BodyMode"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <description> + Return the body mode. + </description> + </method> + <method name="body_get_object_instance_id" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <description> + Get the instance ID of the object the area is assigned to. + </description> + </method> + <method name="body_get_param" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="param" type="int" enum="Physics2DServer.BodyParameter"> + </argument> + <description> + Return the value of a body parameter. + </description> + </method> + <method name="body_get_shape" qualifiers="const"> + <return type="RID"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="shape_idx" type="int"> + </argument> + <description> + Return the [RID] of the nth shape of a body. + </description> + </method> + <method name="body_get_shape_count" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <description> + Return the number of shapes assigned to a body. + </description> + </method> + <method name="body_get_shape_metadata" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="shape_idx" type="int"> + </argument> + <description> + Return the metadata of a shape of a body. + </description> + </method> + <method name="body_get_shape_transform" qualifiers="const"> + <return type="Transform2D"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="shape_idx" type="int"> + </argument> + <description> + Return the transform matrix of a body shape. + </description> + </method> + <method name="body_get_space" qualifiers="const"> + <return type="RID"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <description> + Return the [RID] of the space assigned to a body. + </description> + </method> + <method name="body_get_state" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="state" type="int" enum="Physics2DServer.BodyState"> + </argument> + <description> + Return a body state. + </description> + </method> + <method name="body_is_omitting_force_integration" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <description> + Return whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]). + </description> + </method> + <method name="body_remove_collision_exception"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="excepted_body" type="RID"> + </argument> + <description> + Remove a body from the list of bodies exempt from collisions. + </description> + </method> + <method name="body_remove_shape"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="shape_idx" type="int"> + </argument> + <description> + Remove a shape from a body. The shape is not deleted, so it can be reused afterwards. + </description> + </method> + <method name="body_set_axis_velocity"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="axis_velocity" type="Vector2"> + </argument> + <description> + Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. + </description> + </method> + <method name="body_set_collision_layer"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="layer" type="int"> + </argument> + <description> + Set the physics layer or layers a body belongs to. + </description> + </method> + <method name="body_set_collision_mask"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="mask" type="int"> + </argument> + <description> + Set the physics layer or layers a body can collide with. + </description> + </method> + <method name="body_set_continuous_collision_detection_mode"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="mode" type="int" enum="Physics2DServer.CCDMode"> + </argument> + <description> + Set the continuous collision detection mode from any of the CCD_MODE_* constants. + Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. + </description> + </method> + <method name="body_set_force_integration_callback"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="receiver" type="Object"> + </argument> + <argument index="2" name="method" type="String"> + </argument> + <argument index="3" name="userdata" type="Variant" default="null"> + </argument> + <description> + Set the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force integration]). + </description> + </method> + <method name="body_set_max_contacts_reported"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="amount" type="int"> + </argument> + <description> + Set 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. + </description> + </method> + <method name="body_set_mode"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="mode" type="int" enum="Physics2DServer.BodyMode"> + </argument> + <description> + Set the body mode, from one of the constants BODY_MODE*. + </description> + </method> + <method name="body_set_omit_force_integration"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> + <description> + Set whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]). + </description> + </method> + <method name="body_set_param"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="param" type="int" enum="Physics2DServer.BodyParameter"> + </argument> + <argument index="2" name="value" type="float"> + </argument> + <description> + Set a body parameter (see BODY_PARAM* constants). + </description> + </method> + <method name="body_set_shape"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="shape_idx" type="int"> + </argument> + <argument index="2" name="shape" type="RID"> + </argument> + <description> + Substitute a given body shape by another. The old shape is selected by its index, the new one by its [RID]. + </description> + </method> + <method name="body_set_shape_as_one_way_collision"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="shape_idx" type="int"> + </argument> + <argument index="2" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="body_set_shape_disabled"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="shape_idx" type="int"> + </argument> + <argument index="2" name="disable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="body_set_shape_metadata"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="shape_idx" type="int"> + </argument> + <argument index="2" name="metadata" type="Variant"> + </argument> + <description> + Set metadata of a shape within a body. This metadata is different from [method Object.set_meta], and can be retrieved on shape queries. + </description> + </method> + <method name="body_set_shape_transform"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="shape_idx" type="int"> + </argument> + <argument index="2" name="transform" type="Transform2D"> + </argument> + <description> + Set the transform matrix for a body shape. + </description> + </method> + <method name="body_set_space"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="space" type="RID"> + </argument> + <description> + Assign a space to the body (see [method create_space]). + </description> + </method> + <method name="body_set_state"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="state" type="int" enum="Physics2DServer.BodyState"> + </argument> + <argument index="2" name="value" type="Variant"> + </argument> + <description> + Set a body state (see BODY_STATE* constants). + </description> + </method> + <method name="body_test_motion"> + <return type="bool"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="from" type="Transform2D"> + </argument> + <argument index="2" name="motion" type="Vector2"> + </argument> + <argument index="3" name="margin" type="float" default="0.08"> + </argument> + <argument index="4" name="result" type="Physics2DTestMotionResult" default="null"> + </argument> + <description> + Return whether a body can move from a given point in a given direction. Apart from the boolean return value, a [Physics2DTestMotionResult] can be passed to return additional information in. + </description> + </method> + <method name="damped_spring_joint_create"> + <return type="RID"> + </return> + <argument index="0" name="anchor_a" type="Vector2"> + </argument> + <argument index="1" name="anchor_b" type="Vector2"> + </argument> + <argument index="2" name="body_a" type="RID"> + </argument> + <argument index="3" name="body_b" type="RID"> + </argument> + <description> + Create a damped spring joint between two bodies. If not specified, the second body is assumed to be the joint itself. + </description> + </method> + <method name="damped_string_joint_get_param" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="joint" type="RID"> + </argument> + <argument index="1" name="param" type="int" enum="Physics2DServer.DampedStringParam"> + </argument> + <description> + Return the value of a damped spring joint parameter. + </description> + </method> + <method name="damped_string_joint_set_param"> + <return type="void"> + </return> + <argument index="0" name="joint" type="RID"> + </argument> + <argument index="1" name="param" type="int" enum="Physics2DServer.DampedStringParam"> + </argument> + <argument index="2" name="value" type="float"> + </argument> + <description> + Set a damped spring joint parameter. Parameters are explained in the DAMPED_STRING* constants. + </description> + </method> + <method name="free_rid"> + <return type="void"> + </return> + <argument index="0" name="rid" type="RID"> + </argument> + <description> + Destroy any of the objects created by Physics2DServer. If the [RID] passed is not one of the objects that can be created by Physics2DServer, an error will be sent to the console. + </description> + </method> + <method name="get_process_info"> + <return type="int"> + </return> + <argument index="0" name="process_info" type="int" enum="Physics2DServer.ProcessInfo"> + </argument> + <description> + Return information about the current state of the 2D physics engine. The states are listed under the INFO_* constants. + </description> + </method> + <method name="groove_joint_create"> + <return type="RID"> + </return> + <argument index="0" name="groove1_a" type="Vector2"> + </argument> + <argument index="1" name="groove2_a" type="Vector2"> + </argument> + <argument index="2" name="anchor_b" type="Vector2"> + </argument> + <argument index="3" name="body_a" type="RID"> + </argument> + <argument index="4" name="body_b" type="RID"> + </argument> + <description> + Create a groove joint between two bodies. If not specified, the bodyies are assumed to be the joint itself. + </description> + </method> + <method name="joint_get_param" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="joint" type="RID"> + </argument> + <argument index="1" name="param" type="int" enum="Physics2DServer.JointParam"> + </argument> + <description> + Return the value of a joint parameter. + </description> + </method> + <method name="joint_get_type" qualifiers="const"> + <return type="int" enum="Physics2DServer.JointType"> + </return> + <argument index="0" name="joint" type="RID"> + </argument> + <description> + Return the type of a joint (see JOINT_* constants). + </description> + </method> + <method name="joint_set_param"> + <return type="void"> + </return> + <argument index="0" name="joint" type="RID"> + </argument> + <argument index="1" name="param" type="int" enum="Physics2DServer.JointParam"> + </argument> + <argument index="2" name="value" type="float"> + </argument> + <description> + Set a joint parameter. Parameters are explained in the JOINT_PARAM* constants. + </description> + </method> + <method name="pin_joint_create"> + <return type="RID"> + </return> + <argument index="0" name="anchor" type="Vector2"> + </argument> + <argument index="1" name="body_a" type="RID"> + </argument> + <argument index="2" name="body_b" type="RID"> + </argument> + <description> + Create a pin joint between two bodies. If not specified, the second body is assumed to be the joint itself. + </description> + </method> + <method name="set_active"> + <return type="void"> + </return> + <argument index="0" name="active" type="bool"> + </argument> + <description> + Activate or deactivate the 2D physics engine. + </description> + </method> + <method name="shape_create"> + <return type="RID"> + </return> + <argument index="0" name="type" type="int" enum="Physics2DServer.ShapeType"> + </argument> + <description> + Create a shape of type SHAPE_*. Does not assign it to a body or an area. To do so, you must use [method area_set_shape] or [method body_set_shape]. + </description> + </method> + <method name="shape_get_data" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="shape" type="RID"> + </argument> + <description> + Return the shape data. + </description> + </method> + <method name="shape_get_type" qualifiers="const"> + <return type="int" enum="Physics2DServer.ShapeType"> + </return> + <argument index="0" name="shape" type="RID"> + </argument> + <description> + Return the type of shape (see SHAPE_* constants). + </description> + </method> + <method name="shape_set_data"> + <return type="void"> + </return> + <argument index="0" name="shape" type="RID"> + </argument> + <argument index="1" name="data" type="Variant"> + </argument> + <description> + Set the shape data that defines its shape and size. The data to be passed depends on the kind of shape created [method shape_get_type]. + </description> + </method> + <method name="space_create"> + <return type="RID"> + </return> + <description> + Create a space. A space is a collection of parameters for the physics engine that can be assigned to an area or a body. It can be assigned to an area with [method area_set_space], or to a body with [method body_set_space]. + </description> + </method> + <method name="space_get_direct_state"> + <return type="Physics2DDirectSpaceState"> + </return> + <argument index="0" name="space" type="RID"> + </argument> + <description> + Return the state of a space, a [Physics2DDirectSpaceState]. This object can be used to make collision/intersection queries. + </description> + </method> + <method name="space_get_param" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="space" type="RID"> + </argument> + <argument index="1" name="param" type="int" enum="Physics2DServer.SpaceParameter"> + </argument> + <description> + Return the value of a space parameter. + </description> + </method> + <method name="space_is_active" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="space" type="RID"> + </argument> + <description> + Return whether the space is active. + </description> + </method> + <method name="space_set_active"> + <return type="void"> + </return> + <argument index="0" name="space" type="RID"> + </argument> + <argument index="1" name="active" type="bool"> + </argument> + <description> + Mark a space as active. It will not have an effect, unless it is assigned to an area or body. + </description> + </method> + <method name="space_set_param"> + <return type="void"> + </return> + <argument index="0" name="space" type="RID"> + </argument> + <argument index="1" name="param" type="int" enum="Physics2DServer.SpaceParameter"> + </argument> + <argument index="2" name="value" type="float"> + </argument> + <description> + Set the value for a space parameter. A list of available parameters is on the SPACE_PARAM_* constants. + </description> + </method> + </methods> + <constants> + <constant name="SPACE_PARAM_CONTACT_RECYCLE_RADIUS" value="0"> + Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated. + </constant> + <constant name="SPACE_PARAM_CONTACT_MAX_SEPARATION" value="1"> + Constant to set/get the maximum distance a shape can be from another before they are considered separated. + </constant> + <constant name="SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION" value="2"> + Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision. + </constant> + <constant name="SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD" value="3"> + </constant> + <constant name="SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD" value="4"> + </constant> + <constant name="SPACE_PARAM_BODY_TIME_TO_SLEEP" value="5"> + Constant to set/get the maximum time of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after this time. + </constant> + <constant name="SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS" value="6"> + Constant to set/get the default solver bias for all physics constraints. A solver bias is a factor controlling how much two objects "rebound", after violating a constraint, to avoid leaving them in that state because of numerical imprecision. + </constant> + <constant name="SHAPE_LINE" value="0"> + This is the constant for creating line shapes. A line shape is an infinite line with an origin point, and a normal. Thus, it can be used for front/behind checks. + </constant> + <constant name="SHAPE_SEGMENT" value="2"> + This is the constant for creating segment shapes. A segment shape is a line from a point A to a point B. It can be checked for intersections. + </constant> + <constant name="SHAPE_CIRCLE" value="3"> + This is the constant for creating circle shapes. A circle shape only has a radius. It can be used for intersections and inside/outside checks. + </constant> + <constant name="SHAPE_RECTANGLE" value="4"> + This is the constant for creating rectangle shapes. A rectangle shape is defined by a width and a height. It can be used for intersections and inside/outside checks. + </constant> + <constant name="SHAPE_CAPSULE" value="5"> + This is the constant for creating capsule shapes. A capsule shape is defined by a radius and a length. It can be used for intersections and inside/outside checks. + </constant> + <constant name="SHAPE_CONVEX_POLYGON" value="6"> + This is the constant for creating convex polygon shapes. A polygon is defined by a list of points. It can be used for intersections and inside/outside checks. Unlike the method [method CollisionPolygon2D.set_polygon], polygons modified with [method shape_set_data] do not verify that the points supplied form, in fact, a convex polygon. + </constant> + <constant name="SHAPE_CONCAVE_POLYGON" value="7"> + This is the constant for creating concave polygon shapes. A polygon is defined by a list of points. It can be used for intersections checks, but not for inside/outside checks. + </constant> + <constant name="SHAPE_CUSTOM" value="8"> + This constant is used internally by the engine. Any attempt to create this kind of shape results in an error. + </constant> + <constant name="AREA_PARAM_GRAVITY" value="0"> + Constant to set/get gravity strength in an area. + </constant> + <constant name="AREA_PARAM_GRAVITY_VECTOR" value="1"> + Constant to set/get gravity vector/center in an area. + </constant> + <constant name="AREA_PARAM_GRAVITY_IS_POINT" value="2"> + Constant to set/get whether the gravity vector of an area is a direction, or a center point. + </constant> + <constant name="AREA_PARAM_GRAVITY_DISTANCE_SCALE" value="3"> + Constant to set/get the falloff factor for point gravity of an area. The greater this value is, the faster the strength of gravity decreases with the square of distance. + </constant> + <constant name="AREA_PARAM_GRAVITY_POINT_ATTENUATION" value="4"> + This constant was used to set/get the falloff factor for point gravity. It has been superseded by AREA_PARAM_GRAVITY_DISTANCE_SCALE. + </constant> + <constant name="AREA_PARAM_LINEAR_DAMP" value="5"> + Constant to set/get the linear dampening factor of an area. + </constant> + <constant name="AREA_PARAM_ANGULAR_DAMP" value="6"> + Constant to set/get the angular dampening factor of an area. + </constant> + <constant name="AREA_PARAM_PRIORITY" value="7"> + Constant to set/get the priority (order of processing) of an area. + </constant> + <constant name="AREA_SPACE_OVERRIDE_DISABLED" value="0"> + This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. + </constant> + <constant name="AREA_SPACE_OVERRIDE_COMBINE" value="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. + </constant> + <constant name="AREA_SPACE_OVERRIDE_COMBINE_REPLACE" value="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. + </constant> + <constant name="AREA_SPACE_OVERRIDE_REPLACE" value="3"> + This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. + </constant> + <constant name="AREA_SPACE_OVERRIDE_REPLACE_COMBINE" value="4"> + This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. + </constant> + <constant name="BODY_MODE_STATIC" value="0"> + Constant for static bodies. + </constant> + <constant name="BODY_MODE_KINEMATIC" value="1"> + Constant for kinematic bodies. + </constant> + <constant name="BODY_MODE_RIGID" value="2"> + Constant for rigid bodies. + </constant> + <constant name="BODY_MODE_CHARACTER" value="3"> + Constant for rigid bodies in character mode. In this mode, a body can not rotate, and only its linear velocity is affected by physics. + </constant> + <constant name="BODY_PARAM_BOUNCE" value="0"> + Constant to set/get a body's bounce factor. + </constant> + <constant name="BODY_PARAM_FRICTION" value="1"> + Constant to set/get a body's friction. + </constant> + <constant name="BODY_PARAM_MASS" value="2"> + Constant to set/get a body's mass. + </constant> + <constant name="BODY_PARAM_INERTIA" value="3"> + Constant to set/get a body's inertia. + </constant> + <constant name="BODY_PARAM_GRAVITY_SCALE" value="4"> + Constant to set/get a body's gravity multiplier. + </constant> + <constant name="BODY_PARAM_LINEAR_DAMP" value="5"> + Constant to set/get a body's linear dampening factor. + </constant> + <constant name="BODY_PARAM_ANGULAR_DAMP" value="6"> + Constant to set/get a body's angular dampening factor. + </constant> + <constant name="BODY_PARAM_MAX" value="7"> + This is the last ID for body parameters. Any attempt to set this property is ignored. Any attempt to get it returns 0. + </constant> + <constant name="BODY_STATE_TRANSFORM" value="0"> + Constant to set/get the current transform matrix of the body. + </constant> + <constant name="BODY_STATE_LINEAR_VELOCITY" value="1"> + Constant to set/get the current linear velocity of the body. + </constant> + <constant name="BODY_STATE_ANGULAR_VELOCITY" value="2"> + Constant to set/get the current angular velocity of the body. + </constant> + <constant name="BODY_STATE_SLEEPING" value="3"> + Constant to sleep/wake up a body, or to get whether it is sleeping. + </constant> + <constant name="BODY_STATE_CAN_SLEEP" value="4"> + Constant to set/get whether the body can sleep. + </constant> + <constant name="JOINT_PIN" value="0"> + Constant to create pin joints. + </constant> + <constant name="JOINT_GROOVE" value="1"> + Constant to create groove joints. + </constant> + <constant name="JOINT_DAMPED_SPRING" value="2"> + Constant to create damped spring joints. + </constant> + <constant name="DAMPED_STRING_REST_LENGTH" value="0"> + Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart. + </constant> + <constant name="DAMPED_STRING_STIFFNESS" value="1"> + Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length. + </constant> + <constant name="DAMPED_STRING_DAMPING" value="2"> + Set the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping). + </constant> + <constant name="CCD_MODE_DISABLED" value="0"> + Disables continuous collision detection. This is the fastest way to detect body collisions, but can miss small, fast-moving objects. + </constant> + <constant name="CCD_MODE_CAST_RAY" value="1"> + Enables continuous collision detection by raycasting. It is faster than shapecasting, but less precise. + </constant> + <constant name="CCD_MODE_CAST_SHAPE" value="2"> + Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise. + </constant> + <constant name="AREA_BODY_ADDED" value="0"> + The value of the first parameter and area callback function receives, when an object enters one of its shapes. + </constant> + <constant name="AREA_BODY_REMOVED" value="1"> + The value of the first parameter and area callback function receives, when an object exits one of its shapes. + </constant> + <constant name="INFO_ACTIVE_OBJECTS" value="0"> + Constant to get the number of objects that are not sleeping. + </constant> + <constant name="INFO_COLLISION_PAIRS" value="1"> + Constant to get the number of possible collisions. + </constant> + <constant name="INFO_ISLAND_COUNT" value="2"> + Constant to get the number of space regions where a collision could occur. + </constant> + </constants> +</class> diff --git a/doc/classes/Physics2DServerSW.xml b/doc/classes/Physics2DServerSW.xml new file mode 100644 index 0000000000..a8645c0b96 --- /dev/null +++ b/doc/classes/Physics2DServerSW.xml @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Physics2DServerSW" inherits="Physics2DServer" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Software implementation of [Physics2DServer]. + </brief_description> + <description> + Software implementation of [Physics2DServer]. This class exposes no new methods or properties and should not be used, as [Physics2DServer] automatically selects the best implementation available. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Physics2DShapeQueryParameters.xml b/doc/classes/Physics2DShapeQueryParameters.xml new file mode 100644 index 0000000000..78d12e0b73 --- /dev/null +++ b/doc/classes/Physics2DShapeQueryParameters.xml @@ -0,0 +1,138 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Physics2DShapeQueryParameters" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Parameters to be sent to a 2D shape physics query. + </brief_description> + <description> + This class contains the shape and other parameters for intersection/collision queries. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_collision_layer" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the physics layer the shape belongs to. + </description> + </method> + <method name="get_exclude" qualifiers="const"> + <return type="Array"> + </return> + <description> + Return the list of objects, or object [RID]\ s, that will be excluded from collisions. + </description> + </method> + <method name="get_margin" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the collision margin for the shape. + </description> + </method> + <method name="get_motion" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the current movement speed of the shape. + </description> + </method> + <method name="get_object_type_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the type of object the shape belongs to. + </description> + </method> + <method name="get_shape_rid" qualifiers="const"> + <return type="RID"> + </return> + <description> + Return the [RID] of the shape queried. + </description> + </method> + <method name="get_transform" qualifiers="const"> + <return type="Transform2D"> + </return> + <description> + Return the transform matrix of the shape queried. + </description> + </method> + <method name="set_collision_layer"> + <return type="void"> + </return> + <argument index="0" name="collision_layer" type="int"> + </argument> + <description> + Set the physics layer the shape belongs to. + </description> + </method> + <method name="set_exclude"> + <return type="void"> + </return> + <argument index="0" name="exclude" type="Array"> + </argument> + <description> + Set the list of objects, or object [RID]\ s, that will be excluded from collisions. + </description> + </method> + <method name="set_margin"> + <return type="void"> + </return> + <argument index="0" name="margin" type="float"> + </argument> + <description> + Set the collision margin for the shape. A collision margin is an amount (in pixels) that the shape will grow when computing collisions, to account for numerical imprecision. + </description> + </method> + <method name="set_motion"> + <return type="void"> + </return> + <argument index="0" name="motion" type="Vector2"> + </argument> + <description> + Set the current movement speed of the shape. + </description> + </method> + <method name="set_object_type_mask"> + <return type="void"> + </return> + <argument index="0" name="object_type_mask" type="int"> + </argument> + <description> + Set the type of object the shape belongs to (see Physics2DDirectSpaceState.TYPE_MASK_*). + </description> + </method> + <method name="set_shape"> + <return type="void"> + </return> + <argument index="0" name="shape" type="Resource"> + </argument> + <description> + Set the [Shape2D] that will be used for collision/intersection queries. + </description> + </method> + <method name="set_shape_rid"> + <return type="void"> + </return> + <argument index="0" name="shape" type="RID"> + </argument> + <description> + Set the [RID] of the shape to be used in queries. + </description> + </method> + <method name="set_transform"> + <return type="void"> + </return> + <argument index="0" name="transform" type="Transform2D"> + </argument> + <description> + Set the transormation matrix of the shape. This is necessary to set its position/rotation/scale. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Physics2DShapeQueryResult.xml b/doc/classes/Physics2DShapeQueryResult.xml new file mode 100644 index 0000000000..9786a6aa75 --- /dev/null +++ b/doc/classes/Physics2DShapeQueryResult.xml @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Physics2DShapeQueryResult" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_result_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_result_object" qualifiers="const"> + <return type="Object"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_result_object_id" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_result_object_shape" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_result_rid" qualifiers="const"> + <return type="RID"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Physics2DTestMotionResult.xml b/doc/classes/Physics2DTestMotionResult.xml new file mode 100644 index 0000000000..a71d58faa7 --- /dev/null +++ b/doc/classes/Physics2DTestMotionResult.xml @@ -0,0 +1,69 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Physics2DTestMotionResult" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_collider" qualifiers="const"> + <return type="Object"> + </return> + <description> + </description> + </method> + <method name="get_collider_id" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_collider_rid" qualifiers="const"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="get_collider_shape" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_collider_velocity" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_collision_normal" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_collision_point" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_motion" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_motion_remainder" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/PhysicsBody.xml b/doc/classes/PhysicsBody.xml new file mode 100644 index 0000000000..e75fbb8e2d --- /dev/null +++ b/doc/classes/PhysicsBody.xml @@ -0,0 +1,109 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PhysicsBody" inherits="CollisionObject" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base class for all objects affected by physics in 3D space. + </brief_description> + <description> + PhysicsBody is an abstract base class for implementing a physics body. All *Body types inherit from it. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_collision_exception_with"> + <return type="void"> + </return> + <argument index="0" name="body" type="Node"> + </argument> + <description> + Adds a body to the list of bodies that this body can't collide with. + </description> + </method> + <method name="get_collision_layer" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_collision_layer_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_collision_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_collision_mask_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <description> + </description> + </method> + <method name="remove_collision_exception_with"> + <return type="void"> + </return> + <argument index="0" name="body" type="Node"> + </argument> + <description> + Removes a body from the list of bodies that this body can't collide with. + </description> + </method> + <method name="set_collision_layer"> + <return type="void"> + </return> + <argument index="0" name="layer" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_collision_layer_bit"> + <return type="void"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_collision_mask"> + <return type="void"> + </return> + <argument index="0" name="mask" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_collision_mask_bit"> + <return type="void"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_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. + </member> + <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask"> + The physics layers this area can scan for collisions. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/PhysicsBody2D.xml b/doc/classes/PhysicsBody2D.xml new file mode 100644 index 0000000000..748506baa9 --- /dev/null +++ b/doc/classes/PhysicsBody2D.xml @@ -0,0 +1,122 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PhysicsBody2D" inherits="CollisionObject2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base class for all objects affected by physics in 2D space. + </brief_description> + <description> + PhysicsBody2D is an abstract base class for implementing a physics body. All *Body2D types inherit from it. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_collision_exception_with"> + <return type="void"> + </return> + <argument index="0" name="body" type="Node"> + </argument> + <description> + Adds a body to the list of bodies that this body can't collide with. + </description> + </method> + <method name="get_collision_layer" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the physics layer this area is in. + </description> + </method> + <method name="get_collision_layer_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <description> + Return an individual bit on the collision mask. + </description> + </method> + <method name="get_collision_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the physics layers this area can scan for collisions. + </description> + </method> + <method name="get_collision_mask_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <description> + Return an individual bit on the collision mask. + </description> + </method> + <method name="remove_collision_exception_with"> + <return type="void"> + </return> + <argument index="0" name="body" type="Node"> + </argument> + <description> + Removes a body from the list of bodies that this body can't collide with. + </description> + </method> + <method name="set_collision_layer"> + <return type="void"> + </return> + <argument index="0" name="layer" type="int"> + </argument> + <description> + Set the physics layers this area 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 layer scanned by object A. + </description> + </method> + <method name="set_collision_layer_bit"> + <return type="void"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> + <description> + Set/clear individual bits on the layer mask. This makes getting a body in/out of only one layer easier. + </description> + </method> + <method name="set_collision_mask"> + <return type="void"> + </return> + <argument index="0" name="mask" type="int"> + </argument> + <description> + Set the physics layers this area can scan for collisions. + </description> + </method> + <method name="set_collision_mask_bit"> + <return type="void"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> + <description> + Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. + </description> + </method> + </methods> + <members> + <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_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. + </member> + <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask"> + The physics layers this area can scan for collisions. + </member> + <member name="layers" type="int" setter="_set_layers" getter="_get_layers"> + Both collision_layer and collision_mask. Returns collision_layer when accessed. Updates collision_layers and collision_mask when modified. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/PhysicsDirectBodyState.xml b/doc/classes/PhysicsDirectBodyState.xml new file mode 100644 index 0000000000..de51d0e958 --- /dev/null +++ b/doc/classes/PhysicsDirectBodyState.xml @@ -0,0 +1,237 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PhysicsDirectBodyState" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_force"> + <return type="void"> + </return> + <argument index="0" name="force" type="Vector3"> + </argument> + <argument index="1" name="pos" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="apply_impulse"> + <return type="void"> + </return> + <argument index="0" name="pos" type="Vector3"> + </argument> + <argument index="1" name="j" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="apply_torqe_impulse"> + <return type="void"> + </return> + <argument index="0" name="j" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="get_angular_velocity" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_center_of_mass" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_contact_collider" qualifiers="const"> + <return type="RID"> + </return> + <argument index="0" name="contact_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_contact_collider_id" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="contact_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_contact_collider_object" qualifiers="const"> + <return type="Object"> + </return> + <argument index="0" name="contact_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_contact_collider_pos" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="contact_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_contact_collider_shape" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="contact_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_contact_collider_velocity_at_pos" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="contact_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_contact_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_contact_local_normal" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="contact_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_contact_local_pos" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="contact_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_contact_local_shape" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="contact_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_inverse_inertia" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_inverse_mass" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_linear_velocity" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_principal_inertia_axes" qualifiers="const"> + <return type="Basis"> + </return> + <description> + </description> + </method> + <method name="get_space_state"> + <return type="PhysicsDirectSpaceState"> + </return> + <description> + </description> + </method> + <method name="get_step" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_total_angular_damp" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_total_gravity" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_total_linear_damp" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_transform" qualifiers="const"> + <return type="Transform"> + </return> + <description> + </description> + </method> + <method name="integrate_forces"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="is_sleeping" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_angular_velocity"> + <return type="void"> + </return> + <argument index="0" name="velocity" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="set_linear_velocity"> + <return type="void"> + </return> + <argument index="0" name="velocity" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="set_sleep_state"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_transform"> + <return type="void"> + </return> + <argument index="0" name="transform" type="Transform"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/PhysicsDirectBodyStateSW.xml b/doc/classes/PhysicsDirectBodyStateSW.xml new file mode 100644 index 0000000000..6d283f307e --- /dev/null +++ b/doc/classes/PhysicsDirectBodyStateSW.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PhysicsDirectBodyStateSW" inherits="PhysicsDirectBodyState" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/PhysicsDirectSpaceState.xml b/doc/classes/PhysicsDirectSpaceState.xml new file mode 100644 index 0000000000..1e4354fa7e --- /dev/null +++ b/doc/classes/PhysicsDirectSpaceState.xml @@ -0,0 +1,81 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PhysicsDirectSpaceState" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="cast_motion"> + <return type="Array"> + </return> + <argument index="0" name="shape" type="PhysicsShapeQueryParameters"> + </argument> + <argument index="1" name="motion" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="collide_shape"> + <return type="Array"> + </return> + <argument index="0" name="shape" type="PhysicsShapeQueryParameters"> + </argument> + <argument index="1" name="max_results" type="int" default="32"> + </argument> + <description> + </description> + </method> + <method name="get_rest_info"> + <return type="Dictionary"> + </return> + <argument index="0" name="shape" type="PhysicsShapeQueryParameters"> + </argument> + <description> + </description> + </method> + <method name="intersect_ray"> + <return type="Dictionary"> + </return> + <argument index="0" name="from" type="Vector3"> + </argument> + <argument index="1" name="to" type="Vector3"> + </argument> + <argument index="2" name="exclude" type="Array" default="[ ]"> + </argument> + <argument index="3" name="collision_layer" type="int" default="2147483647"> + </argument> + <argument index="4" name="type_mask" type="int" default="15"> + </argument> + <description> + </description> + </method> + <method name="intersect_shape"> + <return type="Array"> + </return> + <argument index="0" name="shape" type="PhysicsShapeQueryParameters"> + </argument> + <argument index="1" name="max_results" type="int" default="32"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + <constant name="TYPE_MASK_STATIC_BODY" value="1"> + </constant> + <constant name="TYPE_MASK_KINEMATIC_BODY" value="2"> + </constant> + <constant name="TYPE_MASK_RIGID_BODY" value="4"> + </constant> + <constant name="TYPE_MASK_CHARACTER_BODY" value="8"> + </constant> + <constant name="TYPE_MASK_AREA" value="16"> + </constant> + <constant name="TYPE_MASK_COLLISION" value="15"> + </constant> + </constants> +</class> diff --git a/doc/classes/PhysicsServer.xml b/doc/classes/PhysicsServer.xml new file mode 100644 index 0000000000..0076625ebd --- /dev/null +++ b/doc/classes/PhysicsServer.xml @@ -0,0 +1,1276 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PhysicsServer" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="area_add_shape"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="shape" type="RID"> + </argument> + <argument index="2" name="transform" type="Transform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )"> + </argument> + <description> + </description> + </method> + <method name="area_attach_object_instance_id"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="area_clear_shapes"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <description> + </description> + </method> + <method name="area_create"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="area_get_object_instance_id" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <description> + </description> + </method> + <method name="area_get_param" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="param" type="int" enum="PhysicsServer.AreaParameter"> + </argument> + <description> + </description> + </method> + <method name="area_get_shape" qualifiers="const"> + <return type="RID"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="shape_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="area_get_shape_count" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <description> + </description> + </method> + <method name="area_get_shape_transform" qualifiers="const"> + <return type="Transform"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="shape_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="area_get_space" qualifiers="const"> + <return type="RID"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <description> + </description> + </method> + <method name="area_get_space_override_mode" qualifiers="const"> + <return type="int" enum="PhysicsServer.AreaSpaceOverrideMode"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <description> + </description> + </method> + <method name="area_get_transform" qualifiers="const"> + <return type="Transform"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <description> + </description> + </method> + <method name="area_is_ray_pickable" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <description> + </description> + </method> + <method name="area_remove_shape"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="shape_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="area_set_collision_layer"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="layer" type="int"> + </argument> + <description> + </description> + </method> + <method name="area_set_collision_mask"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="mask" type="int"> + </argument> + <description> + </description> + </method> + <method name="area_set_monitor_callback"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="receiver" type="Object"> + </argument> + <argument index="2" name="method" type="String"> + </argument> + <description> + </description> + </method> + <method name="area_set_param"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="param" type="int" enum="PhysicsServer.AreaParameter"> + </argument> + <argument index="2" name="value" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="area_set_ray_pickable"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="area_set_shape"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="shape_idx" type="int"> + </argument> + <argument index="2" name="shape" type="RID"> + </argument> + <description> + </description> + </method> + <method name="area_set_shape_transform"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="shape_idx" type="int"> + </argument> + <argument index="2" name="transform" type="Transform"> + </argument> + <description> + </description> + </method> + <method name="area_set_space"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="space" type="RID"> + </argument> + <description> + </description> + </method> + <method name="area_set_space_override_mode"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="mode" type="int" enum="PhysicsServer.AreaSpaceOverrideMode"> + </argument> + <description> + </description> + </method> + <method name="area_set_transform"> + <return type="void"> + </return> + <argument index="0" name="area" type="RID"> + </argument> + <argument index="1" name="transform" type="Transform"> + </argument> + <description> + </description> + </method> + <method name="body_add_collision_exception"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="excepted_body" type="RID"> + </argument> + <description> + </description> + </method> + <method name="body_add_shape"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="shape" type="RID"> + </argument> + <argument index="2" name="transform" type="Transform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )"> + </argument> + <description> + </description> + </method> + <method name="body_apply_impulse"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="pos" type="Vector3"> + </argument> + <argument index="2" name="impulse" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="body_apply_torque_impulse"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="impulse" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="body_attach_object_instance_id"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="body_clear_shapes"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <description> + </description> + </method> + <method name="body_create"> + <return type="RID"> + </return> + <argument index="0" name="mode" type="int" enum="PhysicsServer.BodyMode" default="2"> + </argument> + <argument index="1" name="init_sleeping" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="body_get_axis_lock" qualifiers="const"> + <return type="int" enum="PhysicsServer.BodyAxisLock"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <description> + </description> + </method> + <method name="body_get_collision_layer" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <description> + </description> + </method> + <method name="body_get_collision_mask" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <description> + </description> + </method> + <method name="body_get_max_contacts_reported" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <description> + </description> + </method> + <method name="body_get_mode" qualifiers="const"> + <return type="int" enum="PhysicsServer.BodyMode"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <description> + </description> + </method> + <method name="body_get_object_instance_id" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <description> + </description> + </method> + <method name="body_get_param" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="param" type="int" enum="PhysicsServer.BodyParameter"> + </argument> + <description> + </description> + </method> + <method name="body_get_shape" qualifiers="const"> + <return type="RID"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="shape_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="body_get_shape_count" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <description> + </description> + </method> + <method name="body_get_shape_transform" qualifiers="const"> + <return type="Transform"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="shape_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="body_get_space" qualifiers="const"> + <return type="RID"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <description> + </description> + </method> + <method name="body_get_state" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="state" type="int" enum="PhysicsServer.BodyState"> + </argument> + <description> + </description> + </method> + <method name="body_is_continuous_collision_detection_enabled" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <description> + </description> + </method> + <method name="body_is_omitting_force_integration" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <description> + </description> + </method> + <method name="body_is_ray_pickable" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <description> + </description> + </method> + <method name="body_remove_collision_exception"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="excepted_body" type="RID"> + </argument> + <description> + </description> + </method> + <method name="body_remove_shape"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="shape_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="body_set_axis_lock"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="axis" type="int" enum="PhysicsServer.BodyAxisLock"> + </argument> + <description> + </description> + </method> + <method name="body_set_axis_velocity"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="axis_velocity" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="body_set_collision_layer"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="layer" type="int"> + </argument> + <description> + </description> + </method> + <method name="body_set_collision_mask"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="mask" type="int"> + </argument> + <description> + </description> + </method> + <method name="body_set_enable_continuous_collision_detection"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="body_set_force_integration_callback"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="receiver" type="Object"> + </argument> + <argument index="2" name="method" type="String"> + </argument> + <argument index="3" name="userdata" type="Variant" default="null"> + </argument> + <description> + </description> + </method> + <method name="body_set_max_contacts_reported"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="amount" type="int"> + </argument> + <description> + </description> + </method> + <method name="body_set_mode"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="mode" type="int" enum="PhysicsServer.BodyMode"> + </argument> + <description> + </description> + </method> + <method name="body_set_omit_force_integration"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="body_set_param"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="param" type="int" enum="PhysicsServer.BodyParameter"> + </argument> + <argument index="2" name="value" type="float"> + </argument> + <description> + </description> + </method> + <method name="body_set_ray_pickable"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="body_set_shape"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="shape_idx" type="int"> + </argument> + <argument index="2" name="shape" type="RID"> + </argument> + <description> + </description> + </method> + <method name="body_set_shape_transform"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="shape_idx" type="int"> + </argument> + <argument index="2" name="transform" type="Transform"> + </argument> + <description> + </description> + </method> + <method name="body_set_space"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="space" type="RID"> + </argument> + <description> + </description> + </method> + <method name="body_set_state"> + <return type="void"> + </return> + <argument index="0" name="body" type="RID"> + </argument> + <argument index="1" name="state" type="int" enum="PhysicsServer.BodyState"> + </argument> + <argument index="2" name="value" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="cone_twist_joint_get_param" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="joint" type="RID"> + </argument> + <argument index="1" name="param" type="int" enum="PhysicsServer.ConeTwistJointParam"> + </argument> + <description> + </description> + </method> + <method name="cone_twist_joint_set_param"> + <return type="void"> + </return> + <argument index="0" name="joint" type="RID"> + </argument> + <argument index="1" name="param" type="int" enum="PhysicsServer.ConeTwistJointParam"> + </argument> + <argument index="2" name="value" type="float"> + </argument> + <description> + </description> + </method> + <method name="free_rid"> + <return type="void"> + </return> + <argument index="0" name="rid" type="RID"> + </argument> + <description> + </description> + </method> + <method name="generic_6dof_joint_get_flag"> + <return type="bool"> + </return> + <argument index="0" name="joint" type="RID"> + </argument> + <argument index="1" name="axis" type="int" enum="Vector3.Axis"> + </argument> + <argument index="2" name="flag" type="int" enum="PhysicsServer.G6DOFJointAxisFlag"> + </argument> + <description> + </description> + </method> + <method name="generic_6dof_joint_get_param"> + <return type="float"> + </return> + <argument index="0" name="joint" type="RID"> + </argument> + <argument index="1" name="axis" type="int" enum="Vector3.Axis"> + </argument> + <argument index="2" name="param" type="int" enum="PhysicsServer.G6DOFJointAxisParam"> + </argument> + <description> + </description> + </method> + <method name="generic_6dof_joint_set_flag"> + <return type="void"> + </return> + <argument index="0" name="joint" type="RID"> + </argument> + <argument index="1" name="axis" type="int" enum="Vector3.Axis"> + </argument> + <argument index="2" name="flag" type="int" enum="PhysicsServer.G6DOFJointAxisFlag"> + </argument> + <argument index="3" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="generic_6dof_joint_set_param"> + <return type="void"> + </return> + <argument index="0" name="joint" type="RID"> + </argument> + <argument index="1" name="axis" type="int" enum="Vector3.Axis"> + </argument> + <argument index="2" name="param" type="int" enum="PhysicsServer.G6DOFJointAxisParam"> + </argument> + <argument index="3" name="value" type="float"> + </argument> + <description> + </description> + </method> + <method name="get_process_info"> + <return type="int"> + </return> + <argument index="0" name="process_info" type="int" enum="PhysicsServer.ProcessInfo"> + </argument> + <description> + </description> + </method> + <method name="hinge_joint_get_flag" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="joint" type="RID"> + </argument> + <argument index="1" name="flag" type="int" enum="PhysicsServer.HingeJointFlag"> + </argument> + <description> + </description> + </method> + <method name="hinge_joint_get_param" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="joint" type="RID"> + </argument> + <argument index="1" name="param" type="int" enum="PhysicsServer.HingeJointParam"> + </argument> + <description> + </description> + </method> + <method name="hinge_joint_set_flag"> + <return type="void"> + </return> + <argument index="0" name="joint" type="RID"> + </argument> + <argument index="1" name="flag" type="int" enum="PhysicsServer.HingeJointFlag"> + </argument> + <argument index="2" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="hinge_joint_set_param"> + <return type="void"> + </return> + <argument index="0" name="joint" type="RID"> + </argument> + <argument index="1" name="param" type="int" enum="PhysicsServer.HingeJointParam"> + </argument> + <argument index="2" name="value" type="float"> + </argument> + <description> + </description> + </method> + <method name="joint_create_cone_twist"> + <return type="RID"> + </return> + <argument index="0" name="body_A" type="RID"> + </argument> + <argument index="1" name="local_ref_A" type="Transform"> + </argument> + <argument index="2" name="body_B" type="RID"> + </argument> + <argument index="3" name="local_ref_B" type="Transform"> + </argument> + <description> + </description> + </method> + <method name="joint_create_generic_6dof"> + <return type="RID"> + </return> + <argument index="0" name="body_A" type="RID"> + </argument> + <argument index="1" name="local_ref_A" type="Transform"> + </argument> + <argument index="2" name="body_B" type="RID"> + </argument> + <argument index="3" name="local_ref_B" type="Transform"> + </argument> + <description> + </description> + </method> + <method name="joint_create_hinge"> + <return type="RID"> + </return> + <argument index="0" name="body_A" type="RID"> + </argument> + <argument index="1" name="hinge_A" type="Transform"> + </argument> + <argument index="2" name="body_B" type="RID"> + </argument> + <argument index="3" name="hinge_B" type="Transform"> + </argument> + <description> + </description> + </method> + <method name="joint_create_pin"> + <return type="RID"> + </return> + <argument index="0" name="body_A" type="RID"> + </argument> + <argument index="1" name="local_A" type="Vector3"> + </argument> + <argument index="2" name="body_B" type="RID"> + </argument> + <argument index="3" name="local_B" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="joint_create_slider"> + <return type="RID"> + </return> + <argument index="0" name="body_A" type="RID"> + </argument> + <argument index="1" name="local_ref_A" type="Transform"> + </argument> + <argument index="2" name="body_B" type="RID"> + </argument> + <argument index="3" name="local_ref_B" type="Transform"> + </argument> + <description> + </description> + </method> + <method name="joint_get_solver_priority" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="joint" type="RID"> + </argument> + <description> + </description> + </method> + <method name="joint_get_type" qualifiers="const"> + <return type="int" enum="PhysicsServer.JointType"> + </return> + <argument index="0" name="joint" type="RID"> + </argument> + <description> + </description> + </method> + <method name="joint_set_solver_priority"> + <return type="void"> + </return> + <argument index="0" name="joint" type="RID"> + </argument> + <argument index="1" name="priority" type="int"> + </argument> + <description> + </description> + </method> + <method name="pin_joint_get_local_a" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="joint" type="RID"> + </argument> + <description> + </description> + </method> + <method name="pin_joint_get_local_b" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="joint" type="RID"> + </argument> + <description> + </description> + </method> + <method name="pin_joint_get_param" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="joint" type="RID"> + </argument> + <argument index="1" name="param" type="int" enum="PhysicsServer.PinJointParam"> + </argument> + <description> + </description> + </method> + <method name="pin_joint_set_local_a"> + <return type="void"> + </return> + <argument index="0" name="joint" type="RID"> + </argument> + <argument index="1" name="local_A" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="pin_joint_set_local_b"> + <return type="void"> + </return> + <argument index="0" name="joint" type="RID"> + </argument> + <argument index="1" name="local_B" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="pin_joint_set_param"> + <return type="void"> + </return> + <argument index="0" name="joint" type="RID"> + </argument> + <argument index="1" name="param" type="int" enum="PhysicsServer.PinJointParam"> + </argument> + <argument index="2" name="value" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_active"> + <return type="void"> + </return> + <argument index="0" name="active" type="bool"> + </argument> + <description> + </description> + </method> + <method name="shape_create"> + <return type="RID"> + </return> + <argument index="0" name="type" type="int" enum="PhysicsServer.ShapeType"> + </argument> + <description> + </description> + </method> + <method name="shape_get_data" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="shape" type="RID"> + </argument> + <description> + </description> + </method> + <method name="shape_get_type" qualifiers="const"> + <return type="int" enum="PhysicsServer.ShapeType"> + </return> + <argument index="0" name="shape" type="RID"> + </argument> + <description> + </description> + </method> + <method name="shape_set_data"> + <return type="void"> + </return> + <argument index="0" name="shape" type="RID"> + </argument> + <argument index="1" name="data" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="slider_joint_get_param" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="joint" type="RID"> + </argument> + <argument index="1" name="param" type="int" enum="PhysicsServer.SliderJointParam"> + </argument> + <description> + </description> + </method> + <method name="slider_joint_set_param"> + <return type="void"> + </return> + <argument index="0" name="joint" type="RID"> + </argument> + <argument index="1" name="param" type="int" enum="PhysicsServer.SliderJointParam"> + </argument> + <argument index="2" name="value" type="float"> + </argument> + <description> + </description> + </method> + <method name="space_create"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="space_get_direct_state"> + <return type="PhysicsDirectSpaceState"> + </return> + <argument index="0" name="space" type="RID"> + </argument> + <description> + </description> + </method> + <method name="space_get_param" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="space" type="RID"> + </argument> + <argument index="1" name="param" type="int" enum="PhysicsServer.SpaceParameter"> + </argument> + <description> + </description> + </method> + <method name="space_is_active" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="space" type="RID"> + </argument> + <description> + </description> + </method> + <method name="space_set_active"> + <return type="void"> + </return> + <argument index="0" name="space" type="RID"> + </argument> + <argument index="1" name="active" type="bool"> + </argument> + <description> + </description> + </method> + <method name="space_set_param"> + <return type="void"> + </return> + <argument index="0" name="space" type="RID"> + </argument> + <argument index="1" name="param" type="int" enum="PhysicsServer.SpaceParameter"> + </argument> + <argument index="2" name="value" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + <constant name="JOINT_PIN" value="0"> + </constant> + <constant name="JOINT_HINGE" value="1"> + </constant> + <constant name="JOINT_SLIDER" value="2"> + </constant> + <constant name="JOINT_CONE_TWIST" value="3"> + </constant> + <constant name="JOINT_6DOF" value="4"> + </constant> + <constant name="PIN_JOINT_BIAS" value="0"> + </constant> + <constant name="PIN_JOINT_DAMPING" value="1"> + </constant> + <constant name="PIN_JOINT_IMPULSE_CLAMP" value="2"> + </constant> + <constant name="HINGE_JOINT_BIAS" value="0"> + </constant> + <constant name="HINGE_JOINT_LIMIT_UPPER" value="1"> + </constant> + <constant name="HINGE_JOINT_LIMIT_LOWER" value="2"> + </constant> + <constant name="HINGE_JOINT_LIMIT_BIAS" value="3"> + </constant> + <constant name="HINGE_JOINT_LIMIT_SOFTNESS" value="4"> + </constant> + <constant name="HINGE_JOINT_LIMIT_RELAXATION" value="5"> + </constant> + <constant name="HINGE_JOINT_MOTOR_TARGET_VELOCITY" value="6"> + </constant> + <constant name="HINGE_JOINT_MOTOR_MAX_IMPULSE" value="7"> + </constant> + <constant name="HINGE_JOINT_FLAG_USE_LIMIT" value="0"> + </constant> + <constant name="HINGE_JOINT_FLAG_ENABLE_MOTOR" value="1"> + </constant> + <constant name="SLIDER_JOINT_LINEAR_LIMIT_UPPER" value="0"> + </constant> + <constant name="SLIDER_JOINT_LINEAR_LIMIT_LOWER" value="1"> + </constant> + <constant name="SLIDER_JOINT_LINEAR_LIMIT_SOFTNESS" value="2"> + </constant> + <constant name="SLIDER_JOINT_LINEAR_LIMIT_RESTITUTION" value="3"> + </constant> + <constant name="SLIDER_JOINT_LINEAR_LIMIT_DAMPING" value="4"> + </constant> + <constant name="SLIDER_JOINT_LINEAR_MOTION_SOFTNESS" value="5"> + </constant> + <constant name="SLIDER_JOINT_LINEAR_MOTION_RESTITUTION" value="6"> + </constant> + <constant name="SLIDER_JOINT_LINEAR_MOTION_DAMPING" value="7"> + </constant> + <constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_SOFTNESS" value="8"> + </constant> + <constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_RESTITUTION" value="9"> + </constant> + <constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_DAMPING" value="10"> + </constant> + <constant name="SLIDER_JOINT_ANGULAR_LIMIT_UPPER" value="11"> + </constant> + <constant name="SLIDER_JOINT_ANGULAR_LIMIT_LOWER" value="12"> + </constant> + <constant name="SLIDER_JOINT_ANGULAR_LIMIT_SOFTNESS" value="13"> + </constant> + <constant name="SLIDER_JOINT_ANGULAR_LIMIT_RESTITUTION" value="14"> + </constant> + <constant name="SLIDER_JOINT_ANGULAR_LIMIT_DAMPING" value="15"> + </constant> + <constant name="SLIDER_JOINT_ANGULAR_MOTION_SOFTNESS" value="16"> + </constant> + <constant name="SLIDER_JOINT_ANGULAR_MOTION_RESTITUTION" value="17"> + </constant> + <constant name="SLIDER_JOINT_ANGULAR_MOTION_DAMPING" value="18"> + </constant> + <constant name="SLIDER_JOINT_ANGULAR_ORTHOGONAL_SOFTNESS" value="19"> + </constant> + <constant name="SLIDER_JOINT_ANGULAR_ORTHOGONAL_RESTITUTION" value="20"> + </constant> + <constant name="SLIDER_JOINT_ANGULAR_ORTHOGONAL_DAMPING" value="21"> + </constant> + <constant name="SLIDER_JOINT_MAX" value="22"> + </constant> + <constant name="CONE_TWIST_JOINT_SWING_SPAN" value="0"> + </constant> + <constant name="CONE_TWIST_JOINT_TWIST_SPAN" value="1"> + </constant> + <constant name="CONE_TWIST_JOINT_BIAS" value="2"> + </constant> + <constant name="CONE_TWIST_JOINT_SOFTNESS" value="3"> + </constant> + <constant name="CONE_TWIST_JOINT_RELAXATION" value="4"> + </constant> + <constant name="G6DOF_JOINT_LINEAR_LOWER_LIMIT" value="0"> + </constant> + <constant name="G6DOF_JOINT_LINEAR_UPPER_LIMIT" value="1"> + </constant> + <constant name="G6DOF_JOINT_LINEAR_LIMIT_SOFTNESS" value="2"> + </constant> + <constant name="G6DOF_JOINT_LINEAR_RESTITUTION" value="3"> + </constant> + <constant name="G6DOF_JOINT_LINEAR_DAMPING" value="4"> + </constant> + <constant name="G6DOF_JOINT_ANGULAR_LOWER_LIMIT" value="5"> + </constant> + <constant name="G6DOF_JOINT_ANGULAR_UPPER_LIMIT" value="6"> + </constant> + <constant name="G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS" value="7"> + </constant> + <constant name="G6DOF_JOINT_ANGULAR_DAMPING" value="8"> + </constant> + <constant name="G6DOF_JOINT_ANGULAR_RESTITUTION" value="9"> + </constant> + <constant name="G6DOF_JOINT_ANGULAR_FORCE_LIMIT" value="10"> + </constant> + <constant name="G6DOF_JOINT_ANGULAR_ERP" value="11"> + </constant> + <constant name="G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY" value="12"> + </constant> + <constant name="G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT" value="13"> + </constant> + <constant name="G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT" value="0"> + </constant> + <constant name="G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT" value="1"> + </constant> + <constant name="G6DOF_JOINT_FLAG_ENABLE_MOTOR" value="2"> + </constant> + <constant name="SHAPE_PLANE" value="0"> + </constant> + <constant name="SHAPE_RAY" value="1"> + </constant> + <constant name="SHAPE_SPHERE" value="2"> + </constant> + <constant name="SHAPE_BOX" value="3"> + </constant> + <constant name="SHAPE_CAPSULE" value="4"> + </constant> + <constant name="SHAPE_CONVEX_POLYGON" value="5"> + </constant> + <constant name="SHAPE_CONCAVE_POLYGON" value="6"> + </constant> + <constant name="SHAPE_HEIGHTMAP" value="7"> + </constant> + <constant name="SHAPE_CUSTOM" value="8"> + </constant> + <constant name="AREA_PARAM_GRAVITY" value="0"> + </constant> + <constant name="AREA_PARAM_GRAVITY_VECTOR" value="1"> + </constant> + <constant name="AREA_PARAM_GRAVITY_IS_POINT" value="2"> + </constant> + <constant name="AREA_PARAM_GRAVITY_DISTANCE_SCALE" value="3"> + </constant> + <constant name="AREA_PARAM_GRAVITY_POINT_ATTENUATION" value="4"> + </constant> + <constant name="AREA_PARAM_LINEAR_DAMP" value="5"> + </constant> + <constant name="AREA_PARAM_ANGULAR_DAMP" value="6"> + </constant> + <constant name="AREA_PARAM_PRIORITY" value="7"> + </constant> + <constant name="AREA_SPACE_OVERRIDE_DISABLED" value="0"> + This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. + </constant> + <constant name="AREA_SPACE_OVERRIDE_COMBINE" value="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. + </constant> + <constant name="AREA_SPACE_OVERRIDE_COMBINE_REPLACE" value="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. + </constant> + <constant name="AREA_SPACE_OVERRIDE_REPLACE" value="3"> + This area replaces any gravity/damp, even the default one, and stops taking into account the rest of the areas. + </constant> + <constant name="AREA_SPACE_OVERRIDE_REPLACE_COMBINE" value="4"> + This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. + </constant> + <constant name="BODY_MODE_STATIC" value="0"> + </constant> + <constant name="BODY_MODE_KINEMATIC" value="1"> + </constant> + <constant name="BODY_MODE_RIGID" value="2"> + </constant> + <constant name="BODY_MODE_CHARACTER" value="3"> + </constant> + <constant name="BODY_PARAM_BOUNCE" value="0"> + </constant> + <constant name="BODY_PARAM_FRICTION" value="1"> + </constant> + <constant name="BODY_PARAM_MASS" value="2"> + </constant> + <constant name="BODY_PARAM_GRAVITY_SCALE" value="3"> + </constant> + <constant name="BODY_PARAM_ANGULAR_DAMP" value="5"> + </constant> + <constant name="BODY_PARAM_LINEAR_DAMP" value="4"> + </constant> + <constant name="BODY_PARAM_MAX" value="6"> + </constant> + <constant name="BODY_STATE_TRANSFORM" value="0"> + </constant> + <constant name="BODY_STATE_LINEAR_VELOCITY" value="1"> + </constant> + <constant name="BODY_STATE_ANGULAR_VELOCITY" value="2"> + </constant> + <constant name="BODY_STATE_SLEEPING" value="3"> + </constant> + <constant name="BODY_STATE_CAN_SLEEP" value="4"> + </constant> + <constant name="AREA_BODY_ADDED" value="0"> + </constant> + <constant name="AREA_BODY_REMOVED" value="1"> + </constant> + <constant name="INFO_ACTIVE_OBJECTS" value="0"> + </constant> + <constant name="INFO_COLLISION_PAIRS" value="1"> + </constant> + <constant name="INFO_ISLAND_COUNT" value="2"> + </constant> + <constant name="SPACE_PARAM_CONTACT_RECYCLE_RADIUS" value="0"> + </constant> + <constant name="SPACE_PARAM_CONTACT_MAX_SEPARATION" value="1"> + </constant> + <constant name="SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION" value="2"> + </constant> + <constant name="SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD" value="3"> + </constant> + <constant name="SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD" value="4"> + </constant> + <constant name="SPACE_PARAM_BODY_TIME_TO_SLEEP" value="5"> + </constant> + <constant name="SPACE_PARAM_BODY_ANGULAR_VELOCITY_DAMP_RATIO" value="6"> + </constant> + <constant name="SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS" value="7"> + </constant> + <constant name="BODY_AXIS_LOCK_DISABLED" value="0"> + </constant> + <constant name="BODY_AXIS_LOCK_X" value="1"> + </constant> + <constant name="BODY_AXIS_LOCK_Y" value="2"> + </constant> + <constant name="BODY_AXIS_LOCK_Z" value="3"> + </constant> + </constants> +</class> diff --git a/doc/classes/PhysicsServerSW.xml b/doc/classes/PhysicsServerSW.xml new file mode 100644 index 0000000000..7bffc23258 --- /dev/null +++ b/doc/classes/PhysicsServerSW.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PhysicsServerSW" inherits="PhysicsServer" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/PhysicsShapeQueryParameters.xml b/doc/classes/PhysicsShapeQueryParameters.xml new file mode 100644 index 0000000000..f2e8b1986a --- /dev/null +++ b/doc/classes/PhysicsShapeQueryParameters.xml @@ -0,0 +1,107 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PhysicsShapeQueryParameters" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_collision_layer" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_exclude" qualifiers="const"> + <return type="Array"> + </return> + <description> + </description> + </method> + <method name="get_margin" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_object_type_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_shape_rid" qualifiers="const"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="get_transform" qualifiers="const"> + <return type="Transform"> + </return> + <description> + </description> + </method> + <method name="set_collision_layer"> + <return type="void"> + </return> + <argument index="0" name="collision_layer" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_exclude"> + <return type="void"> + </return> + <argument index="0" name="exclude" type="Array"> + </argument> + <description> + </description> + </method> + <method name="set_margin"> + <return type="void"> + </return> + <argument index="0" name="margin" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_object_type_mask"> + <return type="void"> + </return> + <argument index="0" name="object_type_mask" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_shape"> + <return type="void"> + </return> + <argument index="0" name="shape" type="Resource"> + </argument> + <description> + </description> + </method> + <method name="set_shape_rid"> + <return type="void"> + </return> + <argument index="0" name="shape" type="RID"> + </argument> + <description> + </description> + </method> + <method name="set_transform"> + <return type="void"> + </return> + <argument index="0" name="transform" type="Transform"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/PhysicsShapeQueryResult.xml b/doc/classes/PhysicsShapeQueryResult.xml new file mode 100644 index 0000000000..4c4a283688 --- /dev/null +++ b/doc/classes/PhysicsShapeQueryResult.xml @@ -0,0 +1,54 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PhysicsShapeQueryResult" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Result of a shape query in Physics2DServer. + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_result_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_result_object" qualifiers="const"> + <return type="Object"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_result_object_id" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_result_object_shape" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_result_rid" qualifiers="const"> + <return type="RID"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/PinJoint.xml b/doc/classes/PinJoint.xml new file mode 100644 index 0000000000..22aa35a0a4 --- /dev/null +++ b/doc/classes/PinJoint.xml @@ -0,0 +1,47 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PinJoint" inherits="Joint" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_param" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="param" type="int" enum="PinJoint.Param"> + </argument> + <description> + </description> + </method> + <method name="set_param"> + <return type="void"> + </return> + <argument index="0" name="param" type="int" enum="PinJoint.Param"> + </argument> + <argument index="1" name="value" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="params/bias" type="float" setter="set_param" getter="get_param"> + </member> + <member name="params/damping" type="float" setter="set_param" getter="get_param"> + </member> + <member name="params/impulse_clamp" type="float" setter="set_param" getter="get_param"> + </member> + </members> + <constants> + <constant name="PARAM_BIAS" value="0"> + </constant> + <constant name="PARAM_DAMPING" value="1"> + </constant> + <constant name="PARAM_IMPULSE_CLAMP" value="2"> + </constant> + </constants> +</class> diff --git a/doc/classes/PinJoint2D.xml b/doc/classes/PinJoint2D.xml new file mode 100644 index 0000000000..826a1684a4 --- /dev/null +++ b/doc/classes/PinJoint2D.xml @@ -0,0 +1,35 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PinJoint2D" inherits="Joint2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Pin Joint for 2D Shapes. + </brief_description> + <description> + Pin Joint for 2D Rigid Bodies. It pins 2 bodies (rigid or static) together, or a single body to a fixed position in space. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_softness" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="set_softness"> + <return type="void"> + </return> + <argument index="0" name="softness" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="softness" type="float" setter="set_softness" getter="get_softness"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Plane.xml b/doc/classes/Plane.xml new file mode 100644 index 0000000000..5c4eb984db --- /dev/null +++ b/doc/classes/Plane.xml @@ -0,0 +1,160 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Plane" category="Built-In Types" version="3.0.alpha.custom_build"> + <brief_description> + Plane in hessian form. + </brief_description> + <description> + Plane represents a normalized plane equation. Basically, "normal" is the normal of the plane (a,b,c normalized), and "d" is the distance from the origin to the plane (in the direction of "normal"). "Over" or "Above" the plane is considered the side of the plane towards where the normal is pointing. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="Plane"> + <return type="Plane"> + </return> + <argument index="0" name="a" type="float"> + </argument> + <argument index="1" name="b" type="float"> + </argument> + <argument index="2" name="c" type="float"> + </argument> + <argument index="3" name="d" type="float"> + </argument> + <description> + Creates a plane from the three parameters "a", "b", "c" and "d". + </description> + </method> + <method name="Plane"> + <return type="Plane"> + </return> + <argument index="0" name="v1" type="Vector3"> + </argument> + <argument index="1" name="v2" type="Vector3"> + </argument> + <argument index="2" name="v3" type="Vector3"> + </argument> + <description> + Creates a plane from three points. + </description> + </method> + <method name="Plane"> + <return type="Plane"> + </return> + <argument index="0" name="normal" type="Vector3"> + </argument> + <argument index="1" name="d" type="float"> + </argument> + <description> + Creates a plane from the normal and the plane's distance to the origin. + </description> + </method> + <method name="center"> + <return type="Vector3"> + </return> + <description> + Returns the center of the plane. + </description> + </method> + <method name="distance_to"> + <return type="float"> + </return> + <argument index="0" name="point" type="Vector3"> + </argument> + <description> + Returns the shortest distance from the plane to the position "point". + </description> + </method> + <method name="get_any_point"> + <return type="Vector3"> + </return> + <description> + Returns a point on the plane. + </description> + </method> + <method name="has_point"> + <return type="bool"> + </return> + <argument index="0" name="point" type="Vector3"> + </argument> + <argument index="1" name="epsilon" type="float" default="0.00001"> + </argument> + <description> + Returns true if "point" is inside the plane (by a very minimum threshold). + </description> + </method> + <method name="intersect_3"> + <return type="Vector3"> + </return> + <argument index="0" name="b" type="Plane"> + </argument> + <argument index="1" name="c" type="Plane"> + </argument> + <description> + Returns the intersection point of the three planes "b", "c" and this plane. If no intersection is found null is returned. + </description> + </method> + <method name="intersects_ray"> + <return type="Vector3"> + </return> + <argument index="0" name="from" type="Vector3"> + </argument> + <argument index="1" name="dir" type="Vector3"> + </argument> + <description> + Returns the intersection point of a ray consisting of the position "from" and the direction normal "dir" with this plane. If no intersection is found null is returned. + </description> + </method> + <method name="intersects_segment"> + <return type="Vector3"> + </return> + <argument index="0" name="begin" type="Vector3"> + </argument> + <argument index="1" name="end" type="Vector3"> + </argument> + <description> + Returns the intersection point of a segment from position "begin" to position "end" with this plane. If no intersection is found null is returned. + </description> + </method> + <method name="is_point_over"> + <return type="bool"> + </return> + <argument index="0" name="point" type="Vector3"> + </argument> + <description> + Returns true if "point" is located above the plane. + </description> + </method> + <method name="normalized"> + <return type="Plane"> + </return> + <description> + Returns a copy of the plane, normalized. + </description> + </method> + <method name="project"> + <return type="Vector3"> + </return> + <argument index="0" name="point" type="Vector3"> + </argument> + <description> + Returns the orthogonal projection of point "p" into a point in the plane. + </description> + </method> + </methods> + <members> + <member name="d" type="float" setter="" getter=""> + </member> + <member name="normal" type="Vector3" setter="" getter=""> + </member> + <member name="x" type="float" setter="" getter=""> + </member> + <member name="y" type="float" setter="" getter=""> + </member> + <member name="z" type="float" setter="" getter=""> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/PlaneMesh.xml b/doc/classes/PlaneMesh.xml new file mode 100644 index 0000000000..034bc391a6 --- /dev/null +++ b/doc/classes/PlaneMesh.xml @@ -0,0 +1,70 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PlaneMesh" inherits="PrimitiveMesh" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Class representing a planar [PrimitiveMesh]. + </brief_description> + <description> + Class representing a planar [PrimitiveMesh]. This flat mesh does not have a thickness. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_size" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_subdivide_depth" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_subdivide_width" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_size"> + <return type="void"> + </return> + <argument index="0" name="size" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_subdivide_depth"> + <return type="void"> + </return> + <argument index="0" name="subdivide" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_subdivide_width"> + <return type="void"> + </return> + <argument index="0" name="subdivide" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="size" type="Vector2" setter="set_size" getter="get_size"> + Size of the generated plane. Defaults to (2.0, 2.0). + </member> + <member name="subdivide_depth" type="int" setter="set_subdivide_depth" getter="get_subdivide_depth"> + Number of subdivision along the z-axis. Defaults to 0. + </member> + <member name="subdivide_width" type="int" setter="set_subdivide_width" getter="get_subdivide_width"> + Number of subdivision along the x-axis. Defaults to 0. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/PlaneShape.xml b/doc/classes/PlaneShape.xml new file mode 100644 index 0000000000..7e7bde4db3 --- /dev/null +++ b/doc/classes/PlaneShape.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PlaneShape" inherits="Shape" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_plane" qualifiers="const"> + <return type="Plane"> + </return> + <description> + </description> + </method> + <method name="set_plane"> + <return type="void"> + </return> + <argument index="0" name="plane" type="Plane"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="plane" type="Plane" setter="set_plane" getter="get_plane"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Polygon2D.xml b/doc/classes/Polygon2D.xml new file mode 100644 index 0000000000..05869c514e --- /dev/null +++ b/doc/classes/Polygon2D.xml @@ -0,0 +1,233 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Polygon2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + 2D polygon representation + </brief_description> + <description> + A Polygon2D is defined by a set of n vertices connected together by line segments, meaning that the vertex 1 will be connected with vertex 2, vertex 2 with vertex 3 ..., vertex n-1 with vertex n and vertex n with vertex 1 in order to close the loop and define a polygon. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_antialiased" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + Return the polygon fill color. + </description> + </method> + <method name="get_invert" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether this polygon is inverted or not. + </description> + </method> + <method name="get_invert_border" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the added padding around the bounding box. + </description> + </method> + <method name="get_offset" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the offset for the polygon vertices. + </description> + </method> + <method name="get_polygon" qualifiers="const"> + <return type="PoolVector2Array"> + </return> + <description> + Return the set of vertices that defines this polygon. + </description> + </method> + <method name="get_texture" qualifiers="const"> + <return type="Texture"> + </return> + <description> + Return the polygon texture + </description> + </method> + <method name="get_texture_offset" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the polygon texture offset. + </description> + </method> + <method name="get_texture_rotation" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the rotation in radians of the texture polygon. + </description> + </method> + <method name="get_texture_scale" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the uv coordinate multiplier. + </description> + </method> + <method name="get_uv" qualifiers="const"> + <return type="PoolVector2Array"> + </return> + <description> + Return the texture coordinates associated with every vertex of the polygon. + </description> + </method> + <method name="get_vertex_colors" qualifiers="const"> + <return type="PoolColorArray"> + </return> + <description> + Return the list of vertex colors. + </description> + </method> + <method name="set_antialiased"> + <return type="void"> + </return> + <argument index="0" name="antialiased" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + Set the polygon fill color. If the polygon has a texture defined, the defined texture will be multiplied by the polygon fill color. This, also, is the default color for those vertices that are not defined by [method get_vertex_colors]. + </description> + </method> + <method name="set_invert"> + <return type="void"> + </return> + <argument index="0" name="invert" type="bool"> + </argument> + <description> + Set the polygon as the defined polygon bounding box minus the defined polygon (the defined polygon will appear as a hole on the square that contains the defined polygon). + </description> + </method> + <method name="set_invert_border"> + <return type="void"> + </return> + <argument index="0" name="invert_border" type="float"> + </argument> + <description> + Add extra padding around the bounding box, making it bigger. Too small a value can make the polygon triangulate strangely, due to numerical imprecision. + </description> + </method> + <method name="set_offset"> + <return type="void"> + </return> + <argument index="0" name="offset" type="Vector2"> + </argument> + <description> + Set the an offset that will be added to the vertices' position. E.g. if the offset is set to (10,10) then all the polygon points will move 10 units to the right and 10 units to the bottom. + </description> + </method> + <method name="set_polygon"> + <return type="void"> + </return> + <argument index="0" name="polygon" type="PoolVector2Array"> + </argument> + <description> + Define the set of vertices that will represent the polygon. + </description> + </method> + <method name="set_texture"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_texture_offset"> + <return type="void"> + </return> + <argument index="0" name="texture_offset" type="Vector2"> + </argument> + <description> + Set the offset of the polygon texture. Initially the texture will appear anchored to the polygon position, the offset is used to move the texture location away from that point (notice that the texture origin is set to its top left corner, so when offset is 0,0 the top left corner of the texture is at the polygon position), for example setting the offset to 10, 10 will move the texture 10 units to the left and 10 units to the top. + </description> + </method> + <method name="set_texture_rotation"> + <return type="void"> + </return> + <argument index="0" name="texture_rotation" type="float"> + </argument> + <description> + Set the amount of rotation of the polygon texture, [code]texture_rotation[/code] is specified in radians and clockwise rotation. + </description> + </method> + <method name="set_texture_scale"> + <return type="void"> + </return> + <argument index="0" name="texture_scale" type="Vector2"> + </argument> + <description> + Set the value that will multiply the uv coordinates ([method get_uv]) when applying the texture. Larger values make the texture smaller, and vice versa. + </description> + </method> + <method name="set_uv"> + <return type="void"> + </return> + <argument index="0" name="uv" type="PoolVector2Array"> + </argument> + <description> + Set the texture coordinates for every vertex of the polygon. There should be one uv vertex for every vertex in the polygon. If there are less, the undefined ones will be assumed to be (0,0). Extra uv vertices are ignored. + </description> + </method> + <method name="set_vertex_colors"> + <return type="void"> + </return> + <argument index="0" name="vertex_colors" type="PoolColorArray"> + </argument> + <description> + Set the color for each vertex of the polygon. There should be one color for every vertex in the polygon. If there are less, the undefined ones will be assumed to be [method get_color]. Extra color entries are ignored. + Colors are interpolated between vertices, resulting in smooth gradients when they differ. + </description> + </method> + </methods> + <members> + <member name="antialiased" type="bool" setter="set_antialiased" getter="get_antialiased"> + </member> + <member name="color" type="Color" setter="set_color" getter="get_color"> + </member> + <member name="invert_border" type="float" setter="set_invert_border" getter="get_invert_border"> + </member> + <member name="invert_enable" type="bool" setter="set_invert" getter="get_invert"> + </member> + <member name="offset" type="Vector2" setter="set_offset" getter="get_offset"> + </member> + <member name="polygon" type="PoolVector2Array" setter="set_polygon" getter="get_polygon"> + </member> + <member name="texture" type="Texture" setter="set_texture" getter="get_texture"> + </member> + <member name="texture_offset" type="Vector2" setter="set_texture_offset" getter="get_texture_offset"> + </member> + <member name="texture_rotation" type="float" setter="_set_texture_rotationd" getter="_get_texture_rotationd"> + </member> + <member name="texture_scale" type="Vector2" setter="set_texture_scale" getter="get_texture_scale"> + </member> + <member name="uv" type="PoolVector2Array" setter="set_uv" getter="get_uv"> + </member> + <member name="vertex_colors" type="PoolColorArray" setter="set_vertex_colors" getter="get_vertex_colors"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/PolygonPathFinder.xml b/doc/classes/PolygonPathFinder.xml new file mode 100644 index 0000000000..a0d1284a85 --- /dev/null +++ b/doc/classes/PolygonPathFinder.xml @@ -0,0 +1,89 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PolygonPathFinder" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="find_path"> + <return type="PoolVector2Array"> + </return> + <argument index="0" name="from" type="Vector2"> + </argument> + <argument index="1" name="to" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="get_bounds" qualifiers="const"> + <return type="Rect2"> + </return> + <description> + </description> + </method> + <method name="get_closest_point" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="point" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="get_intersections" qualifiers="const"> + <return type="PoolVector2Array"> + </return> + <argument index="0" name="from" type="Vector2"> + </argument> + <argument index="1" name="to" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="get_point_penalty" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="is_point_inside" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="point" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_point_penalty"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="penalty" type="float"> + </argument> + <description> + </description> + </method> + <method name="setup"> + <return type="void"> + </return> + <argument index="0" name="points" type="PoolVector2Array"> + </argument> + <argument index="1" name="connections" type="PoolIntArray"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="data" type="Dictionary" setter="_set_data" getter="_get_data"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/PoolByteArray.xml b/doc/classes/PoolByteArray.xml new file mode 100644 index 0000000000..2640b5118f --- /dev/null +++ b/doc/classes/PoolByteArray.xml @@ -0,0 +1,138 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PoolByteArray" category="Built-In Types" version="3.0.alpha.custom_build"> + <brief_description> + Raw byte array. + </brief_description> + <description> + Raw byte array. Contains bytes. Optimized for memory usage, can't fragment the memory. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="PoolByteArray"> + <return type="PoolByteArray"> + </return> + <argument index="0" name="from" type="Array"> + </argument> + <description> + Create from a generic array. + </description> + </method> + <method name="append"> + <argument index="0" name="byte" type="int"> + </argument> + <description> + Append an element at the end of the array (alias of [method push_back]). + </description> + </method> + <method name="append_array"> + <argument index="0" name="array" type="PoolByteArray"> + </argument> + <description> + Append a [PoolByteArray] at the end of this array. + </description> + </method> + <method name="compress"> + <return type="PoolByteArray"> + </return> + <argument index="0" name="compression_mode" type="int" default="0"> + </argument> + <description> + Returns a new [PoolByteArray] with the data compressed. Set the compression mode using one of [File]'s COMPRESS_* constants. + </description> + </method> + <method name="decompress"> + <return type="PoolByteArray"> + </return> + <argument index="0" name="buffer_size" type="int"> + </argument> + <argument index="1" name="compression_mode" type="int" default="0"> + </argument> + <description> + Returns a new [PoolByteArray] with the data decompressed. Set buffer_size to the size of the uncompressed data. Set the compression mode using one of [File]'s COMPRESS_* constants. + </description> + </method> + <method name="get_string_from_ascii"> + <return type="String"> + </return> + <description> + Returns a copy of the array's contents as [String]. Fast alternative to [method 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 [method PoolByteArray.get_string_from_utf8]. + </description> + </method> + <method name="get_string_from_utf8"> + <return type="String"> + </return> + <description> + Returns a copy of the array's contents as [String]. Slower than [method 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. + </description> + </method> + <method name="insert"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="byte" type="int"> + </argument> + <description> + 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()). + </description> + </method> + <method name="invert"> + <description> + Reverse the order of the elements in the array (so first element will now be the last). + </description> + </method> + <method name="push_back"> + <argument index="0" name="byte" type="int"> + </argument> + <description> + Append an element at the end of the array. + </description> + </method> + <method name="remove"> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Remove an element from the array by index. + </description> + </method> + <method name="resize"> + <argument index="0" name="idx" type="int"> + </argument> + <description> + 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. + </description> + </method> + <method name="set"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="byte" type="int"> + </argument> + <description> + Change the byte at the given index. + </description> + </method> + <method name="size"> + <return type="int"> + </return> + <description> + Return the size of the array. + </description> + </method> + <method name="subarray"> + <return type="PoolByteArray"> + </return> + <argument index="0" name="from" type="int"> + </argument> + <argument index="1" name="to" type="int"> + </argument> + <description> + Returns the slice of the [PoolByteArray] between indices (inclusive) as a new [PoolByteArray]. Any negative index is considered to be from the end of the array. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/PoolColorArray.xml b/doc/classes/PoolColorArray.xml new file mode 100644 index 0000000000..644256e765 --- /dev/null +++ b/doc/classes/PoolColorArray.xml @@ -0,0 +1,93 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PoolColorArray" category="Built-In Types" version="3.0.alpha.custom_build"> + <brief_description> + Array of Colors + </brief_description> + <description> + Array of Color, Contains colors. Optimized for memory usage, can't fragment the memory. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="PoolColorArray"> + <return type="PoolColorArray"> + </return> + <argument index="0" name="from" type="Array"> + </argument> + <description> + Create from a generic array. + </description> + </method> + <method name="append"> + <argument index="0" name="color" type="Color"> + </argument> + <description> + Append an element at the end of the array (alias of [method push_back]). + </description> + </method> + <method name="append_array"> + <argument index="0" name="array" type="PoolColorArray"> + </argument> + <description> + Append a [PoolColorArray] at the end of this array. + </description> + </method> + <method name="insert"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <description> + 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()). + </description> + </method> + <method name="invert"> + <description> + Reverse the order of the elements in the array (so first element will now be the last). + </description> + </method> + <method name="push_back"> + <argument index="0" name="color" type="Color"> + </argument> + <description> + Append a value to the array. + </description> + </method> + <method name="remove"> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Remove an element from the array by index. + </description> + </method> + <method name="resize"> + <argument index="0" name="idx" type="int"> + </argument> + <description> + 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. + </description> + </method> + <method name="set"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <description> + Change the [Color] at the given index. + </description> + </method> + <method name="size"> + <return type="int"> + </return> + <description> + Return the size of the array. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/PoolIntArray.xml b/doc/classes/PoolIntArray.xml new file mode 100644 index 0000000000..17772b6e2a --- /dev/null +++ b/doc/classes/PoolIntArray.xml @@ -0,0 +1,93 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PoolIntArray" category="Built-In Types" version="3.0.alpha.custom_build"> + <brief_description> + Integer Array. + </brief_description> + <description> + Integer Array. Contains integers. Optimized for memory usage, can't fragment the memory. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="PoolIntArray"> + <return type="PoolIntArray"> + </return> + <argument index="0" name="from" type="Array"> + </argument> + <description> + Create from a generic array. + </description> + </method> + <method name="append"> + <argument index="0" name="integer" type="int"> + </argument> + <description> + Append an element at the end of the array (alias of [method push_back]). + </description> + </method> + <method name="append_array"> + <argument index="0" name="array" type="PoolIntArray"> + </argument> + <description> + Append an [PoolIntArray] at the end of this array. + </description> + </method> + <method name="insert"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="integer" type="int"> + </argument> + <description> + Insert a new int at a given position in the array. The position must be valid, or at the end of the array (pos==size()). + </description> + </method> + <method name="invert"> + <description> + Reverse the order of the elements in the array (so first element will now be the last). + </description> + </method> + <method name="push_back"> + <argument index="0" name="integer" type="int"> + </argument> + <description> + Append a value to the array. + </description> + </method> + <method name="remove"> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Remove an element from the array by index. + </description> + </method> + <method name="resize"> + <argument index="0" name="idx" type="int"> + </argument> + <description> + 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. + </description> + </method> + <method name="set"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="integer" type="int"> + </argument> + <description> + Change the int at the given index. + </description> + </method> + <method name="size"> + <return type="int"> + </return> + <description> + Return the array size. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/PoolRealArray.xml b/doc/classes/PoolRealArray.xml new file mode 100644 index 0000000000..ee2740e92a --- /dev/null +++ b/doc/classes/PoolRealArray.xml @@ -0,0 +1,93 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PoolRealArray" category="Built-In Types" version="3.0.alpha.custom_build"> + <brief_description> + Real Array. + </brief_description> + <description> + Real Array. Array of floating point values. Can only contain floats. Optimized for memory usage, can't fragment the memory. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="PoolRealArray"> + <return type="PoolRealArray"> + </return> + <argument index="0" name="from" type="Array"> + </argument> + <description> + Create from a generic array. + </description> + </method> + <method name="append"> + <argument index="0" name="value" type="float"> + </argument> + <description> + Append an element at the end of the array (alias of [method push_back]). + </description> + </method> + <method name="append_array"> + <argument index="0" name="array" type="PoolRealArray"> + </argument> + <description> + Append an [RealArray] at the end of this array. + </description> + </method> + <method name="insert"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="value" type="float"> + </argument> + <description> + 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()). + </description> + </method> + <method name="invert"> + <description> + Reverse the order of the elements in the array (so first element will now be the last). + </description> + </method> + <method name="push_back"> + <argument index="0" name="value" type="float"> + </argument> + <description> + Append an element at the end of the array. + </description> + </method> + <method name="remove"> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Remove an element from the array by index. + </description> + </method> + <method name="resize"> + <argument index="0" name="idx" type="int"> + </argument> + <description> + 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. + </description> + </method> + <method name="set"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="value" type="float"> + </argument> + <description> + Change the float at the given index. + </description> + </method> + <method name="size"> + <return type="int"> + </return> + <description> + Return the size of the array. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/PoolStringArray.xml b/doc/classes/PoolStringArray.xml new file mode 100644 index 0000000000..ace4f732da --- /dev/null +++ b/doc/classes/PoolStringArray.xml @@ -0,0 +1,102 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PoolStringArray" category="Built-In Types" version="3.0.alpha.custom_build"> + <brief_description> + String Array. + </brief_description> + <description> + String Array. Array of strings. Can only contain strings. Optimized for memory usage, can't fragment the memory. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="PoolStringArray"> + <return type="PoolStringArray"> + </return> + <argument index="0" name="from" type="Array"> + </argument> + <description> + Create from a generic array. + </description> + </method> + <method name="append"> + <argument index="0" name="string" type="String"> + </argument> + <description> + Append an element at the end of the array (alias of [method push_back]). + </description> + </method> + <method name="append_array"> + <argument index="0" name="array" type="PoolStringArray"> + </argument> + <description> + Append an [StringArray] at the end of this array. + </description> + </method> + <method name="insert"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="string" type="String"> + </argument> + <description> + 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()). + </description> + </method> + <method name="invert"> + <description> + Reverse the order of the elements in the array (so first element will now be the last). + </description> + </method> + <method name="join"> + <return type="String"> + </return> + <argument index="0" name="delimiter" type="String"> + </argument> + <description> + Returns a [String] with each element of the array joined with the delimiter. + </description> + </method> + <method name="push_back"> + <argument index="0" name="string" type="String"> + </argument> + <description> + Append a string element at end of the array. + </description> + </method> + <method name="remove"> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Remove an element from the array by index. + </description> + </method> + <method name="resize"> + <argument index="0" name="idx" type="int"> + </argument> + <description> + 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. + </description> + </method> + <method name="set"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="string" type="String"> + </argument> + <description> + Change the [String] at the given index. + </description> + </method> + <method name="size"> + <return type="int"> + </return> + <description> + Return the size of the array. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/PoolVector2Array.xml b/doc/classes/PoolVector2Array.xml new file mode 100644 index 0000000000..e5df38483a --- /dev/null +++ b/doc/classes/PoolVector2Array.xml @@ -0,0 +1,93 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PoolVector2Array" category="Built-In Types" version="3.0.alpha.custom_build"> + <brief_description> + An Array of Vector2. + </brief_description> + <description> + An Array specifically designed to hold Vector2. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="PoolVector2Array"> + <return type="PoolVector2Array"> + </return> + <argument index="0" name="from" type="Array"> + </argument> + <description> + Construct a new [PoolVector2Array]. Optionally, you can pass in an Array that will be converted. + </description> + </method> + <method name="append"> + <argument index="0" name="vector2" type="Vector2"> + </argument> + <description> + Append an element at the end of the array (alias of [method push_back]). + </description> + </method> + <method name="append_array"> + <argument index="0" name="array" type="PoolVector2Array"> + </argument> + <description> + Append an [PoolVector2Array] at the end of this array. + </description> + </method> + <method name="insert"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="vector2" type="Vector2"> + </argument> + <description> + 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()). + </description> + </method> + <method name="invert"> + <description> + Reverse the order of the elements in the array (so first element will now be the last). + </description> + </method> + <method name="push_back"> + <argument index="0" name="vector2" type="Vector2"> + </argument> + <description> + Insert a [Vector2] at the end. + </description> + </method> + <method name="remove"> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Remove an element from the array by index. + </description> + </method> + <method name="resize"> + <argument index="0" name="idx" type="int"> + </argument> + <description> + 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. + </description> + </method> + <method name="set"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="vector2" type="Vector2"> + </argument> + <description> + Change the [Vector2] at the given index. + </description> + </method> + <method name="size"> + <return type="int"> + </return> + <description> + Return the size of the array. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/PoolVector3Array.xml b/doc/classes/PoolVector3Array.xml new file mode 100644 index 0000000000..13a8290531 --- /dev/null +++ b/doc/classes/PoolVector3Array.xml @@ -0,0 +1,93 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PoolVector3Array" category="Built-In Types" version="3.0.alpha.custom_build"> + <brief_description> + An Array of Vector3. + </brief_description> + <description> + An Array specifically designed to hold Vector3. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="PoolVector3Array"> + <return type="PoolVector3Array"> + </return> + <argument index="0" name="from" type="Array"> + </argument> + <description> + Construct a new PoolVector3Array. Optionally, you can pass in an Array that will be converted. + </description> + </method> + <method name="append"> + <argument index="0" name="vector3" type="Vector3"> + </argument> + <description> + Append an element at the end of the array (alias of [method push_back]). + </description> + </method> + <method name="append_array"> + <argument index="0" name="array" type="PoolVector3Array"> + </argument> + <description> + Append an [PoolVector3Array] at the end of this array. + </description> + </method> + <method name="insert"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="vector3" type="Vector3"> + </argument> + <description> + 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()). + </description> + </method> + <method name="invert"> + <description> + Reverse the order of the elements in the array (so first element will now be the last). + </description> + </method> + <method name="push_back"> + <argument index="0" name="vector3" type="Vector3"> + </argument> + <description> + Insert a [Vector3] at the end. + </description> + </method> + <method name="remove"> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Remove an element from the array by index. + </description> + </method> + <method name="resize"> + <argument index="0" name="idx" type="int"> + </argument> + <description> + 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. + </description> + </method> + <method name="set"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="vector3" type="Vector3"> + </argument> + <description> + Change the [Vector3] at the given index. + </description> + </method> + <method name="size"> + <return type="int"> + </return> + <description> + Return the size of the array. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Popup.xml b/doc/classes/Popup.xml new file mode 100644 index 0000000000..7e87c9fcc0 --- /dev/null +++ b/doc/classes/Popup.xml @@ -0,0 +1,91 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Popup" inherits="Control" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base container control for popups and dialogs. + </brief_description> + <description> + Popup is a base [Control] used to show dialogs and popups. It's a subwindow and modal by default (see [Control]) and has helpers for custom popup behavior. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="is_exclusive" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns whether the popup will hide other popups when shown on the screen. + </description> + </method> + <method name="popup"> + <return type="void"> + </return> + <argument index="0" name="bounds" type="Rect2" default="Rect2( 0, 0, 0, 0 )"> + </argument> + <description> + Popup (show the control in modal form). + </description> + </method> + <method name="popup_centered"> + <return type="void"> + </return> + <argument index="0" name="size" type="Vector2" default="Vector2( 0, 0 )"> + </argument> + <description> + Popup (show the control in modal form) in the center of the screen, at the current size, or at a size determined by "size". + </description> + </method> + <method name="popup_centered_minsize"> + <return type="void"> + </return> + <argument index="0" name="minsize" type="Vector2" default="Vector2( 0, 0 )"> + </argument> + <description> + Popup (show the control in modal form) in the center of the screen, ensuring the size is never smaller than [code]minsize[/code]. + </description> + </method> + <method name="popup_centered_ratio"> + <return type="void"> + </return> + <argument index="0" name="ratio" type="float" default="0.75"> + </argument> + <description> + Popup (show the control in modal form) in the center of the screen, scaled at a ratio of size of the screen. + </description> + </method> + <method name="set_exclusive"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Make the popup hide other popups when shown on the screen. + </description> + </method> + </methods> + <members> + <member name="popup_exclusive" type="bool" setter="set_exclusive" getter="is_exclusive"> + </member> + </members> + <signals> + <signal name="about_to_show"> + <description> + This signal is emitted when a popup is about to be shown. (often used in [PopupMenu] for clearing the list of options and creating a new one according to the current context). + </description> + </signal> + <signal name="popup_hide"> + <description> + This signal is emitted when a popup is hidden. + </description> + </signal> + </signals> + <constants> + <constant name="NOTIFICATION_POST_POPUP" value="80" enum=""> + Notification sent right after the popup is shown. + </constant> + <constant name="NOTIFICATION_POPUP_HIDE" value="81" enum=""> + Notification sent right after the popup is hidden. + </constant> + </constants> +</class> diff --git a/doc/classes/PopupDialog.xml b/doc/classes/PopupDialog.xml new file mode 100644 index 0000000000..c51c5b6d21 --- /dev/null +++ b/doc/classes/PopupDialog.xml @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PopupDialog" inherits="Popup" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base class for Popup Dialogs. + </brief_description> + <description> + PopupDialog is a base class for popup dialogs, along with [WindowDialog]. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml new file mode 100644 index 0000000000..086eb8e34d --- /dev/null +++ b/doc/classes/PopupMenu.xml @@ -0,0 +1,509 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PopupMenu" inherits="Popup" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + PopupMenu displays a list of options. + </brief_description> + <description> + PopupMenu is the typical Control that displays a list of options. They are popular in toolbars or context menus. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_check_item"> + <return type="void"> + </return> + <argument index="0" name="label" type="String"> + </argument> + <argument index="1" name="id" type="int" default="-1"> + </argument> + <argument index="2" name="accel" type="int" default="0"> + </argument> + <description> + Add a new checkable item with text "label". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. + </description> + </method> + <method name="add_check_shortcut"> + <return type="void"> + </return> + <argument index="0" name="shortcut" type="ShortCut"> + </argument> + <argument index="1" name="id" type="int" default="-1"> + </argument> + <argument index="2" name="global" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="add_icon_check_item"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <argument index="1" name="label" type="String"> + </argument> + <argument index="2" name="id" type="int" default="-1"> + </argument> + <argument index="3" name="accel" type="int" default="0"> + </argument> + <description> + Add a new checkable item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be + created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. + </description> + </method> + <method name="add_icon_check_shortcut"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <argument index="1" name="shortcut" type="ShortCut"> + </argument> + <argument index="2" name="id" type="int" default="-1"> + </argument> + <argument index="3" name="global" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="add_icon_item"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <argument index="1" name="label" type="String"> + </argument> + <argument index="2" name="id" type="int" default="-1"> + </argument> + <argument index="3" name="accel" type="int" default="0"> + </argument> + <description> + Add a new item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index. + </description> + </method> + <method name="add_icon_shortcut"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <argument index="1" name="shortcut" type="ShortCut"> + </argument> + <argument index="2" name="id" type="int" default="-1"> + </argument> + <argument index="3" name="global" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="add_item"> + <return type="void"> + </return> + <argument index="0" name="label" type="String"> + </argument> + <argument index="1" name="id" type="int" default="-1"> + </argument> + <argument index="2" name="accel" type="int" default="0"> + </argument> + <description> + Add a new item with text "label". An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index. + </description> + </method> + <method name="add_separator"> + <return type="void"> + </return> + <description> + Add a separator between items. Separators also occupy an index. + </description> + </method> + <method name="add_shortcut"> + <return type="void"> + </return> + <argument index="0" name="shortcut" type="ShortCut"> + </argument> + <argument index="1" name="id" type="int" default="-1"> + </argument> + <argument index="2" name="global" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="add_submenu_item"> + <return type="void"> + </return> + <argument index="0" name="label" type="String"> + </argument> + <argument index="1" name="submenu" type="String"> + </argument> + <argument index="2" name="id" type="int" default="-1"> + </argument> + <description> + Adds an item with a submenu. The submenu is the name of a child PopupMenu node that would be shown when the item is clicked. An id can optionally be provided, but if is isn't provided, one will be created from the index. + </description> + </method> + <method name="clear"> + <return type="void"> + </return> + <description> + Clear the popup menu, in effect removing all items. + </description> + </method> + <method name="get_item_accelerator" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused. + </description> + </method> + <method name="get_item_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the amount of items. + </description> + </method> + <method name="get_item_icon" qualifiers="const"> + <return type="Texture"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return the icon of the item at index "idx". + </description> + </method> + <method name="get_item_id" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return the id of the item at index "idx". + </description> + </method> + <method name="get_item_index" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + Find and return the index of the item containing a given id. + </description> + </method> + <method name="get_item_metadata" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return the metadata of an item, which might be of any type. You can set it with [method set_item_metadata], which provides a simple way of assigning context data to items. + </description> + </method> + <method name="get_item_shortcut" qualifiers="const"> + <return type="ShortCut"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_item_submenu" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return the submenu name of the item at index "idx". + </description> + </method> + <method name="get_item_text" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return the text of the item at index "idx". + </description> + </method> + <method name="get_item_tooltip" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="is_hide_on_checkable_item_selection"> + <return type="bool"> + </return> + <description> + Returns a boolean that indicates whether or not the PopupMenu will hide on checkable item selection. + </description> + </method> + <method name="is_hide_on_item_selection"> + <return type="bool"> + </return> + <description> + Returns a boolean that indicates whether or not the PopupMenu will hide on item selection. + </description> + </method> + <method name="is_item_checkable" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return whether the item at index "idx" has a checkbox. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. + </description> + </method> + <method name="is_item_checked" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return the checkstate status of the item at index "idx". + </description> + </method> + <method name="is_item_disabled" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return whether the item at index "idx" is disabled. When it is disabled it can't be selected, or its action invoked. + </description> + </method> + <method name="is_item_separator" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return whether the item is a seperator. If it is, it would be displayed as a line. + </description> + </method> + <method name="remove_item"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Removes the item at index "idx" from the menu. Note that the indexes of items after the removed item are going to be shifted by one. + </description> + </method> + <method name="set_hide_on_checkable_item_selection"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Sets whether or not the PopupMenu will hide on checkable item selection. + </description> + </method> + <method name="set_hide_on_item_selection"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Sets whether or not the PopupMenu will hide on item selection. + </description> + </method> + <method name="set_item_accelerator"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="accel" type="int"> + </argument> + <description> + Set the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused. + </description> + </method> + <method name="set_item_as_checkable"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> + <description> + Set whether the item at index "idx" has a checkbox. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. + </description> + </method> + <method name="set_item_as_separator"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> + <description> + Mark the item at index "idx" as a seperator, which means that it would be displayed as a mere line. + </description> + </method> + <method name="set_item_checked"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="checked" type="bool"> + </argument> + <description> + Set the checkstate status of the item at index "idx". + </description> + </method> + <method name="set_item_disabled"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="disabled" type="bool"> + </argument> + <description> + Sets whether the item at index "idx" is disabled or not. When it is disabled it can't be selected, or its action invoked. + </description> + </method> + <method name="set_item_icon"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="icon" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_item_id"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="id" type="int"> + </argument> + <description> + Set the id of the item at index "idx". + </description> + </method> + <method name="set_item_metadata"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="metadata" type="Variant"> + </argument> + <description> + Sets the metadata of an item, which might be of any type. You can later get it with [method get_item_metadata], which provides a simple way of assigning context data to items. + </description> + </method> + <method name="set_item_shortcut"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="shortcut" type="ShortCut"> + </argument> + <argument index="2" name="global" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="set_item_submenu"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="submenu" type="String"> + </argument> + <description> + Sets the submenu of the item at index "idx". The submenu is the name of a child PopupMenu node that would be shown when the item is clicked. + </description> + </method> + <method name="set_item_text"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="text" type="String"> + </argument> + <description> + Set the text of the item at index "idx". + </description> + </method> + <method name="set_item_tooltip"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="tooltip" type="String"> + </argument> + <description> + </description> + </method> + <method name="toggle_item_checked"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="hide_on_checkable_item_selection" type="bool" setter="set_hide_on_checkable_item_selection" getter="is_hide_on_checkable_item_selection"> + </member> + <member name="hide_on_item_selection" type="bool" setter="set_hide_on_item_selection" getter="is_hide_on_item_selection"> + </member> + <member name="items" type="Array" setter="_set_items" getter="_get_items"> + </member> + </members> + <signals> + <signal name="id_pressed"> + <argument index="0" name="ID" type="int"> + </argument> + <description> + This event is emitted when an item of some id is pressed or its accelerator is activated. + </description> + </signal> + <signal name="index_pressed"> + <argument index="0" name="index" type="int"> + </argument> + <description> + This event is emitted when an item of some index is pressed or its accelerator is activated. + </description> + </signal> + </signals> + <constants> + </constants> + <theme_items> + <theme_item name="checked" type="Texture"> + </theme_item> + <theme_item name="font" type="Font"> + </theme_item> + <theme_item name="font_color" type="Color"> + </theme_item> + <theme_item name="font_color_accel" type="Color"> + </theme_item> + <theme_item name="font_color_disabled" type="Color"> + </theme_item> + <theme_item name="font_color_hover" type="Color"> + </theme_item> + <theme_item name="hover" type="StyleBox"> + </theme_item> + <theme_item name="hseparation" type="int"> + </theme_item> + <theme_item name="panel" type="StyleBox"> + </theme_item> + <theme_item name="panel_disabled" type="StyleBox"> + </theme_item> + <theme_item name="separator" type="StyleBox"> + </theme_item> + <theme_item name="submenu" type="Texture"> + </theme_item> + <theme_item name="unchecked" type="Texture"> + </theme_item> + <theme_item name="vseparation" type="int"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/PopupPanel.xml b/doc/classes/PopupPanel.xml new file mode 100644 index 0000000000..f8060ab4f6 --- /dev/null +++ b/doc/classes/PopupPanel.xml @@ -0,0 +1,21 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PopupPanel" inherits="Popup" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Class for displaying popups with a panel background. + </brief_description> + <description> + Class for displaying popups with a panel background. In some cases it might be simpler to use than [Popup], since it provides a configurable background. If you are making windows, better check [WindowDialog]. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> + <theme_items> + <theme_item name="panel" type="StyleBox"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/Position2D.xml b/doc/classes/Position2D.xml new file mode 100644 index 0000000000..ffb1c62d0f --- /dev/null +++ b/doc/classes/Position2D.xml @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Position2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Generic 2D Position hint for editing. + </brief_description> + <description> + Generic 2D Position hint for editing. It's just like a plain [Node2D] but displays as a cross in the 2D-Editor at all times. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Position3D.xml b/doc/classes/Position3D.xml new file mode 100644 index 0000000000..a544e59ddc --- /dev/null +++ b/doc/classes/Position3D.xml @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Position3D" inherits="Spatial" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Generic 3D Position hint for editing + </brief_description> + <description> + Generic 3D Position hint for editing. It's just like a plain [Spatial] but displays as a cross in the 3D-Editor at all times. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/PrimitiveMesh.xml b/doc/classes/PrimitiveMesh.xml new file mode 100644 index 0000000000..34141edbe7 --- /dev/null +++ b/doc/classes/PrimitiveMesh.xml @@ -0,0 +1,42 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PrimitiveMesh" inherits="Mesh" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base class for all primitive meshes. Handles applying a [Material] to a primitive mesh. + </brief_description> + <description> + Base class for all primitive meshes. Handles applying a [Material] to a primitive mesh. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_material" qualifiers="const"> + <return type="Material"> + </return> + <description> + </description> + </method> + <method name="get_mesh_arrays" qualifiers="const"> + <return type="Array"> + </return> + <description> + </description> + </method> + <method name="set_material"> + <return type="void"> + </return> + <argument index="0" name="material" type="Material"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="material" type="Material" setter="set_material" getter="get_material"> + The current [Material] of the primitive mesh. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/PrismMesh.xml b/doc/classes/PrismMesh.xml new file mode 100644 index 0000000000..21fa67bc82 --- /dev/null +++ b/doc/classes/PrismMesh.xml @@ -0,0 +1,104 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PrismMesh" inherits="PrimitiveMesh" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Class representing a prism-shaped [PrimitiveMesh]. + </brief_description> + <description> + Class representing a prism-shaped [PrimitiveMesh]. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_left_to_right" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_size" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_subdivide_depth" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_subdivide_height" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_subdivide_width" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_left_to_right"> + <return type="void"> + </return> + <argument index="0" name="left_to_right" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_size"> + <return type="void"> + </return> + <argument index="0" name="size" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="set_subdivide_depth"> + <return type="void"> + </return> + <argument index="0" name="segments" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_subdivide_height"> + <return type="void"> + </return> + <argument index="0" name="segments" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_subdivide_width"> + <return type="void"> + </return> + <argument index="0" name="segments" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="left_to_right" type="float" setter="set_left_to_right" getter="get_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). + </member> + <member name="size" type="Vector3" setter="set_size" getter="get_size"> + Size of the prism. Defaults to (2.0, 2.0, 2.0). + </member> + <member name="subdivide_depth" type="int" setter="set_subdivide_depth" getter="get_subdivide_depth"> + Number of added edge loops along the z-axis. Defaults to 0. + </member> + <member name="subdivide_height" type="int" setter="set_subdivide_height" getter="get_subdivide_height"> + Number of added edge loops along the y-axis. Defaults to 0. + </member> + <member name="subdivide_width" type="int" setter="set_subdivide_width" getter="get_subdivide_width"> + Number of added edge loops along the x-axis. Defaults to 0. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/ProceduralSky.xml b/doc/classes/ProceduralSky.xml new file mode 100644 index 0000000000..032ce9def2 --- /dev/null +++ b/doc/classes/ProceduralSky.xml @@ -0,0 +1,285 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ProceduralSky" inherits="Sky" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_ground_bottom_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_ground_curve" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_ground_energy" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_ground_horizon_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_sky_curve" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_sky_energy" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_sky_horizon_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_sky_top_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_sun_angle_max" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_sun_angle_min" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_sun_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_sun_curve" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_sun_energy" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_sun_latitude" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_sun_longitude" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_texture_size" qualifiers="const"> + <return type="int" enum="ProceduralSky.TextureSize"> + </return> + <description> + </description> + </method> + <method name="set_ground_bottom_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_ground_curve"> + <return type="void"> + </return> + <argument index="0" name="curve" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_ground_energy"> + <return type="void"> + </return> + <argument index="0" name="energy" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_ground_horizon_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_sky_curve"> + <return type="void"> + </return> + <argument index="0" name="curve" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_sky_energy"> + <return type="void"> + </return> + <argument index="0" name="energy" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_sky_horizon_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_sky_top_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_sun_angle_max"> + <return type="void"> + </return> + <argument index="0" name="degrees" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_sun_angle_min"> + <return type="void"> + </return> + <argument index="0" name="degrees" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_sun_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_sun_curve"> + <return type="void"> + </return> + <argument index="0" name="curve" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_sun_energy"> + <return type="void"> + </return> + <argument index="0" name="energy" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_sun_latitude"> + <return type="void"> + </return> + <argument index="0" name="degrees" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_sun_longitude"> + <return type="void"> + </return> + <argument index="0" name="degrees" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_texture_size"> + <return type="void"> + </return> + <argument index="0" name="size" type="int" enum="ProceduralSky.TextureSize"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="ground_bottom_color" type="Color" setter="set_ground_bottom_color" getter="get_ground_bottom_color"> + </member> + <member name="ground_curve" type="float" setter="set_ground_curve" getter="get_ground_curve"> + </member> + <member name="ground_energy" type="float" setter="set_ground_energy" getter="get_ground_energy"> + </member> + <member name="ground_horizon_color" type="Color" setter="set_ground_horizon_color" getter="get_ground_horizon_color"> + </member> + <member name="sky_curve" type="float" setter="set_sky_curve" getter="get_sky_curve"> + </member> + <member name="sky_energy" type="float" setter="set_sky_energy" getter="get_sky_energy"> + </member> + <member name="sky_horizon_color" type="Color" setter="set_sky_horizon_color" getter="get_sky_horizon_color"> + </member> + <member name="sky_top_color" type="Color" setter="set_sky_top_color" getter="get_sky_top_color"> + </member> + <member name="sun_angle_max" type="float" setter="set_sun_angle_max" getter="get_sun_angle_max"> + </member> + <member name="sun_angle_min" type="float" setter="set_sun_angle_min" getter="get_sun_angle_min"> + </member> + <member name="sun_color" type="Color" setter="set_sun_color" getter="get_sun_color"> + </member> + <member name="sun_curve" type="float" setter="set_sun_curve" getter="get_sun_curve"> + </member> + <member name="sun_energy" type="float" setter="set_sun_energy" getter="get_sun_energy"> + </member> + <member name="sun_latitude" type="float" setter="set_sun_latitude" getter="get_sun_latitude"> + </member> + <member name="sun_longitude" type="float" setter="set_sun_longitude" getter="get_sun_longitude"> + </member> + <member name="texture_size" type="int" setter="set_texture_size" getter="get_texture_size" enum="ProceduralSky.TextureSize"> + </member> + </members> + <constants> + <constant name="TEXTURE_SIZE_256" value="0"> + </constant> + <constant name="TEXTURE_SIZE_512" value="1"> + </constant> + <constant name="TEXTURE_SIZE_1024" value="2"> + </constant> + <constant name="TEXTURE_SIZE_2048" value="3"> + </constant> + <constant name="TEXTURE_SIZE_4096" value="4"> + </constant> + <constant name="TEXTURE_SIZE_MAX" value="5"> + </constant> + </constants> +</class> diff --git a/doc/classes/ProgressBar.xml b/doc/classes/ProgressBar.xml new file mode 100644 index 0000000000..f6be04cc19 --- /dev/null +++ b/doc/classes/ProgressBar.xml @@ -0,0 +1,47 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ProgressBar" inherits="Range" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + General purpose progress bar. + </brief_description> + <description> + General purpose progress bar. Shows fill percentage from right to left. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="is_percent_visible" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_percent_visible"> + <return type="void"> + </return> + <argument index="0" name="visible" type="bool"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="percent_visible" type="bool" setter="set_percent_visible" getter="is_percent_visible"> + </member> + </members> + <constants> + </constants> + <theme_items> + <theme_item name="bg" type="StyleBox"> + </theme_item> + <theme_item name="fg" type="StyleBox"> + </theme_item> + <theme_item name="font" type="Font"> + </theme_item> + <theme_item name="font_color" type="Color"> + </theme_item> + <theme_item name="font_color_shadow" type="Color"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml new file mode 100644 index 0000000000..bec9525a45 --- /dev/null +++ b/doc/classes/ProjectSettings.xml @@ -0,0 +1,159 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ProjectSettings" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Contains global variables accessible from everywhere. + </brief_description> + <description> + Contains global variables accessible from everywhere. Use the normal [Object] API, such as "ProjectSettings.get(variable)", "ProjectSettings.set(variable,value)" or "ProjectSettings.has(variable)" to access them. Variables stored in project.godot are also loaded into ProjectSettings, making this object very useful for reading custom game configuration options. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_property_info"> + <return type="void"> + </return> + <argument index="0" name="hint" type="Dictionary"> + </argument> + <description> + Add a custom property info to a property. The dictionary must contain: name:[String](the name of the property) and type:[int](see TYPE_* in [@Global Scope]), and optionally hint:[int](see PROPERTY_HINT_* in [@Global Scope]), hint_string:[String]. + Example: + [codeblock] + ProjectSettings.set("category/property_name", 0) + + var property_info = { + "name": "category/property_name", + "type": TYPE_INT, + "hint": PROPERTY_HINT_ENUM, + "hint_string": "one,two,three" + } + + ProjectSettings.add_property_info(property_info) + [/codeblock] + </description> + </method> + <method name="clear"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Clear the whole configuration (not recommended, may break things). + </description> + </method> + <method name="get_order" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Return the order of a configuration value (influences when saved to the config file). + </description> + </method> + <method name="get_singleton" qualifiers="const"> + <return type="Object"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="globalize_path" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + Convert a localized path (res://) to a full native OS path. + </description> + </method> + <method name="has" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Return true if a configuration value is present. + </description> + </method> + <method name="has_singleton" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="load_resource_pack"> + <return type="bool"> + </return> + <argument index="0" name="pack" type="String"> + </argument> + <description> + </description> + </method> + <method name="localize_path" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + Convert a path to a localized path (res:// path). + </description> + </method> + <method name="property_can_revert"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="property_get_revert"> + <return type="Variant"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="save"> + <return type="int" enum="Error"> + </return> + <description> + </description> + </method> + <method name="save_custom"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="file" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_initial_value"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="value" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="set_order"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="pos" type="int"> + </argument> + <description> + Set the order of a configuration value (influences when saved to the config file). + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/ProximityGroup.xml b/doc/classes/ProximityGroup.xml new file mode 100644 index 0000000000..9b4b564900 --- /dev/null +++ b/doc/classes/ProximityGroup.xml @@ -0,0 +1,71 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ProximityGroup" inherits="Spatial" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + General purpose proximity-detection node. + </brief_description> + <description> + General purpose proximity-detection node. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="broadcast"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="parameters" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="get_grid_radius" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="set_dispatch_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_grid_radius"> + <return type="void"> + </return> + <argument index="0" name="radius" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="set_group_name"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="grid_radius" type="Vector3" setter="set_grid_radius" getter="get_grid_radius"> + </member> + </members> + <signals> + <signal name="broadcast"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="parameters" type="Array"> + </argument> + <description> + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/QuadMesh.xml b/doc/classes/QuadMesh.xml new file mode 100644 index 0000000000..b7c66b04de --- /dev/null +++ b/doc/classes/QuadMesh.xml @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="QuadMesh" inherits="PrimitiveMesh" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Class representing a square mesh. + </brief_description> + <description> + Class representing a square mesh with size (2,2,0). Consider using a [PlaneMesh] if you require a differently sized plane. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Quat.xml b/doc/classes/Quat.xml new file mode 100644 index 0000000000..f07e143aa0 --- /dev/null +++ b/doc/classes/Quat.xml @@ -0,0 +1,148 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Quat" category="Built-In Types" version="3.0.alpha.custom_build"> + <brief_description> + Quaternion. + </brief_description> + <description> + Quaternion is a 4 dimensional vector that is used to represent a rotation. It mainly exists to perform SLERP (spherical-linear interpolation) between two rotations. Multiplying quaternions also cheaply reproduces rotation sequences. However quaternions need to be often renormalized, or else they suffer from precision issues. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="Quat"> + <return type="Quat"> + </return> + <argument index="0" name="x" type="float"> + </argument> + <argument index="1" name="y" type="float"> + </argument> + <argument index="2" name="z" type="float"> + </argument> + <argument index="3" name="w" type="float"> + </argument> + <description> + </description> + </method> + <method name="Quat"> + <return type="Quat"> + </return> + <argument index="0" name="axis" type="Vector3"> + </argument> + <argument index="1" name="angle" type="float"> + </argument> + <description> + Returns a quaternion that will rotate around the given axis by the specified angle. The axis must be a normalized vector. + </description> + </method> + <method name="Quat"> + <return type="Quat"> + </return> + <argument index="0" name="from" type="Basis"> + </argument> + <description> + Returns the rotation matrix corresponding to the given quaternion. + </description> + </method> + <method name="cubic_slerp"> + <return type="Quat"> + </return> + <argument index="0" name="b" type="Quat"> + </argument> + <argument index="1" name="pre_a" type="Quat"> + </argument> + <argument index="2" name="post_b" type="Quat"> + </argument> + <argument index="3" name="t" type="float"> + </argument> + <description> + </description> + </method> + <method name="dot"> + <return type="float"> + </return> + <argument index="0" name="b" type="Quat"> + </argument> + <description> + Returns the dot product of two quaternions. + </description> + </method> + <method name="inverse"> + <return type="Quat"> + </return> + <description> + Returns the inverse of the quaternion. + </description> + </method> + <method name="is_normalized"> + <return type="bool"> + </return> + <description> + Returns whether the quaternion is normalized or not. + </description> + </method> + <method name="length"> + <return type="float"> + </return> + <description> + Returns the length of the quaternion. + </description> + </method> + <method name="length_squared"> + <return type="float"> + </return> + <description> + Returns the length of the quaternion, squared. + </description> + </method> + <method name="normalized"> + <return type="Quat"> + </return> + <description> + Returns a copy of the quaternion, normalized to unit length. + </description> + </method> + <method name="slerp"> + <return type="Quat"> + </return> + <argument index="0" name="b" type="Quat"> + </argument> + <argument index="1" name="t" type="float"> + </argument> + <description> + Perform a spherical-linear interpolation with another quaternion. + </description> + </method> + <method name="slerpni"> + <return type="Quat"> + </return> + <argument index="0" name="b" type="Quat"> + </argument> + <argument index="1" name="t" type="float"> + </argument> + <description> + </description> + </method> + <method name="xform"> + <return type="Vector3"> + </return> + <argument index="0" name="v" type="Vector3"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="w" type="float" setter="" getter=""> + </member> + <member name="x" type="float" setter="" getter=""> + </member> + <member name="y" type="float" setter="" getter=""> + </member> + <member name="z" type="float" setter="" getter=""> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/RID.xml b/doc/classes/RID.xml new file mode 100644 index 0000000000..89005b0d3b --- /dev/null +++ b/doc/classes/RID.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="RID" category="Built-In Types" version="3.0.alpha.custom_build"> + <brief_description> + Handle for a [Resource]'s unique ID. + </brief_description> + <description> + The RID type is used to access the unique integer ID of a resource. They are opaque, so they do not grant access to the associated resource by themselves. They are used by and with the low-level Server classes such as [VisualServer]. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="RID"> + <return type="RID"> + </return> + <argument index="0" name="from" type="Object"> + </argument> + <description> + Create a new RID instance with the ID of a given resource. When not handed a valid resource, silently stores the unused ID 0. + </description> + </method> + <method name="get_id"> + <return type="int"> + </return> + <description> + Retrieve the ID of the referenced resource. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Range.xml b/doc/classes/Range.xml new file mode 100644 index 0000000000..9af6abf7b8 --- /dev/null +++ b/doc/classes/Range.xml @@ -0,0 +1,182 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Range" inherits="Control" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Abstract base class for range-based controls. + </brief_description> + <description> + Range is a base class for [Control] nodes that change a floating point [i]value[/i] between a [i]minimum[/i] and a [i]maximum[/i], using [i]step[/i] and [i]page[/i], for example a [ScrollBar]. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_as_ratio" qualifiers="const"> + <return type="float"> + </return> + <description> + Return value mapped to 0 to 1 range. + </description> + </method> + <method name="get_max" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the maximum value. + </description> + </method> + <method name="get_min" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the minimum value. + </description> + </method> + <method name="get_page" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the page size, if page is 0, paging is disabled. + </description> + </method> + <method name="get_step" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the stepping, if step is 0, stepping is disabled. + </description> + </method> + <method name="get_value" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="is_ratio_exp" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_using_rounded_values" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_as_ratio"> + <return type="void"> + </return> + <argument index="0" name="value" type="float"> + </argument> + <description> + Set value mapped to 0 to 1 (unit) range, it will then be converted to the actual value within min and max. + </description> + </method> + <method name="set_exp_ratio"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_max"> + <return type="void"> + </return> + <argument index="0" name="maximum" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_min"> + <return type="void"> + </return> + <argument index="0" name="minimum" type="float"> + </argument> + <description> + Set minimum value, clamped range value to it if it's less. + </description> + </method> + <method name="set_page"> + <return type="void"> + </return> + <argument index="0" name="pagesize" type="float"> + </argument> + <description> + Set page size. Page is mainly used for scrollbars or anything that controls text scrolling. + </description> + </method> + <method name="set_step"> + <return type="void"> + </return> + <argument index="0" name="step" type="float"> + </argument> + <description> + Set step value. If step is 0, stepping will be disabled. + </description> + </method> + <method name="set_use_rounded_values"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_value"> + <return type="void"> + </return> + <argument index="0" name="value" type="float"> + </argument> + <description> + </description> + </method> + <method name="share"> + <return type="void"> + </return> + <argument index="0" name="with" type="Node"> + </argument> + <description> + </description> + </method> + <method name="unshare"> + <return type="void"> + </return> + <description> + </description> + </method> + </methods> + <members> + <member name="exp_edit" type="bool" setter="set_exp_ratio" getter="is_ratio_exp"> + </member> + <member name="max_value" type="float" setter="set_max" getter="get_max"> + </member> + <member name="min_value" type="float" setter="set_min" getter="get_min"> + </member> + <member name="page" type="float" setter="set_page" getter="get_page"> + </member> + <member name="rounded" type="bool" setter="set_use_rounded_values" getter="is_using_rounded_values"> + </member> + <member name="step" type="float" setter="set_step" getter="get_step"> + </member> + <member name="value" type="float" setter="set_value" getter="get_value"> + </member> + </members> + <signals> + <signal name="changed"> + <description> + This signal is emitted when min, max, range or step change. + </description> + </signal> + <signal name="value_changed"> + <argument index="0" name="value" type="float"> + </argument> + <description> + This signal is emitted when value changes. + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/RayCast.xml b/doc/classes/RayCast.xml new file mode 100644 index 0000000000..2e6efff769 --- /dev/null +++ b/doc/classes/RayCast.xml @@ -0,0 +1,201 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="RayCast" inherits="Spatial" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Query the closest object intersecting a ray. + </brief_description> + <description> + A RayCast represents a line from its origin to its destination position, [code]cast_to[/code]. 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 [code]add_exception[/code], by setting proper filtering with collision layers, or by filtering object types with type masks. + + Only enabled raycasts will be able to query the space and report collisions. + + RayCast calculates intersection every fixed frame (see [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 [method force_raycast_update] after adjusting the raycast. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_exception"> + <return type="void"> + </return> + <argument index="0" name="node" type="Object"> + </argument> + <description> + Adds a collision exception so the ray does not report collisions with the specified node. + </description> + </method> + <method name="add_exception_rid"> + <return type="void"> + </return> + <argument index="0" name="rid" type="RID"> + </argument> + <description> + Adds a collision exception so the ray does not report collisions with the specified [RID]. + </description> + </method> + <method name="clear_exceptions"> + <return type="void"> + </return> + <description> + Removes all collision exceptions for this ray. + </description> + </method> + <method name="force_raycast_update"> + <return type="void"> + </return> + <description> + Updates the collision information for the ray. + Use this method to update the collision information immediately instead of waiting for the next [code]_fixed_process[/code] call, for example if the ray or its parent has changed state. Note: [code]enabled == true[/code] is not required for this to work. + </description> + </method> + <method name="get_cast_to" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + Return the destination point of this ray object. + </description> + </method> + <method name="get_collider" qualifiers="const"> + <return type="Object"> + </return> + <description> + 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 [method is_colliding] to check if the object returned is actually colliding with the ray. + Example: + [codeblock] + if RayCast.is_colliding(): + var collider = RayCast.get_collider() + [/codeblock] + </description> + </method> + <method name="get_collider_shape" qualifiers="const"> + <return type="int"> + </return> + <description> + 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 [method is_colliding] to check if the object returned is actually colliding with the ray. + Example: + [codeblock] + if RayCast.is_colliding(): + var shape = RayCast.get_collider_shape() + [/codeblock] + </description> + </method> + <method name="get_collision_layer" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the collision layer for this ray. + </description> + </method> + <method name="get_collision_normal" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + Returns the normal of the intersecting object's shape at the collision point. + </description> + </method> + <method name="get_collision_point" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + Returns the collision point at which the ray intersects the closest object. Note: this point is in the [b]global[/b] coordinate system. + </description> + </method> + <method name="get_type_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the type mask (types of objects to detect) for this ray. The value is a sum (bitwise OR'd) of constants available for [PhysicsDirectSpaceState]. + </description> + </method> + <method name="is_colliding" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether the closest object the ray is pointing to is colliding with the vector (considering the vector length). + </description> + </method> + <method name="is_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns whether the ray is enabled or not. + </description> + </method> + <method name="remove_exception"> + <return type="void"> + </return> + <argument index="0" name="node" type="Object"> + </argument> + <description> + Removes a collision exception so the ray does report collisions with the specified node. + </description> + </method> + <method name="remove_exception_rid"> + <return type="void"> + </return> + <argument index="0" name="rid" type="RID"> + </argument> + <description> + Removes a collision exception so the ray does report collisions with the specified [RID]. + </description> + </method> + <method name="set_cast_to"> + <return type="void"> + </return> + <argument index="0" name="local_point" type="Vector3"> + </argument> + <description> + Sets the ray destination point, so that the ray will test from the ray's origin to [code]local_point[/code]. + </description> + </method> + <method name="set_collision_layer"> + <return type="void"> + </return> + <argument index="0" name="layer" type="int"> + </argument> + <description> + Set the mask to filter objects. Only objects with at least the same mask element set will be detected. + </description> + </method> + <method name="set_enabled"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Enables the RayCast2D. Only enabled raycasts will be able to query the space and report collisions. + </description> + </method> + <method name="set_type_mask"> + <return type="void"> + </return> + <argument index="0" name="mask" type="int"> + </argument> + <description> + Set the types of objects to detect. For [code]mask[/code] use a logic sum (OR operation) of constants defined in [PhysicsDirectSpaceState], eg. [code]PhysicsDirectSpaceState.TYPE_MASK_STATIC_BODY | PhysicsDirectSpaceState.TYPE_MASK_KINEMATIC_BODY[/code] to detect only those two types. + </description> + </method> + </methods> + <members> + <member name="cast_to" type="Vector3" setter="set_cast_to" getter="get_cast_to"> + The ray's destination point, relative to the RayCast's [code]position[/code]. + </member> + <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer"> + The RayCast's collison layer(s). Only bodies in the same collision layer(s) will be detected. + </member> + <member name="enabled" type="bool" setter="set_enabled" getter="is_enabled"> + If [code]true[/code], collisions will be reported. Default value: [code]false[/code]. + </member> + <member name="type_mask" type="int" setter="set_type_mask" getter="get_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] + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml new file mode 100644 index 0000000000..5520abe050 --- /dev/null +++ b/doc/classes/RayCast2D.xml @@ -0,0 +1,216 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="RayCast2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Query the closest object intersecting a ray. + </brief_description> + <description> + A RayCast represents a line from its origin to its destination position, [code]cast_to[/code]. 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 [code]add_exception[/code], 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 [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 [method force_raycast_update] after adjusting the raycast. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_exception"> + <return type="void"> + </return> + <argument index="0" name="node" type="Object"> + </argument> + <description> + Adds a collision exception so the ray does not report collisions with the specified node. + </description> + </method> + <method name="add_exception_rid"> + <return type="void"> + </return> + <argument index="0" name="rid" type="RID"> + </argument> + <description> + Adds a collision exception so the ray does not report collisions with the specified [RID]. + </description> + </method> + <method name="clear_exceptions"> + <return type="void"> + </return> + <description> + Removes all collision exceptions for this ray. + </description> + </method> + <method name="force_raycast_update"> + <return type="void"> + </return> + <description> + Updates the collision information for the ray. Use this method to update the collision information immediately instead of waiting for the next [code]_fixed_process[/code] call, for example if the ray or its parent has changed state. Note: [code]enabled == true[/code] is not required for this to work. + </description> + </method> + <method name="get_cast_to" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the destination point of this ray object. + </description> + </method> + <method name="get_collider" qualifiers="const"> + <return type="Object"> + </return> + <description> + 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 [method is_colliding] to check if the object returned is actually colliding with the ray. + Example: + [codeblock] + if RayCast2D.is_colliding(): + var collider = RayCast2D.get_collider() + [/codeblock] + </description> + </method> + <method name="get_collider_shape" qualifiers="const"> + <return type="int"> + </return> + <description> + 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 [method is_colliding] to check if the object returned is actually colliding with the ray. + Example: + [codeblock] + if RayCast2D.is_colliding(): + var shape = RayCast2D.get_collider_shape() + [/codeblock] + </description> + </method> + <method name="get_collision_layer" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the collision layer for this ray. + </description> + </method> + <method name="get_collision_normal" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Returns the normal of the intersecting object's shape at the collision point. + </description> + </method> + <method name="get_collision_point" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Returns the collision point at which the ray intersects the closest object. Note: this point is in the [b]global[/b] coordinate system. + </description> + </method> + <method name="get_exclude_parent_body" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns whether this ray should hit your parent node, if it's a body. + </description> + </method> + <method name="get_type_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the type mask (types of objects to detect) for this ray. The value is a sum (bitwise OR'd) of constants available for [Physics2DDirectSpaceState]. + </description> + </method> + <method name="is_colliding" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether the closest object the ray is pointing to is colliding with the vector (considering the vector length). + </description> + </method> + <method name="is_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns whether this raycast is enabled or not. + </description> + </method> + <method name="remove_exception"> + <return type="void"> + </return> + <argument index="0" name="node" type="Object"> + </argument> + <description> + Removes a collision exception so the ray does report collisions with the specified node. + </description> + </method> + <method name="remove_exception_rid"> + <return type="void"> + </return> + <argument index="0" name="rid" type="RID"> + </argument> + <description> + Removes a collision exception so the ray does report collisions with the specified [RID]. + </description> + </method> + <method name="set_cast_to"> + <return type="void"> + </return> + <argument index="0" name="local_point" type="Vector2"> + </argument> + <description> + Sets the ray destination point, so that the ray will test from the ray's origin to [code]local_point[/code] + </description> + </method> + <method name="set_collision_layer"> + <return type="void"> + </return> + <argument index="0" name="layer" type="int"> + </argument> + <description> + Set the mask to filter objects. Only objects with at least the same mask element set will be detected. + </description> + </method> + <method name="set_enabled"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Enables the RayCast2D. Only enabled raycasts will be able to query the space and report collisions. + </description> + </method> + <method name="set_exclude_parent_body"> + <return type="void"> + </return> + <argument index="0" name="mask" type="bool"> + </argument> + <description> + Toggle whether this ray should hit your parent node, if it's a body. + </description> + </method> + <method name="set_type_mask"> + <return type="void"> + </return> + <argument index="0" name="mask" type="int"> + </argument> + <description> + Set the types of objects to detect. For [code]mask[/code] use a logic sum (OR operation) of constants defined in [Physics2DDirectSpaceState], eg. [code]Physics2DDirectSpaceState.TYPE_MASK_STATIC_BODY | Physics2DDirectSpaceState.TYPE_MASK_KINEMATIC_BODY[/code] to detect only those two types. + </description> + </method> + </methods> + <members> + <member name="cast_to" type="Vector2" setter="set_cast_to" getter="get_cast_to"> + The ray's destination point, relative to the RayCast's [code]position[/code]. + </member> + <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer"> + The RayCast2D's collison layer(s). Only bodies in the same collision layer(s) will be detected. + </member> + <member name="enabled" type="bool" setter="set_enabled" getter="is_enabled"> + If [code]true[/code], collisions will be reported. Default value: [code]false[/code]. + </member> + <member name="exclude_parent" type="bool" setter="set_exclude_parent_body" getter="get_exclude_parent_body"> + If [code]true[/code], the parent node will be excluded from collision detection. Default value: [code]true[/code]. + </member> + <member name="type_mask" type="int" setter="set_type_mask" getter="get_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] + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/RayShape.xml b/doc/classes/RayShape.xml new file mode 100644 index 0000000000..7fab9c3949 --- /dev/null +++ b/doc/classes/RayShape.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="RayShape" inherits="Shape" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_length" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="set_length"> + <return type="void"> + </return> + <argument index="0" name="length" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="length" type="float" setter="set_length" getter="get_length"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/RayShape2D.xml b/doc/classes/RayShape2D.xml new file mode 100644 index 0000000000..4f6313a1d2 --- /dev/null +++ b/doc/classes/RayShape2D.xml @@ -0,0 +1,38 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="RayShape2D" inherits="Shape2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Ray shape for 2D collisions. + </brief_description> + <description> + Ray shape for 2D collisions. A ray is not really a collision body, instead it tries to separate itself from whatever is touching its far endpoint. It's often useful for characters. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_length" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the length of the ray. + </description> + </method> + <method name="set_length"> + <return type="void"> + </return> + <argument index="0" name="length" type="float"> + </argument> + <description> + Set the length of the ray. + </description> + </method> + </methods> + <members> + <member name="length" type="float" setter="set_length" getter="get_length"> + The ray's length. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Rect2.xml b/doc/classes/Rect2.xml new file mode 100644 index 0000000000..1a467861b3 --- /dev/null +++ b/doc/classes/Rect2.xml @@ -0,0 +1,155 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Rect2" category="Built-In Types" version="3.0.alpha.custom_build"> + <brief_description> + 2D Axis-aligned bounding box. + </brief_description> + <description> + Rect2 provides an 2D Axis-Aligned Bounding Box. It consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="Rect2"> + <return type="Rect2"> + </return> + <argument index="0" name="pos" type="Vector2"> + </argument> + <argument index="1" name="size" type="Vector2"> + </argument> + <description> + Construct a [Rect2] by position and size. + </description> + </method> + <method name="Rect2"> + <return type="Rect2"> + </return> + <argument index="0" name="x" type="float"> + </argument> + <argument index="1" name="y" type="float"> + </argument> + <argument index="2" name="width" type="float"> + </argument> + <argument index="3" name="height" type="float"> + </argument> + <description> + Construct a [Rect2] by x, y, width and height. + </description> + </method> + <method name="clip"> + <return type="Rect2"> + </return> + <argument index="0" name="b" type="Rect2"> + </argument> + <description> + Returns the intersection of this [Rect2] and b. + </description> + </method> + <method name="encloses"> + <return type="bool"> + </return> + <argument index="0" name="b" type="Rect2"> + </argument> + <description> + Returns true if this [Rect2] completely encloses another one. + </description> + </method> + <method name="expand"> + <return type="Rect2"> + </return> + <argument index="0" name="to" type="Vector2"> + </argument> + <description> + Return this [Rect2] expanded to include a given point. + </description> + </method> + <method name="get_area"> + <return type="float"> + </return> + <description> + Get the area of the [Rect2]. + </description> + </method> + <method name="grow"> + <return type="Rect2"> + </return> + <argument index="0" name="by" type="float"> + </argument> + <description> + Return a copy of the [Rect2] grown a given amount of units towards all the sides. + </description> + </method> + <method name="grow_individual"> + <return type="Rect2"> + </return> + <argument index="0" name="left" type="float"> + </argument> + <argument index="1" name="top" type="float"> + </argument> + <argument index="2" name="right" type="float"> + </argument> + <argument index="3" name=" bottom" type="float"> + </argument> + <description> + </description> + </method> + <method name="grow_margin"> + <return type="Rect2"> + </return> + <argument index="0" name="margin" type="int"> + </argument> + <argument index="1" name="by" type="float"> + </argument> + <description> + </description> + </method> + <method name="has_no_area"> + <return type="bool"> + </return> + <description> + Return true if the [Rect2] is flat or empty. + </description> + </method> + <method name="has_point"> + <return type="bool"> + </return> + <argument index="0" name="point" type="Vector2"> + </argument> + <description> + Return true if the [Rect2] contains a point. + </description> + </method> + <method name="intersects"> + <return type="bool"> + </return> + <argument index="0" name="b" type="Rect2"> + </argument> + <description> + Return true if the [Rect2] overlaps with another. + </description> + </method> + <method name="merge"> + <return type="Rect2"> + </return> + <argument index="0" name="b" type="Rect2"> + </argument> + <description> + Combine this [Rect2] with another, a larger one is returned that contains both. + </description> + </method> + </methods> + <members> + <member name="end" type="Vector2" setter="" getter=""> + Ending corner. + </member> + <member name="position" type="Vector2" setter="" getter=""> + Position (starting corner). + </member> + <member name="size" type="Vector2" setter="" getter=""> + Size from position to end. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Rect3.xml b/doc/classes/Rect3.xml new file mode 100644 index 0000000000..8837b8f812 --- /dev/null +++ b/doc/classes/Rect3.xml @@ -0,0 +1,202 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Rect3" category="Built-In Types" version="3.0.alpha.custom_build"> + <brief_description> + Axis-Aligned Bounding Box. + </brief_description> + <description> + Rect3 provides an 3D Axis-Aligned Bounding Box. It consists of a position, a size, and several utility functions. It is typically used for simple (fast) overlap tests. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="Rect3"> + <return type="Rect3"> + </return> + <argument index="0" name="pos" type="Vector3"> + </argument> + <argument index="1" name="size" type="Vector3"> + </argument> + <description> + Optional constructor, accepts position and size. + </description> + </method> + <method name="encloses"> + <return type="bool"> + </return> + <argument index="0" name="with" type="Rect3"> + </argument> + <description> + Return true if this [Rect3] completely encloses another one. + </description> + </method> + <method name="expand"> + <return type="Rect3"> + </return> + <argument index="0" name="to_point" type="Vector3"> + </argument> + <description> + Return this [Rect3] expanded to include a given point. + </description> + </method> + <method name="get_area"> + <return type="float"> + </return> + <description> + Get the area of the [Rect3]. + </description> + </method> + <method name="get_endpoint"> + <return type="Vector3"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Get the position of the 8 endpoints of the [Rect3] in space. + </description> + </method> + <method name="get_longest_axis"> + <return type="Vector3"> + </return> + <description> + Return the normalized longest axis of the [Rect3]. + </description> + </method> + <method name="get_longest_axis_index"> + <return type="int"> + </return> + <description> + Return the index of the longest axis of the [Rect3] (according to [Vector3]::AXIS* enum). + </description> + </method> + <method name="get_longest_axis_size"> + <return type="float"> + </return> + <description> + Return the scalar length of the longest axis of the [Rect3]. + </description> + </method> + <method name="get_shortest_axis"> + <return type="Vector3"> + </return> + <description> + Return the normalized shortest axis of the [Rect3]. + </description> + </method> + <method name="get_shortest_axis_index"> + <return type="int"> + </return> + <description> + Return the index of the shortest axis of the [Rect3] (according to [Vector3]::AXIS* enum). + </description> + </method> + <method name="get_shortest_axis_size"> + <return type="float"> + </return> + <description> + Return the scalar length of the shortest axis of the [Rect3]. + </description> + </method> + <method name="get_support"> + <return type="Vector3"> + </return> + <argument index="0" name="dir" type="Vector3"> + </argument> + <description> + Return the support point in a given direction. This is useful for collision detection algorithms. + </description> + </method> + <method name="grow"> + <return type="Rect3"> + </return> + <argument index="0" name="by" type="float"> + </argument> + <description> + Return a copy of the [Rect3] grown a given amount of units towards all the sides. + </description> + </method> + <method name="has_no_area"> + <return type="bool"> + </return> + <description> + Return true if the [Rect3] is flat or empty. + </description> + </method> + <method name="has_no_surface"> + <return type="bool"> + </return> + <description> + Return true if the [Rect3] is empty. + </description> + </method> + <method name="has_point"> + <return type="bool"> + </return> + <argument index="0" name="point" type="Vector3"> + </argument> + <description> + Return true if the [Rect3] contains a point. + </description> + </method> + <method name="intersection"> + <return type="Rect3"> + </return> + <argument index="0" name="with" type="Rect3"> + </argument> + <description> + Return the intersection between two [Rect3]. An empty Rect3 (size 0,0,0) is returned on failure. + </description> + </method> + <method name="intersects"> + <return type="bool"> + </return> + <argument index="0" name="with" type="Rect3"> + </argument> + <description> + Return true if the [Rect3] overlaps with another. + </description> + </method> + <method name="intersects_plane"> + <return type="bool"> + </return> + <argument index="0" name="plane" type="Plane"> + </argument> + <description> + Return true if the [Rect3] is at both sides of a plane. + </description> + </method> + <method name="intersects_segment"> + <return type="bool"> + </return> + <argument index="0" name="from" type="Vector3"> + </argument> + <argument index="1" name="to" type="Vector3"> + </argument> + <description> + Return true if the [Rect3] intersects the line segment between from and to + </description> + </method> + <method name="merge"> + <return type="Rect3"> + </return> + <argument index="0" name="with" type="Rect3"> + </argument> + <description> + Combine this [Rect3] with another, a larger one is returned that contains both. + </description> + </method> + </methods> + <members> + <member name="end" type="Vector3" setter="" getter=""> + Ending corner. + </member> + <member name="position" type="Vector3" setter="" getter=""> + </member> + <member name="size" type="Vector3" setter="" getter=""> + Size from position to end. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/RectangleShape2D.xml b/doc/classes/RectangleShape2D.xml new file mode 100644 index 0000000000..7a1aec2021 --- /dev/null +++ b/doc/classes/RectangleShape2D.xml @@ -0,0 +1,38 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="RectangleShape2D" inherits="Shape2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Rectangle shape for 2D collisions. + </brief_description> + <description> + Rectangle shape for 2D collisions. This shape is useful for modeling box-like 2D objects. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_extents" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the half extents, the actual width and height of this shape is twice the half extents. + </description> + </method> + <method name="set_extents"> + <return type="void"> + </return> + <argument index="0" name="extents" type="Vector2"> + </argument> + <description> + Set the half extents, the actual width and height of this shape is twice the half extents. + </description> + </method> + </methods> + <members> + <member name="extents" type="Vector2" setter="set_extents" getter="get_extents"> + The rectangle's half extents. The width and height of this shape is twice the half extents. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Reference.xml b/doc/classes/Reference.xml new file mode 100644 index 0000000000..2531ea88ad --- /dev/null +++ b/doc/classes/Reference.xml @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Reference" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base class for anything that keeps a reference count. + </brief_description> + <description> + Base class for anything that keeps a reference count. Resource and many other helper objects inherit this. References keep an internal reference counter so they are only released when no longer in use. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="init_ref"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="reference"> + <return type="bool"> + </return> + <description> + Increase the internal reference counter. Use this only if you really know what you are doing. + </description> + </method> + <method name="unreference"> + <return type="bool"> + </return> + <description> + Decrease the internal reference counter. Use this only if you really know what you are doing. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/ReferenceRect.xml b/doc/classes/ReferenceRect.xml new file mode 100644 index 0000000000..e8de910cc8 --- /dev/null +++ b/doc/classes/ReferenceRect.xml @@ -0,0 +1,21 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ReferenceRect" inherits="Control" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Reference frame for GUI. + </brief_description> + <description> + Reference frame for GUI. It's just like an empty control, except a red box is displayed while editing around its size at all times. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> + <theme_items> + <theme_item name="border" type="StyleBox"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/ReflectionProbe.xml b/doc/classes/ReflectionProbe.xml new file mode 100644 index 0000000000..c3d95e5a62 --- /dev/null +++ b/doc/classes/ReflectionProbe.xml @@ -0,0 +1,213 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ReflectionProbe" inherits="VisualInstance" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="are_shadows_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_cull_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_extents" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_intensity" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_interior_ambient" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_interior_ambient_energy" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_interior_ambient_probe_contribution" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_max_distance" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_origin_offset" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_update_mode" qualifiers="const"> + <return type="int" enum="ReflectionProbe.UpdateMode"> + </return> + <description> + </description> + </method> + <method name="is_box_projection_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_set_as_interior" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_as_interior"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_cull_mask"> + <return type="void"> + </return> + <argument index="0" name="layers" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_enable_box_projection"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_enable_shadows"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_extents"> + <return type="void"> + </return> + <argument index="0" name="extents" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="set_intensity"> + <return type="void"> + </return> + <argument index="0" name="intensity" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_interior_ambient"> + <return type="void"> + </return> + <argument index="0" name="ambient" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_interior_ambient_energy"> + <return type="void"> + </return> + <argument index="0" name="ambient_energy" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_interior_ambient_probe_contribution"> + <return type="void"> + </return> + <argument index="0" name="ambient_probe_contribution" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_max_distance"> + <return type="void"> + </return> + <argument index="0" name="max_distance" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_origin_offset"> + <return type="void"> + </return> + <argument index="0" name="origin_offset" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="set_update_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="ReflectionProbe.UpdateMode"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="box_projection" type="bool" setter="set_enable_box_projection" getter="is_box_projection_enabled"> + </member> + <member name="cull_mask" type="int" setter="set_cull_mask" getter="get_cull_mask"> + </member> + <member name="enable_shadows" type="bool" setter="set_enable_shadows" getter="are_shadows_enabled"> + </member> + <member name="extents" type="Vector3" setter="set_extents" getter="get_extents"> + </member> + <member name="intensity" type="float" setter="set_intensity" getter="get_intensity"> + </member> + <member name="interior_ambient_color" type="Color" setter="set_interior_ambient" getter="get_interior_ambient"> + </member> + <member name="interior_ambient_contrib" type="float" setter="set_interior_ambient_probe_contribution" getter="get_interior_ambient_probe_contribution"> + </member> + <member name="interior_ambient_energy" type="float" setter="set_interior_ambient_energy" getter="get_interior_ambient_energy"> + </member> + <member name="interior_enable" type="bool" setter="set_as_interior" getter="is_set_as_interior"> + </member> + <member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance"> + </member> + <member name="origin_offset" type="Vector3" setter="set_origin_offset" getter="get_origin_offset"> + </member> + <member name="update_mode" type="int" setter="set_update_mode" getter="get_update_mode" enum="ReflectionProbe.UpdateMode"> + </member> + </members> + <constants> + <constant name="UPDATE_ONCE" value="0"> + </constant> + <constant name="UPDATE_ALWAYS" value="1"> + </constant> + </constants> +</class> diff --git a/doc/classes/RegEx.xml b/doc/classes/RegEx.xml new file mode 100644 index 0000000000..626f8f1a93 --- /dev/null +++ b/doc/classes/RegEx.xml @@ -0,0 +1,114 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="RegEx" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Simple regular expression matcher. + </brief_description> + <description> + Class for finding text patterns in a string using regular expressions. It can not perform replacements. Regular expressions are a way to define patterns of text to be searched. Details on writing patterns are too long to explain here but the Internet is full of tutorials and detailed explanations. + Once created, the RegEx object needs to be compiled with the pattern before it can be used. The pattern must be escaped first for gdscript before it is escaped for the expression. For example: + [code]var exp = RegEx.new()[/code] + [code]exp.compile("\\d+")[/code] + would be read by RegEx as [code]\d+[/code] + Similarly: + [code]exp.compile("\"(?:\\\\.|[^\"])*\"")[/code] + would be read as [code]"(?:\\.|[^"])*"[/code] + Currently supported features: + * Capturing [code]()[/code] and non-capturing [code](?:)[/code] groups + * Named capturing groups [code](?P<name>)[/code] + * Any character [code].[/code] + * Shorthand character classes [code]\w \W \s \S \d \D[/code] + * User-defined character classes such as [code][A-Za-z][/code] + * Simple quantifiers [code]?[/code], [code]*[/code] and [code]+[/code] + * Range quantifiers [code]{x,y}[/code] + * Lazy (non-greedy) quantifiers [code]*?[/code] + * Beginning [code]^[/code] and end [code]$[/code] anchors + * Alternation [code]|[/code] + * Backreferences [code]\1[/code], [code]\g{1}[/code], and [code]\g<name>[/code] + * POSIX character classes [code][[:alnum:]][/code] + * Lookahead [code](?=)[/code], [code](?!)[/code] and lookbehind [code](?<=)[/code], [code](?<!)[/code] + * ASCII [code]\xFF[/code] and Unicode [code]\uFFFF[/code] code points (in a style similar to Python) + * Word boundaries [code]\b[/code], [code]\B[/code] + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="clear"> + <return type="void"> + </return> + <description> + This method resets the state of the object, as it was freshly created. Namely, it unassigns the regular expression of this object. + </description> + </method> + <method name="compile"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="pattern" type="String"> + </argument> + <description> + Compiles and assign the regular expression pattern to use. + </description> + </method> + <method name="get_group_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the number of numeric capturing groups. + </description> + </method> + <method name="get_names" qualifiers="const"> + <return type="Array"> + </return> + <description> + Returns an array of names of named capturing groups. + </description> + </method> + <method name="get_pattern" qualifiers="const"> + <return type="String"> + </return> + <description> + Returns the expression used to compile the code. + </description> + </method> + <method name="is_valid" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns whether this object has a valid regular expression assigned. + </description> + </method> + <method name="search" qualifiers="const"> + <return type="RegExMatch"> + </return> + <argument index="0" name="subject" type="String"> + </argument> + <argument index="1" name="offset" type="int" default="0"> + </argument> + <argument index="2" name="end" type="int" default="-1"> + </argument> + <description> + Searches the text for the compiled pattern. Returns a [RegExMatch] container of the first matching reult if found, otherwise null. The region to search within can be specified without modifying where the start and end anchor would be. + </description> + </method> + <method name="sub" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="subject" type="String"> + </argument> + <argument index="1" name="replacement" type="String"> + </argument> + <argument index="2" name="all" type="bool" default="false"> + </argument> + <argument index="3" name="offset" type="int" default="0"> + </argument> + <argument index="4" name="end" type="int" default="-1"> + </argument> + <description> + Searches the text for the compiled pattern and replaces it with the specified string. Escapes and backreferences such as [code]\1[/code] and [code]\g<name>[/code] expanded and resolved. By default only the first instance is replaced but it can be changed for all instances (global replacement). The region to search within can be specified without modifying where the start and end anchor would be. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/RegExMatch.xml b/doc/classes/RegExMatch.xml new file mode 100644 index 0000000000..9e021ed6c8 --- /dev/null +++ b/doc/classes/RegExMatch.xml @@ -0,0 +1,68 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="RegExMatch" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_end" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="name" type="Variant" default="0"> + </argument> + <description> + Returns the end position of the match in the string. An integer can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern). + </description> + </method> + <method name="get_group_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the number of numeric capturing groups. + </description> + </method> + <method name="get_names" qualifiers="const"> + <return type="Dictionary"> + </return> + <description> + Returns an array of names of named capturing groups. + </description> + </method> + <method name="get_start" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="name" type="Variant" default="0"> + </argument> + <description> + Returns the starting position of the match in the string. An integer can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern). + </description> + </method> + <method name="get_string" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="name" type="Variant" default="0"> + </argument> + <description> + Returns the result of the match in the string. An integer can be specified for numeric groups or a string for named groups. Returns -1 if that group wasn't found or doesn't exist. Defaults to 0 (whole pattern). + </description> + </method> + <method name="get_strings" qualifiers="const"> + <return type="Array"> + </return> + <description> + </description> + </method> + <method name="get_subject" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/RemoteTransform.xml b/doc/classes/RemoteTransform.xml new file mode 100644 index 0000000000..ecc136055e --- /dev/null +++ b/doc/classes/RemoteTransform.xml @@ -0,0 +1,97 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="RemoteTransform" inherits="Spatial" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_remote_node" qualifiers="const"> + <return type="NodePath"> + </return> + <description> + </description> + </method> + <method name="get_update_position" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_update_rotation" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_update_scale" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_use_global_coordinates" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_remote_node"> + <return type="void"> + </return> + <argument index="0" name="path" type="NodePath"> + </argument> + <description> + </description> + </method> + <method name="set_update_position"> + <return type="void"> + </return> + <argument index="0" name="update_remote_position" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_update_rotation"> + <return type="void"> + </return> + <argument index="0" name="update_remote_rotation" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_update_scale"> + <return type="void"> + </return> + <argument index="0" name="update_remote_scale" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_use_global_coordinates"> + <return type="void"> + </return> + <argument index="0" name="use_global_coordinates" type="bool"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="remote_path" type="NodePath" setter="set_remote_node" getter="get_remote_node"> + </member> + <member name="update_position" type="bool" setter="set_update_position" getter="get_update_position"> + </member> + <member name="update_rotation" type="bool" setter="set_update_rotation" getter="get_update_rotation"> + </member> + <member name="update_scale" type="bool" setter="set_update_scale" getter="get_update_scale"> + </member> + <member name="use_global_coordinates" type="bool" setter="set_use_global_coordinates" getter="get_use_global_coordinates"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/RemoteTransform2D.xml b/doc/classes/RemoteTransform2D.xml new file mode 100644 index 0000000000..346b8de621 --- /dev/null +++ b/doc/classes/RemoteTransform2D.xml @@ -0,0 +1,97 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="RemoteTransform2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_remote_node" qualifiers="const"> + <return type="NodePath"> + </return> + <description> + </description> + </method> + <method name="get_update_position" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_update_rotation" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_update_scale" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_use_global_coordinates" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_remote_node"> + <return type="void"> + </return> + <argument index="0" name="path" type="NodePath"> + </argument> + <description> + </description> + </method> + <method name="set_update_position"> + <return type="void"> + </return> + <argument index="0" name="update_remote_position" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_update_rotation"> + <return type="void"> + </return> + <argument index="0" name="update_remote_rotation" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_update_scale"> + <return type="void"> + </return> + <argument index="0" name="update_remote_scale" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_use_global_coordinates"> + <return type="void"> + </return> + <argument index="0" name="use_global_coordinates" type="bool"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="remote_path" type="NodePath" setter="set_remote_node" getter="get_remote_node"> + </member> + <member name="update_position" type="bool" setter="set_update_position" getter="get_update_position"> + </member> + <member name="update_rotation" type="bool" setter="set_update_rotation" getter="get_update_rotation"> + </member> + <member name="update_scale" type="bool" setter="set_update_scale" getter="get_update_scale"> + </member> + <member name="use_global_coordinates" type="bool" setter="set_use_global_coordinates" getter="get_use_global_coordinates"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Resource.xml b/doc/classes/Resource.xml new file mode 100644 index 0000000000..57497f5d78 --- /dev/null +++ b/doc/classes/Resource.xml @@ -0,0 +1,119 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Resource" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base class for all resources. + </brief_description> + <description> + Resource is the base class for all resource types. Resources are primarily data containers. They are reference counted and freed when no longer in use. They are also loaded only once from disk, and further attempts to load the resource will return the same reference (all this in contrast to a [Node], which is not reference counted and can be instanced from disk as many times as desired). Resources can be saved externally on disk or bundled into another object, such as a [Node] or another resource. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="_setup_local_to_scene" qualifiers="virtual"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="duplicate" qualifiers="const"> + <return type="Resource"> + </return> + <argument index="0" name="subresources" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="get_local_scene" qualifiers="const"> + <return type="Node"> + </return> + <description> + </description> + </method> + <method name="get_name" qualifiers="const"> + <return type="String"> + </return> + <description> + Return the name of the resources, any name is valid (it doesn't have to be unique). Name is for descriptive purposes only. + </description> + </method> + <method name="get_path" qualifiers="const"> + <return type="String"> + </return> + <description> + Return the path of the resource. This is useful mainly for editors when saving/loading, and shouldn't be changed by anything else. + </description> + </method> + <method name="get_rid" qualifiers="const"> + <return type="RID"> + </return> + <description> + Return the RID of the resource (or an empty RID). Many resources (such as [Texture], [Mesh], etc) are high level abstractions of resources stored in a server, so this function will return the original RID. + </description> + </method> + <method name="is_local_to_scene" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_local_to_scene"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_name"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Set the name of the resources, any name is valid (it doesn't have to be unique). Name is for descriptive purposes only. + </description> + </method> + <method name="set_path"> + <return type="void"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + Set the path of the resource. This is useful mainly for editors when saving/loading, and shouldn't be changed by anything else. Fails if another [Resource] already has path "path". + </description> + </method> + <method name="setup_local_to_scene"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="take_over_path"> + <return type="void"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + Set the path of the resource. Differs from set_path(), if another [Resource] exists with "path" it over-takes it, instead of failing. + </description> + </method> + </methods> + <members> + <member name="resource_local_to_scene" type="bool" setter="set_local_to_scene" getter="is_local_to_scene"> + </member> + <member name="resource_name" type="String" setter="set_name" getter="get_name"> + </member> + <member name="resource_path" type="String" setter="set_path" getter="get_path"> + </member> + </members> + <signals> + <signal name="changed"> + <description> + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/ResourceImporter.xml b/doc/classes/ResourceImporter.xml new file mode 100644 index 0000000000..419c4a84fb --- /dev/null +++ b/doc/classes/ResourceImporter.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ResourceImporter" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/ResourceImporterOGGVorbis.xml b/doc/classes/ResourceImporterOGGVorbis.xml new file mode 100644 index 0000000000..eef626cee7 --- /dev/null +++ b/doc/classes/ResourceImporterOGGVorbis.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ResourceImporterOGGVorbis" inherits="ResourceImporter" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/ResourceInteractiveLoader.xml b/doc/classes/ResourceInteractiveLoader.xml new file mode 100644 index 0000000000..d508b0a532 --- /dev/null +++ b/doc/classes/ResourceInteractiveLoader.xml @@ -0,0 +1,51 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ResourceInteractiveLoader" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Interactive Resource Loader. + </brief_description> + <description> + Interactive Resource Loader. This object is returned by ResourceLoader when performing an interactive load. It allows to load with high granularity, so this is mainly useful for displaying load bars/percentages. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_resource"> + <return type="Resource"> + </return> + <description> + Return the loaded resource (only if loaded). Otherwise, returns null. + </description> + </method> + <method name="get_stage" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the load stage. The total amount of stages can be queried with [method get_stage_count] + </description> + </method> + <method name="get_stage_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the total amount of stages (calls to [method poll]) needed to completely load this resource. + </description> + </method> + <method name="poll"> + <return type="int" enum="Error"> + </return> + <description> + Poll the load. If OK is returned, this means poll will have to be called again. If ERR_FILE_EOF is returned, them the load has finished and the resource can be obtained by calling [method get_resource]. + </description> + </method> + <method name="wait"> + <return type="int" enum="Error"> + </return> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/ResourceLoader.xml b/doc/classes/ResourceLoader.xml new file mode 100644 index 0000000000..6558a388c8 --- /dev/null +++ b/doc/classes/ResourceLoader.xml @@ -0,0 +1,74 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ResourceLoader" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Resource Loader. + </brief_description> + <description> + Resource Loader. This is a static object accessible as [ResourceLoader]. GDScript has a simplified load() function, though. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_dependencies"> + <return type="PoolStringArray"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_recognized_extensions_for_type"> + <return type="PoolStringArray"> + </return> + <argument index="0" name="type" type="String"> + </argument> + <description> + Return the list of recognized extensions for a resource type. + </description> + </method> + <method name="has"> + <return type="bool"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + </description> + </method> + <method name="load"> + <return type="Resource"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="type_hint" type="String" default=""""> + </argument> + <argument index="2" name="p_no_cache" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="load_interactive"> + <return type="ResourceInteractiveLoader"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="type_hint" type="String" default=""""> + </argument> + <description> + Load a resource interactively, the returned object allows to load with high granularity. + </description> + </method> + <method name="set_abort_on_missing_resources"> + <return type="void"> + </return> + <argument index="0" name="abort" type="bool"> + </argument> + <description> + Change the behavior on missing sub-resources. Default is to abort load. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/ResourcePreloader.xml b/doc/classes/ResourcePreloader.xml new file mode 100644 index 0000000000..35ebeb1760 --- /dev/null +++ b/doc/classes/ResourcePreloader.xml @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ResourcePreloader" inherits="Node" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Resource Preloader Node. + </brief_description> + <description> + Resource Preloader Node. This node is used to preload sub-resources inside a scene, so when the scene is loaded all the resources are ready to use and be retrieved from here. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_resource"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="resource" type="Resource"> + </argument> + <description> + </description> + </method> + <method name="get_resource" qualifiers="const"> + <return type="Resource"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Return the resource given a text-id. + </description> + </method> + <method name="get_resource_list" qualifiers="const"> + <return type="PoolStringArray"> + </return> + <description> + Return the list of resources inside the preloader. + </description> + </method> + <method name="has_resource" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Return true if the preloader has a given resource. + </description> + </method> + <method name="remove_resource"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Remove a resource from the preloader by text id. + </description> + </method> + <method name="rename_resource"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="newname" type="String"> + </argument> + <description> + Rename a resource inside the preloader, from a text-id to a new text-id. + </description> + </method> + </methods> + <members> + <member name="resources" type="Array" setter="_set_resources" getter="_get_resources"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/ResourceSaver.xml b/doc/classes/ResourceSaver.xml new file mode 100644 index 0000000000..de296776ad --- /dev/null +++ b/doc/classes/ResourceSaver.xml @@ -0,0 +1,51 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ResourceSaver" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Resource Saving Interface. + </brief_description> + <description> + Resource Saving Interface. This interface is used for saving resources to disk. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_recognized_extensions"> + <return type="PoolStringArray"> + </return> + <argument index="0" name="type" type="Resource"> + </argument> + <description> + Return the list of extensions available for saving a resource of a given type. + </description> + </method> + <method name="save"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="resource" type="Resource"> + </argument> + <argument index="2" name="flags" type="int" default="0"> + </argument> + <description> + Save a resource to disk, to a given path. + </description> + </method> + </methods> + <constants> + <constant name="FLAG_RELATIVE_PATHS" value="1"> + </constant> + <constant name="FLAG_BUNDLE_RESOURCES" value="2"> + </constant> + <constant name="FLAG_CHANGE_PATH" value="4"> + </constant> + <constant name="FLAG_OMIT_EDITOR_PROPERTIES" value="8"> + </constant> + <constant name="FLAG_SAVE_BIG_ENDIAN" value="16"> + </constant> + <constant name="FLAG_COMPRESS" value="32"> + </constant> + </constants> +</class> diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml new file mode 100644 index 0000000000..90ee76cb98 --- /dev/null +++ b/doc/classes/RichTextLabel.xml @@ -0,0 +1,400 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="RichTextLabel" inherits="Control" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Label that displays rich text. + </brief_description> + <description> + Label that displays rich text. Rich text can contain custom text, fonts, images and some basic formatting. It also adapts itself to given width/heights. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_image"> + <return type="void"> + </return> + <argument index="0" name="image" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="add_text"> + <return type="void"> + </return> + <argument index="0" name="text" type="String"> + </argument> + <description> + </description> + </method> + <method name="append_bbcode"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="bbcode" type="String"> + </argument> + <description> + </description> + </method> + <method name="clear"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="get_bbcode" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_percent_visible" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_tab_size" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_text"> + <return type="String"> + </return> + <description> + Returns the raw text, stripping out the formatting information. + </description> + </method> + <method name="get_total_character_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_v_scroll"> + <return type="VScrollBar"> + </return> + <description> + </description> + </method> + <method name="get_visible_characters" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="is_meta_underlined" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_scroll_active" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_scroll_following" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_selection_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if selecting the text inside this richtext is allowed. + </description> + </method> + <method name="is_using_bbcode" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="newline"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="parse_bbcode"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="bbcode" type="String"> + </argument> + <description> + </description> + </method> + <method name="pop"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="push_align"> + <return type="void"> + </return> + <argument index="0" name="align" type="int" enum="RichTextLabel.Align"> + </argument> + <description> + </description> + </method> + <method name="push_cell"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="push_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="push_font"> + <return type="void"> + </return> + <argument index="0" name="font" type="Font"> + </argument> + <description> + </description> + </method> + <method name="push_indent"> + <return type="void"> + </return> + <argument index="0" name="level" type="int"> + </argument> + <description> + </description> + </method> + <method name="push_list"> + <return type="void"> + </return> + <argument index="0" name="type" type="int" enum="RichTextLabel.ListType"> + </argument> + <description> + </description> + </method> + <method name="push_meta"> + <return type="void"> + </return> + <argument index="0" name="data" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="push_table"> + <return type="void"> + </return> + <argument index="0" name="columns" type="int"> + </argument> + <description> + </description> + </method> + <method name="push_underline"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="remove_line"> + <return type="bool"> + </return> + <argument index="0" name="line" type="int"> + </argument> + <description> + </description> + </method> + <method name="scroll_to_line"> + <return type="void"> + </return> + <argument index="0" name="line" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_bbcode"> + <return type="void"> + </return> + <argument index="0" name="text" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_meta_underline"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_percent_visible"> + <return type="void"> + </return> + <argument index="0" name="percent_visible" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_scroll_active"> + <return type="void"> + </return> + <argument index="0" name="active" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_scroll_follow"> + <return type="void"> + </return> + <argument index="0" name="follow" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_selection_enabled"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Set to true if selecting the text inside this richtext is allowed. + </description> + </method> + <method name="set_tab_size"> + <return type="void"> + </return> + <argument index="0" name="spaces" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_table_column_expand"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="expand" type="bool"> + </argument> + <argument index="2" name="ratio" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_text"> + <return type="void"> + </return> + <argument index="0" name="text" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_use_bbcode"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_visible_characters"> + <return type="void"> + </return> + <argument index="0" name="amount" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="bbcode_enabled" type="bool" setter="set_use_bbcode" getter="is_using_bbcode"> + </member> + <member name="bbcode_text" type="String" setter="set_bbcode" getter="get_bbcode"> + </member> + <member name="percent_visible" type="float" setter="set_percent_visible" getter="get_percent_visible"> + </member> + <member name="visible_characters" type="int" setter="set_visible_characters" getter="get_visible_characters"> + </member> + </members> + <signals> + <signal name="meta_clicked"> + <argument index="0" name="meta" type="Nil"> + </argument> + <description> + </description> + </signal> + </signals> + <constants> + <constant name="ALIGN_LEFT" value="0"> + </constant> + <constant name="ALIGN_CENTER" value="1"> + </constant> + <constant name="ALIGN_RIGHT" value="2"> + </constant> + <constant name="ALIGN_FILL" value="3"> + </constant> + <constant name="LIST_NUMBERS" value="0"> + </constant> + <constant name="LIST_LETTERS" value="1"> + </constant> + <constant name="LIST_DOTS" value="2"> + </constant> + <constant name="ITEM_FRAME" value="0"> + </constant> + <constant name="ITEM_TEXT" value="1"> + </constant> + <constant name="ITEM_IMAGE" value="2"> + </constant> + <constant name="ITEM_NEWLINE" value="3"> + </constant> + <constant name="ITEM_FONT" value="4"> + </constant> + <constant name="ITEM_COLOR" value="5"> + </constant> + <constant name="ITEM_UNDERLINE" value="6"> + </constant> + <constant name="ITEM_ALIGN" value="7"> + </constant> + <constant name="ITEM_INDENT" value="8"> + </constant> + <constant name="ITEM_LIST" value="9"> + </constant> + <constant name="ITEM_META" value="11"> + </constant> + </constants> + <theme_items> + <theme_item name="bold_font" type="Font"> + </theme_item> + <theme_item name="bold_italics_font" type="Font"> + </theme_item> + <theme_item name="default_color" type="Color"> + </theme_item> + <theme_item name="focus" type="StyleBox"> + </theme_item> + <theme_item name="font_color_selected" type="Color"> + </theme_item> + <theme_item name="italics_font" type="Font"> + </theme_item> + <theme_item name="line_separation" type="int"> + </theme_item> + <theme_item name="mono_font" type="Font"> + </theme_item> + <theme_item name="normal" type="StyleBox"> + </theme_item> + <theme_item name="normal_font" type="Font"> + </theme_item> + <theme_item name="selection_color" type="Color"> + </theme_item> + <theme_item name="table_hseparation" type="int"> + </theme_item> + <theme_item name="table_vseparation" type="int"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/RigidBody.xml b/doc/classes/RigidBody.xml new file mode 100644 index 0000000000..8347597daf --- /dev/null +++ b/doc/classes/RigidBody.xml @@ -0,0 +1,454 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="RigidBody" inherits="PhysicsBody" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Physics Body whose position is determined through physics simulation in 3D space. + </brief_description> + <description> + This is the node that implements full 3D physics. This means that you do not control a RigidBody directly. Instead you can apply forces to it (gravity, impulses, etc.), and the physics simulation will calculate the resulting movement, collision, bouncing, rotating, etc. + 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. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="_integrate_forces" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="state" type="PhysicsDirectBodyState"> + </argument> + <description> + Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default it works in addition to the usual physics behavior, but [method set_use_custom_integrator] allows you to disable the default behavior and do fully custom force integration for a body. + </description> + </method> + <method name="apply_impulse"> + <return type="void"> + </return> + <argument index="0" name="pos" type="Vector3"> + </argument> + <argument index="1" name="impulse" type="Vector3"> + </argument> + <description> + Apply a positioned impulse (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. Both the impulse and the offset from the body origin are in global coordinates. + </description> + </method> + <method name="get_angular_damp" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the current body angular damp. Default is -1. + </description> + </method> + <method name="get_angular_velocity" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + Return the current body angular velocity. + </description> + </method> + <method name="get_axis_lock" qualifiers="const"> + <return type="int" enum="RigidBody.AxisLock"> + </return> + <description> + Return the current axis lock of the body. One of AXIS_LOCK_* enum. + </description> + </method> + <method name="get_bounce" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the current body bounciness. + </description> + </method> + <method name="get_colliding_bodies" qualifiers="const"> + <return type="Array"> + </return> + <description> + Return a list of the bodies colliding with this one. By default, number of max contacts reported is at 0 , see [method set_max_contacts_reported] to increase it. + </description> + </method> + <method name="get_friction" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the current body friction, from 0 (frictionless) to 1 (max friction). + </description> + </method> + <method name="get_gravity_scale" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the current body gravity scale. + </description> + </method> + <method name="get_linear_damp" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the current body linear damp. Default is -1. + </description> + </method> + <method name="get_linear_velocity" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + Return the current body linear velocity. + </description> + </method> + <method name="get_mass" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the current body mass. + </description> + </method> + <method name="get_max_contacts_reported" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the maximum contacts that can be reported. See [method set_max_contacts_reported]. + </description> + </method> + <method name="get_mode" qualifiers="const"> + <return type="int" enum="RigidBody.Mode"> + </return> + <description> + Return the current body mode, see [method set_mode]. + </description> + </method> + <method name="get_weight" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the current body weight, given standard earth-weight (gravity 9.8). + </description> + </method> + <method name="is_able_to_sleep" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether the body has the ability to fall asleep when not moving. See [method set_can_sleep]. + </description> + </method> + <method name="is_contact_monitor_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether contact monitoring is enabled. + </description> + </method> + <method name="is_sleeping" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether the body is sleeping. + </description> + </method> + <method name="is_using_continuous_collision_detection" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether this body is using continuous collision detection. + </description> + </method> + <method name="is_using_custom_integrator"> + <return type="bool"> + </return> + <description> + Return whether the body is using a custom integrator. + </description> + </method> + <method name="set_angular_damp"> + <return type="void"> + </return> + <argument index="0" name="angular_damp" type="float"> + </argument> + <description> + Set the angular damp for this body. Default of -1, cannot be less than -1. If this value is different from -1, any angular damp derived from the world or areas will be overridden. + </description> + </method> + <method name="set_angular_velocity"> + <return type="void"> + </return> + <argument index="0" name="angular_velocity" type="Vector3"> + </argument> + <description> + Set the body angular velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state. + </description> + </method> + <method name="set_axis_lock"> + <return type="void"> + </return> + <argument index="0" name="axis_lock" type="int" enum="RigidBody.AxisLock"> + </argument> + <description> + Set the axis lock of the body, from the AXIS_LOCK_* enum. Axis lock stops the body from moving along the specified axis(X/Y/Z) and rotating along the other two axes. + </description> + </method> + <method name="set_axis_velocity"> + <return type="void"> + </return> + <argument index="0" name="axis_velocity" type="Vector3"> + </argument> + <description> + Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. + </description> + </method> + <method name="set_bounce"> + <return type="void"> + </return> + <argument index="0" name="bounce" type="float"> + </argument> + <description> + Set the body bounciness, from 0 (no bounciness) to 1 (max bounciness). + </description> + </method> + <method name="set_can_sleep"> + <return type="void"> + </return> + <argument index="0" name="able_to_sleep" type="bool"> + </argument> + <description> + Set the body ability to fall asleep when not moving. This saves an enormous amount of processor time when there are plenty of rigid bodies (non static) in a scene. + Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] / [method set_applied_force] wakes them up. Until then, they behave like a static body. + </description> + </method> + <method name="set_contact_monitor"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Enable contact monitoring. This allows the body to emit signals when it collides with another. + </description> + </method> + <method name="set_friction"> + <return type="void"> + </return> + <argument index="0" name="friction" type="float"> + </argument> + <description> + Set the body friction, from 0 (frictionless) to 1 (max friction). + </description> + </method> + <method name="set_gravity_scale"> + <return type="void"> + </return> + <argument index="0" name="gravity_scale" type="float"> + </argument> + <description> + Set the gravity factor. This factor multiplies gravity intensity just for this body. + </description> + </method> + <method name="set_linear_damp"> + <return type="void"> + </return> + <argument index="0" name="linear_damp" type="float"> + </argument> + <description> + Set the linear damp for this body. 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. + </description> + </method> + <method name="set_linear_velocity"> + <return type="void"> + </return> + <argument index="0" name="linear_velocity" type="Vector3"> + </argument> + <description> + Set the body linear velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state. + </description> + </method> + <method name="set_mass"> + <return type="void"> + </return> + <argument index="0" name="mass" type="float"> + </argument> + <description> + Set the body mass. + </description> + </method> + <method name="set_max_contacts_reported"> + <return type="void"> + </return> + <argument index="0" name="amount" type="int"> + </argument> + <description> + Set 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. + </description> + </method> + <method name="set_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="RigidBody.Mode"> + </argument> + <description> + Set the body mode, from the MODE_* enum. This allows to change to a static body or a character body. + </description> + </method> + <method name="set_sleeping"> + <return type="void"> + </return> + <argument index="0" name="sleeping" type="bool"> + </argument> + <description> + Set whether a body is sleeping or not. Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] wakes them up. Until then, they behave like a static body. + </description> + </method> + <method name="set_use_continuous_collision_detection"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set the continuous collision detection mode from the enum CCD_MODE_*. + Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. The first is more precise, and misses less impacts by small, fast-moving objects. The second is faster to compute, but can miss small, fast-moving objects. + </description> + </method> + <method name="set_use_custom_integrator"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Pass true to disable the internal force integration (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. + </description> + </method> + <method name="set_weight"> + <return type="void"> + </return> + <argument index="0" name="weight" type="float"> + </argument> + <description> + Set the body weight given standard earth-weight (gravity 9.8). + </description> + </method> + </methods> + <members> + <member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp"> + Damps RigidBody's rotational forces. + </member> + <member name="angular_velocity" type="Vector3" setter="set_angular_velocity" getter="get_angular_velocity"> + RigidBody's rotational velocity. + </member> + <member name="axis_lock" type="int" setter="set_axis_lock" getter="get_axis_lock" enum="RigidBody.AxisLock"> + Locks the rotational forces to a particular axis, preventing rotations on other axes. + </member> + <member name="bounce" type="float" setter="set_bounce" getter="get_bounce"> + RigidBody's bounciness. + </member> + <member name="can_sleep" type="bool" setter="set_can_sleep" getter="is_able_to_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. + </member> + <member name="contact_monitor" type="bool" setter="set_contact_monitor" getter="is_contact_monitor_enabled"> + If true, the RigidBody will emit signals when it collides with another RigidBody. + </member> + <member name="contacts_reported" type="int" setter="set_max_contacts_reported" getter="get_max_contacts_reported"> + The maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. + </member> + <member name="continuous_cd" type="bool" setter="set_use_continuous_collision_detection" getter="is_using_continuous_collision_detection"> + 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. + </member> + <member name="custom_integrator" type="bool" setter="set_use_custom_integrator" getter="is_using_custom_integrator"> + If [code]true[/code] internal force integration will be disabled (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the [method _integrate_forces] function, if defined. + </member> + <member name="friction" type="float" setter="set_friction" getter="get_friction"> + The body friction, from 0 (frictionless) to 1 (max friction). + </member> + <member name="gravity_scale" type="float" setter="set_gravity_scale" getter="get_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. + </member> + <member name="linear_damp" type="float" setter="set_linear_damp" getter="get_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. + </member> + <member name="linear_velocity" type="Vector3" setter="set_linear_velocity" getter="get_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. + </member> + <member name="mass" type="float" setter="set_mass" getter="get_mass"> + RigidBody's mass. + </member> + <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="RigidBody.Mode"> + The body mode from the MODE_* enum. Modes include: MODE_STATIC, MODE_KINEMATIC, MODE_RIGID, and MODE_CHARACTER. + </member> + <member name="sleeping" type="bool" setter="set_sleeping" getter="is_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. + </member> + <member name="weight" type="float" setter="set_weight" getter="get_weight"> + RigidBody's weight based on its mass and the global 3D gravity. Global values are set in "Project > Project Settings > Physics > 3d". + </member> + </members> + <signals> + <signal name="body_entered"> + <argument index="0" name="body" type="Object"> + </argument> + <description> + Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. + </description> + </signal> + <signal name="body_exited"> + <argument index="0" name="body" type="Object"> + </argument> + <description> + Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. + </description> + </signal> + <signal name="body_shape_entered"> + <argument index="0" name="body_id" type="int"> + </argument> + <argument index="1" name="body" type="Object"> + </argument> + <argument index="2" name="body_shape" type="int"> + </argument> + <argument index="3" name="local_shape" type="int"> + </argument> + <description> + Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. + This signal not only receives the body that collided with this one, but also its [RID] (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body collided with. + </description> + </signal> + <signal name="body_shape_exited"> + <argument index="0" name="body_id" type="int"> + </argument> + <argument index="1" name="body" type="Object"> + </argument> + <argument index="2" name="body_shape" type="int"> + </argument> + <argument index="3" name="local_shape" type="int"> + </argument> + <description> + Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. + This signal not only receives the body that stopped colliding with this one, but also its [RID] (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body stopped colliding with. + </description> + </signal> + <signal name="sleeping_state_changed"> + <description> + Emitted when the body changes its sleeping state. Either by sleeping or waking up. + </description> + </signal> + </signals> + <constants> + <constant name="MODE_STATIC" value="1"> + Static mode. The body behaves like a [StaticBody], and can only move by user code. + </constant> + <constant name="MODE_KINEMATIC" value="3"> + Kinematic body. The body behaves like a [KinematicBody], and can only move by user code. + </constant> + <constant name="MODE_RIGID" value="0"> + Rigid body. This is the "natural" state of a rigid body. It is affected by forces, and can move, rotate, and be affected by user code. + </constant> + <constant name="MODE_CHARACTER" value="2"> + Character body. This behaves like a rigid body, but can not rotate. + </constant> + <constant name="AXIS_LOCK_DISABLED" value="0"> + </constant> + <constant name="AXIS_LOCK_X" value="1"> + </constant> + <constant name="AXIS_LOCK_Y" value="2"> + </constant> + <constant name="AXIS_LOCK_Z" value="3"> + </constant> + </constants> +</class> diff --git a/doc/classes/RigidBody2D.xml b/doc/classes/RigidBody2D.xml new file mode 100644 index 0000000000..a4faa697de --- /dev/null +++ b/doc/classes/RigidBody2D.xml @@ -0,0 +1,508 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="RigidBody2D" inherits="PhysicsBody2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Physics Body whose position is determined through physics simulation in 2D space. + </brief_description> + <description> + This is the node that implements full 2D physics. This means that you do not control a RigidBody2D directly. Instead you can apply forces to it (gravity, impulses, etc.), and the physics simulation will calculate the resulting movement, collision, bouncing, rotating, etc. + This node can use custom force integration, for writing complex physics motion behavior per node. + This node can shift state between regular Rigid body, Kinematic, Character or Static. + Character mode forbids this node from being rotated. + As a warning, don't change RigidBody2D's position every frame or very often. Sporadic changes work fine, but physics runs at a different granularity (fixed hz) than usual rendering (process callback) and maybe even in a separate thread, so changing this from a process loop will yield strange behavior. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="_integrate_forces" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="state" type="Physics2DDirectBodyState"> + </argument> + <description> + Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default it works in addition to the usual physics behavior, but [method set_use_custom_integrator] allows you to disable the default behavior and do fully custom force integration for a body. + </description> + </method> + <method name="add_force"> + <return type="void"> + </return> + <argument index="0" name="offset" type="Vector2"> + </argument> + <argument index="1" name="force" type="Vector2"> + </argument> + <description> + Add a positioned force to the applied force and torque. As with [method apply_impulse], both the force and the offset from the body origin are in global coordinates. + </description> + </method> + <method name="apply_impulse"> + <return type="void"> + </return> + <argument index="0" name="offset" type="Vector2"> + </argument> + <argument index="1" name="impulse" type="Vector2"> + </argument> + <description> + Apply a positioned impulse (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. Both the impulse and the offset from the body origin are in global coordinates. + </description> + </method> + <method name="get_angular_damp" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the angular damp for this body. + </description> + </method> + <method name="get_angular_velocity" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the body angular velocity. This changes by physics granularity. See [method set_angular_velocity]. + </description> + </method> + <method name="get_applied_force" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the applied force vector. + </description> + </method> + <method name="get_applied_torque" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the torque which is being applied to this body. + </description> + </method> + <method name="get_bounce" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the body bounciness. + </description> + </method> + <method name="get_colliding_bodies" qualifiers="const"> + <return type="Array"> + </return> + <description> + Return a list of the bodies colliding with this one. By default, number of max contacts reported is at 0 , see [method set_max_contacts_reported] to increase it. You must also enable contact monitor, see [method set_contact_monitor] + </description> + </method> + <method name="get_continuous_collision_detection_mode" qualifiers="const"> + <return type="int" enum="RigidBody2D.CCDMode"> + </return> + <description> + Return whether this body is using continuous collision detection. + </description> + </method> + <method name="get_friction" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the body friction. + </description> + </method> + <method name="get_gravity_scale" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the gravity factor. + </description> + </method> + <method name="get_inertia" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the body's moment of inertia. This is usually automatically computed from the mass and the shapes. Note that this doesn't seem to work in a [code]_ready[/code] function: it apparently has not been auto-computed yet. + </description> + </method> + <method name="get_linear_damp" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the linear damp for this body. + </description> + </method> + <method name="get_linear_velocity" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the body linear velocity. This changes by physics granularity. See [method set_linear_velocity]. + </description> + </method> + <method name="get_mass" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the body mass. + </description> + </method> + <method name="get_max_contacts_reported" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the maximum contacts that can be reported. See [method set_max_contacts_reported]. + </description> + </method> + <method name="get_mode" qualifiers="const"> + <return type="int" enum="RigidBody2D.Mode"> + </return> + <description> + Return the current body mode, see [method set_mode]. + </description> + </method> + <method name="get_weight" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the body weight given standard earth-weight (gravity 9.8). + </description> + </method> + <method name="is_able_to_sleep" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if the body has the ability to fall asleep when not moving. See [method set_can_sleep]. + </description> + </method> + <method name="is_contact_monitor_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether contact monitoring is enabled. + </description> + </method> + <method name="is_sleeping" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether the body is sleeping. + </description> + </method> + <method name="is_using_custom_integrator"> + <return type="bool"> + </return> + <description> + Return true if the body is not doing any built-in force integration. + </description> + </method> + <method name="set_angular_damp"> + <return type="void"> + </return> + <argument index="0" name="angular_damp" type="float"> + </argument> + <description> + Set the angular damp for this body. If this value is different from -1, any angular damp derived from the world or areas will be overridden. + </description> + </method> + <method name="set_angular_velocity"> + <return type="void"> + </return> + <argument index="0" name="angular_velocity" type="float"> + </argument> + <description> + Set the body angular velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state. + </description> + </method> + <method name="set_applied_force"> + <return type="void"> + </return> + <argument index="0" name="force" type="Vector2"> + </argument> + <description> + Set the applied force vector. This is the equivalent of pushing a box over the ground: the force applied is applied constantly. + </description> + </method> + <method name="set_applied_torque"> + <return type="void"> + </return> + <argument index="0" name="torque" type="float"> + </argument> + <description> + Set a constant torque which will be applied to this body. + </description> + </method> + <method name="set_axis_velocity"> + <return type="void"> + </return> + <argument index="0" name="axis_velocity" type="Vector2"> + </argument> + <description> + Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. + </description> + </method> + <method name="set_bounce"> + <return type="void"> + </return> + <argument index="0" name="bounce" type="float"> + </argument> + <description> + Set the body bounciness, from 0 (no bounce) to 1 (full bounce). + </description> + </method> + <method name="set_can_sleep"> + <return type="void"> + </return> + <argument index="0" name="able_to_sleep" type="bool"> + </argument> + <description> + Set the body ability to fall asleep when not moving. This saves an enormous amount of processor time when there are plenty of rigid bodies (non static) in a scene. + Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] / [method set_applied_force] wakes them up. Until then, they behave like a static body. + </description> + </method> + <method name="set_contact_monitor"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Enable contact monitoring. This allows the body to emit signals when it collides with another. + </description> + </method> + <method name="set_continuous_collision_detection_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="RigidBody2D.CCDMode"> + </argument> + <description> + Set the continuous collision detection mode from the enum CCD_MODE_*. + Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. The first is more precise, and misses less impacts by small, fast-moving objects. The second is faster to compute, but can miss small, fast-moving objects. + </description> + </method> + <method name="set_friction"> + <return type="void"> + </return> + <argument index="0" name="friction" type="float"> + </argument> + <description> + Set the body friction, from 0 (frictionless) to 1 (full friction). + </description> + </method> + <method name="set_gravity_scale"> + <return type="void"> + </return> + <argument index="0" name="gravity_scale" type="float"> + </argument> + <description> + Set the gravity factor. This factor multiplies gravity intensity just for this body. + </description> + </method> + <method name="set_inertia"> + <return type="void"> + </return> + <argument index="0" name="inertia" type="float"> + </argument> + <description> + Set the body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body. The moment of inertia is usually computed automatically from the mass and the shapes, but this function allows you to set a custom value. Set 0 (or negative) inertia to return to automatically computing it. + </description> + </method> + <method name="set_linear_damp"> + <return type="void"> + </return> + <argument index="0" name="linear_damp" type="float"> + </argument> + <description> + Set the linear damp for this body. If this value is different from -1, any linear damp derived from the world or areas will be overridden. + </description> + </method> + <method name="set_linear_velocity"> + <return type="void"> + </return> + <argument index="0" name="linear_velocity" type="Vector2"> + </argument> + <description> + Set the body linear velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state. + </description> + </method> + <method name="set_mass"> + <return type="void"> + </return> + <argument index="0" name="mass" type="float"> + </argument> + <description> + Set the body mass. + </description> + </method> + <method name="set_max_contacts_reported"> + <return type="void"> + </return> + <argument index="0" name="amount" type="int"> + </argument> + <description> + Set 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. + </description> + </method> + <method name="set_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="RigidBody2D.Mode"> + </argument> + <description> + Set the body mode, from the MODE_* enum. This allows to change to a static body or a character body. + </description> + </method> + <method name="set_sleeping"> + <return type="void"> + </return> + <argument index="0" name="sleeping" type="bool"> + </argument> + <description> + Set whether a body is sleeping or not. Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] / [method set_applied_force] wakes them up. Until then, they behave like a static body. + </description> + </method> + <method name="set_use_custom_integrator"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Pass true to disable the internal force integration (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. + </description> + </method> + <method name="set_weight"> + <return type="void"> + </return> + <argument index="0" name="weight" type="float"> + </argument> + <description> + Set the body weight given standard earth-weight (gravity 9.8). Not really useful for 2D since most measures for this node are in pixels. + </description> + </method> + <method name="test_motion"> + <return type="bool"> + </return> + <argument index="0" name="motion" type="Vector2"> + </argument> + <argument index="1" name="margin" type="float" default="0.08"> + </argument> + <argument index="2" name="result" type="Physics2DTestMotionResult" default="null"> + </argument> + <description> + Return whether the body would collide, if it tried to move in the given vector. This method allows two extra parameters: A margin, which increases slightly the size of the shapes involved in the collision detection, and an object of type [Physics2DTestMotionResult], which will store additional information about the collision (should there be one). + </description> + </method> + </methods> + <members> + <member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp"> + Damps RigidBody2D's rotational forces. + </member> + <member name="angular_velocity" type="float" setter="set_angular_velocity" getter="get_angular_velocity"> + RigidBody2D's rotational velocity. + </member> + <member name="bounce" type="float" setter="set_bounce" getter="get_bounce"> + RigidBody2D's bounciness. + </member> + <member name="can_sleep" type="bool" setter="set_can_sleep" getter="is_able_to_sleep"> + If [code]true[/code] RigidBody2D will not calculate forces and will act as a static body while there is no movement. It will wake up when other forces are applied through other collisions or when the [code]apply_impulse[/code] method is used. Default value: [code]true[/code] + </member> + <member name="contact_monitor" type="bool" setter="set_contact_monitor" getter="is_contact_monitor_enabled"> + If [code]true[/code] RigidBody2D will emit signals when it collides with another RigidBody2D. + </member> + <member name="contacts_reported" type="int" setter="set_max_contacts_reported" getter="get_max_contacts_reported"> + The maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. + </member> + <member name="continuous_cd" type="int" setter="set_continuous_collision_detection_mode" getter="get_continuous_collision_detection_mode" enum="RigidBody2D.CCDMode"> + If [code]true[/code] continuous collision detection is used. Default value: [code]false[/code] + Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. Continuous collision detection is more precise, and misses less impacts by small, fast-moving objects. Not using continuous collision detection is faster to compute, but can miss small, fast-moving objects. + </member> + <member name="custom_integrator" type="bool" setter="set_use_custom_integrator" getter="is_using_custom_integrator"> + If [code]true[/code] internal force integration will be disabled (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the [method _integrate_forces] function, if defined. + </member> + <member name="friction" type="float" setter="set_friction" getter="get_friction"> + The body friction, from 0 (frictionless) to 1 (max friction). + </member> + <member name="gravity_scale" type="float" setter="set_gravity_scale" getter="get_gravity_scale"> + This is multiplied by the global 2D gravity setting found in "Project > Project Settings > Physics > 2d" to produce RigidBody2D's gravity. E.g. a value of 1 will be normal gravity, 2 will apply double gravity, and 0.5 will apply half gravity to this object. + </member> + <member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp"> + RigidBody2D's linear damp. Default of -1, cannot be less than -1. If this value is different from -1, any linear damp derived from the world or areas will be overridden. + </member> + <member name="linear_velocity" type="Vector2" setter="set_linear_velocity" getter="get_linear_velocity"> + RigidBody2D's linear velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may run in another thread and runs at a different granularity. Use [method _integrate_forces] as your process loop for precise control of the body state. + </member> + <member name="mass" type="float" setter="set_mass" getter="get_mass"> + RigidBody2D's mass. + </member> + <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="RigidBody2D.Mode"> + The body mode from the MODE_* enum. Modes include: MODE_STATIC, MODE_KINEMATIC, MODE_RIGID, and MODE_CHARACTER. + </member> + <member name="sleeping" type="bool" setter="set_sleeping" getter="is_sleeping"> + If [code]true[/code] RigidBody2D is sleeping and will not calculate forces until woken up by a collision or the [code]apply_impulse[/code] method. + </member> + <member name="weight" type="float" setter="set_weight" getter="get_weight"> + RigidBody2D's weight based on its mass and the global 2D gravity. Global values are set in "Project > Project Settings > Physics > 2d". + </member> + </members> + <signals> + <signal name="body_entered"> + <argument index="0" name="body" type="Object"> + </argument> + <description> + Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. + </description> + </signal> + <signal name="body_exited"> + <argument index="0" name="body" type="Object"> + </argument> + <description> + Emitted when a body exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. + </description> + </signal> + <signal name="body_shape_entered"> + <argument index="0" name="body_id" type="int"> + </argument> + <argument index="1" name="body" type="Object"> + </argument> + <argument index="2" name="body_shape" type="int"> + </argument> + <argument index="3" name="local_shape" type="int"> + </argument> + <description> + Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. + This signal not only receives the body that collided with this one, but also its [RID] (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body collided with. + </description> + </signal> + <signal name="body_shape_exited"> + <argument index="0" name="body_id" type="int"> + </argument> + <argument index="1" name="body" type="Object"> + </argument> + <argument index="2" name="body_shape" type="int"> + </argument> + <argument index="3" name="local_shape" type="int"> + </argument> + <description> + Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. + This signal not only receives the body that stopped colliding with this one, but also its [RID] (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body stopped colliding with. + </description> + </signal> + <signal name="sleeping_state_changed"> + <description> + Emitted when the body changes its sleeping state. Either by sleeping or waking up. + </description> + </signal> + </signals> + <constants> + <constant name="MODE_STATIC" value="1"> + Static mode. The body behaves like a [StaticBody2D], and can only move by user code. + </constant> + <constant name="MODE_KINEMATIC" value="3"> + Kinematic body. The body behaves like a [KinematicBody2D], and can only move by user code. + </constant> + <constant name="MODE_RIGID" value="0"> + Rigid body. This is the "natural" state of a rigid body. It is affected by forces, and can move, rotate, and be affected by user code. + </constant> + <constant name="MODE_CHARACTER" value="2"> + Character body. This behaves like a rigid body, but can not rotate. + </constant> + <constant name="CCD_MODE_DISABLED" value="0"> + Disables continuous collision detection. This is the fastest way to detect body collisions, but can miss small, fast-moving objects. + </constant> + <constant name="CCD_MODE_CAST_RAY" value="1"> + Enables continuous collision detection by raycasting. It is faster than shapecasting, but less precise. + </constant> + <constant name="CCD_MODE_CAST_SHAPE" value="2"> + Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise. + </constant> + </constants> +</class> diff --git a/doc/classes/SceneState.xml b/doc/classes/SceneState.xml new file mode 100644 index 0000000000..967c3fbad6 --- /dev/null +++ b/doc/classes/SceneState.xml @@ -0,0 +1,175 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="SceneState" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_connection_binds" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_connection_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_connection_flags" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_connection_method" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_connection_signal" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_connection_source" qualifiers="const"> + <return type="NodePath"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_connection_target" qualifiers="const"> + <return type="NodePath"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_node_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_node_groups" qualifiers="const"> + <return type="PoolStringArray"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_node_instance" qualifiers="const"> + <return type="PackedScene"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_node_instance_placeholder" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_node_name" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_node_owner_path" qualifiers="const"> + <return type="NodePath"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_node_path" qualifiers="const"> + <return type="NodePath"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="for_parent" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="get_node_property_count" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_node_property_name" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="prop_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_node_property_value" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="prop_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_node_type" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="is_node_instance_placeholder" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + <constant name="GEN_EDIT_STATE_DISABLED" value="0"> + </constant> + <constant name="GEN_EDIT_STATE_INSTANCE" value="1"> + </constant> + <constant name="GEN_EDIT_STATE_MAIN" value="2"> + </constant> + </constants> +</class> diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml new file mode 100644 index 0000000000..c40d9339d1 --- /dev/null +++ b/doc/classes/SceneTree.xml @@ -0,0 +1,408 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="SceneTree" inherits="MainLoop" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="call_group" qualifiers="vararg"> + <return type="Variant"> + </return> + <argument index="0" name="group" type="String"> + </argument> + <argument index="1" name="method" type="String"> + </argument> + <description> + </description> + </method> + <method name="call_group_flags" qualifiers="vararg"> + <return type="Variant"> + </return> + <argument index="0" name="flags" type="int"> + </argument> + <argument index="1" name="group" type="String"> + </argument> + <argument index="2" name="method" type="String"> + </argument> + <description> + </description> + </method> + <method name="change_scene"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + </description> + </method> + <method name="change_scene_to"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="packed_scene" type="PackedScene"> + </argument> + <description> + </description> + </method> + <method name="create_timer"> + <return type="SceneTreeTimer"> + </return> + <argument index="0" name="time_sec" type="float"> + </argument> + <argument index="1" name="pause_mode_process" type="bool" default="true"> + </argument> + <description> + </description> + </method> + <method name="get_current_scene" qualifiers="const"> + <return type="Node"> + </return> + <description> + </description> + </method> + <method name="get_edited_scene_root" qualifiers="const"> + <return type="Node"> + </return> + <description> + </description> + </method> + <method name="get_frame" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_network_connected_peers" qualifiers="const"> + <return type="PoolIntArray"> + </return> + <description> + </description> + </method> + <method name="get_network_unique_id" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_node_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_nodes_in_group"> + <return type="Array"> + </return> + <argument index="0" name="group" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_root" qualifiers="const"> + <return type="Viewport"> + </return> + <description> + </description> + </method> + <method name="get_rpc_sender_id" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="has_group" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="has_network_peer" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns true if there is a [NetworkedMultiplayerPeer] set (with [method SceneTree.set_network_peer]). + </description> + </method> + <method name="is_debugging_collisions_hint" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_debugging_navigation_hint" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_input_handled"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_network_server" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns true if this SceneTree's [NetworkedMultiplayerPeer] is in server mode (listening for connections). + </description> + </method> + <method name="is_paused" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_refusing_new_network_connections" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="notify_group"> + <return type="void"> + </return> + <argument index="0" name="group" type="String"> + </argument> + <argument index="1" name="notification" type="int"> + </argument> + <description> + </description> + </method> + <method name="notify_group_flags"> + <return type="void"> + </return> + <argument index="0" name="call_flags" type="int"> + </argument> + <argument index="1" name="group" type="String"> + </argument> + <argument index="2" name="notification" type="int"> + </argument> + <description> + </description> + </method> + <method name="queue_delete"> + <return type="void"> + </return> + <argument index="0" name="obj" type="Object"> + </argument> + <description> + </description> + </method> + <method name="quit"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="reload_current_scene"> + <return type="int" enum="Error"> + </return> + <description> + </description> + </method> + <method name="set_auto_accept_quit"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_current_scene"> + <return type="void"> + </return> + <argument index="0" name="child_node" type="Node"> + </argument> + <description> + </description> + </method> + <method name="set_debug_collisions_hint"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_debug_navigation_hint"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_edited_scene_root"> + <return type="void"> + </return> + <argument index="0" name="scene" type="Node"> + </argument> + <description> + </description> + </method> + <method name="set_group"> + <return type="void"> + </return> + <argument index="0" name="group" type="String"> + </argument> + <argument index="1" name="property" type="String"> + </argument> + <argument index="2" name="value" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="set_group_flags"> + <return type="void"> + </return> + <argument index="0" name="call_flags" type="int"> + </argument> + <argument index="1" name="group" type="String"> + </argument> + <argument index="2" name="property" type="String"> + </argument> + <argument index="3" name="value" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="set_input_as_handled"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="set_network_peer"> + <return type="void"> + </return> + <argument index="0" name="peer" type="NetworkedMultiplayerPeer"> + </argument> + <description> + Set the peer object to handle the RPC system (effectively enabling networking). Depending on the peer itself, the SceneTree will become a network server (check with [method is_network_server()]) and will set root node's network mode to master (see NETWORK_MODE_* constants in [Node]), or it will become a regular peer with root node set to slave. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to SceneTree's signals. + </description> + </method> + <method name="set_pause"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_refuse_new_network_connections"> + <return type="void"> + </return> + <argument index="0" name="refuse" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_screen_stretch"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="SceneTree.StretchMode"> + </argument> + <argument index="1" name="aspect" type="int" enum="SceneTree.StretchAspect"> + </argument> + <argument index="2" name="minsize" type="Vector2"> + </argument> + <argument index="3" name="shrink" type="int" default="1"> + </argument> + <description> + </description> + </method> + </methods> + <signals> + <signal name="connected_to_server"> + <description> + </description> + </signal> + <signal name="connection_failed"> + <description> + </description> + </signal> + <signal name="files_dropped"> + <argument index="0" name="files" type="PoolStringArray"> + </argument> + <argument index="1" name="screen" type="int"> + </argument> + <description> + </description> + </signal> + <signal name="fixed_frame"> + <description> + </description> + </signal> + <signal name="idle_frame"> + <description> + </description> + </signal> + <signal name="network_peer_connected"> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </signal> + <signal name="network_peer_disconnected"> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </signal> + <signal name="node_configuration_warning_changed"> + <argument index="0" name="node" type="Object"> + </argument> + <description> + </description> + </signal> + <signal name="node_removed"> + <argument index="0" name="node" type="Object"> + </argument> + <description> + </description> + </signal> + <signal name="screen_resized"> + <description> + </description> + </signal> + <signal name="server_disconnected"> + <description> + </description> + </signal> + <signal name="tree_changed"> + <description> + </description> + </signal> + </signals> + <constants> + <constant name="GROUP_CALL_DEFAULT" value="0"> + </constant> + <constant name="GROUP_CALL_REVERSE" value="1"> + </constant> + <constant name="GROUP_CALL_REALTIME" value="2"> + </constant> + <constant name="GROUP_CALL_UNIQUE" value="4"> + </constant> + <constant name="STRETCH_MODE_DISABLED" value="0"> + </constant> + <constant name="STRETCH_MODE_2D" value="1"> + </constant> + <constant name="STRETCH_MODE_VIEWPORT" value="2"> + </constant> + <constant name="STRETCH_ASPECT_IGNORE" value="0"> + </constant> + <constant name="STRETCH_ASPECT_KEEP" value="1"> + </constant> + <constant name="STRETCH_ASPECT_KEEP_WIDTH" value="2"> + </constant> + <constant name="STRETCH_ASPECT_KEEP_HEIGHT" value="3"> + </constant> + </constants> +</class> diff --git a/doc/classes/SceneTreeTimer.xml b/doc/classes/SceneTreeTimer.xml new file mode 100644 index 0000000000..276c6857ae --- /dev/null +++ b/doc/classes/SceneTreeTimer.xml @@ -0,0 +1,35 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="SceneTreeTimer" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_time_left" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="set_time_left"> + <return type="void"> + </return> + <argument index="0" name="time" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <signals> + <signal name="timeout"> + <description> + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/Script.xml b/doc/classes/Script.xml new file mode 100644 index 0000000000..307afba8a7 --- /dev/null +++ b/doc/classes/Script.xml @@ -0,0 +1,88 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Script" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + A class stored as a resource. + </brief_description> + <description> + 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. [method Object.set_script] extends an existing object, if that object's class matches one of the script's base classes. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="can_instance" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns true if the script can be instanced. + </description> + </method> + <method name="get_node_type" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_source_code" qualifiers="const"> + <return type="String"> + </return> + <description> + Returns the script source code, or an empty string if source code is not available. + </description> + </method> + <method name="has_script_signal" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="signal_name" type="String"> + </argument> + <description> + Returns true if the script, or a base class, defines a signal with the given name. + </description> + </method> + <method name="has_source_code" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns true if the script contains non-empty source code. + </description> + </method> + <method name="instance_has" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="base_object" type="Object"> + </argument> + <description> + Returns true if 'base_object' is an instance of this script. + </description> + </method> + <method name="is_tool" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns true if the script is a tool script. A tool script can run in the editor. + </description> + </method> + <method name="reload"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="keep_state" type="bool" default="false"> + </argument> + <description> + Reloads the script's class implementation. Returns an error code. + </description> + </method> + <method name="set_source_code"> + <return type="void"> + </return> + <argument index="0" name="source" type="String"> + </argument> + <description> + Sets the script source code. Does not reload the class implementation. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/ScriptEditor.xml b/doc/classes/ScriptEditor.xml new file mode 100644 index 0000000000..e93a0eda0c --- /dev/null +++ b/doc/classes/ScriptEditor.xml @@ -0,0 +1,45 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ScriptEditor" inherits="PanelContainer" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_current_script"> + <return type="Script"> + </return> + <description> + Returns a [Script] that is currently active in editor. + </description> + </method> + <method name="get_open_scripts" qualifiers="const"> + <return type="Array"> + </return> + <description> + Returns an array with all [Script] objects which are currently open in editor. + </description> + </method> + </methods> + <signals> + <signal name="editor_script_changed"> + <argument index="0" name="script" type="Object"> + </argument> + <description> + Emitted when user changed active script. Argument is a freshly activated [Script]. + </description> + </signal> + <signal name="script_close"> + <argument index="0" name="script" type="Object"> + </argument> + <description> + Emitted when editor is about to close the active script. Argument is a [Script] that is going to be closed. + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/ScrollBar.xml b/doc/classes/ScrollBar.xml new file mode 100644 index 0000000000..7a10d3679e --- /dev/null +++ b/doc/classes/ScrollBar.xml @@ -0,0 +1,41 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ScrollBar" inherits="Range" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base class for scroll bars. + </brief_description> + <description> + Scrollbars are a [Range] based [Control], that display a draggable area (the size of the page). Horizontal ([HScrollBar]) and Vertical ([VScrollBar]) versions are available. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_custom_step" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="set_custom_step"> + <return type="void"> + </return> + <argument index="0" name="step" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="custom_step" type="float" setter="set_custom_step" getter="get_custom_step"> + </member> + </members> + <signals> + <signal name="scrolling"> + <description> + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/ScrollContainer.xml b/doc/classes/ScrollContainer.xml new file mode 100644 index 0000000000..1ae06bde70 --- /dev/null +++ b/doc/classes/ScrollContainer.xml @@ -0,0 +1,87 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ScrollContainer" inherits="Container" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + A helper node for displaying scrollable elements (e.g. lists). + </brief_description> + <description> + A ScrollContainer node with a [Control] child and scrollbar child ([HScrollbar], [VScrollBar], or both) will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the minimum_size of the Control relative to the ScrollContainer. Works great with a [Panel] control. You can set EXPAND on children size flags, so they will upscale to ScrollContainer size if ScrollContainer size is bigger (scroll is invisible for chosen dimension). + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_h_scroll" qualifiers="const"> + <return type="int"> + </return> + <description> + Return current horizontal scroll value. + </description> + </method> + <method name="get_v_scroll" qualifiers="const"> + <return type="int"> + </return> + <description> + Return current vertical scroll value. + </description> + </method> + <method name="is_h_scroll_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if horizontal scroll is allowed. + </description> + </method> + <method name="is_v_scroll_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if vertical scroll is allowed. + </description> + </method> + <method name="set_enable_h_scroll"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set allows horizontal scroll. + </description> + </method> + <method name="set_enable_v_scroll"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set allows vertical scroll. + </description> + </method> + <method name="set_h_scroll"> + <return type="void"> + </return> + <argument index="0" name="val" type="int"> + </argument> + <description> + Set horizontal scroll value. + </description> + </method> + <method name="set_v_scroll"> + <return type="void"> + </return> + <argument index="0" name="val" type="int"> + </argument> + <description> + Set vertical scroll value. + </description> + </method> + </methods> + <members> + <member name="scroll_horizontal" type="bool" setter="set_enable_h_scroll" getter="is_h_scroll_enabled"> + </member> + <member name="scroll_vertical" type="bool" setter="set_enable_v_scroll" getter="is_v_scroll_enabled"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/SegmentShape2D.xml b/doc/classes/SegmentShape2D.xml new file mode 100644 index 0000000000..3b7a747bcb --- /dev/null +++ b/doc/classes/SegmentShape2D.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="SegmentShape2D" inherits="Shape2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Segment shape for 2D collisions. + </brief_description> + <description> + Segment shape for 2D collisions. Consists of two points, [code]a[/code] and [code]b[/code]. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_a" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the first point's position. + </description> + </method> + <method name="get_b" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the second point's position. + </description> + </method> + <method name="set_a"> + <return type="void"> + </return> + <argument index="0" name="a" type="Vector2"> + </argument> + <description> + Set the first point's position. + </description> + </method> + <method name="set_b"> + <return type="void"> + </return> + <argument index="0" name="b" type="Vector2"> + </argument> + <description> + Set the second point's position. + </description> + </method> + </methods> + <members> + <member name="a" type="Vector2" setter="set_a" getter="get_a"> + The segment's first point position. + </member> + <member name="b" type="Vector2" setter="set_b" getter="get_b"> + The segment's second point position. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Semaphore.xml b/doc/classes/Semaphore.xml new file mode 100644 index 0000000000..0aeb6472af --- /dev/null +++ b/doc/classes/Semaphore.xml @@ -0,0 +1,31 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Semaphore" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + A synchronization Semaphore. + </brief_description> + <description> + A synchronization Semaphore. Element used in multi-threadding. Initialized to zero on creation. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="post"> + <return type="int" enum="Error"> + </return> + <description> + Lowers the [Semaphore], allowing one more thread in. + </description> + </method> + <method name="wait"> + <return type="int" enum="Error"> + </return> + <description> + Tries to wait for the [Semaphore], if its value is zero, blocks until non-zero. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Separator.xml b/doc/classes/Separator.xml new file mode 100644 index 0000000000..4bbabe58aa --- /dev/null +++ b/doc/classes/Separator.xml @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Separator" inherits="Control" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base class for separators. + </brief_description> + <description> + Separator is a [Control] used for separating other controls. It's purely a visual decoration. Horizontal ([HSeparator]) and Vertical ([VSeparator]) versions are available. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Shader.xml b/doc/classes/Shader.xml new file mode 100644 index 0000000000..75644c31ab --- /dev/null +++ b/doc/classes/Shader.xml @@ -0,0 +1,73 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Shader" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + To be changed, ignore. + </brief_description> + <description> + To be changed, ignore. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_code" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_default_texture_param" qualifiers="const"> + <return type="Texture"> + </return> + <argument index="0" name="param" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_mode" qualifiers="const"> + <return type="int" enum="Shader.Mode"> + </return> + <description> + </description> + </method> + <method name="has_param" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_code"> + <return type="void"> + </return> + <argument index="0" name="code" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_default_texture_param"> + <return type="void"> + </return> + <argument index="0" name="param" type="String"> + </argument> + <argument index="1" name="texture" type="Texture"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="code" type="String" setter="set_code" getter="get_code"> + </member> + </members> + <constants> + <constant name="MODE_SPATIAL" value="0"> + </constant> + <constant name="MODE_CANVAS_ITEM" value="1"> + </constant> + <constant name="MODE_PARTICLES" value="2"> + </constant> + </constants> +</class> diff --git a/doc/classes/ShaderMaterial.xml b/doc/classes/ShaderMaterial.xml new file mode 100644 index 0000000000..8bd9f1039e --- /dev/null +++ b/doc/classes/ShaderMaterial.xml @@ -0,0 +1,47 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ShaderMaterial" inherits="Material" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_shader" qualifiers="const"> + <return type="Shader"> + </return> + <description> + </description> + </method> + <method name="get_shader_param" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="param" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_shader"> + <return type="void"> + </return> + <argument index="0" name="shader" type="Shader"> + </argument> + <description> + </description> + </method> + <method name="set_shader_param"> + <return type="void"> + </return> + <argument index="0" name="param" type="String"> + </argument> + <argument index="1" name="value" type="Variant"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Shape.xml b/doc/classes/Shape.xml new file mode 100644 index 0000000000..8e6e12a736 --- /dev/null +++ b/doc/classes/Shape.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Shape" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Shape2D.xml b/doc/classes/Shape2D.xml new file mode 100644 index 0000000000..d5e2984ba0 --- /dev/null +++ b/doc/classes/Shape2D.xml @@ -0,0 +1,102 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Shape2D" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base class for all 2D Shapes. + </brief_description> + <description> + Base class for all 2D Shapes. All 2D shape types inherit from this. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="collide"> + <return type="bool"> + </return> + <argument index="0" name="local_xform" type="Transform2D"> + </argument> + <argument index="1" name="with_shape" type="Shape2D"> + </argument> + <argument index="2" name="shape_xform" type="Transform2D"> + </argument> + <description> + Return whether this shape is colliding with another. + This method needs the transformation matrix for this shape ([code]local_xform[/code]), the shape to check collisions with ([code]with_shape[/code]), and the transformation matrix of that shape ([code]shape_xform[/code]). + </description> + </method> + <method name="collide_and_get_contacts"> + <return type="Variant"> + </return> + <argument index="0" name="local_xform" type="Transform2D"> + </argument> + <argument index="1" name="with_shape" type="Shape2D"> + </argument> + <argument index="2" name="shape_xform" type="Transform2D"> + </argument> + <description> + Return a list of the points where this shape touches another. If there are no collisions, the list is empty. + This method needs the transformation matrix for this shape ([code]local_xform[/code]), the shape to check collisions with ([code]with_shape[/code]), and the transformation matrix of that shape ([code]shape_xform[/code]). + </description> + </method> + <method name="collide_with_motion"> + <return type="bool"> + </return> + <argument index="0" name="local_xform" type="Transform2D"> + </argument> + <argument index="1" name="local_motion" type="Vector2"> + </argument> + <argument index="2" name="with_shape" type="Shape2D"> + </argument> + <argument index="3" name="shape_xform" type="Transform2D"> + </argument> + <argument index="4" name="shape_motion" type="Vector2"> + </argument> + <description> + Return whether this shape would collide with another, if a given movement was applied. + This method needs the transformation matrix for this shape ([code]local_xform[/code]), the movement to test on this shape ([code]local_motion[/code]), the shape to check collisions with ([code]with_shape[/code]), the transformation matrix of that shape ([code]shape_xform[/code]), and the movement to test onto the other object ([code]shape_motion[/code]). + </description> + </method> + <method name="collide_with_motion_and_get_contacts"> + <return type="Variant"> + </return> + <argument index="0" name="local_xform" type="Transform2D"> + </argument> + <argument index="1" name="local_motion" type="Vector2"> + </argument> + <argument index="2" name="with_shape" type="Shape2D"> + </argument> + <argument index="3" name="shape_xform" type="Transform2D"> + </argument> + <argument index="4" name="shape_motion" type="Vector2"> + </argument> + <description> + Return a list of the points where this shape would touch another, if a given movement was applied. If there are no collisions, the list is empty. + This method needs the transformation matrix for this shape ([code]local_xform[/code]), the movement to test on this shape ([code]local_motion[/code]), the shape to check collisions with ([code]with_shape[/code]), the transformation matrix of that shape ([code]shape_xform[/code]), and the movement to test onto the other object ([code]shape_motion[/code]). + </description> + </method> + <method name="get_custom_solver_bias" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the custom solver bias. + </description> + </method> + <method name="set_custom_solver_bias"> + <return type="void"> + </return> + <argument index="0" name="bias" type="float"> + </argument> + <description> + Use a custom solver bias. No need to change this unless you really know what you are doing. + The solver bias is a factor controlling how much two objects "rebound" off each other, when colliding, to avoid them getting into each other because of numerical imprecision. + </description> + </method> + </methods> + <members> + <member name="custom_solver_bias" type="float" setter="set_custom_solver_bias" getter="get_custom_solver_bias"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/ShortCut.xml b/doc/classes/ShortCut.xml new file mode 100644 index 0000000000..e8b3b962d3 --- /dev/null +++ b/doc/classes/ShortCut.xml @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ShortCut" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_as_text" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_shortcut" qualifiers="const"> + <return type="InputEvent"> + </return> + <description> + </description> + </method> + <method name="is_shortcut" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="event" type="InputEvent"> + </argument> + <description> + </description> + </method> + <method name="is_valid" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_shortcut"> + <return type="void"> + </return> + <argument index="0" name="event" type="InputEvent"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="shortcut" type="InputEvent" setter="set_shortcut" getter="get_shortcut"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Skeleton.xml b/doc/classes/Skeleton.xml new file mode 100644 index 0000000000..b5be340b77 --- /dev/null +++ b/doc/classes/Skeleton.xml @@ -0,0 +1,221 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Skeleton" inherits="Spatial" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Skeleton for characters and animated objects. + </brief_description> + <description> + Skeleton provides a hierarchical interface for managing bones, including pose, rest and animation (see [Animation]). Skeleton will support rag doll dynamics in the future. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_bone"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Add a bone, with name "name". [method get_bone_count] will become the bone index. + </description> + </method> + <method name="bind_child_node_to_bone"> + <return type="void"> + </return> + <argument index="0" name="bone_idx" type="int"> + </argument> + <argument index="1" name="node" type="Node"> + </argument> + <description> + Deprecated soon. + </description> + </method> + <method name="clear_bones"> + <return type="void"> + </return> + <description> + Clear all the bones in this skeleton. + </description> + </method> + <method name="find_bone" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Return the bone index that matches "name" as its name. + </description> + </method> + <method name="get_bone_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the amount of bones in the skeleton. + </description> + </method> + <method name="get_bone_custom_pose" qualifiers="const"> + <return type="Transform"> + </return> + <argument index="0" name="bone_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_bone_global_pose" qualifiers="const"> + <return type="Transform"> + </return> + <argument index="0" name="bone_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_bone_name" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="bone_idx" type="int"> + </argument> + <description> + Return the name of the bone at index "index" + </description> + </method> + <method name="get_bone_parent" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="bone_idx" type="int"> + </argument> + <description> + Return the bone index which is the parent of the bone at "bone_idx". If -1, then bone has no parent. Note that the parent bone returned will always be less than "bone_idx". + </description> + </method> + <method name="get_bone_pose" qualifiers="const"> + <return type="Transform"> + </return> + <argument index="0" name="bone_idx" type="int"> + </argument> + <description> + Return the pose transform for bone "bone_idx". + </description> + </method> + <method name="get_bone_rest" qualifiers="const"> + <return type="Transform"> + </return> + <argument index="0" name="bone_idx" type="int"> + </argument> + <description> + Return the rest transform for a bone "bone_idx". + </description> + </method> + <method name="get_bone_transform" qualifiers="const"> + <return type="Transform"> + </return> + <argument index="0" name="bone_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_bound_child_nodes_to_bone" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="bone_idx" type="int"> + </argument> + <description> + Deprecated soon. + </description> + </method> + <method name="is_bone_rest_disabled" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="bone_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_bone_custom_pose"> + <return type="void"> + </return> + <argument index="0" name="bone_idx" type="int"> + </argument> + <argument index="1" name="custom_pose" type="Transform"> + </argument> + <description> + </description> + </method> + <method name="set_bone_disable_rest"> + <return type="void"> + </return> + <argument index="0" name="bone_idx" type="int"> + </argument> + <argument index="1" name="disable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_bone_global_pose"> + <return type="void"> + </return> + <argument index="0" name="bone_idx" type="int"> + </argument> + <argument index="1" name="pose" type="Transform"> + </argument> + <description> + </description> + </method> + <method name="set_bone_parent"> + <return type="void"> + </return> + <argument index="0" name="bone_idx" type="int"> + </argument> + <argument index="1" name="parent_idx" type="int"> + </argument> + <description> + Set the bone index "parent_idx" as the parent of the bone at "bone_idx". If -1, then bone has no parent. Note: "parent_idx" must be less than "bone_idx". + </description> + </method> + <method name="set_bone_pose"> + <return type="void"> + </return> + <argument index="0" name="bone_idx" type="int"> + </argument> + <argument index="1" name="pose" type="Transform"> + </argument> + <description> + Return the pose transform for bone "bone_idx". + </description> + </method> + <method name="set_bone_rest"> + <return type="void"> + </return> + <argument index="0" name="bone_idx" type="int"> + </argument> + <argument index="1" name="rest" type="Transform"> + </argument> + <description> + Set the rest transform for bone "bone_idx" + </description> + </method> + <method name="unbind_child_node_from_bone"> + <return type="void"> + </return> + <argument index="0" name="bone_idx" type="int"> + </argument> + <argument index="1" name="node" type="Node"> + </argument> + <description> + Deprecated soon. + </description> + </method> + <method name="unparent_bone_and_rest"> + <return type="void"> + </return> + <argument index="0" name="bone_idx" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + <constant name="NOTIFICATION_UPDATE_SKELETON" value="50" enum=""> + </constant> + </constants> +</class> diff --git a/doc/classes/Sky.xml b/doc/classes/Sky.xml new file mode 100644 index 0000000000..3045167346 --- /dev/null +++ b/doc/classes/Sky.xml @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Sky" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_radiance_size" qualifiers="const"> + <return type="int" enum="Sky.RadianceSize"> + </return> + <description> + </description> + </method> + <method name="set_radiance_size"> + <return type="void"> + </return> + <argument index="0" name="size" type="int" enum="Sky.RadianceSize"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="radiance_size" type="int" setter="set_radiance_size" getter="get_radiance_size" enum="Sky.RadianceSize"> + </member> + </members> + <constants> + <constant name="RADIANCE_SIZE_32" value="0"> + </constant> + <constant name="RADIANCE_SIZE_64" value="1"> + </constant> + <constant name="RADIANCE_SIZE_128" value="2"> + </constant> + <constant name="RADIANCE_SIZE_256" value="3"> + </constant> + <constant name="RADIANCE_SIZE_512" value="4"> + </constant> + <constant name="RADIANCE_SIZE_1024" value="5"> + </constant> + <constant name="RADIANCE_SIZE_2048" value="6"> + </constant> + <constant name="RADIANCE_SIZE_MAX" value="7"> + </constant> + </constants> +</class> diff --git a/doc/classes/Slider.xml b/doc/classes/Slider.xml new file mode 100644 index 0000000000..b9b2b98549 --- /dev/null +++ b/doc/classes/Slider.xml @@ -0,0 +1,73 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Slider" inherits="Range" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base class for GUI Sliders. + </brief_description> + <description> + Base class for GUI Sliders. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_ticks" qualifiers="const"> + <return type="int"> + </return> + <description> + Return amounts of ticks to display on slider. + </description> + </method> + <method name="get_ticks_on_borders" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if ticks are visible on borders. + </description> + </method> + <method name="is_editable" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_editable"> + <return type="void"> + </return> + <argument index="0" name="editable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_ticks"> + <return type="void"> + </return> + <argument index="0" name="count" type="int"> + </argument> + <description> + Set amount of ticks to display in slider. + </description> + </method> + <method name="set_ticks_on_borders"> + <return type="void"> + </return> + <argument index="0" name="ticks_on_border" type="bool"> + </argument> + <description> + Set true if ticks are visible on borders. + </description> + </method> + </methods> + <members> + <member name="editable" type="bool" setter="set_editable" getter="is_editable"> + </member> + <member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" enum="Control.FocusMode"> + </member> + <member name="tick_count" type="int" setter="set_ticks" getter="get_ticks"> + </member> + <member name="ticks_on_borders" type="bool" setter="set_ticks_on_borders" getter="get_ticks_on_borders"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/SliderJoint.xml b/doc/classes/SliderJoint.xml new file mode 100644 index 0000000000..617390b6a4 --- /dev/null +++ b/doc/classes/SliderJoint.xml @@ -0,0 +1,125 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="SliderJoint" inherits="Joint" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_param" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="param" type="int" enum="SliderJoint.Param"> + </argument> + <description> + </description> + </method> + <method name="set_param"> + <return type="void"> + </return> + <argument index="0" name="param" type="int" enum="SliderJoint.Param"> + </argument> + <argument index="1" name="value" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="angular_limit/damping" type="float" setter="set_param" getter="get_param"> + </member> + <member name="angular_limit/lower_angle" type="float" setter="_set_lower_limit_angular" getter="_get_lower_limit_angular"> + </member> + <member name="angular_limit/restitution" type="float" setter="set_param" getter="get_param"> + </member> + <member name="angular_limit/softness" type="float" setter="set_param" getter="get_param"> + </member> + <member name="angular_limit/upper_angle" type="float" setter="_set_upper_limit_angular" getter="_get_upper_limit_angular"> + </member> + <member name="angular_motion/damping" type="float" setter="set_param" getter="get_param"> + </member> + <member name="angular_motion/restitution" type="float" setter="set_param" getter="get_param"> + </member> + <member name="angular_motion/softness" type="float" setter="set_param" getter="get_param"> + </member> + <member name="angular_ortho/damping" type="float" setter="set_param" getter="get_param"> + </member> + <member name="angular_ortho/restitution" type="float" setter="set_param" getter="get_param"> + </member> + <member name="angular_ortho/softness" type="float" setter="set_param" getter="get_param"> + </member> + <member name="linear_limit/damping" type="float" setter="set_param" getter="get_param"> + </member> + <member name="linear_limit/lower_distance" type="float" setter="set_param" getter="get_param"> + </member> + <member name="linear_limit/restitution" type="float" setter="set_param" getter="get_param"> + </member> + <member name="linear_limit/softness" type="float" setter="set_param" getter="get_param"> + </member> + <member name="linear_limit/upper_distance" type="float" setter="set_param" getter="get_param"> + </member> + <member name="linear_motion/damping" type="float" setter="set_param" getter="get_param"> + </member> + <member name="linear_motion/restitution" type="float" setter="set_param" getter="get_param"> + </member> + <member name="linear_motion/softness" type="float" setter="set_param" getter="get_param"> + </member> + <member name="linear_ortho/damping" type="float" setter="set_param" getter="get_param"> + </member> + <member name="linear_ortho/restitution" type="float" setter="set_param" getter="get_param"> + </member> + <member name="linear_ortho/softness" type="float" setter="set_param" getter="get_param"> + </member> + </members> + <constants> + <constant name="PARAM_LINEAR_LIMIT_UPPER" value="0"> + </constant> + <constant name="PARAM_LINEAR_LIMIT_LOWER" value="1"> + </constant> + <constant name="PARAM_LINEAR_LIMIT_SOFTNESS" value="2"> + </constant> + <constant name="PARAM_LINEAR_LIMIT_RESTITUTION" value="3"> + </constant> + <constant name="PARAM_LINEAR_LIMIT_DAMPING" value="4"> + </constant> + <constant name="PARAM_LINEAR_MOTION_SOFTNESS" value="5"> + </constant> + <constant name="PARAM_LINEAR_MOTION_RESTITUTION" value="6"> + </constant> + <constant name="PARAM_LINEAR_MOTION_DAMPING" value="7"> + </constant> + <constant name="PARAM_LINEAR_ORTHOGONAL_SOFTNESS" value="8"> + </constant> + <constant name="PARAM_LINEAR_ORTHOGONAL_RESTITUTION" value="9"> + </constant> + <constant name="PARAM_LINEAR_ORTHOGONAL_DAMPING" value="10"> + </constant> + <constant name="PARAM_ANGULAR_LIMIT_UPPER" value="11"> + </constant> + <constant name="PARAM_ANGULAR_LIMIT_LOWER" value="12"> + </constant> + <constant name="PARAM_ANGULAR_LIMIT_SOFTNESS" value="13"> + </constant> + <constant name="PARAM_ANGULAR_LIMIT_RESTITUTION" value="14"> + </constant> + <constant name="PARAM_ANGULAR_LIMIT_DAMPING" value="15"> + </constant> + <constant name="PARAM_ANGULAR_MOTION_SOFTNESS" value="16"> + </constant> + <constant name="PARAM_ANGULAR_MOTION_RESTITUTION" value="17"> + </constant> + <constant name="PARAM_ANGULAR_MOTION_DAMPING" value="18"> + </constant> + <constant name="PARAM_ANGULAR_ORTHOGONAL_SOFTNESS" value="19"> + </constant> + <constant name="PARAM_ANGULAR_ORTHOGONAL_RESTITUTION" value="20"> + </constant> + <constant name="PARAM_ANGULAR_ORTHOGONAL_DAMPING" value="21"> + </constant> + <constant name="PARAM_MAX" value="22"> + </constant> + </constants> +</class> diff --git a/doc/classes/Spatial.xml b/doc/classes/Spatial.xml new file mode 100644 index 0000000000..e43e4dcc1b --- /dev/null +++ b/doc/classes/Spatial.xml @@ -0,0 +1,406 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Spatial" inherits="Node" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Most basic 3D game object, parent of all 3D related nodes. + </brief_description> + <description> + Most basic 3D game object, with a 3D [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. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_gizmo" qualifiers="const"> + <return type="SpatialGizmo"> + </return> + <description> + Returns the SpatialGizmo for this node. Used for example in [EditorSpatialGizmo] as custom visualization and editing handles in Editor. + </description> + </method> + <method name="get_global_transform" qualifiers="const"> + <return type="Transform"> + </return> + <description> + Returns the global transform, relative to worldspace. + </description> + </method> + <method name="get_parent_spatial" qualifiers="const"> + <return type="Spatial"> + </return> + <description> + Returns the parent [Spatial], or an empty [Object] if no parent exists or parent is not of type [Spatial]. + </description> + </method> + <method name="get_rotation" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + Returns the rotation (in radians). + </description> + </method> + <method name="get_rotation_deg" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + Returns the rotation (in degrees). + </description> + </method> + <method name="get_scale" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_transform" qualifiers="const"> + <return type="Transform"> + </return> + <description> + Returns the local transform, relative to the bone parent. + </description> + </method> + <method name="get_translation" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_world" qualifiers="const"> + <return type="World"> + </return> + <description> + Returns the current [World] resource this Spatial node is registered to. + </description> + </method> + <method name="global_rotate"> + <return type="void"> + </return> + <argument index="0" name="normal" type="Vector3"> + </argument> + <argument index="1" name="radians" type="float"> + </argument> + <description> + Rotates the current node along normal [Vector3] by angle in radians in Global space. + </description> + </method> + <method name="global_translate"> + <return type="void"> + </return> + <argument index="0" name="offset" type="Vector3"> + </argument> + <description> + Moves the node by [Vector3] offset in Global space. + </description> + </method> + <method name="hide"> + <return type="void"> + </return> + <description> + Disables rendering of this node. Change Spatial Visible property to false. + </description> + </method> + <method name="is_local_transform_notification_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns whether node notifies about its local transformation changes. Spatial will not propagate this by default. + </description> + </method> + <method name="is_set_as_toplevel" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns whether this node is set as Toplevel, that is whether it ignores its parent nodes transformations. + </description> + </method> + <method name="is_transform_notification_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns whether the node notifies about its global and local transformation changes. Spatial will not propagate this by default. + </description> + </method> + <method name="is_visible" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns whether the node is set to be visible. + </description> + </method> + <method name="is_visible_in_tree" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns whether the node is visible, taking into consideration that its parents visibility. + </description> + </method> + <method name="look_at"> + <return type="void"> + </return> + <argument index="0" name="target" type="Vector3"> + </argument> + <argument index="1" name="up" type="Vector3"> + </argument> + <description> + Rotates itself to point into direction of target position. Operations take place in global space. + </description> + </method> + <method name="look_at_from_pos"> + <return type="void"> + </return> + <argument index="0" name="pos" type="Vector3"> + </argument> + <argument index="1" name="target" type="Vector3"> + </argument> + <argument index="2" name="up" type="Vector3"> + </argument> + <description> + Moves the node to specified position and then rotates itself to point into direction of target position. Operations take place in global space. + </description> + </method> + <method name="orthonormalize"> + <return type="void"> + </return> + <description> + Resets this node's transformations (like scale, skew and taper) preserving its rotation and translation. Performs orthonormalization on this node [Transform3D]. + </description> + </method> + <method name="rotate"> + <return type="void"> + </return> + <argument index="0" name="normal" type="Vector3"> + </argument> + <argument index="1" name="radians" type="float"> + </argument> + <description> + Rotates the node in local space on given normal [Vector3] by angle in radians. + </description> + </method> + <method name="rotate_x"> + <return type="void"> + </return> + <argument index="0" name="radians" type="float"> + </argument> + <description> + Rotates the node in local space on X axis by angle in radians. + </description> + </method> + <method name="rotate_y"> + <return type="void"> + </return> + <argument index="0" name="radians" type="float"> + </argument> + <description> + Rotates the node in local space on Y axis by angle in radians. + </description> + </method> + <method name="rotate_z"> + <return type="void"> + </return> + <argument index="0" name="radians" type="float"> + </argument> + <description> + Rotates the node in local space on Z axis by angle in radians. + </description> + </method> + <method name="set_as_toplevel"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Makes the node ignore its parents tranformations. Node tranformations are only in global space. + </description> + </method> + <method name="set_gizmo"> + <return type="void"> + </return> + <argument index="0" name="gizmo" type="SpatialGizmo"> + </argument> + <description> + Set [SpatialGizmo] for this node. Used for example in [EditorSpatialGizmo] as custom visualization and editing handles in Editor. + </description> + </method> + <method name="set_global_transform"> + <return type="void"> + </return> + <argument index="0" name="global" type="Transform"> + </argument> + <description> + Set the transform globally, relative to world space. + </description> + </method> + <method name="set_identity"> + <return type="void"> + </return> + <description> + Reset all tranformations for this node. Set its [Transform3D] to identity matrix. + </description> + </method> + <method name="set_ignore_transform_notification"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Set whether the node ignores notification that its transformation (global or local) changed. + </description> + </method> + <method name="set_notify_local_transform"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set whether the node notifies about its local transformation changes. Spatial will not propagate this by default. + </description> + </method> + <method name="set_notify_transform"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set whether the node notifies about its global and local transformation changes. Spatial will not propagate this by default. + </description> + </method> + <method name="set_rotation"> + <return type="void"> + </return> + <argument index="0" name="rotation_rad" type="Vector3"> + </argument> + <description> + Set the rotation (in radians). + </description> + </method> + <method name="set_rotation_deg"> + <return type="void"> + </return> + <argument index="0" name="rotation_deg" type="Vector3"> + </argument> + <description> + Set the rotation (in degrees). + </description> + </method> + <method name="set_scale"> + <return type="void"> + </return> + <argument index="0" name="scale" type="Vector3"> + </argument> + <description> + Set the scale. + </description> + </method> + <method name="set_transform"> + <return type="void"> + </return> + <argument index="0" name="local" type="Transform"> + </argument> + <description> + Set the transform locally, relative to the parent spatial node. + </description> + </method> + <method name="set_translation"> + <return type="void"> + </return> + <argument index="0" name="translation" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="set_visible"> + <return type="void"> + </return> + <argument index="0" name="visible" type="bool"> + </argument> + <description> + </description> + </method> + <method name="show"> + <return type="void"> + </return> + <description> + Enables rendering of this node. Change Spatial Visible property to "True". + </description> + </method> + <method name="to_global" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="local_point" type="Vector3"> + </argument> + <description> + Tranforms [Vector3] "local_point" from this node's local space to world space. + </description> + </method> + <method name="to_local" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="global_point" type="Vector3"> + </argument> + <description> + Tranforms [Vector3] "global_point" from world space to this node's local space. + </description> + </method> + <method name="translate"> + <return type="void"> + </return> + <argument index="0" name="offset" type="Vector3"> + </argument> + <description> + Changes the node's position by given offset [Vector3]. + </description> + </method> + <method name="update_gizmo"> + <return type="void"> + </return> + <description> + Updates the [SpatialGizmo] of this node. + </description> + </method> + </methods> + <members> + <member name="global_transform" type="Transform" setter="set_global_transform" getter="get_global_transform"> + World space (global) [Transform] of this node. + </member> + <member name="rotation" type="Vector3" setter="set_rotation" getter="get_rotation"> + Local euler rotation in radians of this node. + </member> + <member name="rotation_deg" type="Vector3" setter="set_rotation_deg" getter="get_rotation_deg"> + Local euler rotation in degrees of this node. + </member> + <member name="scale" type="Vector3" setter="set_scale" getter="get_scale"> + Local scale of this node. + </member> + <member name="transform" type="Transform" setter="set_transform" getter="get_transform"> + Local space [Transform] of this node. + </member> + <member name="translation" type="Vector3" setter="set_translation" getter="get_translation"> + Local translation of this node. + </member> + <member name="visible" type="bool" setter="set_visible" getter="is_visible"> + Visibility of this node. Toggles if this node is rendered. + </member> + </members> + <signals> + <signal name="visibility_changed"> + <description> + Emitted when node visibility changes. + </description> + </signal> + </signals> + <constants> + <constant name="NOTIFICATION_TRANSFORM_CHANGED" value="29" enum=""> + 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). + </constant> + <constant name="NOTIFICATION_ENTER_WORLD" value="41" enum=""> + Spatial nodes receives this notification when they are registered to new [World] resource. + </constant> + <constant name="NOTIFICATION_EXIT_WORLD" value="42" enum=""> + Spatial nodes receives this notification when they are unregistered from current [World] resource. + </constant> + <constant name="NOTIFICATION_VISIBILITY_CHANGED" value="43" enum=""> + Spatial nodes receives this notification when their visibility changes. + </constant> + </constants> +</class> diff --git a/doc/classes/SpatialGizmo.xml b/doc/classes/SpatialGizmo.xml new file mode 100644 index 0000000000..1612e80500 --- /dev/null +++ b/doc/classes/SpatialGizmo.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="SpatialGizmo" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/SpatialMaterial.xml b/doc/classes/SpatialMaterial.xml new file mode 100644 index 0000000000..0f1c57e85b --- /dev/null +++ b/doc/classes/SpatialMaterial.xml @@ -0,0 +1,1021 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="SpatialMaterial" inherits="Material" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_albedo" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_alpha_scissor_threshold" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_anisotropy" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_ao_texture_channel" qualifiers="const"> + <return type="int" enum="SpatialMaterial.TextureChannel"> + </return> + <description> + </description> + </method> + <method name="get_billboard_mode" qualifiers="const"> + <return type="int" enum="SpatialMaterial.BillboardMode"> + </return> + <description> + </description> + </method> + <method name="get_blend_mode" qualifiers="const"> + <return type="int" enum="SpatialMaterial.BlendMode"> + </return> + <description> + </description> + </method> + <method name="get_clearcoat" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_clearcoat_gloss" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_cull_mode" qualifiers="const"> + <return type="int" enum="SpatialMaterial.CullMode"> + </return> + <description> + </description> + </method> + <method name="get_depth_deep_parallax_max_layers" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_depth_deep_parallax_min_layers" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_depth_draw_mode" qualifiers="const"> + <return type="int" enum="SpatialMaterial.DepthDrawMode"> + </return> + <description> + </description> + </method> + <method name="get_depth_scale" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_detail_blend_mode" qualifiers="const"> + <return type="int" enum="SpatialMaterial.BlendMode"> + </return> + <description> + </description> + </method> + <method name="get_detail_uv" qualifiers="const"> + <return type="int" enum="SpatialMaterial.DetailUV"> + </return> + <description> + </description> + </method> + <method name="get_diffuse_mode" qualifiers="const"> + <return type="int" enum="SpatialMaterial.DiffuseMode"> + </return> + <description> + </description> + </method> + <method name="get_emission" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_emission_energy" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_feature" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="feature" type="int" enum="SpatialMaterial.Feature"> + </argument> + <description> + </description> + </method> + <method name="get_flag" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="flag" type="int" enum="SpatialMaterial.Flags"> + </argument> + <description> + </description> + </method> + <method name="get_grow" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_line_width" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_metallic" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_metallic_texture_channel" qualifiers="const"> + <return type="int" enum="SpatialMaterial.TextureChannel"> + </return> + <description> + </description> + </method> + <method name="get_normal_scale" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_particles_anim_h_frames" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_particles_anim_loop" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_particles_anim_v_frames" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_point_size" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_refraction" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_refraction_texture_channel" qualifiers="const"> + <return type="int" enum="SpatialMaterial.TextureChannel"> + </return> + <description> + </description> + </method> + <method name="get_rim" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_rim_tint" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_roughness" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_roughness_texture_channel" qualifiers="const"> + <return type="int" enum="SpatialMaterial.TextureChannel"> + </return> + <description> + </description> + </method> + <method name="get_specular" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_specular_mode" qualifiers="const"> + <return type="int" enum="SpatialMaterial.SpecularMode"> + </return> + <description> + </description> + </method> + <method name="get_subsurface_scattering_strength" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_texture" qualifiers="const"> + <return type="Texture"> + </return> + <argument index="0" name="param" type="int" enum="SpatialMaterial.TextureParam"> + </argument> + <description> + </description> + </method> + <method name="get_transmission" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_uv1_offset" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_uv1_scale" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_uv1_triplanar_blend_sharpness" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_uv2_offset" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_uv2_scale" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_uv2_triplanar_blend_sharpness" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="is_depth_deep_parallax_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_grow_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_albedo"> + <return type="void"> + </return> + <argument index="0" name="albedo" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_alpha_scissor_threshold"> + <return type="void"> + </return> + <argument index="0" name="threshold" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_anisotropy"> + <return type="void"> + </return> + <argument index="0" name="anisotropy" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_ao_texture_channel"> + <return type="void"> + </return> + <argument index="0" name="channel" type="int" enum="SpatialMaterial.TextureChannel"> + </argument> + <description> + </description> + </method> + <method name="set_billboard_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="SpatialMaterial.BillboardMode"> + </argument> + <description> + </description> + </method> + <method name="set_blend_mode"> + <return type="void"> + </return> + <argument index="0" name="blend_mode" type="int" enum="SpatialMaterial.BlendMode"> + </argument> + <description> + </description> + </method> + <method name="set_clearcoat"> + <return type="void"> + </return> + <argument index="0" name="clearcoat" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_clearcoat_gloss"> + <return type="void"> + </return> + <argument index="0" name="clearcoat_gloss" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_cull_mode"> + <return type="void"> + </return> + <argument index="0" name="cull_mode" type="int" enum="SpatialMaterial.CullMode"> + </argument> + <description> + </description> + </method> + <method name="set_depth_deep_parallax"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_depth_deep_parallax_max_layers"> + <return type="void"> + </return> + <argument index="0" name="layer" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_depth_deep_parallax_min_layers"> + <return type="void"> + </return> + <argument index="0" name="layer" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_depth_draw_mode"> + <return type="void"> + </return> + <argument index="0" name="depth_draw_mode" type="int" enum="SpatialMaterial.DepthDrawMode"> + </argument> + <description> + </description> + </method> + <method name="set_depth_scale"> + <return type="void"> + </return> + <argument index="0" name="depth_scale" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_detail_blend_mode"> + <return type="void"> + </return> + <argument index="0" name="detail_blend_mode" type="int" enum="SpatialMaterial.BlendMode"> + </argument> + <description> + </description> + </method> + <method name="set_detail_uv"> + <return type="void"> + </return> + <argument index="0" name="detail_uv" type="int" enum="SpatialMaterial.DetailUV"> + </argument> + <description> + </description> + </method> + <method name="set_diffuse_mode"> + <return type="void"> + </return> + <argument index="0" name="diffuse_mode" type="int" enum="SpatialMaterial.DiffuseMode"> + </argument> + <description> + </description> + </method> + <method name="set_emission"> + <return type="void"> + </return> + <argument index="0" name="emission" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_emission_energy"> + <return type="void"> + </return> + <argument index="0" name="emission_energy" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_feature"> + <return type="void"> + </return> + <argument index="0" name="feature" type="int" enum="SpatialMaterial.Feature"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_flag"> + <return type="void"> + </return> + <argument index="0" name="flag" type="int" enum="SpatialMaterial.Flags"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_grow"> + <return type="void"> + </return> + <argument index="0" name="amount" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_grow_enabled"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_line_width"> + <return type="void"> + </return> + <argument index="0" name="line_width" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_metallic"> + <return type="void"> + </return> + <argument index="0" name="metallic" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_metallic_texture_channel"> + <return type="void"> + </return> + <argument index="0" name="channel" type="int" enum="SpatialMaterial.TextureChannel"> + </argument> + <description> + </description> + </method> + <method name="set_normal_scale"> + <return type="void"> + </return> + <argument index="0" name="normal_scale" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_particles_anim_h_frames"> + <return type="void"> + </return> + <argument index="0" name="frames" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_particles_anim_loop"> + <return type="void"> + </return> + <argument index="0" name="frames" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_particles_anim_v_frames"> + <return type="void"> + </return> + <argument index="0" name="frames" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_point_size"> + <return type="void"> + </return> + <argument index="0" name="point_size" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_refraction"> + <return type="void"> + </return> + <argument index="0" name="refraction" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_refraction_texture_channel"> + <return type="void"> + </return> + <argument index="0" name="channel" type="int" enum="SpatialMaterial.TextureChannel"> + </argument> + <description> + </description> + </method> + <method name="set_rim"> + <return type="void"> + </return> + <argument index="0" name="rim" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_rim_tint"> + <return type="void"> + </return> + <argument index="0" name="rim_tint" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_roughness"> + <return type="void"> + </return> + <argument index="0" name="roughness" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_roughness_texture_channel"> + <return type="void"> + </return> + <argument index="0" name="channel" type="int" enum="SpatialMaterial.TextureChannel"> + </argument> + <description> + </description> + </method> + <method name="set_specular"> + <return type="void"> + </return> + <argument index="0" name="specular" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_specular_mode"> + <return type="void"> + </return> + <argument index="0" name="specular_mode" type="int" enum="SpatialMaterial.SpecularMode"> + </argument> + <description> + </description> + </method> + <method name="set_subsurface_scattering_strength"> + <return type="void"> + </return> + <argument index="0" name="strength" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_texture"> + <return type="void"> + </return> + <argument index="0" name="param" type="int" enum="SpatialMaterial.TextureParam"> + </argument> + <argument index="1" name="texture" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_transmission"> + <return type="void"> + </return> + <argument index="0" name="transmission" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_uv1_offset"> + <return type="void"> + </return> + <argument index="0" name="offset" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="set_uv1_scale"> + <return type="void"> + </return> + <argument index="0" name="scale" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="set_uv1_triplanar_blend_sharpness"> + <return type="void"> + </return> + <argument index="0" name="sharpness" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_uv2_offset"> + <return type="void"> + </return> + <argument index="0" name="offset" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="set_uv2_scale"> + <return type="void"> + </return> + <argument index="0" name="scale" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="set_uv2_triplanar_blend_sharpness"> + <return type="void"> + </return> + <argument index="0" name="sharpness" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="albedo_color" type="Color" setter="set_albedo" getter="get_albedo"> + </member> + <member name="albedo_texture" type="Texture" setter="set_texture" getter="get_texture"> + </member> + <member name="anisotropy" type="float" setter="set_anisotropy" getter="get_anisotropy"> + </member> + <member name="anisotropy_enabled" type="bool" setter="set_feature" getter="get_feature"> + </member> + <member name="anisotropy_flowmap" type="Texture" setter="set_texture" getter="get_texture"> + </member> + <member name="ao_enabled" type="bool" setter="set_feature" getter="get_feature"> + </member> + <member name="ao_on_uv2" type="bool" setter="set_flag" getter="get_flag"> + </member> + <member name="ao_texture" type="Texture" setter="set_texture" getter="get_texture"> + </member> + <member name="ao_texture_channel" type="int" setter="set_ao_texture_channel" getter="get_ao_texture_channel" enum="SpatialMaterial.TextureChannel"> + </member> + <member name="clearcoat" type="float" setter="set_clearcoat" getter="get_clearcoat"> + </member> + <member name="clearcoat_enabled" type="bool" setter="set_feature" getter="get_feature"> + </member> + <member name="clearcoat_gloss" type="float" setter="set_clearcoat_gloss" getter="get_clearcoat_gloss"> + </member> + <member name="clearcoat_texture" type="Texture" setter="set_texture" getter="get_texture"> + </member> + <member name="depth_deep_parallax" type="bool" setter="set_depth_deep_parallax" getter="is_depth_deep_parallax_enabled"> + </member> + <member name="depth_enabled" type="bool" setter="set_feature" getter="get_feature"> + </member> + <member name="depth_max_layers" type="int" setter="set_depth_deep_parallax_max_layers" getter="get_depth_deep_parallax_max_layers"> + </member> + <member name="depth_min_layers" type="int" setter="set_depth_deep_parallax_min_layers" getter="get_depth_deep_parallax_min_layers"> + </member> + <member name="depth_scale" type="float" setter="set_depth_scale" getter="get_depth_scale"> + </member> + <member name="depth_texture" type="Texture" setter="set_texture" getter="get_texture"> + </member> + <member name="detail_albedo" type="Texture" setter="set_texture" getter="get_texture"> + </member> + <member name="detail_blend_mode" type="int" setter="set_detail_blend_mode" getter="get_detail_blend_mode" enum="SpatialMaterial.BlendMode"> + </member> + <member name="detail_enabled" type="bool" setter="set_feature" getter="get_feature"> + </member> + <member name="detail_mask" type="Texture" setter="set_texture" getter="get_texture"> + </member> + <member name="detail_normal" type="Texture" setter="set_texture" getter="get_texture"> + </member> + <member name="detail_uv_layer" type="int" setter="set_detail_uv" getter="get_detail_uv" enum="SpatialMaterial.DetailUV"> + </member> + <member name="emission" type="Color" setter="set_emission" getter="get_emission"> + </member> + <member name="emission_enabled" type="bool" setter="set_feature" getter="get_feature"> + </member> + <member name="emission_energy" type="float" setter="set_emission_energy" getter="get_emission_energy"> + </member> + <member name="emission_texture" type="Texture" setter="set_texture" getter="get_texture"> + </member> + <member name="flags_fixed_size" type="bool" setter="set_flag" getter="get_flag"> + </member> + <member name="flags_no_depth_test" type="bool" setter="set_flag" getter="get_flag"> + </member> + <member name="flags_transparent" type="bool" setter="set_feature" getter="get_feature"> + </member> + <member name="flags_unshaded" type="bool" setter="set_flag" getter="get_flag"> + </member> + <member name="flags_use_point_size" type="bool" setter="set_flag" getter="get_flag"> + </member> + <member name="flags_vertex_lighting" type="bool" setter="set_flag" getter="get_flag"> + </member> + <member name="flags_world_triplanar" type="bool" setter="set_flag" getter="get_flag"> + </member> + <member name="metallic" type="float" setter="set_metallic" getter="get_metallic"> + </member> + <member name="metallic_specular" type="float" setter="set_specular" getter="get_specular"> + </member> + <member name="metallic_texture" type="Texture" setter="set_texture" getter="get_texture"> + </member> + <member name="metallic_texture_channel" type="int" setter="set_metallic_texture_channel" getter="get_metallic_texture_channel" enum="SpatialMaterial.TextureChannel"> + </member> + <member name="normal_enabled" type="bool" setter="set_feature" getter="get_feature"> + </member> + <member name="normal_scale" type="float" setter="set_normal_scale" getter="get_normal_scale"> + </member> + <member name="normal_texture" type="Texture" setter="set_texture" getter="get_texture"> + </member> + <member name="params_alpha_scissor_threshold" type="float" setter="set_alpha_scissor_threshold" getter="get_alpha_scissor_threshold"> + </member> + <member name="params_billboard_mode" type="int" setter="set_billboard_mode" getter="get_billboard_mode" enum="SpatialMaterial.BillboardMode"> + </member> + <member name="params_blend_mode" type="int" setter="set_blend_mode" getter="get_blend_mode" enum="SpatialMaterial.BlendMode"> + </member> + <member name="params_cull_mode" type="int" setter="set_cull_mode" getter="get_cull_mode" enum="SpatialMaterial.CullMode"> + </member> + <member name="params_depth_draw_mode" type="int" setter="set_depth_draw_mode" getter="get_depth_draw_mode" enum="SpatialMaterial.DepthDrawMode"> + </member> + <member name="params_diffuse_mode" type="int" setter="set_diffuse_mode" getter="get_diffuse_mode" enum="SpatialMaterial.DiffuseMode"> + </member> + <member name="params_grow" type="bool" setter="set_grow_enabled" getter="is_grow_enabled"> + </member> + <member name="params_grow_amount" type="float" setter="set_grow" getter="get_grow"> + </member> + <member name="params_line_width" type="float" setter="set_line_width" getter="get_line_width"> + </member> + <member name="params_point_size" type="float" setter="set_point_size" getter="get_point_size"> + </member> + <member name="params_specular_mode" type="int" setter="set_specular_mode" getter="get_specular_mode" enum="SpatialMaterial.SpecularMode"> + </member> + <member name="params_use_alpha_scissor" type="bool" setter="set_flag" getter="get_flag"> + </member> + <member name="particles_anim_h_frames" type="int" setter="set_particles_anim_h_frames" getter="get_particles_anim_h_frames"> + </member> + <member name="particles_anim_loop" type="int" setter="set_particles_anim_loop" getter="get_particles_anim_loop"> + </member> + <member name="particles_anim_v_frames" type="int" setter="set_particles_anim_v_frames" getter="get_particles_anim_v_frames"> + </member> + <member name="refraction_enabled" type="bool" setter="set_feature" getter="get_feature"> + </member> + <member name="refraction_scale" type="float" setter="set_refraction" getter="get_refraction"> + </member> + <member name="refraction_texture" type="Texture" setter="set_texture" getter="get_texture"> + </member> + <member name="refraction_texture_channel" type="int" setter="set_refraction_texture_channel" getter="get_refraction_texture_channel" enum="SpatialMaterial.TextureChannel"> + </member> + <member name="rim" type="float" setter="set_rim" getter="get_rim"> + </member> + <member name="rim_enabled" type="bool" setter="set_feature" getter="get_feature"> + </member> + <member name="rim_texture" type="Texture" setter="set_texture" getter="get_texture"> + </member> + <member name="rim_tint" type="float" setter="set_rim_tint" getter="get_rim_tint"> + </member> + <member name="roughness" type="float" setter="set_roughness" getter="get_roughness"> + </member> + <member name="roughness_texture" type="Texture" setter="set_texture" getter="get_texture"> + </member> + <member name="roughness_texture_channel" type="int" setter="set_roughness_texture_channel" getter="get_roughness_texture_channel" enum="SpatialMaterial.TextureChannel"> + </member> + <member name="subsurf_scatter_enabled" type="bool" setter="set_feature" getter="get_feature"> + </member> + <member name="subsurf_scatter_strength" type="float" setter="set_subsurface_scattering_strength" getter="get_subsurface_scattering_strength"> + </member> + <member name="subsurf_scatter_texture" type="Texture" setter="set_texture" getter="get_texture"> + </member> + <member name="transmission" type="Color" setter="set_transmission" getter="get_transmission"> + </member> + <member name="transmission_enabled" type="bool" setter="set_feature" getter="get_feature"> + </member> + <member name="transmission_texture" type="Texture" setter="set_texture" getter="get_texture"> + </member> + <member name="uv1_offset" type="Vector3" setter="set_uv1_offset" getter="get_uv1_offset"> + </member> + <member name="uv1_scale" type="Vector3" setter="set_uv1_scale" getter="get_uv1_scale"> + </member> + <member name="uv1_triplanar" type="bool" setter="set_flag" getter="get_flag"> + </member> + <member name="uv1_triplanar_sharpness" type="float" setter="set_uv1_triplanar_blend_sharpness" getter="get_uv1_triplanar_blend_sharpness"> + </member> + <member name="uv2_offset" type="Vector3" setter="set_uv2_offset" getter="get_uv2_offset"> + </member> + <member name="uv2_scale" type="Vector3" setter="set_uv2_scale" getter="get_uv2_scale"> + </member> + <member name="uv2_triplanar" type="bool" setter="set_flag" getter="get_flag"> + </member> + <member name="uv2_triplanar_sharpness" type="float" setter="set_uv2_triplanar_blend_sharpness" getter="get_uv2_triplanar_blend_sharpness"> + </member> + <member name="vertex_color_is_srgb" type="bool" setter="set_flag" getter="get_flag"> + </member> + <member name="vertex_color_use_as_albedo" type="bool" setter="set_flag" getter="get_flag"> + </member> + </members> + <constants> + <constant name="TEXTURE_ALBEDO" value="0"> + </constant> + <constant name="TEXTURE_METALLIC" value="1"> + </constant> + <constant name="TEXTURE_ROUGHNESS" value="2"> + </constant> + <constant name="TEXTURE_EMISSION" value="3"> + </constant> + <constant name="TEXTURE_NORMAL" value="4"> + </constant> + <constant name="TEXTURE_RIM" value="5"> + </constant> + <constant name="TEXTURE_CLEARCOAT" value="6"> + </constant> + <constant name="TEXTURE_FLOWMAP" value="7"> + </constant> + <constant name="TEXTURE_AMBIENT_OCCLUSION" value="8"> + </constant> + <constant name="TEXTURE_DEPTH" value="9"> + </constant> + <constant name="TEXTURE_SUBSURFACE_SCATTERING" value="10"> + </constant> + <constant name="TEXTURE_TRANSMISSION" value="11"> + </constant> + <constant name="TEXTURE_REFRACTION" value="12"> + </constant> + <constant name="TEXTURE_DETAIL_MASK" value="13"> + </constant> + <constant name="TEXTURE_DETAIL_ALBEDO" value="14"> + </constant> + <constant name="TEXTURE_DETAIL_NORMAL" value="15"> + </constant> + <constant name="TEXTURE_MAX" value="16"> + </constant> + <constant name="DETAIL_UV_1" value="0"> + </constant> + <constant name="DETAIL_UV_2" value="1"> + </constant> + <constant name="FEATURE_TRANSPARENT" value="0"> + </constant> + <constant name="FEATURE_EMISSION" value="1"> + </constant> + <constant name="FEATURE_NORMAL_MAPPING" value="2"> + </constant> + <constant name="FEATURE_RIM" value="3"> + </constant> + <constant name="FEATURE_CLEARCOAT" value="4"> + </constant> + <constant name="FEATURE_ANISOTROPY" value="5"> + </constant> + <constant name="FEATURE_AMBIENT_OCCLUSION" value="6"> + </constant> + <constant name="FEATURE_DEPTH_MAPPING" value="7"> + </constant> + <constant name="FEATURE_SUBSURACE_SCATTERING" value="8"> + </constant> + <constant name="FEATURE_TRANSMISSION" value="9"> + </constant> + <constant name="FEATURE_REFRACTION" value="10"> + </constant> + <constant name="FEATURE_DETAIL" value="11"> + </constant> + <constant name="FEATURE_MAX" value="12"> + </constant> + <constant name="BLEND_MODE_MIX" value="0"> + </constant> + <constant name="BLEND_MODE_ADD" value="1"> + </constant> + <constant name="BLEND_MODE_SUB" value="2"> + </constant> + <constant name="BLEND_MODE_MUL" value="3"> + </constant> + <constant name="DEPTH_DRAW_OPAQUE_ONLY" value="0"> + </constant> + <constant name="DEPTH_DRAW_ALWAYS" value="1"> + </constant> + <constant name="DEPTH_DRAW_DISABLED" value="2"> + </constant> + <constant name="DEPTH_DRAW_ALPHA_OPAQUE_PREPASS" value="3"> + </constant> + <constant name="CULL_BACK" value="0"> + </constant> + <constant name="CULL_FRONT" value="1"> + </constant> + <constant name="CULL_DISABLED" value="2"> + </constant> + <constant name="FLAG_UNSHADED" value="0"> + </constant> + <constant name="FLAG_USE_VERTEX_LIGHTING" value="1"> + </constant> + <constant name="FLAG_DISABLE_DEPTH_TEST" value="2"> + </constant> + <constant name="FLAG_ALBEDO_FROM_VERTEX_COLOR" value="3"> + </constant> + <constant name="FLAG_SRGB_VERTEX_COLOR" value="4"> + </constant> + <constant name="FLAG_USE_POINT_SIZE" value="5"> + </constant> + <constant name="FLAG_FIXED_SIZE" value="6"> + </constant> + <constant name="FLAG_UV1_USE_TRIPLANAR" value="7"> + </constant> + <constant name="FLAG_UV2_USE_TRIPLANAR" value="8"> + </constant> + <constant name="FLAG_AO_ON_UV2" value="10"> + </constant> + <constant name="FLAG_USE_ALPHA_SCISSOR" value="11"> + </constant> + <constant name="FLAG_TRIPLANAR_USE_WORLD" value="9"> + </constant> + <constant name="FLAG_MAX" value="12"> + </constant> + <constant name="DIFFUSE_LAMBERT" value="0"> + </constant> + <constant name="DIFFUSE_LAMBERT_WRAP" value="1"> + </constant> + <constant name="DIFFUSE_OREN_NAYAR" value="2"> + </constant> + <constant name="DIFFUSE_BURLEY" value="3"> + </constant> + <constant name="DIFFUSE_TOON" value="4"> + </constant> + <constant name="SPECULAR_SCHLICK_GGX" value="0"> + </constant> + <constant name="SPECULAR_BLINN" value="1"> + </constant> + <constant name="SPECULAR_PHONG" value="2"> + </constant> + <constant name="SPECULAR_TOON" value="3"> + </constant> + <constant name="SPECULAR_DISABLED" value="4"> + </constant> + <constant name="BILLBOARD_DISABLED" value="0"> + </constant> + <constant name="BILLBOARD_ENABLED" value="1"> + </constant> + <constant name="BILLBOARD_FIXED_Y" value="2"> + </constant> + <constant name="BILLBOARD_PARTICLES" value="3"> + </constant> + <constant name="TEXTURE_CHANNEL_RED" value="0"> + </constant> + <constant name="TEXTURE_CHANNEL_GREEN" value="1"> + </constant> + <constant name="TEXTURE_CHANNEL_BLUE" value="2"> + </constant> + <constant name="TEXTURE_CHANNEL_ALPHA" value="3"> + </constant> + <constant name="TEXTURE_CHANNEL_GRAYSCALE" value="4"> + </constant> + </constants> +</class> diff --git a/doc/classes/SpatialVelocityTracker.xml b/doc/classes/SpatialVelocityTracker.xml new file mode 100644 index 0000000000..2cbc2b9739 --- /dev/null +++ b/doc/classes/SpatialVelocityTracker.xml @@ -0,0 +1,51 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="SpatialVelocityTracker" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_tracked_linear_velocity" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="is_tracking_fixed_step" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="reset"> + <return type="void"> + </return> + <argument index="0" name="position" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="set_track_fixed_step"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="update_position"> + <return type="void"> + </return> + <argument index="0" name="position" type="Vector3"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/SphereMesh.xml b/doc/classes/SphereMesh.xml new file mode 100644 index 0000000000..0ae48cb7d7 --- /dev/null +++ b/doc/classes/SphereMesh.xml @@ -0,0 +1,104 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="SphereMesh" inherits="PrimitiveMesh" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Class representing a spherical [PrimitiveMesh]. + </brief_description> + <description> + Class representing a spherical [PrimitiveMesh]. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_height" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_is_hemisphere" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_radial_segments" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_radius" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_rings" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_height"> + <return type="void"> + </return> + <argument index="0" name="height" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_is_hemisphere"> + <return type="void"> + </return> + <argument index="0" name="is_hemisphere" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_radial_segments"> + <return type="void"> + </return> + <argument index="0" name="radial_segments" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_radius"> + <return type="void"> + </return> + <argument index="0" name="radius" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_rings"> + <return type="void"> + </return> + <argument index="0" name="rings" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="height" type="float" setter="set_height" getter="get_height"> + Full height of the sphere. Defaults to 2.0. + </member> + <member name="is_hemisphere" type="bool" setter="set_is_hemisphere" getter="get_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. + </member> + <member name="radial_segments" type="int" setter="set_radial_segments" getter="get_radial_segments"> + Number of radial segments on the sphere. Defaults to 64. + </member> + <member name="radius" type="float" setter="set_radius" getter="get_radius"> + Radius of sphere. Defaults to 1.0. + </member> + <member name="rings" type="int" setter="set_rings" getter="get_rings"> + Number of segments along the height of the sphere. Defaults to 32. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/SphereShape.xml b/doc/classes/SphereShape.xml new file mode 100644 index 0000000000..120c7fcc25 --- /dev/null +++ b/doc/classes/SphereShape.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="SphereShape" inherits="Shape" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_radius" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="set_radius"> + <return type="void"> + </return> + <argument index="0" name="radius" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="radius" type="float" setter="set_radius" getter="get_radius"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/SpinBox.xml b/doc/classes/SpinBox.xml new file mode 100644 index 0000000000..31ef1865e9 --- /dev/null +++ b/doc/classes/SpinBox.xml @@ -0,0 +1,82 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="SpinBox" inherits="Range" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Numerical input text field. + </brief_description> + <description> + SpinBox is a numerical input text field. It allows entering integers and floats. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_line_edit"> + <return type="LineEdit"> + </return> + <description> + </description> + </method> + <method name="get_prefix" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_suffix" qualifiers="const"> + <return type="String"> + </return> + <description> + Return the specific suffix. + </description> + </method> + <method name="is_editable" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return if the spinbox is editable. + </description> + </method> + <method name="set_editable"> + <return type="void"> + </return> + <argument index="0" name="editable" type="bool"> + </argument> + <description> + Set whether the spinbox is editable. + </description> + </method> + <method name="set_prefix"> + <return type="void"> + </return> + <argument index="0" name="prefix" type="String"> + </argument> + <description> + Set a prefix. + </description> + </method> + <method name="set_suffix"> + <return type="void"> + </return> + <argument index="0" name="suffix" type="String"> + </argument> + <description> + Set a specific suffix. + </description> + </method> + </methods> + <members> + <member name="editable" type="bool" setter="set_editable" getter="is_editable"> + </member> + <member name="prefix" type="String" setter="set_prefix" getter="get_prefix"> + </member> + <member name="suffix" type="String" setter="set_suffix" getter="get_suffix"> + </member> + </members> + <constants> + </constants> + <theme_items> + <theme_item name="updown" type="Texture"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/SplitContainer.xml b/doc/classes/SplitContainer.xml new file mode 100644 index 0000000000..861a483f6d --- /dev/null +++ b/doc/classes/SplitContainer.xml @@ -0,0 +1,91 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="SplitContainer" inherits="Container" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Container for splitting and adjusting. + </brief_description> + <description> + Container for splitting two controls vertically or horizontally, with a grabber that allows adjusting the split offset or ratio. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_dragger_visibility" qualifiers="const"> + <return type="int" enum="SplitContainer.DraggerVisibility"> + </return> + <description> + Return visibility of the split dragger (one of [DRAGGER_VISIBLE], [DRAGGER_HIDDEN] or [DRAGGER_HIDDEN_COLLAPSED]). + </description> + </method> + <method name="get_split_offset" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the split offset. + </description> + </method> + <method name="is_collapsed" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if the split is collapsed. + </description> + </method> + <method name="set_collapsed"> + <return type="void"> + </return> + <argument index="0" name="collapsed" type="bool"> + </argument> + <description> + Set if the split must be collapsed. + </description> + </method> + <method name="set_dragger_visibility"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="SplitContainer.DraggerVisibility"> + </argument> + <description> + Set visibility of the split dragger ([i]mode[/i] must be one of [DRAGGER_VISIBLE], [DRAGGER_HIDDEN] or [DRAGGER_HIDDEN_COLLAPSED]). + </description> + </method> + <method name="set_split_offset"> + <return type="void"> + </return> + <argument index="0" name="offset" type="int"> + </argument> + <description> + Set the split offset. + </description> + </method> + </methods> + <members> + <member name="collapsed" type="bool" setter="set_collapsed" getter="is_collapsed"> + </member> + <member name="dragger_visibility" type="int" setter="set_dragger_visibility" getter="get_dragger_visibility" enum="SplitContainer.DraggerVisibility"> + </member> + <member name="split_offset" type="int" setter="set_split_offset" getter="get_split_offset"> + </member> + </members> + <signals> + <signal name="dragged"> + <argument index="0" name="offset" type="int"> + </argument> + <description> + Emitted when the dragger is dragged by user. + </description> + </signal> + </signals> + <constants> + <constant name="DRAGGER_VISIBLE" value="0"> + The split dragger is visible. + </constant> + <constant name="DRAGGER_HIDDEN" value="1"> + The split dragger is invisible. + </constant> + <constant name="DRAGGER_HIDDEN_COLLAPSED" value="2"> + The split dragger is invisible and collapsed. + </constant> + </constants> +</class> diff --git a/doc/classes/SpotLight.xml b/doc/classes/SpotLight.xml new file mode 100644 index 0000000000..430e7c4a26 --- /dev/null +++ b/doc/classes/SpotLight.xml @@ -0,0 +1,27 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="SpotLight" inherits="Light" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Spotlight [Light], such as a reflector spotlight or a lantern. + </brief_description> + <description> + A SpotLight light is a type of [Light] node that emits lights in a specific direction, in the shape of a cone. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of [Light]. TODO: Image of a spotlight. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <members> + <member name="spot_angle" type="float" setter="set_param" getter="get_param"> + </member> + <member name="spot_angle_attenuation" type="float" setter="set_param" getter="get_param"> + </member> + <member name="spot_attenuation" type="float" setter="set_param" getter="get_param"> + </member> + <member name="spot_range" type="float" setter="set_param" getter="get_param"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Sprite.xml b/doc/classes/Sprite.xml new file mode 100644 index 0000000000..90ebe79666 --- /dev/null +++ b/doc/classes/Sprite.xml @@ -0,0 +1,241 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Sprite" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + General purpose Sprite node. + </brief_description> + <description> + General purpose Sprite node. This Sprite node can show any texture as a sprite. The texture can be used as a spritesheet for animation, or only a region from a bigger texture can referenced, like an atlas. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_frame" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1. + </description> + </method> + <method name="get_hframes" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the amount of horizontal frames. See [method set_hframes]. + </description> + </method> + <method name="get_normal_map" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="get_offset" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return sprite draw offset. + </description> + </method> + <method name="get_region_rect" qualifiers="const"> + <return type="Rect2"> + </return> + <description> + Return the region rect to read from. + </description> + </method> + <method name="get_texture" qualifiers="const"> + <return type="Texture"> + </return> + <description> + Return the base texture for the sprite. + </description> + </method> + <method name="get_vframes" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the amount of vertical frames. See [method set_vframes]. + </description> + </method> + <method name="is_centered" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return if the sprite is centered at the local origin. + </description> + </method> + <method name="is_flipped_h" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if the sprite is flipped horizontally. + </description> + </method> + <method name="is_flipped_v" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if the sprite is flipped vertically. + </description> + </method> + <method name="is_region" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return if the sprite reads from a region. + </description> + </method> + <method name="is_region_filter_clip_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_centered"> + <return type="void"> + </return> + <argument index="0" name="centered" type="bool"> + </argument> + <description> + Set whether the sprite should be centered on the origin. + </description> + </method> + <method name="set_flip_h"> + <return type="void"> + </return> + <argument index="0" name="flip_h" type="bool"> + </argument> + <description> + Set true to flip the sprite horizontally. + </description> + </method> + <method name="set_flip_v"> + <return type="void"> + </return> + <argument index="0" name="flip_v" type="bool"> + </argument> + <description> + Set true to flip the sprite vertically. + </description> + </method> + <method name="set_frame"> + <return type="void"> + </return> + <argument index="0" name="frame" type="int"> + </argument> + <description> + Set the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1. + </description> + </method> + <method name="set_hframes"> + <return type="void"> + </return> + <argument index="0" name="hframes" type="int"> + </argument> + <description> + Set the amount of horizontal frames and converts the sprite into a sprite-sheet. This is useful for animation. + </description> + </method> + <method name="set_normal_map"> + <return type="void"> + </return> + <argument index="0" name="normal_map" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_offset"> + <return type="void"> + </return> + <argument index="0" name="offset" type="Vector2"> + </argument> + <description> + Set the sprite draw offset, useful for setting rotation pivots. + </description> + </method> + <method name="set_region"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Set the sprite as a sub-region of a bigger texture. Useful for texture-atlases. + </description> + </method> + <method name="set_region_filter_clip"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_region_rect"> + <return type="void"> + </return> + <argument index="0" name="rect" type="Rect2"> + </argument> + <description> + Set the region rect to read from. + </description> + </method> + <method name="set_texture"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <description> + Set the base texture for the sprite. + </description> + </method> + <method name="set_vframes"> + <return type="void"> + </return> + <argument index="0" name="vframes" type="int"> + </argument> + <description> + Set the amount of vertical frames and converts the sprite into a sprite-sheet. This is useful for animation. + </description> + </method> + </methods> + <members> + <member name="centered" type="bool" setter="set_centered" getter="is_centered"> + </member> + <member name="flip_h" type="bool" setter="set_flip_h" getter="is_flipped_h"> + </member> + <member name="flip_v" type="bool" setter="set_flip_v" getter="is_flipped_v"> + </member> + <member name="frame" type="int" setter="set_frame" getter="get_frame"> + </member> + <member name="hframes" type="int" setter="set_hframes" getter="get_hframes"> + </member> + <member name="normal_map" type="Texture" setter="set_normal_map" getter="get_normal_map"> + </member> + <member name="offset" type="Vector2" setter="set_offset" getter="get_offset"> + </member> + <member name="region_enabled" type="bool" setter="set_region" getter="is_region"> + </member> + <member name="region_filter_clip" type="bool" setter="set_region_filter_clip" getter="is_region_filter_clip_enabled"> + </member> + <member name="region_rect" type="Rect2" setter="set_region_rect" getter="get_region_rect"> + </member> + <member name="texture" type="Texture" setter="set_texture" getter="get_texture"> + </member> + <member name="vframes" type="int" setter="set_vframes" getter="get_vframes"> + </member> + </members> + <signals> + <signal name="frame_changed"> + <description> + </description> + </signal> + <signal name="texture_changed"> + <description> + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/Sprite3D.xml b/doc/classes/Sprite3D.xml new file mode 100644 index 0000000000..f6f2f8f00c --- /dev/null +++ b/doc/classes/Sprite3D.xml @@ -0,0 +1,119 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Sprite3D" inherits="SpriteBase3D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_frame" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_hframes" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_region_rect" qualifiers="const"> + <return type="Rect2"> + </return> + <description> + </description> + </method> + <method name="get_texture" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="get_vframes" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="is_region" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_frame"> + <return type="void"> + </return> + <argument index="0" name="frame" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_hframes"> + <return type="void"> + </return> + <argument index="0" name="hframes" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_region"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_region_rect"> + <return type="void"> + </return> + <argument index="0" name="rect" type="Rect2"> + </argument> + <description> + </description> + </method> + <method name="set_texture"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_vframes"> + <return type="void"> + </return> + <argument index="0" name="vframes" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="frame" type="int" setter="set_frame" getter="get_frame"> + </member> + <member name="hframes" type="int" setter="set_hframes" getter="get_hframes"> + </member> + <member name="region_enabled" type="bool" setter="set_region" getter="is_region"> + </member> + <member name="region_rect" type="Rect2" setter="set_region_rect" getter="get_region_rect"> + </member> + <member name="texture" type="Texture" setter="set_texture" getter="get_texture"> + </member> + <member name="vframes" type="int" setter="set_vframes" getter="get_vframes"> + </member> + </members> + <signals> + <signal name="frame_changed"> + <description> + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/SpriteBase3D.xml b/doc/classes/SpriteBase3D.xml new file mode 100644 index 0000000000..1640e5dc9f --- /dev/null +++ b/doc/classes/SpriteBase3D.xml @@ -0,0 +1,205 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="SpriteBase3D" inherits="GeometryInstance" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_alpha_cut_mode" qualifiers="const"> + <return type="int" enum="SpriteBase3D.AlphaCutMode"> + </return> + <description> + </description> + </method> + <method name="get_axis" qualifiers="const"> + <return type="int" enum="Vector3.Axis"> + </return> + <description> + </description> + </method> + <method name="get_draw_flag" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="flag" type="int" enum="SpriteBase3D.DrawFlags"> + </argument> + <description> + </description> + </method> + <method name="get_item_rect" qualifiers="const"> + <return type="Rect2"> + </return> + <description> + </description> + </method> + <method name="get_modulate" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_offset" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_opacity" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_pixel_size" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="is_centered" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_flipped_h" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_flipped_v" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_alpha_cut_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="SpriteBase3D.AlphaCutMode"> + </argument> + <description> + </description> + </method> + <method name="set_axis"> + <return type="void"> + </return> + <argument index="0" name="axis" type="int" enum="Vector3.Axis"> + </argument> + <description> + </description> + </method> + <method name="set_centered"> + <return type="void"> + </return> + <argument index="0" name="centered" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_draw_flag"> + <return type="void"> + </return> + <argument index="0" name="flag" type="int" enum="SpriteBase3D.DrawFlags"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_flip_h"> + <return type="void"> + </return> + <argument index="0" name="flip_h" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_flip_v"> + <return type="void"> + </return> + <argument index="0" name="flip_v" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_modulate"> + <return type="void"> + </return> + <argument index="0" name="modulate" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_offset"> + <return type="void"> + </return> + <argument index="0" name="offset" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_opacity"> + <return type="void"> + </return> + <argument index="0" name="opacity" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_pixel_size"> + <return type="void"> + </return> + <argument index="0" name="pixel_size" type="float"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="alpha_cut" type="int" setter="set_alpha_cut_mode" getter="get_alpha_cut_mode" enum="SpriteBase3D.AlphaCutMode"> + </member> + <member name="axis" type="int" setter="set_axis" getter="get_axis" enum="Vector3.Axis"> + </member> + <member name="centered" type="bool" setter="set_centered" getter="is_centered"> + </member> + <member name="double_sided" type="bool" setter="set_draw_flag" getter="get_draw_flag"> + </member> + <member name="flip_h" type="bool" setter="set_flip_h" getter="is_flipped_h"> + </member> + <member name="flip_v" type="bool" setter="set_flip_v" getter="is_flipped_v"> + </member> + <member name="modulate" type="Color" setter="set_modulate" getter="get_modulate"> + </member> + <member name="offset" type="Vector2" setter="set_offset" getter="get_offset"> + </member> + <member name="opacity" type="float" setter="set_opacity" getter="get_opacity"> + </member> + <member name="pixel_size" type="float" setter="set_pixel_size" getter="get_pixel_size"> + </member> + <member name="shaded" type="bool" setter="set_draw_flag" getter="get_draw_flag"> + </member> + <member name="transparent" type="bool" setter="set_draw_flag" getter="get_draw_flag"> + </member> + </members> + <constants> + <constant name="FLAG_TRANSPARENT" value="0"> + </constant> + <constant name="FLAG_SHADED" value="1"> + </constant> + <constant name="FLAG_DOUBLE_SIDED" value="2"> + </constant> + <constant name="FLAG_MAX" value="3"> + </constant> + <constant name="ALPHA_CUT_DISABLED" value="0"> + </constant> + <constant name="ALPHA_CUT_DISCARD" value="1"> + </constant> + <constant name="ALPHA_CUT_OPAQUE_PREPASS" value="2"> + </constant> + </constants> +</class> diff --git a/doc/classes/SpriteFrames.xml b/doc/classes/SpriteFrames.xml new file mode 100644 index 0000000000..1c5669b898 --- /dev/null +++ b/doc/classes/SpriteFrames.xml @@ -0,0 +1,159 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="SpriteFrames" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Sprite frame library for AnimatedSprite. + </brief_description> + <description> + Sprite frame library for [AnimatedSprite]. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_animation"> + <return type="void"> + </return> + <argument index="0" name="anim" type="String"> + </argument> + <description> + </description> + </method> + <method name="add_frame"> + <return type="void"> + </return> + <argument index="0" name="anim" type="String"> + </argument> + <argument index="1" name="frame" type="Texture"> + </argument> + <argument index="2" name="atpos" type="int" default="-1"> + </argument> + <description> + </description> + </method> + <method name="clear"> + <return type="void"> + </return> + <argument index="0" name="anim" type="String"> + </argument> + <description> + </description> + </method> + <method name="clear_all"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="get_animation_loop" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="anim" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_animation_speed" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="anim" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_frame" qualifiers="const"> + <return type="Texture"> + </return> + <argument index="0" name="anim" type="String"> + </argument> + <argument index="1" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_frame_count" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="anim" type="String"> + </argument> + <description> + </description> + </method> + <method name="has_animation" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="anim" type="String"> + </argument> + <description> + </description> + </method> + <method name="remove_animation"> + <return type="void"> + </return> + <argument index="0" name="anim" type="String"> + </argument> + <description> + </description> + </method> + <method name="remove_frame"> + <return type="void"> + </return> + <argument index="0" name="anim" type="String"> + </argument> + <argument index="1" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="rename_animation"> + <return type="void"> + </return> + <argument index="0" name="anim" type="String"> + </argument> + <argument index="1" name="newname" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_animation_loop"> + <return type="void"> + </return> + <argument index="0" name="anim" type="String"> + </argument> + <argument index="1" name="loop" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_animation_speed"> + <return type="void"> + </return> + <argument index="0" name="anim" type="String"> + </argument> + <argument index="1" name="speed" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_frame"> + <return type="void"> + </return> + <argument index="0" name="anim" type="String"> + </argument> + <argument index="1" name="idx" type="int"> + </argument> + <argument index="2" name="txt" type="Texture"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="animations" type="Array" setter="_set_animations" getter="_get_animations"> + </member> + <member name="frames" type="Array" setter="_set_frames" getter="_get_frames"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/StaticBody.xml b/doc/classes/StaticBody.xml new file mode 100644 index 0000000000..6b5b007310 --- /dev/null +++ b/doc/classes/StaticBody.xml @@ -0,0 +1,97 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="StaticBody" inherits="PhysicsBody" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Static body for 3D Physics. + </brief_description> + <description> + Static body for 3D Physics. A static body is a simple body that is not intended to move. They don't consume any CPU resources in contrast to a [RigidBody3D] so they are great for scenario collision. + A static body can also be animated by using simulated motion mode. This is useful for implementing functionalities such as moving platforms. When this mode is active the body can be animated and automatically computes linear and angular velocity to apply in that frame and to influence other bodies. + Alternatively, a constant linear or angular velocity can be set for the static body, so even if it doesn't move, it affects other bodies as if it was moving (this is useful for simulating conveyor belts or conveyor wheels). + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_bounce" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the body bounciness. + </description> + </method> + <method name="get_constant_angular_velocity" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + Return the constant angular velocity for the body. + </description> + </method> + <method name="get_constant_linear_velocity" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + Return the constant linear velocity for the body. + </description> + </method> + <method name="get_friction" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the body friction. + </description> + </method> + <method name="set_bounce"> + <return type="void"> + </return> + <argument index="0" name="bounce" type="float"> + </argument> + <description> + Set the body bounciness, from 0 (not bouncy) to 1 (bouncy). + </description> + </method> + <method name="set_constant_angular_velocity"> + <return type="void"> + </return> + <argument index="0" name="vel" type="Vector3"> + </argument> + <description> + Set a constant angular velocity for the body. This does not rotate the body, but affects other bodies touching it, as if it was rotating. + </description> + </method> + <method name="set_constant_linear_velocity"> + <return type="void"> + </return> + <argument index="0" name="vel" type="Vector3"> + </argument> + <description> + Set a constant linear velocity for the body. This does not move the body, but affects other bodies touching it, as if it was moving. + </description> + </method> + <method name="set_friction"> + <return type="void"> + </return> + <argument index="0" name="friction" type="float"> + </argument> + <description> + Set the body friction, from 0 (frictionless) to 1 (full friction). + </description> + </method> + </methods> + <members> + <member name="bounce" type="float" setter="set_bounce" getter="get_bounce"> + The body bounciness. + </member> + <member name="constant_angular_velocity" type="Vector3" setter="set_constant_angular_velocity" getter="get_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. + </member> + <member name="constant_linear_velocity" type="Vector3" setter="set_constant_linear_velocity" getter="get_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. + </member> + <member name="friction" type="float" setter="set_friction" getter="get_friction"> + The body friction, from 0 (frictionless) to 1 (full friction). + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/StaticBody2D.xml b/doc/classes/StaticBody2D.xml new file mode 100644 index 0000000000..2f23ac588b --- /dev/null +++ b/doc/classes/StaticBody2D.xml @@ -0,0 +1,93 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="StaticBody2D" inherits="PhysicsBody2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Static body for 2D Physics. + </brief_description> + <description> + Static body for 2D Physics. A static body is a simple body that is not intended to move. They don't consume any CPU resources in contrast to a [RigidBody2D] so they are great for scenario collision. + A static body can also be animated by using simulated motion mode. This is useful for implementing functionalities such as moving platforms. When this mode is active the body can be animated and automatically computes linear and angular velocity to apply in that frame and to influence other bodies. + Alternatively, a constant linear or angular velocity can be set for the static body, so even if it doesn't move, it affects other bodies as if it was moving (this is useful for simulating conveyor belts or conveyor wheels). + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_bounce" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the body bounciness. + </description> + </method> + <method name="get_constant_angular_velocity" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the constant angular velocity for the body. + </description> + </method> + <method name="get_constant_linear_velocity" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the constant linear velocity for the body. + </description> + </method> + <method name="get_friction" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the body friction. + </description> + </method> + <method name="set_bounce"> + <return type="void"> + </return> + <argument index="0" name="bounce" type="float"> + </argument> + <description> + Set the body bounciness, from 0 (not bouncy) to 1 (bouncy). + </description> + </method> + <method name="set_constant_angular_velocity"> + <return type="void"> + </return> + <argument index="0" name="vel" type="float"> + </argument> + <description> + Set a constant angular velocity for the body. This does not rotate the body, but affects other bodies touching it, as if it was rotating. + </description> + </method> + <method name="set_constant_linear_velocity"> + <return type="void"> + </return> + <argument index="0" name="vel" type="Vector2"> + </argument> + <description> + Set a constant linear velocity for the body. This does not move the body, but affects other bodies touching it, as if it was moving. + </description> + </method> + <method name="set_friction"> + <return type="void"> + </return> + <argument index="0" name="friction" type="float"> + </argument> + <description> + Set the body friction, from 0 (frictionless) to 1 (full friction). + </description> + </method> + </methods> + <members> + <member name="bounce" type="float" setter="set_bounce" getter="get_bounce"> + </member> + <member name="constant_angular_velocity" type="float" setter="set_constant_angular_velocity" getter="get_constant_angular_velocity"> + </member> + <member name="constant_linear_velocity" type="Vector2" setter="set_constant_linear_velocity" getter="get_constant_linear_velocity"> + </member> + <member name="friction" type="float" setter="set_friction" getter="get_friction"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/StreamPeer.xml b/doc/classes/StreamPeer.xml new file mode 100644 index 0000000000..2fdd4b07d5 --- /dev/null +++ b/doc/classes/StreamPeer.xml @@ -0,0 +1,279 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="StreamPeer" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Abstraction and base class for stream-based protocols. + </brief_description> + <description> + StreamPeer is an abstraction and base class for stream-based protocols (such as TCP or Unix Sockets). It provides an API for sending and receiving data through streams as raw data or strings. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_16"> + <return type="int"> + </return> + <description> + Get a signed 16 bit value from the stream. + </description> + </method> + <method name="get_32"> + <return type="int"> + </return> + <description> + Get a signed 32 bit value from the stream. + </description> + </method> + <method name="get_64"> + <return type="int"> + </return> + <description> + Get a signed 64 bit value from the stream. + </description> + </method> + <method name="get_8"> + <return type="int"> + </return> + <description> + Get a signed byte from the stream. + </description> + </method> + <method name="get_available_bytes" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the amount of bytes this [StreamPeer] has available. + </description> + </method> + <method name="get_data"> + <return type="Array"> + </return> + <argument index="0" name="bytes" type="int"> + </argument> + <description> + Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an Error code and a data array. + </description> + </method> + <method name="get_double"> + <return type="float"> + </return> + <description> + Get a double-precision float from the stream. + </description> + </method> + <method name="get_float"> + <return type="float"> + </return> + <description> + Get a single-precision float from the stream. + </description> + </method> + <method name="get_partial_data"> + <return type="Array"> + </return> + <argument index="0" name="bytes" type="int"> + </argument> + <description> + Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an Error code, and a data array. + </description> + </method> + <method name="get_string"> + <return type="String"> + </return> + <argument index="0" name="bytes" type="int"> + </argument> + <description> + Get a string with byte-length "bytes" from the stream. + </description> + </method> + <method name="get_u16"> + <return type="int"> + </return> + <description> + Get an unsigned 16 bit value from the stream. + </description> + </method> + <method name="get_u32"> + <return type="int"> + </return> + <description> + Get an unsigned 32 bit value from the stream. + </description> + </method> + <method name="get_u64"> + <return type="int"> + </return> + <description> + Get an unsigned 16 bit value from the stream. + </description> + </method> + <method name="get_u8"> + <return type="int"> + </return> + <description> + Get an unsigned byte from the stream. + </description> + </method> + <method name="get_utf8_string"> + <return type="String"> + </return> + <argument index="0" name="bytes" type="int"> + </argument> + <description> + Get a utf8 string with byte-length "bytes" from the stream (this decodes the string sent as utf8). + </description> + </method> + <method name="get_var"> + <return type="Variant"> + </return> + <description> + Get a Variant from the stream. + </description> + </method> + <method name="is_big_endian_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether this [StreamPeer] is using big-endian format. + </description> + </method> + <method name="put_16"> + <return type="void"> + </return> + <argument index="0" name="val" type="int"> + </argument> + <description> + Put a signed 16 bit value into the stream. + </description> + </method> + <method name="put_32"> + <return type="void"> + </return> + <argument index="0" name="val" type="int"> + </argument> + <description> + Put a signed 32 bit value into the stream. + </description> + </method> + <method name="put_64"> + <return type="void"> + </return> + <argument index="0" name="val" type="int"> + </argument> + <description> + Put a signed 64 bit value into the stream. + </description> + </method> + <method name="put_8"> + <return type="void"> + </return> + <argument index="0" name="val" type="int"> + </argument> + <description> + Put a signed byte into the stream. + </description> + </method> + <method name="put_data"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="data" type="PoolByteArray"> + </argument> + <description> + Send a chunk of data through the connection, blocking if necessary until the data is done sending. This function returns an Error code. + </description> + </method> + <method name="put_double"> + <return type="void"> + </return> + <argument index="0" name="val" type="float"> + </argument> + <description> + Put a double-precision float into the stream. + </description> + </method> + <method name="put_float"> + <return type="void"> + </return> + <argument index="0" name="val" type="float"> + </argument> + <description> + Put a single-precision float into the stream. + </description> + </method> + <method name="put_partial_data"> + <return type="Array"> + </return> + <argument index="0" name="data" type="PoolByteArray"> + </argument> + <description> + Send a chunk of data through the connection, if all the data could not be sent at once, only part of it will. This function returns two values, an Error code and an integer, describing how much data was actually sent. + </description> + </method> + <method name="put_u16"> + <return type="void"> + </return> + <argument index="0" name="val" type="int"> + </argument> + <description> + Put an unsigned 16 bit value into the stream. + </description> + </method> + <method name="put_u32"> + <return type="void"> + </return> + <argument index="0" name="val" type="int"> + </argument> + <description> + Put an unsigned 32 bit value into the stream. + </description> + </method> + <method name="put_u64"> + <return type="void"> + </return> + <argument index="0" name="val" type="int"> + </argument> + <description> + Put an unsigned 64 bit value into the stream. + </description> + </method> + <method name="put_u8"> + <return type="void"> + </return> + <argument index="0" name="val" type="int"> + </argument> + <description> + Put an unsigned byte into the stream. + </description> + </method> + <method name="put_utf8_string"> + <return type="void"> + </return> + <argument index="0" name="val" type="String"> + </argument> + <description> + Put a zero-terminated utf8 string into the stream. + </description> + </method> + <method name="put_var"> + <return type="void"> + </return> + <argument index="0" name="val" type="Variant"> + </argument> + <description> + Put a Variant into the stream. + </description> + </method> + <method name="set_big_endian"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set this [StreamPeer] to use big-endian format. Default is false. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/StreamPeerBuffer.xml b/doc/classes/StreamPeerBuffer.xml new file mode 100644 index 0000000000..70a4c781c9 --- /dev/null +++ b/doc/classes/StreamPeerBuffer.xml @@ -0,0 +1,69 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="StreamPeerBuffer" inherits="StreamPeer" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="clear"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="duplicate" qualifiers="const"> + <return type="StreamPeerBuffer"> + </return> + <description> + </description> + </method> + <method name="get_data_array" qualifiers="const"> + <return type="PoolByteArray"> + </return> + <description> + </description> + </method> + <method name="get_pos" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_size" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="resize"> + <return type="void"> + </return> + <argument index="0" name="size" type="int"> + </argument> + <description> + </description> + </method> + <method name="seek"> + <return type="void"> + </return> + <argument index="0" name="pos" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_data_array"> + <return type="void"> + </return> + <argument index="0" name="data" type="PoolByteArray"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/StreamPeerSSL.xml b/doc/classes/StreamPeerSSL.xml new file mode 100644 index 0000000000..7a2843ff47 --- /dev/null +++ b/doc/classes/StreamPeerSSL.xml @@ -0,0 +1,64 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="StreamPeerSSL" inherits="StreamPeer" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + SSL Stream peer. + </brief_description> + <description> + SSL Stream peer. This object can be used to connect to SSL servers. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="accept_stream"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="stream" type="StreamPeer"> + </argument> + <description> + </description> + </method> + <method name="connect_to_stream"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="stream" type="StreamPeer"> + </argument> + <argument index="1" name="validate_certs" type="bool" default="false"> + </argument> + <argument index="2" name="for_hostname" type="String" default=""""> + </argument> + <description> + Connect to a peer using an underlying [StreamPeer] "stream", when "validate_certs" is true, [StreamPeerSSL] will validate that the certificate presented by the peer matches the "for_hostname". + </description> + </method> + <method name="disconnect_from_stream"> + <return type="void"> + </return> + <description> + Disconnect from host. + </description> + </method> + <method name="get_status" qualifiers="const"> + <return type="int" enum="StreamPeerSSL.Status"> + </return> + <description> + Return the status of the connection, one of STATUS_* enum. + </description> + </method> + </methods> + <constants> + <constant name="STATUS_DISCONNECTED" value="0"> + A status representing a [StreamPeerSSL] that is disconnected. + </constant> + <constant name="STATUS_CONNECTED" value="1"> + A status representing a [StreamPeerSSL] that is connected to a host. + </constant> + <constant name="STATUS_ERROR_NO_CERTIFICATE" value="2"> + An errot status that shows the peer did not present a SSL certificate and validation was requested. + </constant> + <constant name="STATUS_ERROR_HOSTNAME_MISMATCH" value="3"> + An error status that shows a mismatch in the SSL certificate domain presented by the host and the domain requested for validation. + </constant> + </constants> +</class> diff --git a/doc/classes/StreamPeerTCP.xml b/doc/classes/StreamPeerTCP.xml new file mode 100644 index 0000000000..3b2af330b3 --- /dev/null +++ b/doc/classes/StreamPeerTCP.xml @@ -0,0 +1,74 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="StreamPeerTCP" inherits="StreamPeer" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + TCP Stream peer. + </brief_description> + <description> + TCP Stream peer. This object can be used to connect to TCP servers, or also is returned by a tcp server. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="connect_to_host"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="host" type="String"> + </argument> + <argument index="1" name="port" type="int"> + </argument> + <description> + Connect to the specified host:port pair. A hostname will be resolved if valid. Returns [OK] on success or [FAILED] on failure. + </description> + </method> + <method name="disconnect_from_host"> + <return type="void"> + </return> + <description> + Disconnect from host. + </description> + </method> + <method name="get_connected_host" qualifiers="const"> + <return type="String"> + </return> + <description> + Return the IP of this peer. + </description> + </method> + <method name="get_connected_port" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the port of this peer. + </description> + </method> + <method name="get_status" qualifiers="const"> + <return type="int" enum="StreamPeerTCP.Status"> + </return> + <description> + Return the status of the connection, one of STATUS_* enum. + </description> + </method> + <method name="is_connected_to_host" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + </methods> + <constants> + <constant name="STATUS_NONE" value="0"> + The initial status of the [StreamPeerTCP], also the status after a disconnect. + </constant> + <constant name="STATUS_CONNECTING" value="1"> + A status representing a [StreamPeerTCP] that is connecting to a host. + </constant> + <constant name="STATUS_CONNECTED" value="2"> + A status representing a [StreamPeerTCP] that is connected to a host. + </constant> + <constant name="STATUS_ERROR" value="3"> + A staus representing a [StreamPeerTCP] in error state. + </constant> + </constants> +</class> diff --git a/doc/classes/StreamTexture.xml b/doc/classes/StreamTexture.xml new file mode 100644 index 0000000000..6e6f2e8056 --- /dev/null +++ b/doc/classes/StreamTexture.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="StreamTexture" inherits="Texture" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_load_path" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="load"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="load_path" type="String" setter="load" getter="get_load_path"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/String.xml b/doc/classes/String.xml new file mode 100644 index 0000000000..ce3dc1db2f --- /dev/null +++ b/doc/classes/String.xml @@ -0,0 +1,730 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="String" category="Built-In Types" version="3.0.alpha.custom_build"> + <brief_description> + Built-in string class. + </brief_description> + <description> + This is the built-in string class (and the one used by GDScript). It supports Unicode and provides all necessary means for string handling. Strings are reference counted and use a copy-on-write approach, so passing them around is cheap in resources. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="String"> + <return type="String"> + </return> + <argument index="0" name="from" type="bool"> + </argument> + <description> + </description> + </method> + <method name="String"> + <return type="String"> + </return> + <argument index="0" name="from" type="int"> + </argument> + <description> + </description> + </method> + <method name="String"> + <return type="String"> + </return> + <argument index="0" name="from" type="float"> + </argument> + <description> + </description> + </method> + <method name="String"> + <return type="String"> + </return> + <argument index="0" name="from" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="String"> + <return type="String"> + </return> + <argument index="0" name="from" type="Rect2"> + </argument> + <description> + </description> + </method> + <method name="String"> + <return type="String"> + </return> + <argument index="0" name="from" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="String"> + <return type="String"> + </return> + <argument index="0" name="from" type="Transform2D"> + </argument> + <description> + </description> + </method> + <method name="String"> + <return type="String"> + </return> + <argument index="0" name="from" type="Plane"> + </argument> + <description> + </description> + </method> + <method name="String"> + <return type="String"> + </return> + <argument index="0" name="from" type="Quat"> + </argument> + <description> + </description> + </method> + <method name="String"> + <return type="String"> + </return> + <argument index="0" name="from" type="Rect3"> + </argument> + <description> + </description> + </method> + <method name="String"> + <return type="String"> + </return> + <argument index="0" name="from" type="Basis"> + </argument> + <description> + </description> + </method> + <method name="String"> + <return type="String"> + </return> + <argument index="0" name="from" type="Transform"> + </argument> + <description> + </description> + </method> + <method name="String"> + <return type="String"> + </return> + <argument index="0" name="from" type="Color"> + </argument> + <description> + </description> + </method> + <method name="String"> + <return type="String"> + </return> + <argument index="0" name="from" type="NodePath"> + </argument> + <description> + </description> + </method> + <method name="String"> + <return type="String"> + </return> + <argument index="0" name="from" type="RID"> + </argument> + <description> + </description> + </method> + <method name="String"> + <return type="String"> + </return> + <argument index="0" name="from" type="Dictionary"> + </argument> + <description> + </description> + </method> + <method name="String"> + <return type="String"> + </return> + <argument index="0" name="from" type="Array"> + </argument> + <description> + </description> + </method> + <method name="String"> + <return type="String"> + </return> + <argument index="0" name="from" type="PoolByteArray"> + </argument> + <description> + </description> + </method> + <method name="String"> + <return type="String"> + </return> + <argument index="0" name="from" type="PoolIntArray"> + </argument> + <description> + </description> + </method> + <method name="String"> + <return type="String"> + </return> + <argument index="0" name="from" type="PoolRealArray"> + </argument> + <description> + </description> + </method> + <method name="String"> + <return type="String"> + </return> + <argument index="0" name="from" type="PoolStringArray"> + </argument> + <description> + </description> + </method> + <method name="String"> + <return type="String"> + </return> + <argument index="0" name="from" type="PoolVector2Array"> + </argument> + <description> + </description> + </method> + <method name="String"> + <return type="String"> + </return> + <argument index="0" name="from" type="PoolVector3Array"> + </argument> + <description> + </description> + </method> + <method name="String"> + <return type="String"> + </return> + <argument index="0" name="from" type="PoolColorArray"> + </argument> + <description> + </description> + </method> + <method name="begins_with"> + <return type="bool"> + </return> + <argument index="0" name="text" type="String"> + </argument> + <description> + Return true if the strings begins with the given string. + </description> + </method> + <method name="bigrams"> + <return type="PoolStringArray"> + </return> + <description> + Return the bigrams (pairs of consecutive letters) of this string. + </description> + </method> + <method name="c_escape"> + <return type="String"> + </return> + <description> + Return a copy of the string with special characters escaped using the C language standard. + </description> + </method> + <method name="c_unescape"> + <return type="String"> + </return> + <description> + Return a copy of the string with escaped characters replaced by their meanings according to the C language standard. + </description> + </method> + <method name="capitalize"> + <return type="String"> + </return> + <description> + Change the case of some letters. Replace underscores with spaces, convert all letters to lowercase then capitalize first and every letter following the space character. For [code]capitalize camelCase mixed_with_underscores[/code] it will return [code]Capitalize Camelcase Mixed With Underscores[/code]. + </description> + </method> + <method name="casecmp_to"> + <return type="int"> + </return> + <argument index="0" name="to" type="String"> + </argument> + <description> + Perform a case-sensitive comparison to another string, return -1 if less, 0 if equal and +1 if greater. + </description> + </method> + <method name="empty"> + <return type="bool"> + </return> + <description> + Return true if the string is empty. + </description> + </method> + <method name="ends_with"> + <return type="bool"> + </return> + <argument index="0" name="text" type="String"> + </argument> + <description> + Return true if the strings ends with the given string. + </description> + </method> + <method name="erase"> + <argument index="0" name="pos" type="int"> + </argument> + <argument index="1" name="chars" type="int"> + </argument> + <description> + Erase [code]chars[/code] characters from the string starting from [code]pos[/code]. + </description> + </method> + <method name="find"> + <return type="int"> + </return> + <argument index="0" name="what" type="String"> + </argument> + <argument index="1" name="from" type="int" default="0"> + </argument> + <description> + Find the first occurrence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. + </description> + </method> + <method name="find_last"> + <return type="int"> + </return> + <argument index="0" name="what" type="String"> + </argument> + <description> + Find the last occurrence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. + </description> + </method> + <method name="findn"> + <return type="int"> + </return> + <argument index="0" name="what" type="String"> + </argument> + <argument index="1" name="from" type="int" default="0"> + </argument> + <description> + Find the first occurrence of a substring but search as case-insensitive, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. + </description> + </method> + <method name="format"> + <return type="String"> + </return> + <argument index="0" name="values" type="var"> + </argument> + <argument index="1" name="placeholder" type="String" default="{_}"> + </argument> + <description> + </description> + </method> + <method name="get_base_dir"> + <return type="String"> + </return> + <description> + If the string is a path to a file, return the base directory. + </description> + </method> + <method name="get_basename"> + <return type="String"> + </return> + <description> + If the string is a path to a file, return the path to the file without the extension. + </description> + </method> + <method name="get_extension"> + <return type="String"> + </return> + <description> + If the string is a path to a file, return the extension. + </description> + </method> + <method name="get_file"> + <return type="String"> + </return> + <description> + If the string is a path to a file, return the file and ignore the base directory. + </description> + </method> + <method name="hash"> + <return type="int"> + </return> + <description> + Hash the string and return a 32 bits integer. + </description> + </method> + <method name="hex_to_int"> + <return type="int"> + </return> + <description> + Convert a string containing a hexadecimal number into an int. + </description> + </method> + <method name="insert"> + <return type="String"> + </return> + <argument index="0" name="pos" type="int"> + </argument> + <argument index="1" name="what" type="String"> + </argument> + <description> + Insert a substring at a given position. + </description> + </method> + <method name="is_abs_path"> + <return type="bool"> + </return> + <description> + If the string is a path to a file or directory, return true if the path is absolute. + </description> + </method> + <method name="is_rel_path"> + <return type="bool"> + </return> + <description> + If the string is a path to a file or directory, return true if the path is relative. + </description> + </method> + <method name="is_subsequence_of"> + <return type="bool"> + </return> + <argument index="0" name="text" type="String"> + </argument> + <description> + Check whether this string is a subsequence of the given string. + </description> + </method> + <method name="is_subsequence_ofi"> + <return type="bool"> + </return> + <argument index="0" name="text" type="String"> + </argument> + <description> + Check whether this string is a subsequence of the given string, without considering case. + </description> + </method> + <method name="is_valid_float"> + <return type="bool"> + </return> + <description> + Check whether the string contains a valid float. + </description> + </method> + <method name="is_valid_html_color"> + <return type="bool"> + </return> + <description> + Check whether the string contains a valid color in HTML notation. + </description> + </method> + <method name="is_valid_identifier"> + <return type="bool"> + </return> + <description> + Check whether the string is a valid identifier. As is common in programming languages, a valid identifier may contain only letters, digits and underscores (_) and the first character may not be a digit. + </description> + </method> + <method name="is_valid_integer"> + <return type="bool"> + </return> + <description> + Check whether the string contains a valid integer. + </description> + </method> + <method name="is_valid_ip_address"> + <return type="bool"> + </return> + <description> + Check whether the string contains a valid IP address. + </description> + </method> + <method name="json_escape"> + <return type="String"> + </return> + <description> + Return a copy of the string with special characters escaped using the JSON standard. + </description> + </method> + <method name="left"> + <return type="String"> + </return> + <argument index="0" name="pos" type="int"> + </argument> + <description> + Return an amount of characters from the left of the string. + </description> + </method> + <method name="length"> + <return type="int"> + </return> + <description> + Return the length of the string in characters. + </description> + </method> + <method name="match"> + <return type="bool"> + </return> + <argument index="0" name="expr" type="String"> + </argument> + <description> + Do a simple expression match, where '*' matches zero or more arbitrary characters and '?' matches any single character except '.'. + </description> + </method> + <method name="matchn"> + <return type="bool"> + </return> + <argument index="0" name="expr" type="String"> + </argument> + <description> + Do a simple case insensitive expression match, using ? and * wildcards (see [method match]). + </description> + </method> + <method name="md5_buffer"> + <return type="PoolByteArray"> + </return> + <description> + Return the MD5 hash of the string as an array of bytes. + </description> + </method> + <method name="md5_text"> + <return type="String"> + </return> + <description> + Return the MD5 hash of the string as a string. + </description> + </method> + <method name="nocasecmp_to"> + <return type="int"> + </return> + <argument index="0" name="to" type="String"> + </argument> + <description> + Perform a case-insensitive comparison to another string, return -1 if less, 0 if equal and +1 if greater. + </description> + </method> + <method name="ord_at"> + <return type="int"> + </return> + <argument index="0" name="at" type="int"> + </argument> + <description> + Return the character code at position [code]at[/code]. + </description> + </method> + <method name="pad_decimals"> + <return type="String"> + </return> + <argument index="0" name="digits" type="int"> + </argument> + <description> + Format a number to have an exact number of [code]digits[/code] after the decimal point. + </description> + </method> + <method name="pad_zeros"> + <return type="String"> + </return> + <argument index="0" name="digits" type="int"> + </argument> + <description> + Format a number to have an exact number of [code]digits[/code] before the decimal point. + </description> + </method> + <method name="percent_decode"> + <return type="String"> + </return> + <description> + Decode a percent-encoded string. See [method percent_encode]. + </description> + </method> + <method name="percent_encode"> + <return type="String"> + </return> + <description> + Percent-encode a string. This is meant to encode parameters in a URL when sending a HTTP GET request and bodies of form-urlencoded POST request. + </description> + </method> + <method name="plus_file"> + <return type="String"> + </return> + <argument index="0" name="file" type="String"> + </argument> + <description> + If the string is a path, this concatenates [code]file[/code] at the end of the string as a subpath. E.g. [code]"this/is".plus_file("path") == "this/is/path"[/code]. + </description> + </method> + <method name="replace"> + <return type="String"> + </return> + <argument index="0" name="what" type="String"> + </argument> + <argument index="1" name="forwhat" type="String"> + </argument> + <description> + Replace occurrences of a substring for different ones inside the string. + </description> + </method> + <method name="replacen"> + <return type="String"> + </return> + <argument index="0" name="what" type="String"> + </argument> + <argument index="1" name="forwhat" type="String"> + </argument> + <description> + Replace occurrences of a substring for different ones inside the string, but search case-insensitive. + </description> + </method> + <method name="rfind"> + <return type="int"> + </return> + <argument index="0" name="what" type="String"> + </argument> + <argument index="1" name="from" type="int" default="-1"> + </argument> + <description> + Perform a search for a substring, but start from the end of the string instead of the beginning. + </description> + </method> + <method name="rfindn"> + <return type="int"> + </return> + <argument index="0" name="what" type="String"> + </argument> + <argument index="1" name="from" type="int" default="-1"> + </argument> + <description> + Perform a search for a substring, but start from the end of the string instead of the beginning. Also search case-insensitive. + </description> + </method> + <method name="right"> + <return type="String"> + </return> + <argument index="0" name="pos" type="int"> + </argument> + <description> + Return the right side of the string from a given position. + </description> + </method> + <method name="sha256_buffer"> + <return type="PoolByteArray"> + </return> + <description> + </description> + </method> + <method name="sha256_text"> + <return type="String"> + </return> + <description> + Return the SHA-256 hash of the string as a string. + </description> + </method> + <method name="similarity"> + <return type="float"> + </return> + <argument index="0" name="text" type="String"> + </argument> + <description> + Return the similarity index of the text compared to this string. 1 means totally similar and 0 means totally dissimilar. + </description> + </method> + <method name="split"> + <return type="PoolStringArray"> + </return> + <argument index="0" name="divisor" type="String"> + </argument> + <argument index="1" name="allow_empty" type="bool" default="True"> + </argument> + <description> + Split the string by a divisor string, return an array of the substrings. Example "One,Two,Three" will return ["One","Two","Three"] if split by ",". + </description> + </method> + <method name="split_floats"> + <return type="PoolRealArray"> + </return> + <argument index="0" name="divisor" type="String"> + </argument> + <argument index="1" name="allow_empty" type="bool" default="True"> + </argument> + <description> + Split the string in floats by using a divisor string, return an array of the substrings. Example "1,2.5,3" will return [1,2.5,3] if split by ",". + </description> + </method> + <method name="strip_edges"> + <return type="String"> + </return> + <argument index="0" name="left" type="bool" default="True"> + </argument> + <argument index="1" name="right" type="bool" default="True"> + </argument> + <description> + Return a copy of the string stripped of any non-printable character at the beginning and the end. The optional arguments are used to toggle stripping on the left and right edges respectively. + </description> + </method> + <method name="substr"> + <return type="String"> + </return> + <argument index="0" name="from" type="int"> + </argument> + <argument index="1" name="len" type="int"> + </argument> + <description> + Return part of the string from the position [code]from[/code], with length [code]len[/code]. + </description> + </method> + <method name="to_ascii"> + <return type="PoolByteArray"> + </return> + <description> + Convert the String (which is a character array) to PoolByteArray (which is an array of bytes). The conversion is speeded up in comparison to to_utf8() with the assumption that all the characters the String contains are only ASCII characters. + </description> + </method> + <method name="to_float"> + <return type="float"> + </return> + <description> + Convert a string, containing a decimal number, into a [code]float[/code]. + </description> + </method> + <method name="to_int"> + <return type="int"> + </return> + <description> + Convert a string, containing an integer number, into an [code]int[/code]. + </description> + </method> + <method name="to_lower"> + <return type="String"> + </return> + <description> + Return the string converted to lowercase. + </description> + </method> + <method name="to_upper"> + <return type="String"> + </return> + <description> + Return the string converted to uppercase. + </description> + </method> + <method name="to_utf8"> + <return type="PoolByteArray"> + </return> + <description> + Convert the String (which is an array of characters) to PoolByteArray (which is an array of bytes). The conversion is a bit slower than to_ascii(), but supports all UTF-8 characters. Therefore, you should prefer this function over to_ascii(). + </description> + </method> + <method name="xml_escape"> + <return type="String"> + </return> + <description> + Return a copy of the string with special characters escaped using the XML standard. + </description> + </method> + <method name="xml_unescape"> + <return type="String"> + </return> + <description> + Return a copy of the string with escaped characters replaced by their meanings according to the XML standard. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/StyleBox.xml b/doc/classes/StyleBox.xml new file mode 100644 index 0000000000..ab1ec1f997 --- /dev/null +++ b/doc/classes/StyleBox.xml @@ -0,0 +1,97 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="StyleBox" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base class for drawing stylized boxes for the UI. + </brief_description> + <description> + StyleBox is [Resource] that provides an abstract base class for drawing stylized boxes for the UI. StyleBoxes are used for drawing the styles of buttons, line edit backgrounds, tree backgrounds, etc. and also for testing a transparency mask for pointer signals. If mask test fails on a StyleBox assigned as mask to a control, clicks and motion signals will go through it to the one below. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="draw" qualifiers="const"> + <return type="void"> + </return> + <argument index="0" name="canvas_item" type="RID"> + </argument> + <argument index="1" name="rect" type="Rect2"> + </argument> + <description> + </description> + </method> + <method name="get_center_size" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_default_margin" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <description> + Return the default offset of the margin "margin" (see MARGIN_* enum) of a StyleBox, Controls that draw styleboxes with context inside need to know the margin, so the border of the stylebox is not occluded. + </description> + </method> + <method name="get_margin" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <description> + Return the offset of margin "margin" (see MARGIN_* enum). + </description> + </method> + <method name="get_minimum_size" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the minimum size that this stylebox can be shrunk to. + </description> + </method> + <method name="get_offset" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the "offset" of a stylebox, this is a helper function, like writing [code]Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))[/code]. + </description> + </method> + <method name="set_default_margin"> + <return type="void"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <argument index="1" name="offset" type="float"> + </argument> + <description> + Set the default offset "offset" of the margin "margin" (see MARGIN_* enum) for a StyleBox, Controls that draw styleboxes with context inside need to know the margin, so the border of the stylebox is not occluded. + </description> + </method> + <method name="test_mask" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="point" type="Vector2"> + </argument> + <argument index="1" name="rect" type="Rect2"> + </argument> + <description> + Test a position in a rectangle, return whether it passes the mask test. + </description> + </method> + </methods> + <members> + <member name="content_margin_bottom" type="float" setter="set_default_margin" getter="get_default_margin"> + </member> + <member name="content_margin_left" type="float" setter="set_default_margin" getter="get_default_margin"> + </member> + <member name="content_margin_right" type="float" setter="set_default_margin" getter="get_default_margin"> + </member> + <member name="content_margin_top" type="float" setter="set_default_margin" getter="get_default_margin"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/StyleBoxEmpty.xml b/doc/classes/StyleBoxEmpty.xml new file mode 100644 index 0000000000..f11959c41d --- /dev/null +++ b/doc/classes/StyleBoxEmpty.xml @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="StyleBoxEmpty" inherits="StyleBox" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Empty stylebox (does not display anything). + </brief_description> + <description> + Empty stylebox (really does not display anything). + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/StyleBoxFlat.xml b/doc/classes/StyleBoxFlat.xml new file mode 100644 index 0000000000..b09b9f0679 --- /dev/null +++ b/doc/classes/StyleBoxFlat.xml @@ -0,0 +1,338 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="StyleBoxFlat" inherits="StyleBox" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Customizable Stylebox with a given set of parameters. (no texture required) + </brief_description> + <description> + This stylebox can be used to achieve all kinds of looks without the need of a texture. Those properties are customizable: + - Color + - Border width (individual width for each border) + - Rounded corners (individual radius for each corner) + - Shadow + About corner radius: + Setting corner radius to high values is allowed. As soon as corners would overlap the stylebox will switch to a relative system. Example: + [codeblock] + height = 30 + corner_radius_top_left = 50 + corner_raidus_bottom_left = 100 + [/codeblock] + The relative system now would take the 1:2 ratio of the two left corners to calculate the actual corner width. Both corners added will [b]never[/b] be more than the height. Result: + [codeblock] + corner_radius_top_left: 10 + corner_raidus_bottom_left: 20 + [/codeblock] + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_aa_size" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_bg_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_border_blend" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_border_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_border_width" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <description> + </description> + </method> + <method name="get_border_width_min" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_corner_detail" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_corner_radius" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="corner" type="int" enum="Corner"> + </argument> + <description> + </description> + </method> + <method name="get_expand_margin" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <description> + </description> + </method> + <method name="get_shadow_color" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_shadow_size" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="is_anti_aliased" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_draw_center_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_aa_size"> + <return type="void"> + </return> + <argument index="0" name="size" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_anti_aliased"> + <return type="void"> + </return> + <argument index="0" name="anti_aliased" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_bg_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_border_blend"> + <return type="void"> + </return> + <argument index="0" name="blend" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_border_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_border_width"> + <return type="void"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <argument index="1" name="width" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_border_width_all"> + <return type="void"> + </return> + <argument index="0" name="width" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_corner_detail"> + <return type="void"> + </return> + <argument index="0" name="detail" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_corner_radius"> + <return type="void"> + </return> + <argument index="0" name="corner" type="int" enum="Corner"> + </argument> + <argument index="1" name="radius" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_corner_radius_all"> + <return type="void"> + </return> + <argument index="0" name="radius" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_corner_radius_individual"> + <return type="void"> + </return> + <argument index="0" name="radius_top_left" type="int"> + </argument> + <argument index="1" name="radius_top_right" type="int"> + </argument> + <argument index="2" name="radius_botton_right" type="int"> + </argument> + <argument index="3" name="radius_bottom_left" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_draw_center"> + <return type="void"> + </return> + <argument index="0" name="draw_center" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_expand_margin"> + <return type="void"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <argument index="1" name="size" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_expand_margin_all"> + <return type="void"> + </return> + <argument index="0" name="size" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_expand_margin_individual"> + <return type="void"> + </return> + <argument index="0" name="size_left" type="float"> + </argument> + <argument index="1" name="size_top" type="float"> + </argument> + <argument index="2" name="size_right" type="float"> + </argument> + <argument index="3" name="size_bottom" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_shadow_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_shadow_size"> + <return type="void"> + </return> + <argument index="0" name="size" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="anti_aliasing" type="bool" setter="set_anti_aliased" getter="is_anti_aliased"> + Anti Aliasing draws a small ring around edges. This ring fades to transparent. As a result edges look much smoother. This is only noticable when using rounded corners. + </member> + <member name="anti_aliasing_size" type="int" setter="set_aa_size" getter="get_aa_size"> + This changes the size of the faded ring. Higher values can be used to achieve a "blurry" effect. + </member> + <member name="bg_color" type="Color" setter="set_bg_color" getter="get_bg_color"> + The background color of the stylebox. + </member> + <member name="border_blend" type="bool" setter="set_border_blend" getter="get_border_blend"> + When set to true, the border will fade into the background color. + </member> + <member name="border_color" type="Color" setter="set_border_color" getter="get_border_color"> + Sets the color of the border. + </member> + <member name="border_width_bottom" type="int" setter="set_border_width" getter="get_border_width"> + Border width for the bottom border. + </member> + <member name="border_width_left" type="int" setter="set_border_width" getter="get_border_width"> + Border width for the left border. + </member> + <member name="border_width_right" type="int" setter="set_border_width" getter="get_border_width"> + Border width for the right border. + </member> + <member name="border_width_top" type="int" setter="set_border_width" getter="get_border_width"> + Border width for the top border. + </member> + <member name="corner_detail" type="int" setter="set_corner_detail" getter="get_corner_detail"> + This sets the amount of vertices used for each corner. Higher values result in rounder corners but take more processing power to compute. When choosing a value you should take the corner radius ([method set_corner_radius]) into account. + For corner radius smaller than 10: 4-5 should be enough + For corner radius smaller than 30: 8-12 should be enough ... + </member> + <member name="corner_radius_bottom_left" type="int" setter="set_corner_radius" getter="get_corner_radius"> + The corner radius of the bottom left corner. When set to 0 the corner is not rounded. + </member> + <member name="corner_radius_bottom_right" type="int" setter="set_corner_radius" getter="get_corner_radius"> + The corner radius of the bottom right corner. When set to 0 the corner is not rounded. + </member> + <member name="corner_radius_top_left" type="int" setter="set_corner_radius" getter="get_corner_radius"> + The corner radius of the top left corner. When set to 0 the corner is not rounded. + </member> + <member name="corner_radius_top_right" type="int" setter="set_corner_radius" getter="get_corner_radius"> + The corner radius of the top right corner. When set to 0 the corner is not rounded. + </member> + <member name="draw_center" type="bool" setter="set_draw_center" getter="is_draw_center_enabled"> + Toggels drawing of the inner part of the stylebox. + </member> + <member name="expand_margin_bottom" type="float" setter="set_expand_margin" getter="get_expand_margin"> + Expands the stylebox outside of the control rect on the bottom edge. Useful in combination with border_width_bottom. To draw a border outside the control rect. + </member> + <member name="expand_margin_left" type="float" setter="set_expand_margin" getter="get_expand_margin"> + Expands the stylebox outside of the control rect on the left edge. Useful in combination with border_width_left. To draw a border outside the control rect. + </member> + <member name="expand_margin_right" type="float" setter="set_expand_margin" getter="get_expand_margin"> + Expands the stylebox outside of the control rect on the right edge. Useful in combination with border_width_right. To draw a border outside the control rect. + </member> + <member name="expand_margin_top" type="float" setter="set_expand_margin" getter="get_expand_margin"> + Expands the stylebox outside of the control rect on the top edge. Useful in combination with border_width_top. To draw a border outside the control rect. + </member> + <member name="shadow_color" type="Color" setter="set_shadow_color" getter="get_shadow_color"> + The color of the shadow. (This has no effect when shadow_size < 1) + </member> + <member name="shadow_size" type="int" setter="set_shadow_size" getter="get_shadow_size"> + The shadow size in pixels. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/StyleBoxTexture.xml b/doc/classes/StyleBoxTexture.xml new file mode 100644 index 0000000000..458fdad99e --- /dev/null +++ b/doc/classes/StyleBoxTexture.xml @@ -0,0 +1,217 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="StyleBoxTexture" inherits="StyleBox" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Texture Based 3x3 scale style. + </brief_description> + <description> + Texture Based 3x3 scale style. This stylebox performs a 3x3 scaling of a texture, where only the center cell is fully stretched. This allows for the easy creation of bordered styles. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_expand_margin_size" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <description> + </description> + </method> + <method name="get_h_axis_stretch_mode" qualifiers="const"> + <return type="int" enum="StyleBoxTexture.AxisStretchMode"> + </return> + <description> + </description> + </method> + <method name="get_margin_size" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <description> + </description> + </method> + <method name="get_modulate" qualifiers="const"> + <return type="Color"> + </return> + <description> + </description> + </method> + <method name="get_normal_map" qualifiers="const"> + <return type="Resource"> + </return> + <description> + </description> + </method> + <method name="get_region_rect" qualifiers="const"> + <return type="Rect2"> + </return> + <description> + </description> + </method> + <method name="get_texture" qualifiers="const"> + <return type="Resource"> + </return> + <description> + </description> + </method> + <method name="get_v_axis_stretch_mode" qualifiers="const"> + <return type="int" enum="StyleBoxTexture.AxisStretchMode"> + </return> + <description> + </description> + </method> + <method name="is_draw_center_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_draw_center"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_expand_margin_all"> + <return type="void"> + </return> + <argument index="0" name="size" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_expand_margin_individual"> + <return type="void"> + </return> + <argument index="0" name="size_left" type="float"> + </argument> + <argument index="1" name="size_top" type="float"> + </argument> + <argument index="2" name="size_right" type="float"> + </argument> + <argument index="3" name="size_bottom" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_expand_margin_size"> + <return type="void"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <argument index="1" name="size" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_h_axis_stretch_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="StyleBoxTexture.AxisStretchMode"> + </argument> + <description> + </description> + </method> + <method name="set_margin_size"> + <return type="void"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <argument index="1" name="size" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_modulate"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_normal_map"> + <return type="void"> + </return> + <argument index="0" name="normal_map" type="Resource"> + </argument> + <description> + </description> + </method> + <method name="set_region_rect"> + <return type="void"> + </return> + <argument index="0" name="region" type="Rect2"> + </argument> + <description> + </description> + </method> + <method name="set_texture"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Resource"> + </argument> + <description> + </description> + </method> + <method name="set_v_axis_stretch_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="StyleBoxTexture.AxisStretchMode"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="axis_stretch_horizontal" type="int" setter="set_h_axis_stretch_mode" getter="get_h_axis_stretch_mode" enum="StyleBoxTexture.AxisStretchMode"> + </member> + <member name="axis_stretch_vertical" type="int" setter="set_v_axis_stretch_mode" getter="get_v_axis_stretch_mode" enum="StyleBoxTexture.AxisStretchMode"> + </member> + <member name="draw_center" type="bool" setter="set_draw_center" getter="is_draw_center_enabled"> + </member> + <member name="expand_margin_bottom" type="float" setter="set_expand_margin_size" getter="get_expand_margin_size"> + </member> + <member name="expand_margin_left" type="float" setter="set_expand_margin_size" getter="get_expand_margin_size"> + </member> + <member name="expand_margin_right" type="float" setter="set_expand_margin_size" getter="get_expand_margin_size"> + </member> + <member name="expand_margin_top" type="float" setter="set_expand_margin_size" getter="get_expand_margin_size"> + </member> + <member name="margin_bottom" type="float" setter="set_margin_size" getter="get_margin_size"> + </member> + <member name="margin_left" type="float" setter="set_margin_size" getter="get_margin_size"> + </member> + <member name="margin_right" type="float" setter="set_margin_size" getter="get_margin_size"> + </member> + <member name="margin_top" type="float" setter="set_margin_size" getter="get_margin_size"> + </member> + <member name="modulate_color" type="Color" setter="set_modulate" getter="get_modulate"> + </member> + <member name="normal_map" type="Resource" setter="set_normal_map" getter="get_normal_map"> + </member> + <member name="region_rect" type="Rect2" setter="set_region_rect" getter="get_region_rect"> + </member> + <member name="texture" type="Resource" setter="set_texture" getter="get_texture"> + </member> + </members> + <signals> + <signal name="texture_changed"> + <description> + </description> + </signal> + </signals> + <constants> + <constant name="AXIS_STRETCH_MODE_STRETCH" value="0"> + </constant> + <constant name="AXIS_STRETCH_MODE_TILE" value="1"> + </constant> + <constant name="AXIS_STRETCH_MODE_TILE_FIT" value="2"> + </constant> + </constants> +</class> diff --git a/doc/classes/SurfaceTool.xml b/doc/classes/SurfaceTool.xml new file mode 100644 index 0000000000..1e91ee402b --- /dev/null +++ b/doc/classes/SurfaceTool.xml @@ -0,0 +1,226 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="SurfaceTool" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Helper tool to create geometry. + </brief_description> + <description> + The [SurfaceTool] is used to construct a [Mesh] by specifying vertex attributes individually. It can be used to construct a [Mesh] from script. All properties except index need to be added before a call to [method add_vertex]. For example adding vertex colors and UVs looks like + [codeblock] + var st = SurfaceTool.new() + st.begin(Mesh.PRIMITIVE_TRIANGLES) + st.add_color(Color(1, 0, 0)) + st.add_uv(Vector2(0, 0)) + st.add_vertex(Vector3(0, 0, 0)) + [/codeblock] + The [SurfaceTool] now contains one vertex of a triangle which has a UV coordinate and a specified [Color]. If another vertex were added without calls to [method add_uv] or [method add_color] then the last values would be used. + It is very important that vertex attributes are passed [b]before[/b] the call to [method add_vertex], failure to do this will result in an error when committing the vertex information to a mesh. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_bones"> + <return type="void"> + </return> + <argument index="0" name="bones" type="PoolIntArray"> + </argument> + <description> + Add an array of bones for the next Vertex to use. + </description> + </method> + <method name="add_color"> + <return type="void"> + </return> + <argument index="0" name="color" type="Color"> + </argument> + <description> + Specify a [Color] for the next Vertex to use. + </description> + </method> + <method name="add_index"> + <return type="void"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <description> + Adds an index to index array if you are using indexed Vertices. Does not need to be called before adding Vertex. + </description> + </method> + <method name="add_normal"> + <return type="void"> + </return> + <argument index="0" name="normal" type="Vector3"> + </argument> + <description> + Specify a normal for the next Vertex to use. + </description> + </method> + <method name="add_smooth_group"> + <return type="void"> + </return> + <argument index="0" name="smooth" type="bool"> + </argument> + <description> + Specify whether current Vertex (if using only Vertex arrays) or current index (if also using index arrays) should utilize smooth normals for normal calculation. + </description> + </method> + <method name="add_tangent"> + <return type="void"> + </return> + <argument index="0" name="tangent" type="Plane"> + </argument> + <description> + Specify a Tangent for the next Vertex to use. + </description> + </method> + <method name="add_to_format"> + <return type="void"> + </return> + <argument index="0" name="flags" type="int"> + </argument> + <description> + </description> + </method> + <method name="add_triangle_fan"> + <return type="void"> + </return> + <argument index="0" name="vertexes" type="PoolVector3Array"> + </argument> + <argument index="1" name="uvs" type="PoolVector2Array" default="PoolVector2Array( )"> + </argument> + <argument index="2" name="colors" type="PoolColorArray" default="PoolColorArray( )"> + </argument> + <argument index="3" name="uv2s" type="PoolVector2Array" default="PoolVector2Array( )"> + </argument> + <argument index="4" name="normals" type="PoolVector3Array" default="PoolVector3Array( )"> + </argument> + <argument index="5" name="tangents" type="Array" default="[ ]"> + </argument> + <description> + Insert a triangle fan made of array data into [Mesh] being constructed. + </description> + </method> + <method name="add_uv"> + <return type="void"> + </return> + <argument index="0" name="uv" type="Vector2"> + </argument> + <description> + Specify UV Coordinate for next Vertex to use. + </description> + </method> + <method name="add_uv2"> + <return type="void"> + </return> + <argument index="0" name="uv2" type="Vector2"> + </argument> + <description> + Specify an optional second set of UV coordinates for next Vertex to use. + </description> + </method> + <method name="add_vertex"> + <return type="void"> + </return> + <argument index="0" name="vertex" type="Vector3"> + </argument> + <description> + Specify position of current Vertex. Should be called after specifying other vertex properties (e.g. Color, UV). + </description> + </method> + <method name="add_weights"> + <return type="void"> + </return> + <argument index="0" name="weights" type="PoolRealArray"> + </argument> + <description> + Specify weight value for next Vertex to use. + </description> + </method> + <method name="append_from"> + <return type="void"> + </return> + <argument index="0" name="existing" type="Mesh"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <argument index="2" name="transform" type="Transform"> + </argument> + <description> + </description> + </method> + <method name="begin"> + <return type="void"> + </return> + <argument index="0" name="primitive" type="int" enum="Mesh.PrimitiveType"> + </argument> + <description> + Called before adding any Vertices. Takes the primitive type as an argument (e.g. Mesh.PRIMITIVE_TRIANGLES). + </description> + </method> + <method name="clear"> + <return type="void"> + </return> + <description> + Clear all information passed into the surface tool so far. + </description> + </method> + <method name="commit"> + <return type="ArrayMesh"> + </return> + <argument index="0" name="existing" type="ArrayMesh" default="null"> + </argument> + <description> + Returns a constructed [ArrayMesh] from current information passed in. If an existing [ArrayMesh] is passed in as an argument, will add an extra surface to the existing [ArrayMesh]. + </description> + </method> + <method name="create_from"> + <return type="void"> + </return> + <argument index="0" name="existing" type="Mesh"> + </argument> + <argument index="1" name="surface" type="int"> + </argument> + <description> + </description> + </method> + <method name="deindex"> + <return type="void"> + </return> + <description> + Removes index array by expanding Vertex array. + </description> + </method> + <method name="generate_normals"> + <return type="void"> + </return> + <description> + Generates normals from Vertices so you do not have to do it manually. + </description> + </method> + <method name="generate_tangents"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="index"> + <return type="void"> + </return> + <description> + Shrinks Vertex array by creating an index array. Avoids reusing Vertices. + </description> + </method> + <method name="set_material"> + <return type="void"> + </return> + <argument index="0" name="material" type="Material"> + </argument> + <description> + Sets [Material] to be used by the [Mesh] you are constructing. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/TCP_Server.xml b/doc/classes/TCP_Server.xml new file mode 100644 index 0000000000..97115619ad --- /dev/null +++ b/doc/classes/TCP_Server.xml @@ -0,0 +1,52 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="TCP_Server" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + TCP Server. + </brief_description> + <description> + TCP Server class. Listens to connections on a port and returns a [StreamPeerTCP] when got a connection. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="is_connection_available" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if a connection is available for taking. + </description> + </method> + <method name="listen"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="port" type="int"> + </argument> + <argument index="1" name="bind_address" type="String" default=""*""> + </argument> + <description> + Listen on the "port" binding to "bind_address". + If "bind_address" is set as "*" (default), the server will listen on all available addresses (both IPv4 and IPv6). + If "bind_address" is set as "0.0.0.0" (for IPv4) or "::" (for IPv6), the server will listen on all available addresses matching that IP type. + If "bind_address" is set to any valid address (e.g. "192.168.1.101", "::1", etc), the server will only listen on the interface with that addresses (or fail if no interface with the given address exists). + </description> + </method> + <method name="stop"> + <return type="void"> + </return> + <description> + Stop listening. + </description> + </method> + <method name="take_connection"> + <return type="StreamPeerTCP"> + </return> + <description> + If a connection is available, return a StreamPeerTCP with the connection/ + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/TabContainer.xml b/doc/classes/TabContainer.xml new file mode 100644 index 0000000000..ffe99eb82b --- /dev/null +++ b/doc/classes/TabContainer.xml @@ -0,0 +1,238 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="TabContainer" inherits="Control" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Tabbed Container. + </brief_description> + <description> + Tabbed Container. Contains several children controls, but shows only one at the same time. Clicking on the top tabs allows to change the currently visible one. + Children controls of this one automatically. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="are_tabs_visible" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether the tabs should be visible or hidden. + </description> + </method> + <method name="get_current_tab" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the current tab index that is being shown. + </description> + </method> + <method name="get_current_tab_control" qualifiers="const"> + <return type="Control"> + </return> + <description> + </description> + </method> + <method name="get_popup" qualifiers="const"> + <return type="Popup"> + </return> + <description> + </description> + </method> + <method name="get_previous_tab" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the previous tab index that was being shown. + </description> + </method> + <method name="get_tab_align" qualifiers="const"> + <return type="int" enum="TabContainer.TabAlign"> + </return> + <description> + Return tab alignment, from the ALIGN_* enum. + </description> + </method> + <method name="get_tab_control" qualifiers="const"> + <return type="Control"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Return the current tab control that is being shown. + </description> + </method> + <method name="get_tab_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the amount of tabs. + </description> + </method> + <method name="get_tab_disabled" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="tab_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_tab_icon" qualifiers="const"> + <return type="Texture"> + </return> + <argument index="0" name="tab_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_tab_title" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="tab_idx" type="int"> + </argument> + <description> + Return the title for the tab. Tab titles are by default the children node name, but this can be overridden. + </description> + </method> + <method name="set_current_tab"> + <return type="void"> + </return> + <argument index="0" name="tab_idx" type="int"> + </argument> + <description> + Bring a tab (and the Control it represents) to the front, and hide the rest. + </description> + </method> + <method name="set_popup"> + <return type="void"> + </return> + <argument index="0" name="popup" type="Node"> + </argument> + <description> + </description> + </method> + <method name="set_tab_align"> + <return type="void"> + </return> + <argument index="0" name="align" type="int" enum="TabContainer.TabAlign"> + </argument> + <description> + Set tab alignment, from the ALIGN_* enum. Moves tabs to the left, right or center. + </description> + </method> + <method name="set_tab_disabled"> + <return type="void"> + </return> + <argument index="0" name="tab_idx" type="int"> + </argument> + <argument index="1" name="disabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_tab_icon"> + <return type="void"> + </return> + <argument index="0" name="tab_idx" type="int"> + </argument> + <argument index="1" name="icon" type="Texture"> + </argument> + <description> + Set an icon for a tab. + </description> + </method> + <method name="set_tab_title"> + <return type="void"> + </return> + <argument index="0" name="tab_idx" type="int"> + </argument> + <argument index="1" name="title" type="String"> + </argument> + <description> + Set a title for the tab. Tab titles are by default the children node name, but this can be overridden. + </description> + </method> + <method name="set_tabs_visible"> + <return type="void"> + </return> + <argument index="0" name="visible" type="bool"> + </argument> + <description> + Set whether the tabs should be visible or hidden. + </description> + </method> + </methods> + <members> + <member name="current_tab" type="int" setter="set_current_tab" getter="get_current_tab"> + </member> + <member name="tab_align" type="int" setter="set_tab_align" getter="get_tab_align" enum="TabContainer.TabAlign"> + </member> + <member name="tabs_visible" type="bool" setter="set_tabs_visible" getter="are_tabs_visible"> + </member> + </members> + <signals> + <signal name="pre_popup_pressed"> + <description> + </description> + </signal> + <signal name="tab_changed"> + <argument index="0" name="tab" type="int"> + </argument> + <description> + Emitted only when the current tab changes. + </description> + </signal> + <signal name="tab_selected"> + <argument index="0" name="tab" type="int"> + </argument> + <description> + Emitted when a tab is being selected, even if it is the same tab. + </description> + </signal> + </signals> + <constants> + <constant name="ALIGN_LEFT" value="0"> + </constant> + <constant name="ALIGN_CENTER" value="1"> + </constant> + <constant name="ALIGN_RIGHT" value="2"> + </constant> + </constants> + <theme_items> + <theme_item name="decrement" type="Texture"> + </theme_item> + <theme_item name="decrement_highlight" type="Texture"> + </theme_item> + <theme_item name="font" type="Font"> + </theme_item> + <theme_item name="font_color_bg" type="Color"> + </theme_item> + <theme_item name="font_color_disabled" type="Color"> + </theme_item> + <theme_item name="font_color_fg" type="Color"> + </theme_item> + <theme_item name="hseparation" type="int"> + </theme_item> + <theme_item name="increment" type="Texture"> + </theme_item> + <theme_item name="increment_highlight" type="Texture"> + </theme_item> + <theme_item name="label_valign_bg" type="int"> + </theme_item> + <theme_item name="label_valign_fg" type="int"> + </theme_item> + <theme_item name="menu" type="Texture"> + </theme_item> + <theme_item name="menu_highlight" type="Texture"> + </theme_item> + <theme_item name="panel" type="StyleBox"> + </theme_item> + <theme_item name="side_margin" type="int"> + </theme_item> + <theme_item name="tab_bg" type="StyleBox"> + </theme_item> + <theme_item name="tab_fg" type="StyleBox"> + </theme_item> + <theme_item name="top_margin" type="int"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/Tabs.xml b/doc/classes/Tabs.xml new file mode 100644 index 0000000000..78821a244c --- /dev/null +++ b/doc/classes/Tabs.xml @@ -0,0 +1,263 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Tabs" inherits="Control" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Tabs Control. + </brief_description> + <description> + Simple tabs control, similar to [TabContainer] but is only in charge of drawing tabs, not interact with children. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_tab"> + <return type="void"> + </return> + <argument index="0" name="title" type="String" default=""""> + </argument> + <argument index="1" name="icon" type="Texture" default="null"> + </argument> + <description> + </description> + </method> + <method name="ensure_tab_visible"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_current_tab" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_tab_align" qualifiers="const"> + <return type="int" enum="Tabs.TabAlign"> + </return> + <description> + </description> + </method> + <method name="get_tab_close_display_policy" qualifiers="const"> + <return type="int" enum="Tabs.CloseButtonDisplayPolicy"> + </return> + <description> + </description> + </method> + <method name="get_tab_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_tab_disabled" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="tab_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_tab_icon" qualifiers="const"> + <return type="Texture"> + </return> + <argument index="0" name="tab_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_tab_rect" qualifiers="const"> + <return type="Rect2"> + </return> + <argument index="0" name="tab_idx" type="int"> + </argument> + <description> + Returns tab [Rect2] with local position and size. + </description> + </method> + <method name="get_tab_title" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="tab_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="move_tab"> + <return type="void"> + </return> + <argument index="0" name="from" type="int"> + </argument> + <argument index="1" name="to" type="int"> + </argument> + <description> + Rearrange tab. + </description> + </method> + <method name="remove_tab"> + <return type="void"> + </return> + <argument index="0" name="tab_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_current_tab"> + <return type="void"> + </return> + <argument index="0" name="tab_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_tab_align"> + <return type="void"> + </return> + <argument index="0" name="align" type="int" enum="Tabs.TabAlign"> + </argument> + <description> + </description> + </method> + <method name="set_tab_close_display_policy"> + <return type="void"> + </return> + <argument index="0" name="policy" type="int" enum="Tabs.CloseButtonDisplayPolicy"> + </argument> + <description> + </description> + </method> + <method name="set_tab_disabled"> + <return type="void"> + </return> + <argument index="0" name="tab_idx" type="int"> + </argument> + <argument index="1" name="disabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_tab_icon"> + <return type="void"> + </return> + <argument index="0" name="tab_idx" type="int"> + </argument> + <argument index="1" name="icon" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_tab_title"> + <return type="void"> + </return> + <argument index="0" name="tab_idx" type="int"> + </argument> + <argument index="1" name="title" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="current_tab" type="int" setter="set_current_tab" getter="get_current_tab"> + </member> + <member name="tab_close_display_policy" type="int" setter="set_tab_close_display_policy" getter="get_tab_close_display_policy" enum="Tabs.CloseButtonDisplayPolicy"> + </member> + </members> + <signals> + <signal name="reposition_active_tab_request"> + <argument index="0" name="idx_to" type="int"> + </argument> + <description> + </description> + </signal> + <signal name="right_button_pressed"> + <argument index="0" name="tab" type="int"> + </argument> + <description> + </description> + </signal> + <signal name="tab_changed"> + <argument index="0" name="tab" type="int"> + </argument> + <description> + </description> + </signal> + <signal name="tab_clicked"> + <argument index="0" name="tab" type="int"> + </argument> + <description> + </description> + </signal> + <signal name="tab_close"> + <argument index="0" name="tab" type="int"> + </argument> + <description> + </description> + </signal> + <signal name="tab_hover"> + <argument index="0" name="tab" type="int"> + </argument> + <description> + </description> + </signal> + </signals> + <constants> + <constant name="ALIGN_LEFT" value="0"> + </constant> + <constant name="ALIGN_CENTER" value="1"> + </constant> + <constant name="ALIGN_RIGHT" value="2"> + </constant> + <constant name="ALIGN_MAX" value="3"> + </constant> + <constant name="CLOSE_BUTTON_SHOW_ACTIVE_ONLY" value="1"> + </constant> + <constant name="CLOSE_BUTTON_SHOW_ALWAYS" value="2"> + </constant> + <constant name="CLOSE_BUTTON_SHOW_NEVER" value="0"> + </constant> + <constant name="CLOSE_BUTTON_MAX" value="3"> + </constant> + </constants> + <theme_items> + <theme_item name="button" type="StyleBox"> + </theme_item> + <theme_item name="button_pressed" type="StyleBox"> + </theme_item> + <theme_item name="close" type="Texture"> + </theme_item> + <theme_item name="decrement" type="Texture"> + </theme_item> + <theme_item name="decrement_highlight" type="Texture"> + </theme_item> + <theme_item name="font" type="Font"> + </theme_item> + <theme_item name="font_color_bg" type="Color"> + </theme_item> + <theme_item name="font_color_disabled" type="Color"> + </theme_item> + <theme_item name="font_color_fg" type="Color"> + </theme_item> + <theme_item name="hseparation" type="int"> + </theme_item> + <theme_item name="increment" type="Texture"> + </theme_item> + <theme_item name="increment_highlight" type="Texture"> + </theme_item> + <theme_item name="label_valign_bg" type="int"> + </theme_item> + <theme_item name="label_valign_fg" type="int"> + </theme_item> + <theme_item name="panel" type="StyleBox"> + </theme_item> + <theme_item name="tab_bg" type="StyleBox"> + </theme_item> + <theme_item name="tab_fg" type="StyleBox"> + </theme_item> + <theme_item name="top_margin" type="int"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml new file mode 100644 index 0000000000..d77cb69eef --- /dev/null +++ b/doc/classes/TextEdit.xml @@ -0,0 +1,553 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="TextEdit" inherits="Control" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Multiline text editing control. + </brief_description> + <description> + TextEdit is meant for editing large, multiline text. It also has facilities for editing code, such as syntax highlighting support and multiple levels of undo/redo. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_color_region"> + <return type="void"> + </return> + <argument index="0" name="begin_key" type="String"> + </argument> + <argument index="1" name="end_key" type="String"> + </argument> + <argument index="2" name="color" type="Color"> + </argument> + <argument index="3" name="line_only" type="bool" default="false"> + </argument> + <description> + Add color region (given the delimiters) and its colors. + </description> + </method> + <method name="add_keyword_color"> + <return type="void"> + </return> + <argument index="0" name="keyword" type="String"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <description> + Add a keyword and its color. + </description> + </method> + <method name="clear_colors"> + <return type="void"> + </return> + <description> + Clear all the syntax coloring information. + </description> + </method> + <method name="clear_undo_history"> + <return type="void"> + </return> + <description> + Clear the undo history. + </description> + </method> + <method name="copy"> + <return type="void"> + </return> + <description> + Copy the current selection. + </description> + </method> + <method name="cursor_get_blink_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + Gets whether the text editor caret is blinking. + </description> + </method> + <method name="cursor_get_blink_speed" qualifiers="const"> + <return type="float"> + </return> + <description> + Gets the text editor caret blink speed. + </description> + </method> + <method name="cursor_get_column" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the column the editing cursor is at. + </description> + </method> + <method name="cursor_get_line" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the line the editing cursor is at. + </description> + </method> + <method name="cursor_is_block_mode" qualifiers="const"> + <return type="bool"> + </return> + <description> + Gets whether the text editor caret is in block mode. + </description> + </method> + <method name="cursor_set_blink_enabled"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set the text editor caret to blink. + </description> + </method> + <method name="cursor_set_blink_speed"> + <return type="void"> + </return> + <argument index="0" name="blink_speed" type="float"> + </argument> + <description> + Set the text editor caret blink speed. Cannot be less then or equal to 0. + </description> + </method> + <method name="cursor_set_block_mode"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set the text editor caret to block mode. + </description> + </method> + <method name="cursor_set_column"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="adjust_viewport" type="bool" default="true"> + </argument> + <description> + </description> + </method> + <method name="cursor_set_line"> + <return type="void"> + </return> + <argument index="0" name="line" type="int"> + </argument> + <argument index="1" name="adjust_viewport" type="bool" default="true"> + </argument> + <description> + </description> + </method> + <method name="cut"> + <return type="void"> + </return> + <description> + Cut the current selection. + </description> + </method> + <method name="get_line" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="line" type="int"> + </argument> + <description> + Return the text of a specific line. + </description> + </method> + <method name="get_line_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the amount of total lines in the text. + </description> + </method> + <method name="get_menu" qualifiers="const"> + <return type="PopupMenu"> + </return> + <description> + </description> + </method> + <method name="get_selection_from_column" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the selection begin column. + </description> + </method> + <method name="get_selection_from_line" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the selection begin line. + </description> + </method> + <method name="get_selection_text" qualifiers="const"> + <return type="String"> + </return> + <description> + Return the text inside the selection. + </description> + </method> + <method name="get_selection_to_column" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the selection end column. + </description> + </method> + <method name="get_selection_to_line" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the selection end line. + </description> + </method> + <method name="get_text"> + <return type="String"> + </return> + <description> + Return the whole text. + </description> + </method> + <method name="get_v_scroll_speed" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_word_under_cursor" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="insert_text_at_cursor"> + <return type="void"> + </return> + <argument index="0" name="text" type="String"> + </argument> + <description> + Insert a given text at the cursor position. + </description> + </method> + <method name="is_highlight_all_occurrences_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns true if highlight all occurrences is enabled. + </description> + </method> + <method name="is_selection_active" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if the selection is active. + </description> + </method> + <method name="is_show_line_numbers_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns true if line numbers are enabled. + </description> + </method> + <method name="is_smooth_scroll_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_syntax_coloring_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if the syntax coloring is enabled. + </description> + </method> + <method name="menu_option"> + <return type="void"> + </return> + <argument index="0" name="option" type="int"> + </argument> + <description> + </description> + </method> + <method name="paste"> + <return type="void"> + </return> + <description> + Paste the current selection. + </description> + </method> + <method name="redo"> + <return type="void"> + </return> + <description> + Perform redo operation. + </description> + </method> + <method name="search" qualifiers="const"> + <return type="PoolIntArray"> + </return> + <argument index="0" name="key" type="String"> + </argument> + <argument index="1" name="flags" type="int"> + </argument> + <argument index="2" name="from_line" type="int"> + </argument> + <argument index="3" name="from_column" type="int"> + </argument> + <description> + Perform a search inside the text. Search flags can be specified in the SEARCH_* enum. + </description> + </method> + <method name="select"> + <return type="void"> + </return> + <argument index="0" name="from_line" type="int"> + </argument> + <argument index="1" name="from_column" type="int"> + </argument> + <argument index="2" name="to_line" type="int"> + </argument> + <argument index="3" name="to_column" type="int"> + </argument> + <description> + Perform selection, from line/column to line/column. + </description> + </method> + <method name="select_all"> + <return type="void"> + </return> + <description> + Select all the text. + </description> + </method> + <method name="set_highlight_all_occurrences"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set to enable highlighting all occurrences of the current selection. + </description> + </method> + <method name="set_max_chars"> + <return type="void"> + </return> + <argument index="0" name="amount" type="int"> + </argument> + <description> + Set the maximum amount of characters editable. + </description> + </method> + <method name="set_readonly"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set the text editor as read-only. Text can be displayed but not edited. + </description> + </method> + <method name="set_show_line_numbers"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set to enable showing line numbers. + </description> + </method> + <method name="set_smooth_scroll_enable"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_syntax_coloring"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set to enable the syntax coloring. + </description> + </method> + <method name="set_text"> + <return type="void"> + </return> + <argument index="0" name="text" type="String"> + </argument> + <description> + Set the entire text. + </description> + </method> + <method name="set_v_scroll_speed"> + <return type="void"> + </return> + <argument index="0" name="speed" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_wrap"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Enable text wrapping when it goes beyond he edge of what is visible. + </description> + </method> + <method name="undo"> + <return type="void"> + </return> + <description> + Perform undo operation. + </description> + </method> + </methods> + <members> + <member name="caret_blink" type="bool" setter="cursor_set_blink_enabled" getter="cursor_get_blink_enabled"> + </member> + <member name="caret_blink_speed" type="float" setter="cursor_set_blink_speed" getter="cursor_get_blink_speed"> + </member> + <member name="caret_block_mode" type="bool" setter="cursor_set_block_mode" getter="cursor_is_block_mode"> + </member> + <member name="highlight_all_occurrences" type="bool" setter="set_highlight_all_occurrences" getter="is_highlight_all_occurrences_enabled"> + </member> + <member name="show_line_numbers" type="bool" setter="set_show_line_numbers" getter="is_show_line_numbers_enabled"> + </member> + <member name="smooth_scrolling" type="bool" setter="set_smooth_scroll_enable" getter="is_smooth_scroll_enabled"> + </member> + <member name="syntax_highlighting" type="bool" setter="set_syntax_coloring" getter="is_syntax_coloring_enabled"> + </member> + <member name="v_scroll_speed" type="float" setter="set_v_scroll_speed" getter="get_v_scroll_speed"> + </member> + </members> + <signals> + <signal name="breakpoint_toggled"> + <argument index="0" name="row" type="int"> + </argument> + <description> + Emitted when a breakpoint is placed via the breakpoint gutter. + </description> + </signal> + <signal name="cursor_changed"> + <description> + Emitted when the cursor changes. + </description> + </signal> + <signal name="request_completion"> + <description> + </description> + </signal> + <signal name="symbol_lookup"> + <argument index="0" name="symbol" type="String"> + </argument> + <argument index="1" name="row" type="int"> + </argument> + <argument index="2" name="column" type="int"> + </argument> + <description> + </description> + </signal> + <signal name="text_changed"> + <description> + Emitted when the text changes. + </description> + </signal> + </signals> + <constants> + <constant name="SEARCH_MATCH_CASE" value="1"> + Match case when searching. + </constant> + <constant name="SEARCH_WHOLE_WORDS" value="2"> + Match whole words when searching. + </constant> + <constant name="SEARCH_BACKWARDS" value="4"> + Search from end to beginning. + </constant> + <constant name="MENU_CUT" value="0"> + </constant> + <constant name="MENU_COPY" value="1"> + </constant> + <constant name="MENU_PASTE" value="2"> + </constant> + <constant name="MENU_CLEAR" value="3"> + </constant> + <constant name="MENU_SELECT_ALL" value="4"> + </constant> + <constant name="MENU_UNDO" value="5"> + </constant> + <constant name="MENU_MAX" value="6"> + </constant> + </constants> + <theme_items> + <theme_item name="background_color" type="Color"> + </theme_item> + <theme_item name="brace_mismatch_color" type="Color"> + </theme_item> + <theme_item name="breakpoint_color" type="Color"> + </theme_item> + <theme_item name="caret_background_color" type="Color"> + </theme_item> + <theme_item name="caret_color" type="Color"> + </theme_item> + <theme_item name="completion" type="StyleBox"> + </theme_item> + <theme_item name="completion_background_color" type="Color"> + </theme_item> + <theme_item name="completion_existing_color" type="Color"> + </theme_item> + <theme_item name="completion_font_color" type="Color"> + </theme_item> + <theme_item name="completion_lines" type="int"> + </theme_item> + <theme_item name="completion_max_width" type="int"> + </theme_item> + <theme_item name="completion_scroll_color" type="Color"> + </theme_item> + <theme_item name="completion_scroll_width" type="int"> + </theme_item> + <theme_item name="completion_selected_color" type="Color"> + </theme_item> + <theme_item name="current_line_color" type="Color"> + </theme_item> + <theme_item name="focus" type="StyleBox"> + </theme_item> + <theme_item name="font" type="Font"> + </theme_item> + <theme_item name="font_color" type="Color"> + </theme_item> + <theme_item name="font_color_selected" type="Color"> + </theme_item> + <theme_item name="function_color" type="Color"> + </theme_item> + <theme_item name="line_number_color" type="Color"> + </theme_item> + <theme_item name="line_spacing" type="int"> + </theme_item> + <theme_item name="mark_color" type="Color"> + </theme_item> + <theme_item name="member_variable_color" type="Color"> + </theme_item> + <theme_item name="normal" type="StyleBox"> + </theme_item> + <theme_item name="number_color" type="Color"> + </theme_item> + <theme_item name="selection_color" type="Color"> + </theme_item> + <theme_item name="symbol_color" type="Color"> + </theme_item> + <theme_item name="tab" type="Texture"> + </theme_item> + <theme_item name="word_highlighted_color" type="Color"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/Texture.xml b/doc/classes/Texture.xml new file mode 100644 index 0000000000..d09236bbc9 --- /dev/null +++ b/doc/classes/Texture.xml @@ -0,0 +1,141 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Texture" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Texture for 2D and 3D. + </brief_description> + <description> + A texture works by registering an image in the video hardware, which then can be used in 3D models or 2D [Sprite] or GUI [Control]. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="draw" qualifiers="const"> + <return type="void"> + </return> + <argument index="0" name="canvas_item" type="RID"> + </argument> + <argument index="1" name="pos" type="Vector2"> + </argument> + <argument index="2" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> + </argument> + <argument index="3" name="transpose" type="bool" default="false"> + </argument> + <argument index="4" name="normal_map" type="Texture" default="null"> + </argument> + <description> + </description> + </method> + <method name="draw_rect" qualifiers="const"> + <return type="void"> + </return> + <argument index="0" name="canvas_item" type="RID"> + </argument> + <argument index="1" name="rect" type="Rect2"> + </argument> + <argument index="2" name="tile" type="bool"> + </argument> + <argument index="3" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> + </argument> + <argument index="4" name="transpose" type="bool" default="false"> + </argument> + <argument index="5" name="normal_map" type="Texture" default="null"> + </argument> + <description> + </description> + </method> + <method name="draw_rect_region" qualifiers="const"> + <return type="void"> + </return> + <argument index="0" name="canvas_item" type="RID"> + </argument> + <argument index="1" name="rect" type="Rect2"> + </argument> + <argument index="2" name="src_rect" type="Rect2"> + </argument> + <argument index="3" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )"> + </argument> + <argument index="4" name="transpose" type="bool" default="false"> + </argument> + <argument index="5" name="normal_map" type="Texture" default="null"> + </argument> + <argument index="6" name="clip_uv" type="bool" default="true"> + </argument> + <description> + </description> + </method> + <method name="get_data" qualifiers="const"> + <return type="Image"> + </return> + <description> + </description> + </method> + <method name="get_flags" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the current texture flags. + </description> + </method> + <method name="get_height" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the texture height. + </description> + </method> + <method name="get_size" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the texture size. + </description> + </method> + <method name="get_width" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the texture width. + </description> + </method> + <method name="has_alpha" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_flags"> + <return type="void"> + </return> + <argument index="0" name="flags" type="int"> + </argument> + <description> + Change the texture flags. + </description> + </method> + </methods> + <constants> + <constant name="FLAG_MIPMAPS" value="1"> + Generate mipmaps, to enable smooth zooming out of the texture. + </constant> + <constant name="FLAG_REPEAT" value="2"> + Repeat (instead of clamp to edge). + </constant> + <constant name="FLAG_FILTER" value="4"> + Turn on magnifying filter, to enable smooth zooming in of the texture. + </constant> + <constant name="FLAG_VIDEO_SURFACE" value="4096"> + Texture is a video surface. + </constant> + <constant name="FLAGS_DEFAULT" value="7"> + Default flags. Generate mipmaps, repeat, and filter are enabled. + </constant> + <constant name="FLAG_ANISOTROPIC_FILTER" value="8"> + </constant> + <constant name="FLAG_CONVERT_TO_LINEAR" value="16"> + </constant> + <constant name="FLAG_MIRRORED_REPEAT" value="32"> + </constant> + </constants> +</class> diff --git a/doc/classes/TextureButton.xml b/doc/classes/TextureButton.xml new file mode 100644 index 0000000000..e4f00555b3 --- /dev/null +++ b/doc/classes/TextureButton.xml @@ -0,0 +1,162 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="TextureButton" inherits="BaseButton" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Button that can be themed with textures. + </brief_description> + <description> + Button that can be themed with textures. This is like a regular [Button] but can be themed by assigning textures to it. This button is intended to be easy to theme, however a regular button can expand (that uses styleboxes) and still be better if the interface is expect to have internationalization of texts. + Only the normal texture is required, the others are optional. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_click_mask" qualifiers="const"> + <return type="BitMap"> + </return> + <description> + </description> + </method> + <method name="get_disabled_texture" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="get_expand" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_focused_texture" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="get_hover_texture" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="get_normal_texture" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="get_pressed_texture" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="get_stretch_mode" qualifiers="const"> + <return type="int" enum="TextureButton.StretchMode"> + </return> + <description> + </description> + </method> + <method name="set_click_mask"> + <return type="void"> + </return> + <argument index="0" name="mask" type="BitMap"> + </argument> + <description> + </description> + </method> + <method name="set_disabled_texture"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_expand"> + <return type="void"> + </return> + <argument index="0" name="p_expand" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_focused_texture"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_hover_texture"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_normal_texture"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_pressed_texture"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_stretch_mode"> + <return type="void"> + </return> + <argument index="0" name="p_mode" type="int" enum="TextureButton.StretchMode"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="expand" type="bool" setter="set_expand" getter="get_expand"> + </member> + <member name="stretch_mode" type="int" setter="set_stretch_mode" getter="get_stretch_mode" enum="TextureButton.StretchMode"> + </member> + <member name="texture_click_mask" type="BitMap" setter="set_click_mask" getter="get_click_mask"> + </member> + <member name="texture_disabled" type="Texture" setter="set_disabled_texture" getter="get_disabled_texture"> + </member> + <member name="texture_focused" type="Texture" setter="set_focused_texture" getter="get_focused_texture"> + </member> + <member name="texture_hover" type="Texture" setter="set_hover_texture" getter="get_hover_texture"> + </member> + <member name="texture_normal" type="Texture" setter="set_normal_texture" getter="get_normal_texture"> + </member> + <member name="texture_pressed" type="Texture" setter="set_pressed_texture" getter="get_pressed_texture"> + </member> + </members> + <constants> + <constant name="STRETCH_SCALE" value="0"> + </constant> + <constant name="STRETCH_TILE" value="1"> + </constant> + <constant name="STRETCH_KEEP" value="2"> + </constant> + <constant name="STRETCH_KEEP_CENTERED" value="3"> + </constant> + <constant name="STRETCH_KEEP_ASPECT" value="4"> + </constant> + <constant name="STRETCH_KEEP_ASPECT_CENTERED" value="5"> + </constant> + <constant name="STRETCH_KEEP_ASPECT_COVERED" value="6"> + </constant> + </constants> +</class> diff --git a/doc/classes/TextureProgress.xml b/doc/classes/TextureProgress.xml new file mode 100644 index 0000000000..0a6ffcdeb8 --- /dev/null +++ b/doc/classes/TextureProgress.xml @@ -0,0 +1,201 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="TextureProgress" inherits="Range" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Textured progress bar. + </brief_description> + <description> + A [ProgressBar] that uses textures to display fill percentage. Can be set to linear or radial mode. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_fill_degrees"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_fill_mode"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_nine_patch_stretch" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns true if textures are stretched as nine-patches or false otherwise. + </description> + </method> + <method name="get_over_texture" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="get_progress_texture" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="get_radial_center_offset"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_radial_initial_angle"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_stretch_margin" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <description> + Return nine-patch texture offset for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). + </description> + </method> + <method name="get_under_texture" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="set_fill_degrees"> + <return type="void"> + </return> + <argument index="0" name="mode" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_fill_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_nine_patch_stretch"> + <return type="void"> + </return> + <argument index="0" name="stretch" type="bool"> + </argument> + <description> + Set if textures should be stretched as nine-patches. + </description> + </method> + <method name="set_over_texture"> + <return type="void"> + </return> + <argument index="0" name="tex" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_progress_texture"> + <return type="void"> + </return> + <argument index="0" name="tex" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_radial_center_offset"> + <return type="void"> + </return> + <argument index="0" name="mode" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_radial_initial_angle"> + <return type="void"> + </return> + <argument index="0" name="mode" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_stretch_margin"> + <return type="void"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <argument index="1" name="value" type="int"> + </argument> + <description> + Set nine-patch texture offset for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). + </description> + </method> + <method name="set_under_texture"> + <return type="void"> + </return> + <argument index="0" name="tex" type="Texture"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="fill_mode" type="int" setter="set_fill_mode" getter="get_fill_mode"> + The fill direction. Uses FILL_* constants. + </member> + <member name="nine_patch_stretch" type="bool" setter="set_nine_patch_stretch" getter="get_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] + </member> + <member name="radial_center_offset" type="Vector2" setter="set_radial_center_offset" getter="get_radial_center_offset"> + The offset amount for radial mode. + </member> + <member name="radial_fill_degrees" type="float" setter="set_fill_degrees" getter="get_fill_degrees"> + The amount of the texture to use for radial mode. + </member> + <member name="radial_initial_angle" type="float" setter="set_radial_initial_angle" getter="get_radial_initial_angle"> + Start angle for radial mode. + </member> + <member name="stretch_margin_bottom" type="int" setter="set_stretch_margin" getter="get_stretch_margin"> + Nine-patch texture offset for bottom margin. + </member> + <member name="stretch_margin_left" type="int" setter="set_stretch_margin" getter="get_stretch_margin"> + Nine-patch texture offset for left margin. + </member> + <member name="stretch_margin_right" type="int" setter="set_stretch_margin" getter="get_stretch_margin"> + Nine-patch texture offset for right margin. + </member> + <member name="stretch_margin_top" type="int" setter="set_stretch_margin" getter="get_stretch_margin"> + Nine-patch texture offset for top margin. + </member> + <member name="texture_over" type="Texture" setter="set_over_texture" getter="get_over_texture"> + The [Texture] that will be drawn over the progress bar. + </member> + <member name="texture_progress" type="Texture" setter="set_progress_texture" getter="get_progress_texture"> + The [Texture] used to display [code]value[/code]. + </member> + <member name="texture_under" type="Texture" setter="set_under_texture" getter="get_under_texture"> + The [Texture] that will be drawn under the progress bar. + </member> + </members> + <constants> + <constant name="FILL_LEFT_TO_RIGHT" value="0"> + </constant> + <constant name="FILL_RIGHT_TO_LEFT" value="1"> + </constant> + <constant name="FILL_TOP_TO_BOTTOM" value="2"> + </constant> + <constant name="FILL_BOTTOM_TO_TOP" value="3"> + </constant> + <constant name="FILL_CLOCKWISE" value="4"> + </constant> + <constant name="FILL_COUNTER_CLOCKWISE" value="5"> + </constant> + </constants> +</class> diff --git a/doc/classes/TextureRect.xml b/doc/classes/TextureRect.xml new file mode 100644 index 0000000000..af5626ae84 --- /dev/null +++ b/doc/classes/TextureRect.xml @@ -0,0 +1,94 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="TextureRect" inherits="Control" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Draws a sprite or a texture inside a User Interface. The texture can tile or not. + </brief_description> + <description> + 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. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_stretch_mode" qualifiers="const"> + <return type="int" enum="TextureRect.StretchMode"> + </return> + <description> + </description> + </method> + <method name="get_texture" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="has_expand" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_expand"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_stretch_mode"> + <return type="void"> + </return> + <argument index="0" name="stretch_mode" type="int" enum="TextureRect.StretchMode"> + </argument> + <description> + </description> + </method> + <method name="set_texture"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="expand" type="bool" setter="set_expand" getter="has_expand"> + If [code]true[/code], the texture scales to fit its bounding rectangle. Default value: [code]false[/code]. + </member> + <member name="stretch_mode" type="int" setter="set_stretch_mode" getter="get_stretch_mode" enum="TextureRect.StretchMode"> + 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. + </member> + <member name="texture" type="Texture" setter="set_texture" getter="get_texture"> + The node's [Texture] resource. + </member> + </members> + <constants> + <constant name="STRETCH_SCALE_ON_EXPAND" value="0"> + Scale to fit the node's bounding rectangle, only if [code]expand[/code] is [code]true[/code]. Default [code]stretch_mode[/code], for backwards compatibility. Until you set [code]expand[/code] to [code]true[/code], the texture will behave like [code]STRETCH_KEEP[/code]. + </constant> + <constant name="STRETCH_SCALE" value="1"> + Scale to fit the node's bounding rectangle. + </constant> + <constant name="STRETCH_TILE" value="2"> + Tile inside the node's bounding rectangle. + </constant> + <constant name="STRETCH_KEEP" value="3"> + The texture keeps its original size and stays in the bounding rectangle's top-left corner. + </constant> + <constant name="STRETCH_KEEP_CENTERED" value="4"> + The texture keeps its original size and stays centered in the node's bounding rectangle. + </constant> + <constant name="STRETCH_KEEP_ASPECT" value="5"> + Scale the texture to fit the node's bounding rectangle, but maintain the texture's aspect ratio. + </constant> + <constant name="STRETCH_KEEP_ASPECT_CENTERED" value="6"> + Scale the texture to fit the node's bounding rectangle, center it and maintain its aspect ratio. + </constant> + <constant name="STRETCH_KEEP_ASPECT_COVERED" value="7"> + Scale the texture so that the shorter side fits the bounding rectangle. The other side clips to the node's limits. + </constant> + </constants> +</class> diff --git a/doc/classes/Theme.xml b/doc/classes/Theme.xml new file mode 100644 index 0000000000..4dd45ac821 --- /dev/null +++ b/doc/classes/Theme.xml @@ -0,0 +1,306 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Theme" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Theme for controls. + </brief_description> + <description> + Theme for skinning controls. Controls can be skinned individually, but for complex applications it's more efficient to just create a global theme that defines everything. This theme can be applied to any [Control], and it and its children will automatically use it. + Theme resources can be alternatively loaded by writing them in a .theme file, see docs for more info. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="clear_color"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String"> + </argument> + <description> + </description> + </method> + <method name="clear_constant"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String"> + </argument> + <description> + </description> + </method> + <method name="clear_font"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String"> + </argument> + <description> + </description> + </method> + <method name="clear_icon"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String"> + </argument> + <description> + </description> + </method> + <method name="clear_stylebox"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String"> + </argument> + <description> + </description> + </method> + <method name="copy_default_theme"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="get_color" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_color_list" qualifiers="const"> + <return type="PoolStringArray"> + </return> + <argument index="0" name="type" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_constant" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_constant_list" qualifiers="const"> + <return type="PoolStringArray"> + </return> + <argument index="0" name="type" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_default_font" qualifiers="const"> + <return type="Font"> + </return> + <description> + </description> + </method> + <method name="get_font" qualifiers="const"> + <return type="Font"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_font_list" qualifiers="const"> + <return type="PoolStringArray"> + </return> + <argument index="0" name="type" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_icon" qualifiers="const"> + <return type="Texture"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_icon_list" qualifiers="const"> + <return type="PoolStringArray"> + </return> + <argument index="0" name="type" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_stylebox" qualifiers="const"> + <return type="StyleBox"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_stylebox_list" qualifiers="const"> + <return type="PoolStringArray"> + </return> + <argument index="0" name="type" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_stylebox_types" qualifiers="const"> + <return type="PoolStringArray"> + </return> + <description> + </description> + </method> + <method name="get_type_list" qualifiers="const"> + <return type="PoolStringArray"> + </return> + <argument index="0" name="type" type="String"> + </argument> + <description> + </description> + </method> + <method name="has_color" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String"> + </argument> + <description> + </description> + </method> + <method name="has_constant" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String"> + </argument> + <description> + </description> + </method> + <method name="has_font" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String"> + </argument> + <description> + </description> + </method> + <method name="has_icon" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String"> + </argument> + <description> + </description> + </method> + <method name="has_stylebox" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_color"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String"> + </argument> + <argument index="2" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_constant"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String"> + </argument> + <argument index="2" name="constant" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_default_font"> + <return type="void"> + </return> + <argument index="0" name="font" type="Font"> + </argument> + <description> + </description> + </method> + <method name="set_font"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String"> + </argument> + <argument index="2" name="font" type="Font"> + </argument> + <description> + </description> + </method> + <method name="set_icon"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String"> + </argument> + <argument index="2" name="texture" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_stylebox"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="String"> + </argument> + <argument index="2" name="texture" type="StyleBox"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="default_font" type="Font" setter="set_default_font" getter="get_default_font"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Thread.xml b/doc/classes/Thread.xml new file mode 100644 index 0000000000..2156d04614 --- /dev/null +++ b/doc/classes/Thread.xml @@ -0,0 +1,60 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Thread" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + A unit of execution in a process. + </brief_description> + <description> + A unit of execution in a process. Can run methods on [Object]\ s simultaneously. The use of synchronization via [Mutex], [Semaphore] is advised if working with shared objects. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_id" qualifiers="const"> + <return type="String"> + </return> + <description> + Returns the current [Thread]\ s id, uniquely identifying it among all threads. + </description> + </method> + <method name="is_active" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns true if this [Thread] is currently active. An active [Thread] cannot start work on a new method but can be joined with [method wait_to_finish]. + </description> + </method> + <method name="start"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="instance" type="Object"> + </argument> + <argument index="1" name="method" type="String"> + </argument> + <argument index="2" name="userdata" type="Variant" default="null"> + </argument> + <argument index="3" name="priority" type="int" default="1"> + </argument> + <description> + Starts a new [Thread] that runs "method" on object "instance" with "userdata" passed as an argument. The "priority" of the [Thread] can be changed by passing a PRIORITY_* enum. + Returns OK on success, or ERR_CANT_CREATE on failure. + </description> + </method> + <method name="wait_to_finish"> + <return type="Variant"> + </return> + <description> + Joins the [Thread] and waits for it to finish. Returns what the method called returned. + </description> + </method> + </methods> + <constants> + <constant name="PRIORITY_LOW" value="0"> + </constant> + <constant name="PRIORITY_NORMAL" value="1"> + </constant> + <constant name="PRIORITY_HIGH" value="2"> + </constant> + </constants> +</class> diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml new file mode 100644 index 0000000000..e1a6c0b523 --- /dev/null +++ b/doc/classes/TileMap.xml @@ -0,0 +1,537 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="TileMap" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Node for 2D tile-based maps. + </brief_description> + <description> + Node for 2D tile-based maps. Tilemaps use a [TileSet] which contain a list of tiles (textures plus optional collision, navigation, and/or occluder shapes) which are used to create grid-based maps. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="clear"> + <return type="void"> + </return> + <description> + Clear all cells. + </description> + </method> + <method name="get_cell" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="x" type="int"> + </argument> + <argument index="1" name="y" type="int"> + </argument> + <description> + Return the tile index of the referenced cell. + </description> + </method> + <method name="get_cell_size" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the cell size. + </description> + </method> + <method name="get_cellv" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="pos" type="Vector2"> + </argument> + <description> + Return the tile index of the cell referenced by a Vector2. + </description> + </method> + <method name="get_center_x" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if tiles are to be centered in x coordinate (by default this is false and they are drawn from upper left cell corner). + </description> + </method> + <method name="get_center_y" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if tiles are to be centered in y coordinate (by default this is false and they are drawn from upper left cell corner). + </description> + </method> + <method name="get_collision_bounce" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the collision bounce parameter. + </description> + </method> + <method name="get_collision_friction" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the collision friction parameter. + </description> + </method> + <method name="get_collision_layer" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the collision layer. + </description> + </method> + <method name="get_collision_layer_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_collision_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the collision mask. + </description> + </method> + <method name="get_collision_mask_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_collision_use_kinematic" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether the tilemap handles collisions as a kinematic body. + </description> + </method> + <method name="get_custom_transform" qualifiers="const"> + <return type="Transform2D"> + </return> + <description> + Return the custom transform matrix. + </description> + </method> + <method name="get_half_offset" qualifiers="const"> + <return type="int" enum="TileMap.HalfOffset"> + </return> + <description> + Return the current half offset configuration. + </description> + </method> + <method name="get_mode" qualifiers="const"> + <return type="int" enum="TileMap.Mode"> + </return> + <description> + Return the orientation mode. + </description> + </method> + <method name="get_occluder_light_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_quadrant_size" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the quadrant size. + </description> + </method> + <method name="get_tile_origin" qualifiers="const"> + <return type="int" enum="TileMap.TileOrigin"> + </return> + <description> + Return the tile origin configuration. + </description> + </method> + <method name="get_tileset" qualifiers="const"> + <return type="TileSet"> + </return> + <description> + Return the current tileset. + </description> + </method> + <method name="get_used_cells" qualifiers="const"> + <return type="Array"> + </return> + <description> + Return an array of all cells containing a tile from the tileset (i.e. a tile index different from -1). + </description> + </method> + <method name="get_used_cells_by_id" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_used_rect"> + <return type="Rect2"> + </return> + <description> + </description> + </method> + <method name="is_cell_transposed" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="x" type="int"> + </argument> + <argument index="1" name="y" type="int"> + </argument> + <description> + Return whether the referenced cell is transposed, i.e. the X and Y axes are swapped (mirroring with regard to the (1,1) vector). + </description> + </method> + <method name="is_cell_x_flipped" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="x" type="int"> + </argument> + <argument index="1" name="y" type="int"> + </argument> + <description> + Return whether the referenced cell is flipped over the X axis. + </description> + </method> + <method name="is_cell_y_flipped" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="x" type="int"> + </argument> + <argument index="1" name="y" type="int"> + </argument> + <description> + Return whether the referenced cell is flipped over the Y axis. + </description> + </method> + <method name="is_y_sort_mode_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return the Y sort mode. + </description> + </method> + <method name="map_to_world" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="mappos" type="Vector2"> + </argument> + <argument index="1" name="ignore_half_ofs" type="bool" default="false"> + </argument> + <description> + Return the absolute world position corresponding to the tilemap (grid-based) coordinates given as an argument. + Optionally, the tilemap's potential half offset can be ignored. + </description> + </method> + <method name="set_cell"> + <return type="void"> + </return> + <argument index="0" name="x" type="int"> + </argument> + <argument index="1" name="y" type="int"> + </argument> + <argument index="2" name="tile" type="int"> + </argument> + <argument index="3" name="flip_x" type="bool" default="false"> + </argument> + <argument index="4" name="flip_y" type="bool" default="false"> + </argument> + <argument index="5" name="transpose" type="bool" default="false"> + </argument> + <description> + Set the tile index for the cell referenced by its grid-based X and Y coordinates. + A tile index of -1 clears the cell. + Optionally, the tile can also be flipped over the X and Y coordinates or transposed. + </description> + </method> + <method name="set_cell_size"> + <return type="void"> + </return> + <argument index="0" name="size" type="Vector2"> + </argument> + <description> + Set the cell size. + </description> + </method> + <method name="set_cellv"> + <return type="void"> + </return> + <argument index="0" name="pos" type="Vector2"> + </argument> + <argument index="1" name="tile" type="int"> + </argument> + <argument index="2" name="flip_x" type="bool" default="false"> + </argument> + <argument index="3" name="flip_y" type="bool" default="false"> + </argument> + <argument index="4" name="transpose" type="bool" default="false"> + </argument> + <description> + Set the tile index for the cell referenced by a Vector2 of grid-based coordinates. + A tile index of -1 clears the cell. + Optionally, the tile can also be flipped over the X and Y axes or transposed. + </description> + </method> + <method name="set_center_x"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set tiles to be centered in x coordinate. (by default this is false and they are drawn from upper left cell corner). + </description> + </method> + <method name="set_center_y"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set tiles to be centered in y coordinate. (by default this is false and they are drawn from upper left cell corner). + </description> + </method> + <method name="set_collision_bounce"> + <return type="void"> + </return> + <argument index="0" name="value" type="float"> + </argument> + <description> + Set the collision bounce parameter. Allowable values range from 0 to 1. + </description> + </method> + <method name="set_collision_friction"> + <return type="void"> + </return> + <argument index="0" name="value" type="float"> + </argument> + <description> + Set the collision friction parameter. Allowable values range from 0 to 1. + </description> + </method> + <method name="set_collision_layer"> + <return type="void"> + </return> + <argument index="0" name="layer" type="int"> + </argument> + <description> + Set the collision layer. + Layers are referenced by binary indexes, so allowable values to describe the 20 available layers range from 0 to 2^20-1. + </description> + </method> + <method name="set_collision_layer_bit"> + <return type="void"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_collision_mask"> + <return type="void"> + </return> + <argument index="0" name="mask" type="int"> + </argument> + <description> + Set the collision masks. + Masks are referenced by binary indexes, so allowable values to describe the 20 available masks range from 0 to 2^20-1. + </description> + </method> + <method name="set_collision_mask_bit"> + <return type="void"> + </return> + <argument index="0" name="bit" type="int"> + </argument> + <argument index="1" name="value" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_collision_use_kinematic"> + <return type="void"> + </return> + <argument index="0" name="use_kinematic" type="bool"> + </argument> + <description> + Set the tilemap to handle collisions as a kinematic body (enabled) or a static body (disabled). + </description> + </method> + <method name="set_custom_transform"> + <return type="void"> + </return> + <argument index="0" name="custom_transform" type="Transform2D"> + </argument> + <description> + Set custom transform matrix, to use in combination with the custom orientation mode. + </description> + </method> + <method name="set_half_offset"> + <return type="void"> + </return> + <argument index="0" name="half_offset" type="int" enum="TileMap.HalfOffset"> + </argument> + <description> + Set a half offset on the X coordinate, Y coordinate, or none (use HALF_OFFSET_* constants as argument). + Half offset sets every other tile off by a half tile size in the specified direction. + </description> + </method> + <method name="set_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="TileMap.Mode"> + </argument> + <description> + Set the orientation mode as square, isometric or custom (use MODE_* constants as argument). + </description> + </method> + <method name="set_occluder_light_mask"> + <return type="void"> + </return> + <argument index="0" name="mask" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_quadrant_size"> + <return type="void"> + </return> + <argument index="0" name="size" type="int"> + </argument> + <description> + Set the quadrant size, this optimizes drawing by batching chunks of map at draw/cull time. + Allowed values are integers ranging from 1 to 128. + </description> + </method> + <method name="set_tile_origin"> + <return type="void"> + </return> + <argument index="0" name="origin" type="int" enum="TileMap.TileOrigin"> + </argument> + <description> + Set the tile origin to the tile center or its top-left corner (use TILE_ORIGIN_* constants as argument). + </description> + </method> + <method name="set_tileset"> + <return type="void"> + </return> + <argument index="0" name="tileset" type="TileSet"> + </argument> + <description> + Set the current tileset. + </description> + </method> + <method name="set_y_sort_mode"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set the Y sort mode. Enabled Y sort mode means that children of the tilemap will be drawn in the order defined by their Y coordinate. + A tile with a higher Y coordinate will therefore be drawn later, potentially covering up the tile(s) above it if its sprite is higher than its cell size. + </description> + </method> + <method name="world_to_map" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="worldpos" type="Vector2"> + </argument> + <description> + Return the tilemap (grid-based) coordinates corresponding to the absolute world position given as an argument. + </description> + </method> + </methods> + <members> + <member name="cell_custom_transform" type="Transform2D" setter="set_custom_transform" getter="get_custom_transform"> + The custom [Transform2D] to be applied to the TileMap's cells. + </member> + <member name="cell_half_offset" type="int" setter="set_half_offset" getter="get_half_offset" enum="TileMap.HalfOffset"> + Amount to offset alternating tiles. Uses HALF_OFFSET_* constants. Default value: HALF_OFFSET_DISABLED. + </member> + <member name="cell_quadrant_size" type="int" setter="set_quadrant_size" getter="get_quadrant_size"> + The TileMap's quadrant size. Optimizes drawing by batching, using chunks of this size. Default value: 16. + </member> + <member name="cell_size" type="Vector2" setter="set_cell_size" getter="get_cell_size"> + The TileMap's cell size. + </member> + <member name="cell_tile_origin" type="int" setter="set_tile_origin" getter="get_tile_origin" enum="TileMap.TileOrigin"> + Position for tile origin. Uses TILE_ORIGIN_* constants. Default value: TILE_ORIGIN_TOP_LEFT. + </member> + <member name="cell_y_sort" type="bool" setter="set_y_sort_mode" getter="is_y_sort_mode_enabled"> + If [code]true[/code] the TileMap's children will be drawn in order of their Y coordinate. Default value: [code]false[/code]. + </member> + <member name="collision_bounce" type="float" setter="set_collision_bounce" getter="get_collision_bounce"> + Bounce value for static body collisions (see [code]collision_use_kinematic[/code]). Default value: 0. + </member> + <member name="collision_friction" type="float" setter="set_collision_friction" getter="get_collision_friction"> + Friction value for static body collisions (see [code]collision_use_kinematic[/code]). Default value: 1. + </member> + <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer"> + The collision layer(s) for all colliders in the TileMap. + </member> + <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask"> + The collision mask(s) for all colliders in the TileMap. + </member> + <member name="collision_use_kinematic" type="bool" setter="set_collision_use_kinematic" getter="get_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]. + </member> + <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="TileMap.Mode"> + The TileMap orientation mode. Uses MODE_* constants. Default value: MODE_SQUARE. + </member> + <member name="occluder_light_mask" type="int" setter="set_occluder_light_mask" getter="get_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). + </member> + <member name="tile_data" type="PoolIntArray" setter="_set_tile_data" getter="_get_tile_data"> + A [PoolIntArray] containing + </member> + <member name="tile_set" type="TileSet" setter="set_tileset" getter="get_tileset"> + The assigned [TileSet]. + </member> + </members> + <signals> + <signal name="settings_changed"> + <description> + Emitted when a tilemap setting has changed. + </description> + </signal> + </signals> + <constants> + <constant name="INVALID_CELL" value="-1" enum=""> + Returned when a cell doesn't exist. + </constant> + <constant name="MODE_SQUARE" value="0"> + Orthogonal orientation mode. + </constant> + <constant name="MODE_ISOMETRIC" value="1"> + Isometric orientation mode. + </constant> + <constant name="MODE_CUSTOM" value="2"> + Custom orientation mode. + </constant> + <constant name="HALF_OFFSET_X" value="0"> + Half offset on the X coordinate. + </constant> + <constant name="HALF_OFFSET_Y" value="1"> + Half offset on the Y coordinate. + </constant> + <constant name="HALF_OFFSET_DISABLED" value="2"> + Half offset disabled. + </constant> + <constant name="TILE_ORIGIN_TOP_LEFT" value="0"> + Tile origin at its top-left corner. + </constant> + <constant name="TILE_ORIGIN_CENTER" value="1"> + Tile origin at its center. + </constant> + <constant name="TILE_ORIGIN_BOTTOM_LEFT" value="2"> + </constant> + </constants> +</class> diff --git a/doc/classes/TileSet.xml b/doc/classes/TileSet.xml new file mode 100644 index 0000000000..a858138144 --- /dev/null +++ b/doc/classes/TileSet.xml @@ -0,0 +1,372 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="TileSet" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Tile library for tilemaps. + </brief_description> + <description> + A TileSet is a library of tiles for a [TileMap]. It contains a list of tiles, each consisting of a sprite and optional collision shapes. + Tiles are referenced by a unique integer ID. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="clear"> + <return type="void"> + </return> + <description> + Clear all tiles. + </description> + </method> + <method name="create_tile"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + Create a new tile which will be referenced by the given ID. + </description> + </method> + <method name="find_tile_by_name" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Find the first tile matching the given name. + </description> + </method> + <method name="get_last_unused_tile_id" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the ID following the last currently used ID, useful when creating a new tile. + </description> + </method> + <method name="get_tiles_ids" qualifiers="const"> + <return type="Array"> + </return> + <description> + Return an array of all currently used tile IDs. + </description> + </method> + <method name="remove_tile"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + Remove the tile referenced by the given ID. + </description> + </method> + <method name="tile_add_shape"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="shape" type="Shape2D"> + </argument> + <argument index="2" name="shape_transform" type="Transform2D"> + </argument> + <argument index="3" name="one_way" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="tile_get_light_occluder" qualifiers="const"> + <return type="OccluderPolygon2D"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + Return the light occluder of the tile. + </description> + </method> + <method name="tile_get_material" qualifiers="const"> + <return type="ShaderMaterial"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + Return the material of the tile. + </description> + </method> + <method name="tile_get_name" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + Return the name of the tile. + </description> + </method> + <method name="tile_get_navigation_polygon" qualifiers="const"> + <return type="NavigationPolygon"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + Return the navigation polygon of the tile. + </description> + </method> + <method name="tile_get_navigation_polygon_offset" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + Return the offset of the tile's navigation polygon. + </description> + </method> + <method name="tile_get_normal_map" qualifiers="const"> + <return type="Texture"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="tile_get_occluder_offset" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + Return the offset of the tile's light occluder. + </description> + </method> + <method name="tile_get_region" qualifiers="const"> + <return type="Rect2"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + Return the tile sub-region in the texture. + </description> + </method> + <method name="tile_get_shape" qualifiers="const"> + <return type="Shape2D"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="shape_id" type="int"> + </argument> + <description> + </description> + </method> + <method name="tile_get_shape_count" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="tile_get_shape_one_way" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="shape_id" type="int"> + </argument> + <description> + </description> + </method> + <method name="tile_get_shape_transform" qualifiers="const"> + <return type="Transform2D"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="shape_id" type="int"> + </argument> + <description> + </description> + </method> + <method name="tile_get_shapes" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + Return the array of shapes of the tile. + </description> + </method> + <method name="tile_get_texture" qualifiers="const"> + <return type="Texture"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + Return the texture of the tile. + </description> + </method> + <method name="tile_get_texture_offset" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <description> + Return the texture offset of the tile. + </description> + </method> + <method name="tile_set_light_occluder"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="light_occluder" type="OccluderPolygon2D"> + </argument> + <description> + Set a light occluder for the tile. + </description> + </method> + <method name="tile_set_material"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="material" type="ShaderMaterial"> + </argument> + <description> + Set the material of the tile. + </description> + </method> + <method name="tile_set_name"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="name" type="String"> + </argument> + <description> + Set the name of the tile, for descriptive purposes. + </description> + </method> + <method name="tile_set_navigation_polygon"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="navigation_polygon" type="NavigationPolygon"> + </argument> + <description> + Set a navigation polygon for the tile. + </description> + </method> + <method name="tile_set_navigation_polygon_offset"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="navigation_polygon_offset" type="Vector2"> + </argument> + <description> + Set an offset for the tile's navigation polygon. + </description> + </method> + <method name="tile_set_normal_map"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="normal_map" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="tile_set_occluder_offset"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="occluder_offset" type="Vector2"> + </argument> + <description> + Set an offset for the tile's light occluder. + </description> + </method> + <method name="tile_set_region"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="region" type="Rect2"> + </argument> + <description> + Set the tile sub-region in the texture. This is common in texture atlases. + </description> + </method> + <method name="tile_set_shape"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="shape_id" type="int"> + </argument> + <argument index="2" name="shape" type="Shape2D"> + </argument> + <description> + </description> + </method> + <method name="tile_set_shape_one_way"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="shape_id" type="int"> + </argument> + <argument index="2" name="one_way" type="bool"> + </argument> + <description> + </description> + </method> + <method name="tile_set_shape_transform"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="shape_id" type="int"> + </argument> + <argument index="2" name="shape_transform" type="Transform2D"> + </argument> + <description> + </description> + </method> + <method name="tile_set_shapes"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="shapes" type="Array"> + </argument> + <description> + Set an array of shapes for the tile, enabling physics to collide with it. + </description> + </method> + <method name="tile_set_texture"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="texture" type="Texture"> + </argument> + <description> + Set the texture of the tile. + </description> + </method> + <method name="tile_set_texture_offset"> + <return type="void"> + </return> + <argument index="0" name="id" type="int"> + </argument> + <argument index="1" name="texture_offset" type="Vector2"> + </argument> + <description> + Set the texture offset of the tile. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Timer.xml b/doc/classes/Timer.xml new file mode 100644 index 0000000000..35979bb1fc --- /dev/null +++ b/doc/classes/Timer.xml @@ -0,0 +1,151 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Timer" inherits="Node" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + A countdown timer. + </brief_description> + <description> + Counts down a specified interval and emits a signal on reaching 0. Can be set to repeat or "one shot" mode. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_time_left" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the time left for timeout in seconds if the timer is active, 0 otherwise. + </description> + </method> + <method name="get_timer_process_mode" qualifiers="const"> + <return type="int" enum="Timer.TimerProcessMode"> + </return> + <description> + Return the timer's processing mode. + </description> + </method> + <method name="get_wait_time" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the wait time in seconds. + </description> + </method> + <method name="has_autostart" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if set to automatically start when entering the scene. + </description> + </method> + <method name="is_one_shot" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return true if configured as one-shot. + </description> + </method> + <method name="is_paused" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return if the timer is paused or not. + </description> + </method> + <method name="is_stopped" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_autostart"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set to automatically start when entering the scene. + </description> + </method> + <method name="set_one_shot"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set as one-shot. If enabled, the timer will stop after timeout, otherwise it will automatically restart. + </description> + </method> + <method name="set_paused"> + <return type="void"> + </return> + <argument index="0" name="paused" type="bool"> + </argument> + <description> + Set whether the timer is paused or not. A paused timer will be inactive until it is unpaused again. + </description> + </method> + <method name="set_timer_process_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="Timer.TimerProcessMode"> + </argument> + <description> + Set the timer's processing mode (fixed or idle, use TIMER_PROCESS_* constants as argument). + </description> + </method> + <method name="set_wait_time"> + <return type="void"> + </return> + <argument index="0" name="time_sec" type="float"> + </argument> + <description> + Set wait time in seconds. When the time is over, it will emit the timeout signal. + </description> + </method> + <method name="start"> + <return type="void"> + </return> + <description> + Start the Timer. + </description> + </method> + <method name="stop"> + <return type="void"> + </return> + <description> + Stop (cancel) the Timer. + </description> + </method> + </methods> + <members> + <member name="autostart" type="bool" setter="set_autostart" getter="has_autostart"> + If [code]true[/code], Timer will automatically start when entering the scene tree. Default value: [code]false[/code]. + </member> + <member name="one_shot" type="bool" setter="set_one_shot" getter="is_one_shot"> + If [code]true[/code], Timer will stop when reaching 0. If [code]false[/code], it will restart. Default value: [code]false[/code]. + </member> + <member name="process_mode" type="int" setter="set_timer_process_mode" getter="get_timer_process_mode" enum="Timer.TimerProcessMode"> + Processing mode. Uses TIMER_PROCESS_* constants as value. + </member> + <member name="wait_time" type="float" setter="set_wait_time" getter="get_wait_time"> + Wait time in seconds. + </member> + </members> + <signals> + <signal name="timeout"> + <description> + Emitted when the Timer reaches 0. + </description> + </signal> + </signals> + <constants> + <constant name="TIMER_PROCESS_FIXED" value="0"> + Update the Timer at fixed intervals (framerate processing). + </constant> + <constant name="TIMER_PROCESS_IDLE" value="1"> + Update the Timer during the idle time at each frame. + </constant> + </constants> +</class> diff --git a/doc/classes/ToolButton.xml b/doc/classes/ToolButton.xml new file mode 100644 index 0000000000..7723dadb83 --- /dev/null +++ b/doc/classes/ToolButton.xml @@ -0,0 +1,46 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ToolButton" inherits="Button" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Flat button helper class. + </brief_description> + <description> + This is a helper class to generate a flat [Button] (see [method Button.set_flat]), creating a ToolButton is equivalent to: + + [codeblock] + var btn = Button.new() + btn.set_flat(true) + [/codeblock] + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> + <theme_items> + <theme_item name="disabled" type="StyleBox"> + </theme_item> + <theme_item name="focus" type="StyleBox"> + </theme_item> + <theme_item name="font" type="Font"> + </theme_item> + <theme_item name="font_color" type="Color"> + </theme_item> + <theme_item name="font_color_disabled" type="Color"> + </theme_item> + <theme_item name="font_color_hover" type="Color"> + </theme_item> + <theme_item name="font_color_pressed" type="Color"> + </theme_item> + <theme_item name="hover" type="StyleBox"> + </theme_item> + <theme_item name="hseparation" type="int"> + </theme_item> + <theme_item name="normal" type="StyleBox"> + </theme_item> + <theme_item name="pressed" type="StyleBox"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/TouchScreenButton.xml b/doc/classes/TouchScreenButton.xml new file mode 100644 index 0000000000..8a96fa1454 --- /dev/null +++ b/doc/classes/TouchScreenButton.xml @@ -0,0 +1,181 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="TouchScreenButton" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_action" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_bitmask" qualifiers="const"> + <return type="BitMap"> + </return> + <description> + </description> + </method> + <method name="get_shape" qualifiers="const"> + <return type="Shape2D"> + </return> + <description> + </description> + </method> + <method name="get_texture" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="get_texture_pressed" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="get_visibility_mode" qualifiers="const"> + <return type="int" enum="TouchScreenButton.VisibilityMode"> + </return> + <description> + </description> + </method> + <method name="is_passby_press_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_pressed" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_shape_centered" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_shape_visible" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_action"> + <return type="void"> + </return> + <argument index="0" name="action" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_bitmask"> + <return type="void"> + </return> + <argument index="0" name="bitmask" type="BitMap"> + </argument> + <description> + </description> + </method> + <method name="set_passby_press"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_shape"> + <return type="void"> + </return> + <argument index="0" name="shape" type="Shape2D"> + </argument> + <description> + </description> + </method> + <method name="set_shape_centered"> + <return type="void"> + </return> + <argument index="0" name="bool" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_shape_visible"> + <return type="void"> + </return> + <argument index="0" name="bool" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_texture"> + <return type="void"> + </return> + <argument index="0" name="texture" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_texture_pressed"> + <return type="void"> + </return> + <argument index="0" name="texture_pressed" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_visibility_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="TouchScreenButton.VisibilityMode"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="action" type="String" setter="set_action" getter="get_action"> + </member> + <member name="bitmask" type="BitMap" setter="set_bitmask" getter="get_bitmask"> + </member> + <member name="normal" type="Texture" setter="set_texture" getter="get_texture"> + </member> + <member name="passby_press" type="bool" setter="set_passby_press" getter="is_passby_press_enabled"> + </member> + <member name="pressed" type="Texture" setter="set_texture_pressed" getter="get_texture_pressed"> + </member> + <member name="shape" type="Shape2D" setter="set_shape" getter="get_shape"> + </member> + <member name="shape_centered" type="bool" setter="set_shape_centered" getter="is_shape_centered"> + </member> + <member name="shape_visible" type="bool" setter="set_shape_visible" getter="is_shape_visible"> + </member> + <member name="visibility_mode" type="int" setter="set_visibility_mode" getter="get_visibility_mode" enum="TouchScreenButton.VisibilityMode"> + </member> + </members> + <signals> + <signal name="pressed"> + <description> + </description> + </signal> + <signal name="released"> + <description> + </description> + </signal> + </signals> + <constants> + <constant name="VISIBILITY_ALWAYS" value="0"> + </constant> + <constant name="VISIBILITY_TOUCHSCREEN_ONLY" value="1"> + </constant> + </constants> +</class> diff --git a/doc/classes/Transform.xml b/doc/classes/Transform.xml new file mode 100644 index 0000000000..6780de1943 --- /dev/null +++ b/doc/classes/Transform.xml @@ -0,0 +1,168 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Transform" category="Built-In Types" version="3.0.alpha.custom_build"> + <brief_description> + 3D Transformation. 3x4 matrix. + </brief_description> + <description> + Represents one or many transformations in 3D space such as translation, rotation, or scaling. It consists of a [Basis] "basis" and an [Vector3] "origin". It is similar to a 3x4 matrix. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="Transform"> + <return type="Transform"> + </return> + <argument index="0" name="x_axis" type="Vector3"> + </argument> + <argument index="1" name="y_axis" type="Vector3"> + </argument> + <argument index="2" name="z_axis" type="Vector3"> + </argument> + <argument index="3" name="origin" type="Vector3"> + </argument> + <description> + Constructs the Transform from four [Vector3]. Each axis corresponds to local basis vectors (some of which may be scaled). + </description> + </method> + <method name="Transform"> + <return type="Transform"> + </return> + <argument index="0" name="basis" type="Basis"> + </argument> + <argument index="1" name="origin" type="Vector3"> + </argument> + <description> + Constructs the Transform from a [Basis] and [Vector3]. + </description> + </method> + <method name="Transform"> + <return type="Transform"> + </return> + <argument index="0" name="from" type="Transform2D"> + </argument> + <description> + Constructs the Transform from a [Transform2D]. + </description> + </method> + <method name="Transform"> + <return type="Transform"> + </return> + <argument index="0" name="from" type="Quat"> + </argument> + <description> + Constructs the Transform from a [Quat]. The origin will be Vector3(0, 0, 0). + </description> + </method> + <method name="Transform"> + <return type="Transform"> + </return> + <argument index="0" name="from" type="Basis"> + </argument> + <description> + Constructs the Transform from a [Basis]. The origin will be Vector3(0, 0, 0). + </description> + </method> + <method name="affine_inverse"> + <return type="Transform"> + </return> + <description> + Returns the inverse of the transfrom, under the assumption that the transformation is composed of rotation, scaling and translation. + </description> + </method> + <method name="interpolate_with"> + <return type="Transform"> + </return> + <argument index="0" name="transform" type="Transform"> + </argument> + <argument index="1" name="weight" type="float"> + </argument> + <description> + Interpolates the transform to other Transform by weight amount (0-1). + </description> + </method> + <method name="inverse"> + <return type="Transform"> + </return> + <description> + 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). + </description> + </method> + <method name="looking_at"> + <return type="Transform"> + </return> + <argument index="0" name="target" type="Vector3"> + </argument> + <argument index="1" name="up" type="Vector3"> + </argument> + <description> + Rotate the transform around the up vector to face the target. + </description> + </method> + <method name="orthonormalized"> + <return type="Transform"> + </return> + <description> + Returns the transfrom with the basis orthogonal (90 degrees), and normalized axis vectors. + </description> + </method> + <method name="rotated"> + <return type="Transform"> + </return> + <argument index="0" name="axis" type="Vector3"> + </argument> + <argument index="1" name="phi" type="float"> + </argument> + <description> + Rotates the transform around given axis by phi. The axis must be a normalized vector. + </description> + </method> + <method name="scaled"> + <return type="Transform"> + </return> + <argument index="0" name="scale" type="Vector3"> + </argument> + <description> + Scales the transform by the specified 3D scaling factors. + </description> + </method> + <method name="translated"> + <return type="Transform"> + </return> + <argument index="0" name="ofs" type="Vector3"> + </argument> + <description> + Translates the transform by the specified offset. + </description> + </method> + <method name="xform"> + <return type="var"> + </return> + <argument index="0" name="v" type="var"> + </argument> + <description> + Transforms the given vector "v" by this transform. + </description> + </method> + <method name="xform_inv"> + <return type="var"> + </return> + <argument index="0" name="v" type="var"> + </argument> + <description> + Inverse-transforms the given vector "v" by this transform. + </description> + </method> + </methods> + <members> + <member name="basis" type="Basis" setter="" getter=""> + 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. + </member> + <member name="origin" type="Vector3" setter="" getter=""> + The translation offset of the transform. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml new file mode 100644 index 0000000000..4cbe9123f1 --- /dev/null +++ b/doc/classes/Transform2D.xml @@ -0,0 +1,177 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Transform2D" category="Built-In Types" version="3.0.alpha.custom_build"> + <brief_description> + 2D Transformation. 3x2 matrix. + </brief_description> + <description> + Represents one or many transformations in 3D space such as translation, rotation, or scaling. It consists of a two [Vector2] x, y and [Vector2] "origin". It is similar to a 3x2 matrix. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="Transform2D"> + <return type="Transform2D"> + </return> + <argument index="0" name="from" type="Transform"> + </argument> + <description> + Constructs the [Transform2D] from a 3D [Transform]. + </description> + </method> + <method name="Transform2D"> + <return type="Transform2D"> + </return> + <argument index="0" name="x_axis" type="Vector2"> + </argument> + <argument index="1" name="y_axis" type="Vector2"> + </argument> + <argument index="2" name="origin" type="Vector2"> + </argument> + <description> + Constructs the [Transform2D] from 3 [Vector2] consisting of rows x, y and origin. + </description> + </method> + <method name="Transform2D"> + <return type="Transform2D"> + </return> + <argument index="0" name="rot" type="float"> + </argument> + <argument index="1" name="pos" type="Vector2"> + </argument> + <description> + Constructs the [Transform2D] from rotation angle in radians and position [Vector2]. + </description> + </method> + <method name="affine_inverse"> + <return type="Transform2D"> + </return> + <description> + Returns the inverse of the matrix. + </description> + </method> + <method name="basis_xform"> + <return type="Transform2D"> + </return> + <argument index="0" name="v" type="var"> + </argument> + <description> + Transforms the given vector "v" by this transform basis (no translation). + </description> + </method> + <method name="basis_xform_inv"> + <return type="Transform2D"> + </return> + <argument index="0" name="v" type="var"> + </argument> + <description> + Inverse-transforms the given vector "v" by this transform basis (no translation). + </description> + </method> + <method name="get_origin"> + <return type="Vector2"> + </return> + <description> + Returns the origin [Vector2] (translation). + </description> + </method> + <method name="get_rotation"> + <return type="float"> + </return> + <description> + Returns the rotation (in radians). + </description> + </method> + <method name="get_scale"> + <return type="Vector2"> + </return> + <description> + Returns the scale. + </description> + </method> + <method name="interpolate_with"> + <return type="Transform2D"> + </return> + <argument index="0" name="transform" type="Transform2D"> + </argument> + <argument index="1" name="weight" type="float"> + </argument> + <description> + Interpolates the transform to other Transform2D by weight amount (0-1). + </description> + </method> + <method name="inverse"> + <return type="Transform2D"> + </return> + <description> + 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). + </description> + </method> + <method name="orthonormalized"> + <return type="Transform2D"> + </return> + <description> + Returns the transfrom with the basis orthogonal (90 degrees), and normalized axis vectors. + </description> + </method> + <method name="rotated"> + <return type="Transform2D"> + </return> + <argument index="0" name="phi" type="float"> + </argument> + <description> + Rotates the transform by phi. + </description> + </method> + <method name="scaled"> + <return type="Transform2D"> + </return> + <argument index="0" name="scale" type="Vector2"> + </argument> + <description> + Scales the transform by the specified 2D scaling factors. + </description> + </method> + <method name="translated"> + <return type="Transform2D"> + </return> + <argument index="0" name="offset" type="Vector2"> + </argument> + <description> + Translates the transform by the specified offset. + </description> + </method> + <method name="xform"> + <return type="Transform2D"> + </return> + <argument index="0" name="v" type="var"> + </argument> + <description> + Transforms the given vector "v" by this transform. + </description> + </method> + <method name="xform_inv"> + <return type="Transform2D"> + </return> + <argument index="0" name="v" type="var"> + </argument> + <description> + Inverse-transforms the given vector "v" by this transform. + </description> + </method> + </methods> + <members> + <member name="origin" type="Vector2" setter="" getter=""> + The translation offset of the transform. + </member> + <member name="x" type="Vector2" setter="" getter=""> + 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. + </member> + <member name="y" type="Vector2" setter="" getter=""> + 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. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Translation.xml b/doc/classes/Translation.xml new file mode 100644 index 0000000000..c0707d26b8 --- /dev/null +++ b/doc/classes/Translation.xml @@ -0,0 +1,81 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Translation" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Language Translation. + </brief_description> + <description> + Translations are resources that can be loaded/unloaded on demand. They map a string to another string. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_message"> + <return type="void"> + </return> + <argument index="0" name="src_message" type="String"> + </argument> + <argument index="1" name="xlated_message" type="String"> + </argument> + <description> + Add a message for translation. + </description> + </method> + <method name="erase_message"> + <return type="void"> + </return> + <argument index="0" name="src_message" type="String"> + </argument> + <description> + Erase a message. + </description> + </method> + <method name="get_locale" qualifiers="const"> + <return type="String"> + </return> + <description> + Return the locale of the translation. + </description> + </method> + <method name="get_message" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="src_message" type="String"> + </argument> + <description> + Return a message for translation. + </description> + </method> + <method name="get_message_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_message_list" qualifiers="const"> + <return type="PoolStringArray"> + </return> + <description> + Return all the messages (keys). + </description> + </method> + <method name="set_locale"> + <return type="void"> + </return> + <argument index="0" name="locale" type="String"> + </argument> + <description> + Set the locale of the translation. + </description> + </method> + </methods> + <members> + <member name="locale" type="String" setter="set_locale" getter="get_locale"> + </member> + <member name="messages" type="PoolStringArray" setter="_set_messages" getter="_get_messages"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/TranslationServer.xml b/doc/classes/TranslationServer.xml new file mode 100644 index 0000000000..974b0e283f --- /dev/null +++ b/doc/classes/TranslationServer.xml @@ -0,0 +1,60 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="TranslationServer" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Server that manages all translations. Translations can be set to it and removed from it. + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_translation"> + <return type="void"> + </return> + <argument index="0" name="translation" type="Translation"> + </argument> + <description> + </description> + </method> + <method name="clear"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="get_locale" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="remove_translation"> + <return type="void"> + </return> + <argument index="0" name="translation" type="Translation"> + </argument> + <description> + </description> + </method> + <method name="set_locale"> + <return type="void"> + </return> + <argument index="0" name="locale" type="String"> + </argument> + <description> + </description> + </method> + <method name="translate" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="message" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml new file mode 100644 index 0000000000..a92a51049b --- /dev/null +++ b/doc/classes/Tree.xml @@ -0,0 +1,495 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Tree" inherits="Control" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Control to show a tree of items. + </brief_description> + <description> + This shows a tree of items that can be selected, expanded and collapsed. The tree can have multiple columns with custom controls like text editing, buttons and popups. It can be useful for structural displaying and interactions. + Trees are built via code, using [TreeItem] objects to create the structure. They have a single root but multiple root can be simulated if a dummy hidden root is added. + [codeblock] + func _ready(): + var tree = Tree.new() + var root = tree.create_item() + tree.set_hide_root(true) + var child1 = tree.create_item(root) + var child2 = tree.create_item(root) + var subchild1 = tree.create_item(child1) + subchild1.set_text(0, "Subchild1") + [/codeblock] + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="are_column_titles_visible" qualifiers="const"> + <return type="bool"> + </return> + <description> + Get whether the column titles are being shown. + </description> + </method> + <method name="clear"> + <return type="void"> + </return> + <description> + Clear the tree. This erases all of the items. + </description> + </method> + <method name="create_item"> + <return type="Object"> + </return> + <argument index="0" name="parent" type="Object" default="null"> + </argument> + <description> + Create an item in the tree and add it as the last child of [code]parent[/code]. If parent is not given, it will be added as the last child of the root, or it'll the be the root itself if the tree is empty. + </description> + </method> + <method name="ensure_cursor_is_visible"> + <return type="void"> + </return> + <description> + Make the current selected item visible. This will scroll the tree to make sure the selected item is in sight. + </description> + </method> + <method name="get_allow_reselect" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_allow_rmb_select" qualifiers="const"> + <return type="bool"> + </return> + <description> + Get whether a right click can select items. + </description> + </method> + <method name="get_column_at_pos" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="pos" type="Vector2"> + </argument> + <description> + Get the column index under the given point. + </description> + </method> + <method name="get_column_title" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <description> + Get the title of the given column. + </description> + </method> + <method name="get_column_width" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <description> + Get the width of the given column in pixels. + </description> + </method> + <method name="get_columns" qualifiers="const"> + <return type="int"> + </return> + <description> + Get the amount of columns. + </description> + </method> + <method name="get_custom_popup_rect" qualifiers="const"> + <return type="Rect2"> + </return> + <description> + Get the rectangle for custom popups. Helper to create custom cell controls that display a popup. See [method TreeItem.set_cell_mode]. + </description> + </method> + <method name="get_drop_mode_flags" qualifiers="const"> + <return type="int"> + </return> + <description> + Get the flags of the current drop mode. + </description> + </method> + <method name="get_drop_section_at_pos" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="pos" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="get_edited" qualifiers="const"> + <return type="TreeItem"> + </return> + <description> + Get the current edited item. This is only available for custom cell mode. + </description> + </method> + <method name="get_edited_column" qualifiers="const"> + <return type="int"> + </return> + <description> + Get the column of the cell for the current edited icon. This is only available for custom cell mode. + </description> + </method> + <method name="get_item_area_rect" qualifiers="const"> + <return type="Rect2"> + </return> + <argument index="0" name="item" type="Object"> + </argument> + <argument index="1" name="column" type="int" default="-1"> + </argument> + <description> + 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. + </description> + </method> + <method name="get_item_at_pos" qualifiers="const"> + <return type="TreeItem"> + </return> + <argument index="0" name="pos" type="Vector2"> + </argument> + <description> + Get the tree item at the specified position (relative to the tree origin position). + </description> + </method> + <method name="get_next_selected"> + <return type="TreeItem"> + </return> + <argument index="0" name="from" type="Object"> + </argument> + <description> + Get the next selected item after the given one. + </description> + </method> + <method name="get_pressed_button" qualifiers="const"> + <return type="int"> + </return> + <description> + Get the index of the last pressed button. + </description> + </method> + <method name="get_root"> + <return type="TreeItem"> + </return> + <description> + Get the root item of the tree. + </description> + </method> + <method name="get_scroll" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Get the current scrolling position. + </description> + </method> + <method name="get_selected" qualifiers="const"> + <return type="TreeItem"> + </return> + <description> + Get the currently selected item. + </description> + </method> + <method name="get_selected_column" qualifiers="const"> + <return type="int"> + </return> + <description> + Get the column number of the current selection. + </description> + </method> + <method name="is_folding_hidden" qualifiers="const"> + <return type="bool"> + </return> + <description> + Get whether the folding arrow is hidden. + </description> + </method> + <method name="set_allow_reselect"> + <return type="void"> + </return> + <argument index="0" name="allow" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_allow_rmb_select"> + <return type="void"> + </return> + <argument index="0" name="allow" type="bool"> + </argument> + <description> + Set whether or not a right mouse button click can select items. + </description> + </method> + <method name="set_column_expand"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="expand" type="bool"> + </argument> + <description> + Set whether a column will have the "Expand" flag of [Control]. + </description> + </method> + <method name="set_column_min_width"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="min_width" type="int"> + </argument> + <description> + Set the minimum width of a column. + </description> + </method> + <method name="set_column_title"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="title" type="String"> + </argument> + <description> + Set the title of a column. + </description> + </method> + <method name="set_column_titles_visible"> + <return type="void"> + </return> + <argument index="0" name="visible" type="bool"> + </argument> + <description> + Set whether the column titles visibility. + </description> + </method> + <method name="set_columns"> + <return type="void"> + </return> + <argument index="0" name="amount" type="int"> + </argument> + <description> + Set the amount of columns. + </description> + </method> + <method name="set_drop_mode_flags"> + <return type="void"> + </return> + <argument index="0" name="flags" type="int"> + </argument> + <description> + Set the drop mode as an OR combination of flags. See [code]DROP_MODE_*[/code] constants. + </description> + </method> + <method name="set_hide_folding"> + <return type="void"> + </return> + <argument index="0" name="hide" type="bool"> + </argument> + <description> + Set whether the folding arrow should be hidden. + </description> + </method> + <method name="set_hide_root"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set whether the root of the tree should be hidden. + </description> + </method> + <method name="set_select_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="Tree.SelectMode"> + </argument> + <description> + Set the selection mode. Use one of the [code]SELECT_*[/code] constants. + </description> + </method> + </methods> + <signals> + <signal name="button_pressed"> + <argument index="0" name="item" type="Object"> + </argument> + <argument index="1" name="column" type="int"> + </argument> + <argument index="2" name="id" type="int"> + </argument> + <description> + Emitted when a button on the tree was pressed (see [method TreeItem.add_button]). + </description> + </signal> + <signal name="cell_selected"> + <description> + Emitted when a cell is selected. + </description> + </signal> + <signal name="column_title_pressed"> + <argument index="0" name="column" type="int"> + </argument> + <description> + </description> + </signal> + <signal name="custom_popup_edited"> + <argument index="0" name="arrow_clicked" type="bool"> + </argument> + <description> + Emitted when a cell with the [code]CELL_MODE_CUSTOM[/code] is clicked to be edited. + </description> + </signal> + <signal name="empty_tree_rmb_selected"> + <argument index="0" name="pos" type="Vector2"> + </argument> + <description> + Emitted when the right mouse button is pressed if RMB selection is active and the tree is empty. + </description> + </signal> + <signal name="item_activated"> + <description> + Emitted when an item is activated (double-clicked). + </description> + </signal> + <signal name="item_collapsed"> + <argument index="0" name="item" type="Object"> + </argument> + <description> + Emitted when an item is collapsed by a click on the folding arrow. + </description> + </signal> + <signal name="item_custom_button_pressed"> + <description> + </description> + </signal> + <signal name="item_double_clicked"> + <description> + </description> + </signal> + <signal name="item_edited"> + <description> + Emitted when an item is editted. + </description> + </signal> + <signal name="item_rmb_edited"> + <description> + </description> + </signal> + <signal name="item_rmb_selected"> + <argument index="0" name="pos" type="Vector2"> + </argument> + <description> + Emitted when an item is selected with right mouse button. + </description> + </signal> + <signal name="item_selected"> + <description> + Emitted when an item is selected with right mouse button. + </description> + </signal> + <signal name="multi_selected"> + <argument index="0" name="item" type="Object"> + </argument> + <argument index="1" name="column" type="int"> + </argument> + <argument index="2" name="selected" type="bool"> + </argument> + <description> + </description> + </signal> + </signals> + <constants> + <constant name="SELECT_SINGLE" value="0"> + </constant> + <constant name="SELECT_ROW" value="1"> + </constant> + <constant name="SELECT_MULTI" value="2"> + </constant> + <constant name="DROP_MODE_DISABLED" value="0"> + </constant> + <constant name="DROP_MODE_ON_ITEM" value="1"> + </constant> + <constant name="DROP_MODE_INBETWEEN" value="2"> + </constant> + </constants> + <theme_items> + <theme_item name="arrow" type="Texture"> + </theme_item> + <theme_item name="arrow_collapsed" type="Texture"> + </theme_item> + <theme_item name="bg" type="StyleBox"> + </theme_item> + <theme_item name="bg_focus" type="StyleBox"> + </theme_item> + <theme_item name="button_margin" type="int"> + </theme_item> + <theme_item name="button_pressed" type="StyleBox"> + </theme_item> + <theme_item name="checked" type="Texture"> + </theme_item> + <theme_item name="cursor" type="StyleBox"> + </theme_item> + <theme_item name="cursor_color" type="Color"> + </theme_item> + <theme_item name="cursor_unfocused" type="StyleBox"> + </theme_item> + <theme_item name="custom_button" type="StyleBox"> + </theme_item> + <theme_item name="custom_button_font_highlight" type="Color"> + </theme_item> + <theme_item name="custom_button_hover" type="StyleBox"> + </theme_item> + <theme_item name="custom_button_pressed" type="StyleBox"> + </theme_item> + <theme_item name="draw_relationship_lines" type="int"> + </theme_item> + <theme_item name="drop_position_color" type="Color"> + </theme_item> + <theme_item name="font" type="Font"> + </theme_item> + <theme_item name="font_color" type="Color"> + </theme_item> + <theme_item name="font_color_selected" type="Color"> + </theme_item> + <theme_item name="guide_color" type="Color"> + </theme_item> + <theme_item name="guide_width" type="int"> + </theme_item> + <theme_item name="hseparation" type="int"> + </theme_item> + <theme_item name="item_margin" type="int"> + </theme_item> + <theme_item name="relationship_line_color" type="Color"> + </theme_item> + <theme_item name="scroll_border" type="int"> + </theme_item> + <theme_item name="scroll_speed" type="int"> + </theme_item> + <theme_item name="select_arrow" type="Texture"> + </theme_item> + <theme_item name="selected" type="StyleBox"> + </theme_item> + <theme_item name="selected_focus" type="StyleBox"> + </theme_item> + <theme_item name="selection_color" type="Color"> + </theme_item> + <theme_item name="title_button_color" type="Color"> + </theme_item> + <theme_item name="title_button_font" type="Font"> + </theme_item> + <theme_item name="title_button_hover" type="StyleBox"> + </theme_item> + <theme_item name="title_button_normal" type="StyleBox"> + </theme_item> + <theme_item name="title_button_pressed" type="StyleBox"> + </theme_item> + <theme_item name="unchecked" type="Texture"> + </theme_item> + <theme_item name="updown" type="Texture"> + </theme_item> + <theme_item name="vseparation" type="int"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml new file mode 100644 index 0000000000..d1e45bd10f --- /dev/null +++ b/doc/classes/TreeItem.xml @@ -0,0 +1,555 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="TreeItem" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_button"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="button" type="Texture"> + </argument> + <argument index="2" name="button_idx" type="int" default="-1"> + </argument> + <argument index="3" name="disabled" type="bool" default="false"> + </argument> + <argument index="4" name="tooltip" type="String" default=""""> + </argument> + <description> + </description> + </method> + <method name="clear_custom_bg_color"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <description> + </description> + </method> + <method name="clear_custom_color"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <description> + </description> + </method> + <method name="deselect"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <description> + </description> + </method> + <method name="erase_button"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="button_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_button" qualifiers="const"> + <return type="Texture"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="button_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_button_count" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_cell_mode" qualifiers="const"> + <return type="int" enum="TreeItem.TreeCellMode"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_children"> + <return type="TreeItem"> + </return> + <description> + </description> + </method> + <method name="get_custom_bg_color" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_custom_minimum_height" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_expand_right" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_icon" qualifiers="const"> + <return type="Texture"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_icon_max_width" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_icon_region" qualifiers="const"> + <return type="Rect2"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_metadata" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_next"> + <return type="TreeItem"> + </return> + <description> + </description> + </method> + <method name="get_next_visible"> + <return type="TreeItem"> + </return> + <description> + </description> + </method> + <method name="get_parent"> + <return type="TreeItem"> + </return> + <description> + </description> + </method> + <method name="get_prev"> + <return type="TreeItem"> + </return> + <description> + </description> + </method> + <method name="get_prev_visible"> + <return type="TreeItem"> + </return> + <description> + </description> + </method> + <method name="get_range" qualifiers="const"> + <return type="float"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_range_config"> + <return type="Dictionary"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_text" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_text_align" qualifiers="const"> + <return type="int" enum="TreeItem.TextAlign"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_tooltip" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <description> + </description> + </method> + <method name="is_button_disabled" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="button_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="is_checked" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <description> + </description> + </method> + <method name="is_collapsed"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_custom_set_as_button" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <description> + </description> + </method> + <method name="is_editable"> + <return type="bool"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <description> + </description> + </method> + <method name="is_folding_disabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_selectable" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <description> + </description> + </method> + <method name="is_selected"> + <return type="bool"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <description> + </description> + </method> + <method name="move_to_bottom"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="move_to_top"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="remove_child"> + <return type="void"> + </return> + <argument index="0" name="child" type="Object"> + </argument> + <description> + </description> + </method> + <method name="select"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_button"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="button_idx" type="int"> + </argument> + <argument index="2" name="button" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_cell_mode"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="mode" type="int" enum="TreeItem.TreeCellMode"> + </argument> + <description> + </description> + </method> + <method name="set_checked"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="checked" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_collapsed"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_custom_as_button"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_custom_bg_color"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <argument index="2" name="just_outline" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="set_custom_color"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="color" type="Color"> + </argument> + <description> + </description> + </method> + <method name="set_custom_draw"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="object" type="Object"> + </argument> + <argument index="2" name="callback" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_custom_minimum_height"> + <return type="void"> + </return> + <argument index="0" name="height" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_disable_folding"> + <return type="void"> + </return> + <argument index="0" name="disable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_editable"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_expand_right"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_icon"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="texture" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_icon_max_width"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="width" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_icon_region"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="region" type="Rect2"> + </argument> + <description> + </description> + </method> + <method name="set_metadata"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="meta" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="set_range"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="value" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_range_config"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="min" type="float"> + </argument> + <argument index="2" name="max" type="float"> + </argument> + <argument index="3" name="step" type="float"> + </argument> + <argument index="4" name="expr" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="set_selectable"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="selectable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_text"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="text" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_text_align"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="text_align" type="int" enum="TreeItem.TextAlign"> + </argument> + <description> + </description> + </method> + <method name="set_tooltip"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="tooltip" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + <constant name="CELL_MODE_STRING" value="0"> + </constant> + <constant name="CELL_MODE_CHECK" value="1"> + </constant> + <constant name="CELL_MODE_RANGE" value="2"> + </constant> + <constant name="CELL_MODE_RANGE_EXPRESSION" value="3"> + </constant> + <constant name="CELL_MODE_ICON" value="4"> + </constant> + <constant name="CELL_MODE_CUSTOM" value="5"> + </constant> + <constant name="ALIGN_LEFT" value="0"> + </constant> + <constant name="ALIGN_CENTER" value="1"> + </constant> + <constant name="ALIGN_RIGHT" value="2"> + </constant> + </constants> +</class> diff --git a/doc/classes/TriangleMesh.xml b/doc/classes/TriangleMesh.xml new file mode 100644 index 0000000000..21b85c1d05 --- /dev/null +++ b/doc/classes/TriangleMesh.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="TriangleMesh" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Tween.xml b/doc/classes/Tween.xml new file mode 100644 index 0000000000..790a82a60a --- /dev/null +++ b/doc/classes/Tween.xml @@ -0,0 +1,477 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Tween" inherits="Node" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Node useful for animations with unknown start and end points. + </brief_description> + <description> + Node useful for animations with unknown start and end points, procedural animations, making one node follow another, and other simple behavior. + Because it is easy to get it wrong, here is a quick usage example: + [codeblock] + 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.start() + [/codeblock] + 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. + Many of the methods accept [code]trans_type[/code] and [code]ease_type[/code]. The first accepts an TRANS_* constant, and refers to the way the timing of the animation is handled (you might want to see [code]http://easings.net/[/code] for some examples). The second accepts an EASE_* constant, and controls the where [code]trans_type[/code] is applied to the interpolation (in the beginning, the end, or both). If you don't know which transision and easing to pick, you can try different TRANS_* constants with EASE_IN_OUT, and use the one that looks best. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="follow_method"> + <return type="bool"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="method" type="String"> + </argument> + <argument index="2" name="initial_val" type="Variant"> + </argument> + <argument index="3" name="target" type="Object"> + </argument> + <argument index="4" name="target_method" type="String"> + </argument> + <argument index="5" name="duration" type="float"> + </argument> + <argument index="6" name="trans_type" type="int" enum="Tween.TransitionType"> + </argument> + <argument index="7" name="ease_type" type="int" enum="Tween.EaseType"> + </argument> + <argument index="8" name="delay" type="float" default="0"> + </argument> + <description> + Follow [code]method[/code] of [code]object[/code] and apply the returned value on [code]target_method[/code] of [code]target[/code], beginning from [code]initial_val[/code] for [code]duration[/code] seconds, [code]delay[/code] later. Methods are animated by calling them with consequitive values. + [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the beginning, the end, or both). You can read more about them in the class description. + </description> + </method> + <method name="follow_property"> + <return type="bool"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="property" type="String"> + </argument> + <argument index="2" name="initial_val" type="Variant"> + </argument> + <argument index="3" name="target" type="Object"> + </argument> + <argument index="4" name="target_property" type="String"> + </argument> + <argument index="5" name="duration" type="float"> + </argument> + <argument index="6" name="trans_type" type="int" enum="Tween.TransitionType"> + </argument> + <argument index="7" name="ease_type" type="int" enum="Tween.EaseType"> + </argument> + <argument index="8" name="delay" type="float" default="0"> + </argument> + <description> + Follow [code]property[/code] of [code]object[/code] and apply it on [code]target_property[/code] of [code]target[/code], beginning from [code]initial_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Note that [code]target:target_property[/code] would equal [code]object:property[/code] at the end of the tween. + [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the beginning, the end, or both). You can read more about them in the class description. + </description> + </method> + <method name="get_runtime" qualifiers="const"> + <return type="float"> + </return> + <description> + Returns the time needed for all tweens to end in seconds, measured from the start. Thus, if you have two tweens, one ending 10 seconds after the start and the other - 20 seconds, it would return 20 seconds, as by that time all tweens would have finished. + </description> + </method> + <method name="get_speed_scale" qualifiers="const"> + <return type="float"> + </return> + <description> + Returns the speed that has been set from editor GUI or [method set_repeat]. + </description> + </method> + <method name="get_tween_process_mode" qualifiers="const"> + <return type="int" enum="Tween.TweenProcessMode"> + </return> + <description> + Returns the process mode that has been set from editor GUI or [method set_tween_process_mode] + </description> + </method> + <method name="interpolate_callback"> + <return type="bool"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="duration" type="float"> + </argument> + <argument index="2" name="callback" type="String"> + </argument> + <argument index="3" name="arg1" type="Variant" default="null"> + </argument> + <argument index="4" name="arg2" type="Variant" default="null"> + </argument> + <argument index="5" name="arg3" type="Variant" default="null"> + </argument> + <argument index="6" name="arg4" type="Variant" default="null"> + </argument> + <argument index="7" name="arg5" type="Variant" default="null"> + </argument> + <description> + Call [code]callback[/code] of [code]object[/code] after [code]duration[/code]. [code]arg1[/code]-[code]arg5[/code] are arguments to be passed to the callback. + </description> + </method> + <method name="interpolate_deferred_callback"> + <return type="bool"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="duration" type="float"> + </argument> + <argument index="2" name="callback" type="String"> + </argument> + <argument index="3" name="arg1" type="Variant" default="null"> + </argument> + <argument index="4" name="arg2" type="Variant" default="null"> + </argument> + <argument index="5" name="arg3" type="Variant" default="null"> + </argument> + <argument index="6" name="arg4" type="Variant" default="null"> + </argument> + <argument index="7" name="arg5" type="Variant" default="null"> + </argument> + <description> + Call [code]callback[/code] of [code]object[/code] after [code]duration[/code] on the main thread (similar to [methog Object.call_deferred). [code]arg1[/code]-[code]arg5[/code] are arguments to be passed to the callback. + </description> + </method> + <method name="interpolate_method"> + <return type="bool"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="method" type="String"> + </argument> + <argument index="2" name="initial_val" type="Variant"> + </argument> + <argument index="3" name="final_val" type="Variant"> + </argument> + <argument index="4" name="duration" type="float"> + </argument> + <argument index="5" name="trans_type" type="int" enum="Tween.TransitionType"> + </argument> + <argument index="6" name="ease_type" type="int" enum="Tween.EaseType"> + </argument> + <argument index="7" name="delay" type="float" default="0"> + </argument> + <description> + Animate [code]method[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecuitive values. + [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the beginning, the end, or both). You can read more about them in the class description. + </description> + </method> + <method name="interpolate_property"> + <return type="bool"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="property" type="String"> + </argument> + <argument index="2" name="initial_val" type="Variant"> + </argument> + <argument index="3" name="final_val" type="Variant"> + </argument> + <argument index="4" name="duration" type="float"> + </argument> + <argument index="5" name="trans_type" type="int" enum="Tween.TransitionType"> + </argument> + <argument index="6" name="ease_type" type="int" enum="Tween.EaseType"> + </argument> + <argument index="7" name="delay" type="float" default="0"> + </argument> + <description> + Animate [code]property[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. + [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the beginning, the end, or both). You can read more about them in the class description. + </description> + </method> + <method name="is_active" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns true if any tweens are currently running, and false otherwise. Note that this method doesn't consider tweens that have ended. + </description> + </method> + <method name="is_repeat" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns true if repeat has been set from editor GUI or [method set_repeat]. + </description> + </method> + <method name="remove"> + <return type="bool"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="key" type="String" default=""""> + </argument> + <description> + Stop animating and completely remove a tween, given its object and property/method pair. Passing empty String as key will remove all tweens for given object. + </description> + </method> + <method name="remove_all"> + <return type="bool"> + </return> + <description> + Stop animating and completely remove all tweens. + </description> + </method> + <method name="reset"> + <return type="bool"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="key" type="String" default=""""> + </argument> + <description> + Resets a tween to the initial value (the one given, not the one before the tween), given its object and property/method pair. Passing empty String as key will reset all tweens for given object. + </description> + </method> + <method name="reset_all"> + <return type="bool"> + </return> + <description> + Resets all tweens to their initial values (the ones given, not those before the tween). + </description> + </method> + <method name="resume"> + <return type="bool"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="key" type="String" default=""""> + </argument> + <description> + Continue animating a stopped tween, given its object and property/method pair. Passing empty String as key will resume all tweens for given object. + </description> + </method> + <method name="resume_all"> + <return type="bool"> + </return> + <description> + Continue animating all stopped tweens. + </description> + </method> + <method name="seek"> + <return type="bool"> + </return> + <argument index="0" name="time" type="float"> + </argument> + <description> + Seek the animation to the given [code]time[/code] in seconds. + </description> + </method> + <method name="set_active"> + <return type="void"> + </return> + <argument index="0" name="active" type="bool"> + </argument> + <description> + Activate/deactivate the tween. You can use this for pausing animations, though [method stop_all] and [method resume_all] might be more fit for this. + </description> + </method> + <method name="set_repeat"> + <return type="void"> + </return> + <argument index="0" name="repeat" type="bool"> + </argument> + <description> + Make the tween repeat after all tweens have finished. + </description> + </method> + <method name="set_speed_scale"> + <return type="void"> + </return> + <argument index="0" name="speed" type="float"> + </argument> + <description> + Set the speed multiplier of the tween. Set it to 1 for normal speed, 2 for two times nromal speed, and 0.5 for half of the normal speed. Setting it to 0 would pause the animation, but you might consider using [method set_active] or [method stop_all] and [method resume_all] for this. + </description> + </method> + <method name="set_tween_process_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="Tween.TweenProcessMode"> + </argument> + <description> + Set whether the Tween uses [code]_process[/code] or [code]_fixed_process[/code] (accepts TWEEN_PROCESS_IDLE and TWEEN_PROCESS_FIXED constants, respectively). + </description> + </method> + <method name="start"> + <return type="bool"> + </return> + <description> + Start the tween node. You can define tweens both before and after this. + </description> + </method> + <method name="stop"> + <return type="bool"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="key" type="String" default=""""> + </argument> + <description> + Stop animating a tween, given its object and property/method pair. Passing empty String as key will stop all tweens for given object. + </description> + </method> + <method name="stop_all"> + <return type="bool"> + </return> + <description> + Stop animating all tweens. + </description> + </method> + <method name="targeting_method"> + <return type="bool"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="method" type="String"> + </argument> + <argument index="2" name="initial" type="Object"> + </argument> + <argument index="3" name="initial_method" type="String"> + </argument> + <argument index="4" name="final_val" type="Variant"> + </argument> + <argument index="5" name="duration" type="float"> + </argument> + <argument index="6" name="trans_type" type="int" enum="Tween.TransitionType"> + </argument> + <argument index="7" name="ease_type" type="int" enum="Tween.EaseType"> + </argument> + <argument index="8" name="delay" type="float" default="0"> + </argument> + <description> + Animate [code]method[/code] of [code]object[/code] from the value returned by [code]initial.initial_method[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecuitive values. + [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the beginning, the end, or both). You can read more about them in the class description. + </description> + </method> + <method name="targeting_property"> + <return type="bool"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="property" type="String"> + </argument> + <argument index="2" name="initial" type="Object"> + </argument> + <argument index="3" name="initial_val" type="String"> + </argument> + <argument index="4" name="final_val" type="Variant"> + </argument> + <argument index="5" name="duration" type="float"> + </argument> + <argument index="6" name="trans_type" type="int" enum="Tween.TransitionType"> + </argument> + <argument index="7" name="ease_type" type="int" enum="Tween.EaseType"> + </argument> + <argument index="8" name="delay" type="float" default="0"> + </argument> + <description> + Animate [code]property[/code] of [code]object[/code] from the current value of the [code]initial_val[/code] property of [code]initial[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. + [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the beginning, the end, or both). You can read more about them in the class description. + </description> + </method> + <method name="tell" qualifiers="const"> + <return type="float"> + </return> + <description> + Returns the current time of the tween. + </description> + </method> + </methods> + <members> + <member name="playback_process_mode" type="int" setter="set_tween_process_mode" getter="get_tween_process_mode" enum="Tween.TweenProcessMode"> + </member> + </members> + <signals> + <signal name="tween_completed"> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="key" type="String"> + </argument> + <description> + This signal is emitted when a tween ends. + </description> + </signal> + <signal name="tween_started"> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="key" type="String"> + </argument> + <description> + This signal is emitted when a tween starts. + </description> + </signal> + <signal name="tween_step"> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="key" type="String"> + </argument> + <argument index="2" name="elapsed" type="float"> + </argument> + <argument index="3" name="value" type="Object"> + </argument> + <description> + This signal is emitted each step of the tweening. + </description> + </signal> + </signals> + <constants> + <constant name="TWEEN_PROCESS_FIXED" value="0"> + The [Tween] should use [code]_fixed_process[/code] for timekeeping when this is enabled. + </constant> + <constant name="TWEEN_PROCESS_IDLE" value="1"> + The [Tween] should use [code]_process[/code] for timekeeping when this is enabled (default). + </constant> + <constant name="TRANS_LINEAR" value="0"> + Means that the animation is interpolated linearly. + </constant> + <constant name="TRANS_SINE" value="1"> + Means that the animation is interpolated using a sine wave. + </constant> + <constant name="TRANS_QUINT" value="2"> + Means that the animation is interpolated with a quinary (to the power of 5) function. + </constant> + <constant name="TRANS_QUART" value="3"> + Means that the animation is interpolated with a quartic (to the power of 4) function. + </constant> + <constant name="TRANS_QUAD" value="4"> + Means that the animation is interpolated with a quadratic (to the power of 2) function. + </constant> + <constant name="TRANS_EXPO" value="5"> + Means that the animation is interpolated with an exponential (some number to the power of x) function. + </constant> + <constant name="TRANS_ELASTIC" value="6"> + Means that the animation is interpolated with elasticity, wiggling around the edges. + </constant> + <constant name="TRANS_CUBIC" value="7"> + Means that the animation is interpolated with a cubic (to the power of 3) function. + </constant> + <constant name="TRANS_CIRC" value="8"> + Means that the animation is interpolated with a function using square roots. + </constant> + <constant name="TRANS_BOUNCE" value="9"> + Means that the animation is interpolated by bouncing at, but never surpassing, the end. + </constant> + <constant name="TRANS_BACK" value="10"> + Means that the animation is interpolated backing out at edges. + </constant> + <constant name="EASE_IN" value="0"> + Signifies that the interpolation should be focused in the beginning. + </constant> + <constant name="EASE_OUT" value="1"> + Signifies that the interpolation should be focused in the end. + </constant> + <constant name="EASE_IN_OUT" value="2"> + Signifies that the interpolation should be focused in both ends. + </constant> + <constant name="EASE_OUT_IN" value="3"> + Signifies that the interpolation should be focused in both ends, but they should be switched (a bit hard to explain, try it for yourself to be sure). + </constant> + </constants> +</class> diff --git a/doc/classes/UndoRedo.xml b/doc/classes/UndoRedo.xml new file mode 100644 index 0000000000..d450a8812e --- /dev/null +++ b/doc/classes/UndoRedo.xml @@ -0,0 +1,154 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="UndoRedo" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Helper to manage UndoRedo in the editor or custom tools. + </brief_description> + <description> + Helper to manage UndoRedo in the editor or custom tools. It works by storing calls to functions in both 'do' an 'undo' lists. + Common behavior is to create an action, then add do/undo calls to functions or property changes, then committing the action. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_do_method" qualifiers="vararg"> + <return type="Variant"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="method" type="String"> + </argument> + <description> + </description> + </method> + <method name="add_do_property"> + <return type="void"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="property" type="String"> + </argument> + <argument index="2" name="value" type="Variant"> + </argument> + <description> + Set a property with a custom value. + </description> + </method> + <method name="add_do_reference"> + <return type="void"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <description> + Add a 'do' reference that will be erased if the 'do' history is lost. This is useful mostly for new nodes created for the 'do' call. Do not use for resources. + </description> + </method> + <method name="add_undo_method" qualifiers="vararg"> + <return type="Variant"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="method" type="String"> + </argument> + <description> + </description> + </method> + <method name="add_undo_property"> + <return type="void"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <argument index="1" name="property" type="String"> + </argument> + <argument index="2" name="value" type="Variant"> + </argument> + <description> + Undo setting of a property with a custom value. + </description> + </method> + <method name="add_undo_reference"> + <return type="void"> + </return> + <argument index="0" name="object" type="Object"> + </argument> + <description> + Add an 'undo' reference that will be erased if the 'undo' history is lost. This is useful mostly for nodes removed with the 'do' call (not the 'undo' call!). + </description> + </method> + <method name="clear_history"> + <return type="void"> + </return> + <description> + Clear the undo/redo history and associated references. + </description> + </method> + <method name="commit_action"> + <return type="void"> + </return> + <description> + Commit the action. All 'do' methods/properties are called/set when this function is called. + </description> + </method> + <method name="create_action"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="merge_mode" type="int" enum="UndoRedo.MergeMode" default="0"> + </argument> + <description> + Create a new action. After this is called, do all your calls to [method add_do_method], [method add_undo_method], [method add_do_property] and [method add_undo_property]. + </description> + </method> + <method name="get_current_action_name" qualifiers="const"> + <return type="String"> + </return> + <description> + Get the name of the current action. + </description> + </method> + <method name="get_max_steps" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_version" qualifiers="const"> + <return type="int"> + </return> + <description> + Get the version, each time a new action is committed, the version number of the UndoRedo is increased automatically. + This is useful mostly to check if something changed from a saved version. + </description> + </method> + <method name="redo"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="set_max_steps"> + <return type="void"> + </return> + <argument index="0" name="max_steps" type="int"> + </argument> + <description> + </description> + </method> + <method name="undo"> + <return type="void"> + </return> + <description> + </description> + </method> + </methods> + <constants> + <constant name="MERGE_DISABLE" value="0"> + </constant> + <constant name="MERGE_ENDS" value="1"> + </constant> + <constant name="MERGE_ALL" value="2"> + </constant> + </constants> +</class> diff --git a/doc/classes/VBoxContainer.xml b/doc/classes/VBoxContainer.xml new file mode 100644 index 0000000000..de544ed031 --- /dev/null +++ b/doc/classes/VBoxContainer.xml @@ -0,0 +1,21 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VBoxContainer" inherits="BoxContainer" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Vertical box container. + </brief_description> + <description> + Vertical box container. See [BoxContainer]. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> + <theme_items> + <theme_item name="separation" type="int"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/VScrollBar.xml b/doc/classes/VScrollBar.xml new file mode 100644 index 0000000000..4510ac1e2e --- /dev/null +++ b/doc/classes/VScrollBar.xml @@ -0,0 +1,36 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VScrollBar" inherits="ScrollBar" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Vertical version of [ScrollBar], which goes from left (min) to right (max). + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> + <theme_items> + <theme_item name="decrement" type="Texture"> + </theme_item> + <theme_item name="decrement_highlight" type="Texture"> + </theme_item> + <theme_item name="grabber" type="StyleBox"> + </theme_item> + <theme_item name="grabber_highlight" type="StyleBox"> + </theme_item> + <theme_item name="grabber_pressed" type="StyleBox"> + </theme_item> + <theme_item name="increment" type="Texture"> + </theme_item> + <theme_item name="increment_highlight" type="Texture"> + </theme_item> + <theme_item name="scroll" type="StyleBox"> + </theme_item> + <theme_item name="scroll_focus" type="StyleBox"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/VSeparator.xml b/doc/classes/VSeparator.xml new file mode 100644 index 0000000000..f98473a148 --- /dev/null +++ b/doc/classes/VSeparator.xml @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VSeparator" inherits="Separator" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Vertical version of [Separator]. + </brief_description> + <description> + Vertical version of [Separator]. It is used to separate objects horizontally, though (but it looks vertical!). + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> + <theme_items> + <theme_item name="separation" type="int"> + </theme_item> + <theme_item name="separator" type="StyleBox"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/VSlider.xml b/doc/classes/VSlider.xml new file mode 100644 index 0000000000..e4ba4a19c5 --- /dev/null +++ b/doc/classes/VSlider.xml @@ -0,0 +1,35 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VSlider" inherits="Slider" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Vertical slider. + </brief_description> + <description> + Vertical slider. See [Slider]. This one goes from left (min) to right (max). + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> + <theme_items> + <theme_item name="focus" type="StyleBox"> + </theme_item> + <theme_item name="grabber" type="Texture"> + </theme_item> + <theme_item name="grabber_disabled" type="Texture"> + </theme_item> + <theme_item name="grabber_disabled" type="StyleBox"> + </theme_item> + <theme_item name="grabber_highlight" type="Texture"> + </theme_item> + <theme_item name="grabber_highlight" type="StyleBox"> + </theme_item> + <theme_item name="slider" type="StyleBox"> + </theme_item> + <theme_item name="tick" type="Texture"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/VSplitContainer.xml b/doc/classes/VSplitContainer.xml new file mode 100644 index 0000000000..aac10841c3 --- /dev/null +++ b/doc/classes/VSplitContainer.xml @@ -0,0 +1,27 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VSplitContainer" inherits="SplitContainer" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Vertical split container. + </brief_description> + <description> + Vertical split container. See [SplitContainer]. This goes from left to right. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> + <theme_items> + <theme_item name="autohide" type="int"> + </theme_item> + <theme_item name="bg" type="StyleBox"> + </theme_item> + <theme_item name="grabber" type="Texture"> + </theme_item> + <theme_item name="separation" type="int"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/Variant.xml b/doc/classes/Variant.xml new file mode 100644 index 0000000000..914ef10036 --- /dev/null +++ b/doc/classes/Variant.xml @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Variant" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + The most important data type in Godot. + </brief_description> + <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. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml new file mode 100644 index 0000000000..510559327f --- /dev/null +++ b/doc/classes/Vector2.xml @@ -0,0 +1,225 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Vector2" category="Built-In Types" version="3.0.alpha.custom_build"> + <brief_description> + Vector used for 2D Math. + </brief_description> + <description> + 2-element structure that can be used to represent positions in 2d-space, or any other pair of numeric values. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="Vector2"> + <return type="Vector2"> + </return> + <argument index="0" name="x" type="float"> + </argument> + <argument index="1" name="y" type="float"> + </argument> + <description> + Constructs a new Vector2 from the given x and y. + </description> + </method> + <method name="abs"> + <return type="Vector2"> + </return> + <description> + Returns a new vector with all components in absolute values (i.e. positive). + </description> + </method> + <method name="angle"> + <return type="float"> + </return> + <description> + Returns the result of atan2 when called with the Vector's x and y as parameters (Math::atan2(x,y)). + Be aware that it therefore returns an angle oriented clockwise with regard to the (0, 1) unit vector, and not an angle oriented counter-clockwise with regard to the (1, 0) unit vector (which would be the typical trigonometric representation of the angle when calling Math::atan2(y,x)). + </description> + </method> + <method name="angle_to"> + <return type="float"> + </return> + <argument index="0" name="to" type="Vector2"> + </argument> + <description> + Returns the angle in radians between the two vectors. + </description> + </method> + <method name="angle_to_point"> + <return type="float"> + </return> + <argument index="0" name="to" type="Vector2"> + </argument> + <description> + Returns the angle in radians between the line connecting the two points and the x coordinate. + </description> + </method> + <method name="aspect"> + <return type="float"> + </return> + <description> + Returns the ratio of X to Y. + </description> + </method> + <method name="bounce"> + <return type="Vector2"> + </return> + <argument index="0" name="n" type="Vector2"> + </argument> + <description> + Bounce returns the vector "bounced off" from the given plane, specified by its normal vector. + </description> + </method> + <method name="clamped"> + <return type="Vector2"> + </return> + <argument index="0" name="length" type="float"> + </argument> + <description> + Returns the vector with a maximum length. + </description> + </method> + <method name="cubic_interpolate"> + <return type="Vector2"> + </return> + <argument index="0" name="b" type="Vector2"> + </argument> + <argument index="1" name="pre_a" type="Vector2"> + </argument> + <argument index="2" name="post_b" type="Vector2"> + </argument> + <argument index="3" name="t" type="float"> + </argument> + <description> + Cubicly interpolates between this Vector and "b", using "pre_a" and "post_b" as handles, and returning the result at position "t". + </description> + </method> + <method name="distance_squared_to"> + <return type="float"> + </return> + <argument index="0" name="to" type="Vector2"> + </argument> + <description> + Returns the squared distance to vector "b". Prefer this function over "distance_to" if you need to sort vectors or need the squared distance for some formula. + </description> + </method> + <method name="distance_to"> + <return type="float"> + </return> + <argument index="0" name="to" type="Vector2"> + </argument> + <description> + Returns the distance to vector "b". + </description> + </method> + <method name="dot"> + <return type="float"> + </return> + <argument index="0" name="with" type="Vector2"> + </argument> + <description> + Returns the dot product with vector "b". + </description> + </method> + <method name="floor"> + <return type="Vector2"> + </return> + <description> + Remove the fractional part of x and y. + </description> + </method> + <method name="is_normalized"> + <return type="bool"> + </return> + <description> + Returns whether the vector is normalized or not. + </description> + </method> + <method name="length"> + <return type="float"> + </return> + <description> + Returns the length of the vector. + </description> + </method> + <method name="length_squared"> + <return type="float"> + </return> + <description> + Returns the squared length of the vector. Prefer this function over "length" if you need to sort vectors or need the squared length for some formula. + </description> + </method> + <method name="linear_interpolate"> + <return type="Vector2"> + </return> + <argument index="0" name="b" type="Vector2"> + </argument> + <argument index="1" name="t" type="float"> + </argument> + <description> + Returns the result of the linear interpolation between this vector and "b", by amount "t". + </description> + </method> + <method name="normalized"> + <return type="Vector2"> + </return> + <description> + Returns a normalized vector to unit length. + </description> + </method> + <method name="reflect"> + <return type="Vector2"> + </return> + <argument index="0" name="n" type="Vector2"> + </argument> + <description> + Reflects the vector along the given plane, specified by its normal vector. + </description> + </method> + <method name="rotated"> + <return type="Vector2"> + </return> + <argument index="0" name="phi" type="float"> + </argument> + <description> + Rotates the vector by "phi" radians. + </description> + </method> + <method name="slide"> + <return type="Vector2"> + </return> + <argument index="0" name="n" type="Vector2"> + </argument> + <description> + Slide returns the component of the vector along the given plane, specified by its normal vector. + </description> + </method> + <method name="snapped"> + <return type="Vector2"> + </return> + <argument index="0" name="by" type="Vector2"> + </argument> + <description> + Snaps the vector to a grid with the given size. + </description> + </method> + <method name="tangent"> + <return type="Vector2"> + </return> + <description> + Returns a perpendicular vector. + </description> + </method> + </methods> + <members> + <member name="x" type="float" setter="" getter=""> + X component of the vector. + </member> + <member name="y" type="float" setter="" getter=""> + Y component of the vector. + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml new file mode 100644 index 0000000000..fdbdabafd3 --- /dev/null +++ b/doc/classes/Vector3.xml @@ -0,0 +1,253 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Vector3" category="Built-In Types" version="3.0.alpha.custom_build"> + <brief_description> + Vector class, which performs basic 3D vector math operations. + </brief_description> + <description> + Vector3 is one of the core classes of the engine, and includes several built-in helper functions to perform basic vector math operations. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="Vector3"> + <return type="Vector3"> + </return> + <argument index="0" name="x" type="float"> + </argument> + <argument index="1" name="y" type="float"> + </argument> + <argument index="2" name="z" type="float"> + </argument> + <description> + Returns a Vector3 with the given components. + </description> + </method> + <method name="abs"> + <return type="Vector3"> + </return> + <description> + Returns a new vector with all components in absolute values (i.e. positive). + </description> + </method> + <method name="angle_to"> + <return type="float"> + </return> + <argument index="0" name="to" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="bounce"> + <return type="Vector3"> + </return> + <argument index="0" name="n" type="Vector3"> + </argument> + <description> + Bounce returns the vector "bounced off" from the given plane, specified by its normal vector. + </description> + </method> + <method name="ceil"> + <return type="Vector3"> + </return> + <description> + Returns a new vector with all components rounded up. + </description> + </method> + <method name="cross"> + <return type="Vector3"> + </return> + <argument index="0" name="b" type="Vector3"> + </argument> + <description> + Return the cross product with b. + </description> + </method> + <method name="cubic_interpolate"> + <return type="Vector3"> + </return> + <argument index="0" name="b" type="Vector3"> + </argument> + <argument index="1" name="pre_a" type="Vector3"> + </argument> + <argument index="2" name="post_b" type="Vector3"> + </argument> + <argument index="3" name="t" type="float"> + </argument> + <description> + Perform a cubic interpolation between vectors pre_a, a, b, post_b (a is current), by the given amount (t). + </description> + </method> + <method name="distance_squared_to"> + <return type="float"> + </return> + <argument index="0" name="b" type="Vector3"> + </argument> + <description> + Return the squared distance (distance minus the last square root) to b. Prefer this function over distance_to if you need to sort vectors or need the squared distance for some formula. + </description> + </method> + <method name="distance_to"> + <return type="float"> + </return> + <argument index="0" name="b" type="Vector3"> + </argument> + <description> + Return the distance to b. + </description> + </method> + <method name="dot"> + <return type="float"> + </return> + <argument index="0" name="b" type="Vector3"> + </argument> + <description> + Return the dot product with b. + </description> + </method> + <method name="floor"> + <return type="Vector3"> + </return> + <description> + Returns a new vector with all components rounded down. + </description> + </method> + <method name="inverse"> + <return type="Vector3"> + </return> + <description> + Returns the inverse of the vector. This is the same as Vector3( 1.0 / v.x, 1.0 / v.y, 1.0 / v.z ) + </description> + </method> + <method name="is_normalized"> + <return type="bool"> + </return> + <description> + Returns whether the vector is normalized or not. + </description> + </method> + <method name="length"> + <return type="float"> + </return> + <description> + Return the length of the vector. + </description> + </method> + <method name="length_squared"> + <return type="float"> + </return> + <description> + Return the length of the vector, squared. Prefer this function over "length" if you need to sort vectors or need the squared length for some formula. + </description> + </method> + <method name="linear_interpolate"> + <return type="Vector3"> + </return> + <argument index="0" name="b" type="Vector3"> + </argument> + <argument index="1" name="t" type="float"> + </argument> + <description> + Linearly interpolates the vector to a given one (b), by the given amount (t). + </description> + </method> + <method name="max_axis"> + <return type="int"> + </return> + <description> + Returns AXIS_X, AXIS_Y or AXIS_Z depending on which axis is the largest. + </description> + </method> + <method name="min_axis"> + <return type="int"> + </return> + <description> + Returns AXIS_X, AXIS_Y or AXIS_Z depending on which axis is the smallest. + </description> + </method> + <method name="normalized"> + <return type="Vector3"> + </return> + <description> + Return a copy of the normalized vector to unit length. This is the same as v / v.length(). + </description> + </method> + <method name="outer"> + <return type="Basis"> + </return> + <argument index="0" name="b" type="Vector3"> + </argument> + <description> + Return the outer product with b. + </description> + </method> + <method name="reflect"> + <return type="Vector3"> + </return> + <argument index="0" name="n" type="Vector3"> + </argument> + <description> + Reflects the vector along the given plane, specified by its normal vector. + </description> + </method> + <method name="rotated"> + <return type="Vector3"> + </return> + <argument index="0" name="axis" type="Vector3"> + </argument> + <argument index="1" name="phi" type="float"> + </argument> + <description> + Rotates the vector around some axis by phi radians. The axis must be a normalized vector. + </description> + </method> + <method name="slide"> + <return type="Vector3"> + </return> + <argument index="0" name="n" type="Vector3"> + </argument> + <description> + Slide returns the component of the vector along the given plane, specified by its normal vector. + </description> + </method> + <method name="snapped"> + <return type="Vector3"> + </return> + <argument index="0" name="by" type="float"> + </argument> + <description> + Return a copy of the vector, snapped to the lowest neared multiple. + </description> + </method> + <method name="to_diagonal_matrix"> + <return type="Basis"> + </return> + <description> + Return a diagonal matrix with the vector as main diagonal. + </description> + </method> + </methods> + <members> + <member name="x" type="float" setter="" getter=""> + X component of the vector. + </member> + <member name="y" type="float" setter="" getter=""> + Y component of the vector. + </member> + <member name="z" type="float" setter="" getter=""> + Z component of the vector. + </member> + </members> + <constants> + <constant name="AXIS_X" value="0" enum=""> + Enumerated value for the X axis. Returned by functions like max_axis or min_axis. + </constant> + <constant name="AXIS_Y" value="1" enum=""> + Enumerated value for the Y axis. + </constant> + <constant name="AXIS_Z" value="2" enum=""> + Enumerated value for the Z axis. + </constant> + </constants> +</class> diff --git a/doc/classes/VehicleBody.xml b/doc/classes/VehicleBody.xml new file mode 100644 index 0000000000..48202665fb --- /dev/null +++ b/doc/classes/VehicleBody.xml @@ -0,0 +1,110 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VehicleBody" inherits="PhysicsBody" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_brake" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_engine_force" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_friction" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_linear_velocity" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + Returns the VehicleBody's velocity vector. To get the absolute speed in scalar value, get the length of the return vector in pixels/second. Example: + [codeblock] + # vehicle is an instance of VehicleBody + var speed = vehicle.get_linear_velocity().length() + [/codeblock] + </description> + </method> + <method name="get_mass" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_steering" qualifiers="const"> + <return type="float"> + </return> + <description> + Return the steering angle (in radians). + </description> + </method> + <method name="set_brake"> + <return type="void"> + </return> + <argument index="0" name="brake" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_engine_force"> + <return type="void"> + </return> + <argument index="0" name="engine_force" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_friction"> + <return type="void"> + </return> + <argument index="0" name="friction" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_mass"> + <return type="void"> + </return> + <argument index="0" name="mass" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_steering"> + <return type="void"> + </return> + <argument index="0" name="steering" type="float"> + </argument> + <description> + Set the steering angle (in radians). + </description> + </method> + </methods> + <members> + <member name="brake" type="float" setter="set_brake" getter="get_brake"> + </member> + <member name="engine_force" type="float" setter="set_engine_force" getter="get_engine_force"> + </member> + <member name="friction" type="float" setter="set_friction" getter="get_friction"> + </member> + <member name="mass" type="float" setter="set_mass" getter="get_mass"> + </member> + <member name="steering" type="float" setter="set_steering" getter="get_steering"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VehicleWheel.xml b/doc/classes/VehicleWheel.xml new file mode 100644 index 0000000000..82e93e0f01 --- /dev/null +++ b/doc/classes/VehicleWheel.xml @@ -0,0 +1,199 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VehicleWheel" inherits="Spatial" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_damping_compression" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_damping_relaxation" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_friction_slip" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_radius" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_roll_influence" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_suspension_max_force" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_suspension_rest_length" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_suspension_stiffness" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_suspension_travel" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="is_in_contact" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_used_as_steering" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_used_as_traction" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_damping_compression"> + <return type="void"> + </return> + <argument index="0" name="length" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_damping_relaxation"> + <return type="void"> + </return> + <argument index="0" name="length" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_friction_slip"> + <return type="void"> + </return> + <argument index="0" name="length" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_radius"> + <return type="void"> + </return> + <argument index="0" name="length" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_roll_influence"> + <return type="void"> + </return> + <argument index="0" name="roll_influence" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_suspension_max_force"> + <return type="void"> + </return> + <argument index="0" name="length" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_suspension_rest_length"> + <return type="void"> + </return> + <argument index="0" name="length" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_suspension_stiffness"> + <return type="void"> + </return> + <argument index="0" name="length" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_suspension_travel"> + <return type="void"> + </return> + <argument index="0" name="length" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_use_as_steering"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_use_as_traction"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="damping_compression" type="float" setter="set_damping_compression" getter="get_damping_compression"> + </member> + <member name="damping_relaxation" type="float" setter="set_damping_relaxation" getter="get_damping_relaxation"> + </member> + <member name="suspension_max_force" type="float" setter="set_suspension_max_force" getter="get_suspension_max_force"> + </member> + <member name="suspension_stiffness" type="float" setter="set_suspension_stiffness" getter="get_suspension_stiffness"> + </member> + <member name="suspension_travel" type="float" setter="set_suspension_travel" getter="get_suspension_travel"> + </member> + <member name="use_as_steering" type="bool" setter="set_use_as_steering" getter="is_used_as_steering"> + </member> + <member name="use_as_traction" type="bool" setter="set_use_as_traction" getter="is_used_as_traction"> + </member> + <member name="wheel_friction_slip" type="float" setter="set_friction_slip" getter="get_friction_slip"> + </member> + <member name="wheel_radius" type="float" setter="set_radius" getter="get_radius"> + </member> + <member name="wheel_rest_length" type="float" setter="set_suspension_rest_length" getter="get_suspension_rest_length"> + </member> + <member name="wheel_roll_influence" type="float" setter="set_roll_influence" getter="get_roll_influence"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VideoPlayer.xml b/doc/classes/VideoPlayer.xml new file mode 100644 index 0000000000..7994c1b65a --- /dev/null +++ b/doc/classes/VideoPlayer.xml @@ -0,0 +1,201 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VideoPlayer" inherits="Control" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Control to play video files. + </brief_description> + <description> + This control has the ability to play video streams. The only format accepted is the OGV Theora, so any other format must be converted before using in a project. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_audio_track" qualifiers="const"> + <return type="int"> + </return> + <description> + Get the selected audio track (for multitrack videos). + </description> + </method> + <method name="get_buffering_msec" qualifiers="const"> + <return type="int"> + </return> + <description> + Get the amount of miliseconds to store in buffer while playing. + </description> + </method> + <method name="get_stream" qualifiers="const"> + <return type="VideoStream"> + </return> + <description> + Get the video stream. + </description> + </method> + <method name="get_stream_name" qualifiers="const"> + <return type="String"> + </return> + <description> + Get the name of the video stream. + </description> + </method> + <method name="get_stream_pos" qualifiers="const"> + <return type="float"> + </return> + <description> + Get the current position of the stream, in seconds. + </description> + </method> + <method name="get_video_texture"> + <return type="Texture"> + </return> + <description> + Get the current frame of the video as a [Texture]. + </description> + </method> + <method name="get_volume" qualifiers="const"> + <return type="float"> + </return> + <description> + Get the volume of the audio track as a linear value. + </description> + </method> + <method name="get_volume_db" qualifiers="const"> + <return type="float"> + </return> + <description> + Get the volume of the audio track in decibels. + </description> + </method> + <method name="has_autoplay" qualifiers="const"> + <return type="bool"> + </return> + <description> + Get whether or not the video is set as autoplay. + </description> + </method> + <method name="has_expand" qualifiers="const"> + <return type="bool"> + </return> + <description> + Get whether or not the expand property is set. + </description> + </method> + <method name="is_paused" qualifiers="const"> + <return type="bool"> + </return> + <description> + Get whether or not the video is paused. + </description> + </method> + <method name="is_playing" qualifiers="const"> + <return type="bool"> + </return> + <description> + Get whether or not the video is playing. + </description> + </method> + <method name="play"> + <return type="void"> + </return> + <description> + Start the video playback. + </description> + </method> + <method name="set_audio_track"> + <return type="void"> + </return> + <argument index="0" name="track" type="int"> + </argument> + <description> + Set the audio track (for multitrack videos). + </description> + </method> + <method name="set_autoplay"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Set whether this node should start playing automatically. + </description> + </method> + <method name="set_buffering_msec"> + <return type="void"> + </return> + <argument index="0" name="msec" type="int"> + </argument> + <description> + Set the amount of miliseconds to buffer during playback. + </description> + </method> + <method name="set_expand"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set the expand property. If enabled, the video will grow or shrink to fit the player size, otherwise it will play at the stream resolution. + </description> + </method> + <method name="set_paused"> + <return type="void"> + </return> + <argument index="0" name="paused" type="bool"> + </argument> + <description> + Set whether the video should pause the playback. + </description> + </method> + <method name="set_stream"> + <return type="void"> + </return> + <argument index="0" name="stream" type="VideoStream"> + </argument> + <description> + Set the video stream for this player. + </description> + </method> + <method name="set_volume"> + <return type="void"> + </return> + <argument index="0" name="volume" type="float"> + </argument> + <description> + Set the audio volume as a linear value. + </description> + </method> + <method name="set_volume_db"> + <return type="void"> + </return> + <argument index="0" name="db" type="float"> + </argument> + <description> + Set the audio volume in decibels. + </description> + </method> + <method name="stop"> + <return type="void"> + </return> + <description> + Stop the video playback. + </description> + </method> + </methods> + <members> + <member name="audio_track" type="int" setter="set_audio_track" getter="get_audio_track"> + </member> + <member name="autoplay" type="bool" setter="set_autoplay" getter="has_autoplay"> + </member> + <member name="expand" type="bool" setter="set_expand" getter="has_expand"> + </member> + <member name="paused" type="bool" setter="set_paused" getter="is_paused"> + </member> + <member name="stream" type="VideoStream" setter="set_stream" getter="get_stream"> + </member> + <member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VideoStream.xml b/doc/classes/VideoStream.xml new file mode 100644 index 0000000000..c282cdfbd0 --- /dev/null +++ b/doc/classes/VideoStream.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VideoStream" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml new file mode 100644 index 0000000000..a5170b8d03 --- /dev/null +++ b/doc/classes/Viewport.xml @@ -0,0 +1,668 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Viewport" inherits="Node" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Creates a sub-view into the screen. + </brief_description> + <description> + A Viewport creates a different view into the screen, or a sub-view inside another viewport. Children 2D Nodes will display on it, and children Camera 3D nodes will render on it too. + Optionally, a viewport can have its own 2D or 3D world, so they don't share what they draw with other viewports. + If a viewport is a child of a [Control], it will automatically take up its same rect and position, otherwise they must be set manually. + Viewports can also choose to be audio listeners, so they generate positional audio depending on a 2D or 3D camera child of it. + Also, viewports can be assigned to different screens in case the devices have multiple screens. + Finally, viewports can also behave as render targets, in which case they will not be visible unless the associated texture is used to draw. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="find_world" qualifiers="const"> + <return type="World"> + </return> + <description> + Return the 3D world of the viewport, or if no such present, the one of the parent viewport. + </description> + </method> + <method name="find_world_2d" qualifiers="const"> + <return type="World2D"> + </return> + <description> + Return the 2D world of the viewport. + </description> + </method> + <method name="get_camera" qualifiers="const"> + <return type="Camera"> + </return> + <description> + Return the active 3D camera. + </description> + </method> + <method name="get_canvas_transform" qualifiers="const"> + <return type="Transform2D"> + </return> + <description> + Get the canvas transform of the viewport. + </description> + </method> + <method name="get_clear_mode" qualifiers="const"> + <return type="int" enum="Viewport.ClearMode"> + </return> + <description> + </description> + </method> + <method name="get_debug_draw" qualifiers="const"> + <return type="int" enum="Viewport.DebugDraw"> + </return> + <description> + </description> + </method> + <method name="get_final_transform" qualifiers="const"> + <return type="Transform2D"> + </return> + <description> + Get the total transform of the viewport. + </description> + </method> + <method name="get_global_canvas_transform" qualifiers="const"> + <return type="Transform2D"> + </return> + <description> + Get the global canvas transform of the viewport. + </description> + </method> + <method name="get_hdr" qualifiers="const"> + <return type="bool"> + </return> + <description> + Get whether the rendered texture has filters enabled. + </description> + </method> + <method name="get_mouse_position" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Get the mouse position, relative to the viewport. + </description> + </method> + <method name="get_msaa" qualifiers="const"> + <return type="int" enum="Viewport.MSAA"> + </return> + <description> + </description> + </method> + <method name="get_physics_object_picking"> + <return type="bool"> + </return> + <description> + Get whether picking for all physics objects inside the viewport is enabled. + </description> + </method> + <method name="get_render_info"> + <return type="int"> + </return> + <argument index="0" name="info" type="int" enum="Viewport.RenderInfo"> + </argument> + <description> + </description> + </method> + <method name="get_shadow_atlas_quadrant_subdiv" qualifiers="const"> + <return type="int" enum="Viewport.ShadowAtlasQuadrantSubdiv"> + </return> + <argument index="0" name="quadrant" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_shadow_atlas_size" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_size" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Return the viewport rect. If the viewport is child of a control, it will use the same rect as the parent. Otherwise, if the rect is empty, the viewport will use all the allowed space. + </description> + </method> + <method name="get_size_override" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + Get the size override set with [method set_size_override]. + </description> + </method> + <method name="get_texture" qualifiers="const"> + <return type="ViewportTexture"> + </return> + <description> + Get the viewport's texture, for use with various objects that you want to texture with the viewport. + </description> + </method> + <method name="get_update_mode" qualifiers="const"> + <return type="int" enum="Viewport.UpdateMode"> + </return> + <description> + Get when the viewport would be updated, will be one of the [code]UPDATE_*[/code] constants. + </description> + </method> + <method name="get_usage" qualifiers="const"> + <return type="int" enum="Viewport.Usage"> + </return> + <description> + </description> + </method> + <method name="get_vflip" qualifiers="const"> + <return type="bool"> + </return> + <description> + Set whether the render target is flipped on the Y axis. + </description> + </method> + <method name="get_viewport_rid" qualifiers="const"> + <return type="RID"> + </return> + <description> + Get the viewport RID from the [VisualServer]. + </description> + </method> + <method name="get_visible_rect" qualifiers="const"> + <return type="Rect2"> + </return> + <description> + Return the final, visible rect in global screen coordinates. + </description> + </method> + <method name="get_world" qualifiers="const"> + <return type="World"> + </return> + <description> + Return the 3D world of the viewport. + </description> + </method> + <method name="get_world_2d" qualifiers="const"> + <return type="World2D"> + </return> + <description> + Return the 2D world of the viewport. + </description> + </method> + <method name="gui_get_drag_data" qualifiers="const"> + <return type="Variant"> + </return> + <description> + Returs the drag data from the GUI, that was previously returned by [method Control.get_drag_data]. + </description> + </method> + <method name="gui_has_modal_stack" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returs whether there are shown modals on-screen. + </description> + </method> + <method name="has_transparent_background" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether the viewport lets whatever is behind it to show. + </description> + </method> + <method name="input"> + <return type="void"> + </return> + <argument index="0" name="local_event" type="InputEvent"> + </argument> + <description> + </description> + </method> + <method name="is_3d_disabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_audio_listener" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns whether the viewport sends sounds to the speakers. + </description> + </method> + <method name="is_audio_listener_2d" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns whether the viewport sends soundsfrom 2D emitters to the speakers. + </description> + </method> + <method name="is_input_disabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether input to the viewport is disabled. + </description> + </method> + <method name="is_size_override_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + Get the enabled status of the size override set with [method set_size_override]. + </description> + </method> + <method name="is_size_override_stretch_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + Get the enabled status of the size strech override set with [method set_size_override_stretch]. + </description> + </method> + <method name="is_snap_controls_to_pixels_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="is_using_own_world" qualifiers="const"> + <return type="bool"> + </return> + <description> + Return whether the viewport is using a world separate from the parent viewport's world. + </description> + </method> + <method name="set_as_audio_listener"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Makes the viewport send sounds to the speakers. + </description> + </method> + <method name="set_as_audio_listener_2d"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Makes the viewport send sounds from 2D emitters to the speakers. + </description> + </method> + <method name="set_attach_to_screen_rect"> + <return type="void"> + </return> + <argument index="0" name="rect" type="Rect2"> + </argument> + <description> + </description> + </method> + <method name="set_canvas_transform"> + <return type="void"> + </return> + <argument index="0" name="xform" type="Transform2D"> + </argument> + <description> + Set the canvas transform of the viewport, useful for changing the on-screen positions of all child [CanvasItem]\ s. This is relative to the global canvas transform of the viewport. + </description> + </method> + <method name="set_clear_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="Viewport.ClearMode"> + </argument> + <description> + </description> + </method> + <method name="set_debug_draw"> + <return type="void"> + </return> + <argument index="0" name="debug_draw" type="int" enum="Viewport.DebugDraw"> + </argument> + <description> + </description> + </method> + <method name="set_disable_3d"> + <return type="void"> + </return> + <argument index="0" name="disable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_disable_input"> + <return type="void"> + </return> + <argument index="0" name="disable" type="bool"> + </argument> + <description> + Set whether input to the viewport is disabled. + </description> + </method> + <method name="set_global_canvas_transform"> + <return type="void"> + </return> + <argument index="0" name="xform" type="Transform2D"> + </argument> + <description> + Set the global canvas transform of the viewport. The canvas transform is relative to this. + </description> + </method> + <method name="set_hdr"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_msaa"> + <return type="void"> + </return> + <argument index="0" name="msaa" type="int" enum="Viewport.MSAA"> + </argument> + <description> + </description> + </method> + <method name="set_physics_object_picking"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Enable/disable picking for all physics objects inside the viewport. + </description> + </method> + <method name="set_shadow_atlas_quadrant_subdiv"> + <return type="void"> + </return> + <argument index="0" name="quadrant" type="int"> + </argument> + <argument index="1" name="subdiv" type="int" enum="Viewport.ShadowAtlasQuadrantSubdiv"> + </argument> + <description> + </description> + </method> + <method name="set_shadow_atlas_size"> + <return type="void"> + </return> + <argument index="0" name="size" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_size"> + <return type="void"> + </return> + <argument index="0" name="size" type="Vector2"> + </argument> + <description> + Set the size of the viewport. + </description> + </method> + <method name="set_size_override"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <argument index="1" name="size" type="Vector2" default="Vector2( -1, -1 )"> + </argument> + <argument index="2" name="margin" type="Vector2" default="Vector2( 0, 0 )"> + </argument> + <description> + Set the size override of the viewport. If the enable parameter is true, it would use the override, otherwise it would use the default size. If the size parameter is equal to [code](-1, -1)[/code], it won't update the size. + </description> + </method> + <method name="set_size_override_stretch"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Set whether the size override affects stretch as well. + </description> + </method> + <method name="set_snap_controls_to_pixels"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_transparent_background"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + If this viewport is a child of another viewport, keep the previously drawn background visible. + </description> + </method> + <method name="set_update_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="Viewport.UpdateMode"> + </argument> + <description> + Set when the render target would be updated, using the [code]UPDATE_*[/code] constants + </description> + </method> + <method name="set_usage"> + <return type="void"> + </return> + <argument index="0" name="usage" type="int" enum="Viewport.Usage"> + </argument> + <description> + </description> + </method> + <method name="set_use_arvr"> + <return type="void"> + </return> + <argument index="0" name="use" type="bool"> + </argument> + <description> + 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. + </description> + </method> + <method name="set_use_own_world"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Make the viewport use a world separate from the parent viewport's world. + </description> + </method> + <method name="set_vflip"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + Set whether the viewport is flipped on the Y axis. + </description> + </method> + <method name="set_world"> + <return type="void"> + </return> + <argument index="0" name="world" type="World"> + </argument> + <description> + Change the 3D world of the viewport. + </description> + </method> + <method name="set_world_2d"> + <return type="void"> + </return> + <argument index="0" name="world_2d" type="World2D"> + </argument> + <description> + </description> + </method> + <method name="unhandled_input"> + <return type="void"> + </return> + <argument index="0" name="local_event" type="InputEvent"> + </argument> + <description> + </description> + </method> + <method name="update_worlds"> + <return type="void"> + </return> + <description> + Force update of the 2D and 3D worlds. + </description> + </method> + <method name="use_arvr"> + <return type="bool"> + </return> + <description> + Returns whether this viewport is using our ARVR Server + </description> + </method> + <method name="warp_mouse"> + <return type="void"> + </return> + <argument index="0" name="to_pos" type="Vector2"> + </argument> + <description> + Warp the mouse to a position, relative to the viewport. + </description> + </method> + </methods> + <members> + <member name="arvr" type="bool" setter="set_use_arvr" getter="use_arvr"> + </member> + <member name="audio_listener_enable_2d" type="bool" setter="set_as_audio_listener_2d" getter="is_audio_listener_2d"> + </member> + <member name="audio_listener_enable_3d" type="bool" setter="set_as_audio_listener" getter="is_audio_listener"> + </member> + <member name="debug_draw" type="int" setter="set_debug_draw" getter="get_debug_draw" enum="Viewport.DebugDraw"> + </member> + <member name="disable_3d" type="bool" setter="set_disable_3d" getter="is_3d_disabled"> + </member> + <member name="gui_disable_input" type="bool" setter="set_disable_input" getter="is_input_disabled"> + </member> + <member name="gui_snap_controls_to_pixels" type="bool" setter="set_snap_controls_to_pixels" getter="is_snap_controls_to_pixels_enabled"> + </member> + <member name="hdr" type="bool" setter="set_hdr" getter="get_hdr"> + </member> + <member name="msaa" type="int" setter="set_msaa" getter="get_msaa" enum="Viewport.MSAA"> + </member> + <member name="own_world" type="bool" setter="set_use_own_world" getter="is_using_own_world"> + </member> + <member name="physics_object_picking" type="bool" setter="set_physics_object_picking" getter="get_physics_object_picking"> + </member> + <member name="render_target_clear_mode" type="int" setter="set_clear_mode" getter="get_clear_mode" enum="Viewport.ClearMode"> + </member> + <member name="render_target_update_mode" type="int" setter="set_update_mode" getter="get_update_mode" enum="Viewport.UpdateMode"> + </member> + <member name="render_target_v_flip" type="bool" setter="set_vflip" getter="get_vflip"> + </member> + <member name="shadow_atlas_quad_0" type="int" setter="set_shadow_atlas_quadrant_subdiv" getter="get_shadow_atlas_quadrant_subdiv" enum="Viewport.ShadowAtlasQuadrantSubdiv"> + </member> + <member name="shadow_atlas_quad_1" type="int" setter="set_shadow_atlas_quadrant_subdiv" getter="get_shadow_atlas_quadrant_subdiv" enum="Viewport.ShadowAtlasQuadrantSubdiv"> + </member> + <member name="shadow_atlas_quad_2" type="int" setter="set_shadow_atlas_quadrant_subdiv" getter="get_shadow_atlas_quadrant_subdiv" enum="Viewport.ShadowAtlasQuadrantSubdiv"> + </member> + <member name="shadow_atlas_quad_3" type="int" setter="set_shadow_atlas_quadrant_subdiv" getter="get_shadow_atlas_quadrant_subdiv" enum="Viewport.ShadowAtlasQuadrantSubdiv"> + </member> + <member name="shadow_atlas_size" type="int" setter="set_shadow_atlas_size" getter="get_shadow_atlas_size"> + </member> + <member name="size" type="Vector2" setter="set_size" getter="get_size"> + </member> + <member name="transparent_bg" type="bool" setter="set_transparent_background" getter="has_transparent_background"> + </member> + <member name="usage" type="int" setter="set_usage" getter="get_usage" enum="Viewport.Usage"> + </member> + <member name="world" type="World" setter="set_world" getter="get_world"> + </member> + </members> + <signals> + <signal name="size_changed"> + <description> + Emitted when the size of the viewport is changed, whether by [method set_size_override], resize of window, or some other means. + </description> + </signal> + </signals> + <constants> + <constant name="UPDATE_DISABLED" value="0"> + Do not update the render target. + </constant> + <constant name="UPDATE_ONCE" value="1"> + Update the render target once, then switch to [code]UPDATE_DISABLED[/code] + </constant> + <constant name="UPDATE_WHEN_VISIBLE" value="2"> + Update the render target only when it is visible. This is the default value. + </constant> + <constant name="UPDATE_ALWAYS" value="3"> + </constant> + <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_DISABLED" value="0"> + </constant> + <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_1" value="1"> + </constant> + <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_4" value="2"> + </constant> + <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_16" value="3"> + </constant> + <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_64" value="4"> + </constant> + <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_256" value="5"> + </constant> + <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_1024" value="6"> + </constant> + <constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_MAX" value="7"> + </constant> + <constant name="RENDER_INFO_OBJECTS_IN_FRAME" value="0"> + </constant> + <constant name="RENDER_INFO_VERTICES_IN_FRAME" value="1"> + </constant> + <constant name="RENDER_INFO_MATERIAL_CHANGES_IN_FRAME" value="2"> + </constant> + <constant name="RENDER_INFO_SHADER_CHANGES_IN_FRAME" value="3"> + </constant> + <constant name="RENDER_INFO_SURFACE_CHANGES_IN_FRAME" value="4"> + </constant> + <constant name="RENDER_INFO_DRAW_CALLS_IN_FRAME" value="5"> + </constant> + <constant name="RENDER_INFO_MAX" value="6"> + </constant> + <constant name="DEBUG_DRAW_DISABLED" value="0"> + </constant> + <constant name="DEBUG_DRAW_UNSHADED" value="1"> + </constant> + <constant name="DEBUG_DRAW_OVERDRAW" value="2"> + </constant> + <constant name="DEBUG_DRAW_WIREFRAME" value="3"> + </constant> + <constant name="MSAA_DISABLED" value="0"> + </constant> + <constant name="MSAA_2X" value="1"> + </constant> + <constant name="MSAA_4X" value="2"> + </constant> + <constant name="MSAA_8X" value="3"> + </constant> + <constant name="MSAA_16X" value="4"> + </constant> + <constant name="USAGE_2D" value="0"> + </constant> + <constant name="USAGE_2D_NO_SAMPLING" value="1"> + </constant> + <constant name="USAGE_3D" value="2"> + </constant> + <constant name="USAGE_3D_NO_EFFECTS" value="3"> + </constant> + <constant name="CLEAR_MODE_ALWAYS" value="0"> + </constant> + <constant name="CLEAR_MODE_NEVER" value="1"> + </constant> + <constant name="CLEAR_MODE_ONLY_NEXT_FRAME" value="2"> + </constant> + </constants> +</class> diff --git a/doc/classes/ViewportContainer.xml b/doc/classes/ViewportContainer.xml new file mode 100644 index 0000000000..d4d42ad4fb --- /dev/null +++ b/doc/classes/ViewportContainer.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ViewportContainer" inherits="Container" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="is_stretch_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_stretch"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="stretch" type="bool" setter="set_stretch" getter="is_stretch_enabled"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/ViewportTexture.xml b/doc/classes/ViewportTexture.xml new file mode 100644 index 0000000000..f2515cbcc7 --- /dev/null +++ b/doc/classes/ViewportTexture.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ViewportTexture" inherits="Texture" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_viewport_path_in_scene" qualifiers="const"> + <return type="NodePath"> + </return> + <description> + </description> + </method> + <method name="set_viewport_path_in_scene"> + <return type="void"> + </return> + <argument index="0" name="path" type="NodePath"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="viewport_path" type="NodePath" setter="set_viewport_path_in_scene" getter="get_viewport_path_in_scene"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisibilityEnabler.xml b/doc/classes/VisibilityEnabler.xml new file mode 100644 index 0000000000..ebe646679a --- /dev/null +++ b/doc/classes/VisibilityEnabler.xml @@ -0,0 +1,51 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisibilityEnabler" inherits="VisibilityNotifier" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Enable certain nodes only when visible. + </brief_description> + <description> + The VisibilityEnabler will disable [RigidBody] and [AnimationPlayer] nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler itself. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="is_enabler_enabled" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="enabler" type="int" enum="VisibilityEnabler.Enabler"> + </argument> + <description> + Returns whether the specified enabler was set to true or not. + </description> + </method> + <method name="set_enabler"> + <return type="void"> + </return> + <argument index="0" name="enabler" type="int" enum="VisibilityEnabler.Enabler"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + Set an enabler to true for all nodes of its type to be disabled when the VisibilityEnabler is not in view. See the constants for enablers and what they affect. + </description> + </method> + </methods> + <members> + <member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled"> + </member> + <member name="pause_animations" type="bool" setter="set_enabler" getter="is_enabler_enabled"> + </member> + </members> + <constants> + <constant name="ENABLER_FREEZE_BODIES" value="1"> + This enabler will freeze [RigidBody] nodes. + </constant> + <constant name="ENABLER_PAUSE_ANIMATIONS" value="0"> + This enabler will pause [AnimationPlayer] nodes. + </constant> + <constant name="ENABLER_MAX" value="2"> + </constant> + </constants> +</class> diff --git a/doc/classes/VisibilityEnabler2D.xml b/doc/classes/VisibilityEnabler2D.xml new file mode 100644 index 0000000000..b8ef1f8d22 --- /dev/null +++ b/doc/classes/VisibilityEnabler2D.xml @@ -0,0 +1,70 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisibilityEnabler2D" inherits="VisibilityNotifier2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Enable certain nodes only when visible. + </brief_description> + <description> + The VisibilityEnabler2D will disable [RigidBody2D], [AnimationPlayer], and other nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler2D itself. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="is_enabler_enabled" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="enabler" type="int" enum="VisibilityEnabler2D.Enabler"> + </argument> + <description> + Returns whether the specified enabler was set to true or not. + </description> + </method> + <method name="set_enabler"> + <return type="void"> + </return> + <argument index="0" name="enabler" type="int" enum="VisibilityEnabler2D.Enabler"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + Set an enabler to true for all nodes of its type to be disabled when the VisibilityEnabler2D is not in view. See the constants for enablers and what they affect. + </description> + </method> + </methods> + <members> + <member name="fixed_process_parent" type="bool" setter="set_enabler" getter="is_enabler_enabled"> + </member> + <member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled"> + </member> + <member name="pause_animated_sprites" type="bool" setter="set_enabler" getter="is_enabler_enabled"> + </member> + <member name="pause_animations" type="bool" setter="set_enabler" getter="is_enabler_enabled"> + </member> + <member name="pause_particles" type="bool" setter="set_enabler" getter="is_enabler_enabled"> + </member> + <member name="process_parent" type="bool" setter="set_enabler" getter="is_enabler_enabled"> + </member> + </members> + <constants> + <constant name="ENABLER_FREEZE_BODIES" value="1"> + This enabler will freeze [RigidBody2D] nodes. + </constant> + <constant name="ENABLER_PAUSE_ANIMATIONS" value="0"> + This enabler will pause [AnimationPlayer] nodes. + </constant> + <constant name="ENABLER_PAUSE_PARTICLES" value="2"> + This enabler will stop [Particles2D] nodes. + </constant> + <constant name="ENABLER_PAUSE_ANIMATED_SPRITES" value="5"> + </constant> + <constant name="ENABLER_PARENT_PROCESS" value="3"> + This enabler will stop the parent's _process function. + </constant> + <constant name="ENABLER_PARENT_FIXED_PROCESS" value="4"> + This enabler will stop the parent's _fixed_process function. + </constant> + <constant name="ENABLER_MAX" value="6"> + </constant> + </constants> +</class> diff --git a/doc/classes/VisibilityNotifier.xml b/doc/classes/VisibilityNotifier.xml new file mode 100644 index 0000000000..816523fc27 --- /dev/null +++ b/doc/classes/VisibilityNotifier.xml @@ -0,0 +1,71 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisibilityNotifier" inherits="Spatial" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Detects when the node is visible on screen. + </brief_description> + <description> + The VisibilityNotifier detects when it is visible on the screen. It also notifies when its bounding rectangle enters or exits the screen or a [Camera]'s view. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_aabb" qualifiers="const"> + <return type="Rect3"> + </return> + <description> + Returns the bounding box of the VisibilityNotifier. + </description> + </method> + <method name="is_on_screen" qualifiers="const"> + <return type="bool"> + </return> + <description> + If [code]true[/code] the bounding box is on the screen. + </description> + </method> + <method name="set_aabb"> + <return type="void"> + </return> + <argument index="0" name="rect" type="Rect3"> + </argument> + <description> + Set the visibility bounding box of the VisibilityNotifier. + </description> + </method> + </methods> + <members> + <member name="aabb" type="Rect3" setter="set_aabb" getter="get_aabb"> + The VisibilityNotifier's bounding box. + </member> + </members> + <signals> + <signal name="camera_entered"> + <argument index="0" name="camera" type="Object"> + </argument> + <description> + Emitted when the VisibilityNotifier enters a [Camera]'s view. + </description> + </signal> + <signal name="camera_exited"> + <argument index="0" name="camera" type="Object"> + </argument> + <description> + Emitted when the VisibilityNotifier exits a [Camera]'s view. + </description> + </signal> + <signal name="screen_entered"> + <description> + Emitted when the VisibilityNotifier enters the screen. + </description> + </signal> + <signal name="screen_exited"> + <description> + Emitted when the VisibilityNotifier exits the screen. + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/VisibilityNotifier2D.xml b/doc/classes/VisibilityNotifier2D.xml new file mode 100644 index 0000000000..86227a0277 --- /dev/null +++ b/doc/classes/VisibilityNotifier2D.xml @@ -0,0 +1,71 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisibilityNotifier2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Detects when the node is visible on screen. + </brief_description> + <description> + The VisibilityNotifier2D detects when it is visible on the screen. It also notifies when its bounding rectangle enters or exits the screen or a viewport. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_rect" qualifiers="const"> + <return type="Rect2"> + </return> + <description> + Returns the bounding rectangle of the VisibilityNotifier2D. + </description> + </method> + <method name="is_on_screen" qualifiers="const"> + <return type="bool"> + </return> + <description> + If [code]true[/code] the bounding rectangle is on the screen. + </description> + </method> + <method name="set_rect"> + <return type="void"> + </return> + <argument index="0" name="rect" type="Rect2"> + </argument> + <description> + Set the visibility bounding rectangle of the VisibilityNotifier2D. + </description> + </method> + </methods> + <members> + <member name="rect" type="Rect2" setter="set_rect" getter="get_rect"> + The VisibilityNotifier2D's bounding rectangle. + </member> + </members> + <signals> + <signal name="screen_entered"> + <description> + Emitted when the VisibilityNotifier2D enters the screen. + </description> + </signal> + <signal name="screen_exited"> + <description> + Emitted when the VisibilityNotifier2D exits the screen. + </description> + </signal> + <signal name="viewport_entered"> + <argument index="0" name="viewport" type="Object"> + </argument> + <description> + Emitted when the VisibilityNotifier2D enters a [Viewport]'s view. + </description> + </signal> + <signal name="viewport_exited"> + <argument index="0" name="viewport" type="Object"> + </argument> + <description> + Emitted when the VisibilityNotifier2D exits a [Viewport]'s view. + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualInstance.xml b/doc/classes/VisualInstance.xml new file mode 100644 index 0000000000..ed317882a8 --- /dev/null +++ b/doc/classes/VisualInstance.xml @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualInstance" inherits="Spatial" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_aabb" qualifiers="const"> + <return type="Rect3"> + </return> + <description> + </description> + </method> + <method name="get_layer_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_transformed_aabb" qualifiers="const"> + <return type="Rect3"> + </return> + <description> + </description> + </method> + <method name="set_base"> + <return type="void"> + </return> + <argument index="0" name="base" type="RID"> + </argument> + <description> + </description> + </method> + <method name="set_layer_mask"> + <return type="void"> + </return> + <argument index="0" name="mask" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="layers" type="int" setter="set_layer_mask" getter="get_layer_mask"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScript.xml b/doc/classes/VisualScript.xml new file mode 100644 index 0000000000..0875aafcff --- /dev/null +++ b/doc/classes/VisualScript.xml @@ -0,0 +1,467 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScript" inherits="Script" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_custom_signal"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="add_function"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="add_node"> + <return type="void"> + </return> + <argument index="0" name="func" type="String"> + </argument> + <argument index="1" name="id" type="int"> + </argument> + <argument index="2" name="node" type="VisualScriptNode"> + </argument> + <argument index="3" name="pos" type="Vector2" default="Vector2( 0, 0 )"> + </argument> + <description> + </description> + </method> + <method name="add_variable"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="default_value" type="Variant" default="null"> + </argument> + <argument index="2" name="export" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="custom_signal_add_argument"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="type" type="int" enum="Variant.Type"> + </argument> + <argument index="2" name="argname" type="String"> + </argument> + <argument index="3" name="index" type="int" default="-1"> + </argument> + <description> + </description> + </method> + <method name="custom_signal_get_argument_count" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="custom_signal_get_argument_name" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="argidx" type="int"> + </argument> + <description> + </description> + </method> + <method name="custom_signal_get_argument_type" qualifiers="const"> + <return type="int" enum="Variant.Type"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="argidx" type="int"> + </argument> + <description> + </description> + </method> + <method name="custom_signal_remove_argument"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="argidx" type="int"> + </argument> + <description> + </description> + </method> + <method name="custom_signal_set_argument_name"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="argidx" type="int"> + </argument> + <argument index="2" name="argname" type="String"> + </argument> + <description> + </description> + </method> + <method name="custom_signal_set_argument_type"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="argidx" type="int"> + </argument> + <argument index="2" name="type" type="int" enum="Variant.Type"> + </argument> + <description> + </description> + </method> + <method name="custom_signal_swap_argument"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="argidx" type="int"> + </argument> + <argument index="2" name="withidx" type="int"> + </argument> + <description> + </description> + </method> + <method name="data_connect"> + <return type="void"> + </return> + <argument index="0" name="func" type="String"> + </argument> + <argument index="1" name="from_node" type="int"> + </argument> + <argument index="2" name="from_port" type="int"> + </argument> + <argument index="3" name="to_node" type="int"> + </argument> + <argument index="4" name="to_port" type="int"> + </argument> + <description> + </description> + </method> + <method name="data_disconnect"> + <return type="void"> + </return> + <argument index="0" name="func" type="String"> + </argument> + <argument index="1" name="from_node" type="int"> + </argument> + <argument index="2" name="from_port" type="int"> + </argument> + <argument index="3" name="to_node" type="int"> + </argument> + <argument index="4" name="to_port" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_function_node_id" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_function_scroll" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_node" qualifiers="const"> + <return type="VisualScriptNode"> + </return> + <argument index="0" name="func" type="String"> + </argument> + <argument index="1" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_node_pos" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="func" type="String"> + </argument> + <argument index="1" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_variable_default_value" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_variable_export" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="get_variable_info" qualifiers="const"> + <return type="Dictionary"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="has_custom_signal" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="has_data_connection" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="func" type="String"> + </argument> + <argument index="1" name="from_node" type="int"> + </argument> + <argument index="2" name="from_port" type="int"> + </argument> + <argument index="3" name="to_node" type="int"> + </argument> + <argument index="4" name="to_port" type="int"> + </argument> + <description> + </description> + </method> + <method name="has_function" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="has_node" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="func" type="String"> + </argument> + <argument index="1" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="has_sequence_connection" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="func" type="String"> + </argument> + <argument index="1" name="from_node" type="int"> + </argument> + <argument index="2" name="from_output" type="int"> + </argument> + <argument index="3" name="to_node" type="int"> + </argument> + <description> + </description> + </method> + <method name="has_variable" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="remove_custom_signal"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="remove_function"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="remove_node"> + <return type="void"> + </return> + <argument index="0" name="func" type="String"> + </argument> + <argument index="1" name="id" type="int"> + </argument> + <description> + </description> + </method> + <method name="remove_variable"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="rename_custom_signal"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="new_name" type="String"> + </argument> + <description> + </description> + </method> + <method name="rename_function"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="new_name" type="String"> + </argument> + <description> + </description> + </method> + <method name="rename_variable"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="new_name" type="String"> + </argument> + <description> + </description> + </method> + <method name="sequence_connect"> + <return type="void"> + </return> + <argument index="0" name="func" type="String"> + </argument> + <argument index="1" name="from_node" type="int"> + </argument> + <argument index="2" name="from_output" type="int"> + </argument> + <argument index="3" name="to_node" type="int"> + </argument> + <description> + </description> + </method> + <method name="sequence_disconnect"> + <return type="void"> + </return> + <argument index="0" name="func" type="String"> + </argument> + <argument index="1" name="from_node" type="int"> + </argument> + <argument index="2" name="from_output" type="int"> + </argument> + <argument index="3" name="to_node" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_function_scroll"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="ofs" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_instance_base_type"> + <return type="void"> + </return> + <argument index="0" name="type" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_node_pos"> + <return type="void"> + </return> + <argument index="0" name="func" type="String"> + </argument> + <argument index="1" name="id" type="int"> + </argument> + <argument index="2" name="pos" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_variable_default_value"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="value" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="set_variable_export"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_variable_info"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="value" type="Dictionary"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="data" type="Dictionary" setter="_set_data" getter="_get_data"> + </member> + </members> + <signals> + <signal name="node_ports_changed"> + <argument index="0" name="function" type="String"> + </argument> + <argument index="1" name="id" type="int"> + </argument> + <description> + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptBasicTypeConstant.xml b/doc/classes/VisualScriptBasicTypeConstant.xml new file mode 100644 index 0000000000..5b066f9925 --- /dev/null +++ b/doc/classes/VisualScriptBasicTypeConstant.xml @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptBasicTypeConstant" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_basic_type" qualifiers="const"> + <return type="int" enum="Variant.Type"> + </return> + <description> + </description> + </method> + <method name="get_basic_type_constant" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="set_basic_type"> + <return type="void"> + </return> + <argument index="0" name="name" type="int" enum="Variant.Type"> + </argument> + <description> + </description> + </method> + <method name="set_basic_type_constant"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="basic_type" type="int" setter="set_basic_type" getter="get_basic_type" enum="Variant.Type"> + </member> + <member name="constant" type="String" setter="set_basic_type_constant" getter="get_basic_type_constant"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptBuiltinFunc.xml b/doc/classes/VisualScriptBuiltinFunc.xml new file mode 100644 index 0000000000..a88633749e --- /dev/null +++ b/doc/classes/VisualScriptBuiltinFunc.xml @@ -0,0 +1,149 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptBuiltinFunc" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_func"> + <return type="int" enum="VisualScriptBuiltinFunc.BuiltinFunc"> + </return> + <description> + </description> + </method> + <method name="set_func"> + <return type="void"> + </return> + <argument index="0" name="which" type="int" enum="VisualScriptBuiltinFunc.BuiltinFunc"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="function" type="int" setter="set_func" getter="get_func" enum="VisualScriptBuiltinFunc.BuiltinFunc"> + </member> + </members> + <constants> + <constant name="MATH_SIN" value="0"> + </constant> + <constant name="MATH_COS" value="1"> + </constant> + <constant name="MATH_TAN" value="2"> + </constant> + <constant name="MATH_SINH" value="3"> + </constant> + <constant name="MATH_COSH" value="4"> + </constant> + <constant name="MATH_TANH" value="5"> + </constant> + <constant name="MATH_ASIN" value="6"> + </constant> + <constant name="MATH_ACOS" value="7"> + </constant> + <constant name="MATH_ATAN" value="8"> + </constant> + <constant name="MATH_ATAN2" value="9"> + </constant> + <constant name="MATH_SQRT" value="10"> + </constant> + <constant name="MATH_FMOD" value="11"> + </constant> + <constant name="MATH_FPOSMOD" value="12"> + </constant> + <constant name="MATH_FLOOR" value="13"> + </constant> + <constant name="MATH_CEIL" value="14"> + </constant> + <constant name="MATH_ROUND" value="15"> + </constant> + <constant name="MATH_ABS" value="16"> + </constant> + <constant name="MATH_SIGN" value="17"> + </constant> + <constant name="MATH_POW" value="18"> + </constant> + <constant name="MATH_LOG" value="19"> + </constant> + <constant name="MATH_EXP" value="20"> + </constant> + <constant name="MATH_ISNAN" value="21"> + </constant> + <constant name="MATH_ISINF" value="22"> + </constant> + <constant name="MATH_EASE" value="23"> + </constant> + <constant name="MATH_DECIMALS" value="24"> + </constant> + <constant name="MATH_STEPIFY" value="25"> + </constant> + <constant name="MATH_LERP" value="26"> + </constant> + <constant name="MATH_DECTIME" value="27"> + </constant> + <constant name="MATH_RANDOMIZE" value="28"> + </constant> + <constant name="MATH_RAND" value="29"> + </constant> + <constant name="MATH_RANDF" value="30"> + </constant> + <constant name="MATH_RANDOM" value="31"> + </constant> + <constant name="MATH_SEED" value="32"> + </constant> + <constant name="MATH_RANDSEED" value="33"> + </constant> + <constant name="MATH_DEG2RAD" value="34"> + </constant> + <constant name="MATH_RAD2DEG" value="35"> + </constant> + <constant name="MATH_LINEAR2DB" value="36"> + </constant> + <constant name="MATH_DB2LINEAR" value="37"> + </constant> + <constant name="LOGIC_MAX" value="38"> + </constant> + <constant name="LOGIC_MIN" value="39"> + </constant> + <constant name="LOGIC_CLAMP" value="40"> + </constant> + <constant name="LOGIC_NEAREST_PO2" value="41"> + </constant> + <constant name="OBJ_WEAKREF" value="42"> + </constant> + <constant name="FUNC_FUNCREF" value="43"> + </constant> + <constant name="TYPE_CONVERT" value="44"> + </constant> + <constant name="TYPE_OF" value="45"> + </constant> + <constant name="TYPE_EXISTS" value="46"> + </constant> + <constant name="TEXT_CHAR" value="47"> + </constant> + <constant name="TEXT_STR" value="48"> + </constant> + <constant name="TEXT_PRINT" value="49"> + </constant> + <constant name="TEXT_PRINTERR" value="50"> + </constant> + <constant name="TEXT_PRINTRAW" value="51"> + </constant> + <constant name="VAR_TO_STR" value="52"> + </constant> + <constant name="STR_TO_VAR" value="53"> + </constant> + <constant name="VAR_TO_BYTES" value="54"> + </constant> + <constant name="BYTES_TO_VAR" value="55"> + </constant> + <constant name="COLORN" value="56"> + </constant> + <constant name="FUNC_MAX" value="57"> + </constant> + </constants> +</class> diff --git a/doc/classes/VisualScriptClassConstant.xml b/doc/classes/VisualScriptClassConstant.xml new file mode 100644 index 0000000000..5e43b4972c --- /dev/null +++ b/doc/classes/VisualScriptClassConstant.xml @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptClassConstant" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_base_type"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_class_constant"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="set_base_type"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_class_constant"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="base_type" type="String" setter="set_base_type" getter="get_base_type"> + </member> + <member name="constant" type="String" setter="set_class_constant" getter="get_class_constant"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptComment.xml b/doc/classes/VisualScriptComment.xml new file mode 100644 index 0000000000..be4eefd775 --- /dev/null +++ b/doc/classes/VisualScriptComment.xml @@ -0,0 +1,65 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptComment" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_description" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_size" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_title" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="set_description"> + <return type="void"> + </return> + <argument index="0" name="description" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_size"> + <return type="void"> + </return> + <argument index="0" name="size" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_title"> + <return type="void"> + </return> + <argument index="0" name="title" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="description" type="String" setter="set_description" getter="get_description"> + </member> + <member name="size" type="Vector2" setter="set_size" getter="get_size"> + </member> + <member name="title" type="String" setter="set_title" getter="get_title"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptCondition.xml b/doc/classes/VisualScriptCondition.xml new file mode 100644 index 0000000000..73f1b69c02 --- /dev/null +++ b/doc/classes/VisualScriptCondition.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptCondition" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptConstant.xml b/doc/classes/VisualScriptConstant.xml new file mode 100644 index 0000000000..b0af3bda98 --- /dev/null +++ b/doc/classes/VisualScriptConstant.xml @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptConstant" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_constant_type" qualifiers="const"> + <return type="int" enum="Variant.Type"> + </return> + <description> + </description> + </method> + <method name="get_constant_value" qualifiers="const"> + <return type="Variant"> + </return> + <description> + </description> + </method> + <method name="set_constant_type"> + <return type="void"> + </return> + <argument index="0" name="type" type="int" enum="Variant.Type"> + </argument> + <description> + </description> + </method> + <method name="set_constant_value"> + <return type="void"> + </return> + <argument index="0" name="value" type="Variant"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="type" type="int" setter="set_constant_type" getter="get_constant_type" enum="Variant.Type"> + </member> + <member name="value" type="Variant" setter="set_constant_value" getter="get_constant_value"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptConstructor.xml b/doc/classes/VisualScriptConstructor.xml new file mode 100644 index 0000000000..e8afd36b9c --- /dev/null +++ b/doc/classes/VisualScriptConstructor.xml @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptConstructor" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_constructor" qualifiers="const"> + <return type="Dictionary"> + </return> + <description> + </description> + </method> + <method name="get_constructor_type" qualifiers="const"> + <return type="int" enum="Variant.Type"> + </return> + <description> + </description> + </method> + <method name="set_constructor"> + <return type="void"> + </return> + <argument index="0" name="constructor" type="Dictionary"> + </argument> + <description> + </description> + </method> + <method name="set_constructor_type"> + <return type="void"> + </return> + <argument index="0" name="type" type="int" enum="Variant.Type"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="constructor" type="Dictionary" setter="set_constructor" getter="get_constructor"> + </member> + <member name="type" type="int" setter="set_constructor_type" getter="get_constructor_type" enum="Variant.Type"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptCustomNode.xml b/doc/classes/VisualScriptCustomNode.xml new file mode 100644 index 0000000000..ec442e993c --- /dev/null +++ b/doc/classes/VisualScriptCustomNode.xml @@ -0,0 +1,133 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptCustomNode" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="_get_caption" qualifiers="virtual"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="_get_category" qualifiers="virtual"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="_get_input_value_port_count" qualifiers="virtual"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="_get_input_value_port_name" qualifiers="virtual"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="_get_input_value_port_type" qualifiers="virtual"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="_get_output_sequence_port_count" qualifiers="virtual"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="_get_output_sequence_port_text" qualifiers="virtual"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="_get_output_value_port_count" qualifiers="virtual"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="_get_output_value_port_name" qualifiers="virtual"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="_get_output_value_port_type" qualifiers="virtual"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="_get_text" qualifiers="virtual"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="_get_working_memory_size" qualifiers="virtual"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="_has_input_sequence_port" qualifiers="virtual"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="_step" qualifiers="virtual"> + <return type="Variant"> + </return> + <argument index="0" name="inputs" type="Array"> + </argument> + <argument index="1" name="outputs" type="Array"> + </argument> + <argument index="2" name="start_mode" type="int"> + </argument> + <argument index="3" name="working_mem" type="Array"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + <constant name="START_MODE_BEGIN_SEQUENCE" value="0"> + </constant> + <constant name="START_MODE_CONTINUE_SEQUENCE" value="1"> + </constant> + <constant name="START_MODE_RESUME_YIELD" value="2"> + </constant> + <constant name="STEP_PUSH_STACK_BIT" value="16777216" enum=""> + </constant> + <constant name="STEP_GO_BACK_BIT" value="33554432" enum=""> + </constant> + <constant name="STEP_NO_ADVANCE_BIT" value="67108864" enum=""> + </constant> + <constant name="STEP_EXIT_FUNCTION_BIT" value="134217728" enum=""> + </constant> + <constant name="STEP_YIELD_BIT" value="268435456" enum=""> + </constant> + </constants> +</class> diff --git a/doc/classes/VisualScriptDeconstruct.xml b/doc/classes/VisualScriptDeconstruct.xml new file mode 100644 index 0000000000..5bb12539af --- /dev/null +++ b/doc/classes/VisualScriptDeconstruct.xml @@ -0,0 +1,35 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptDeconstruct" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_deconstruct_type" qualifiers="const"> + <return type="int" enum="Variant.Type"> + </return> + <description> + </description> + </method> + <method name="set_deconstruct_type"> + <return type="void"> + </return> + <argument index="0" name="type" type="int" enum="Variant.Type"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="elem_cache" type="Array" setter="_set_elem_cache" getter="_get_elem_cache"> + </member> + <member name="type" type="int" setter="set_deconstruct_type" getter="get_deconstruct_type" enum="Variant.Type"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptEmitSignal.xml b/doc/classes/VisualScriptEmitSignal.xml new file mode 100644 index 0000000000..21af3c6ea0 --- /dev/null +++ b/doc/classes/VisualScriptEmitSignal.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptEmitSignal" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_signal" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="set_signal"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="signal" type="String" setter="set_signal" getter="get_signal"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptEngineSingleton.xml b/doc/classes/VisualScriptEngineSingleton.xml new file mode 100644 index 0000000000..c00fd2a0a4 --- /dev/null +++ b/doc/classes/VisualScriptEngineSingleton.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptEngineSingleton" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_singleton"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="set_singleton"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="constant" type="String" setter="set_singleton" getter="get_singleton"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptExpression.xml b/doc/classes/VisualScriptExpression.xml new file mode 100644 index 0000000000..1ca943a8a8 --- /dev/null +++ b/doc/classes/VisualScriptExpression.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptExpression" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptFunction.xml b/doc/classes/VisualScriptFunction.xml new file mode 100644 index 0000000000..946231eaad --- /dev/null +++ b/doc/classes/VisualScriptFunction.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptFunction" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptFunctionCall.xml b/doc/classes/VisualScriptFunctionCall.xml new file mode 100644 index 0000000000..36c808afce --- /dev/null +++ b/doc/classes/VisualScriptFunctionCall.xml @@ -0,0 +1,199 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptFunctionCall" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_base_path" qualifiers="const"> + <return type="NodePath"> + </return> + <description> + </description> + </method> + <method name="get_base_script" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_base_type" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_basic_type" qualifiers="const"> + <return type="int" enum="Variant.Type"> + </return> + <description> + </description> + </method> + <method name="get_call_mode" qualifiers="const"> + <return type="int" enum="VisualScriptFunctionCall.CallMode"> + </return> + <description> + </description> + </method> + <method name="get_function" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_rpc_call_mode" qualifiers="const"> + <return type="int" enum="VisualScriptFunctionCall.RPCCallMode"> + </return> + <description> + </description> + </method> + <method name="get_singleton" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_use_default_args" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_validate" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_base_path"> + <return type="void"> + </return> + <argument index="0" name="base_path" type="NodePath"> + </argument> + <description> + </description> + </method> + <method name="set_base_script"> + <return type="void"> + </return> + <argument index="0" name="base_script" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_base_type"> + <return type="void"> + </return> + <argument index="0" name="base_type" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_basic_type"> + <return type="void"> + </return> + <argument index="0" name="basic_type" type="int" enum="Variant.Type"> + </argument> + <description> + </description> + </method> + <method name="set_call_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="VisualScriptFunctionCall.CallMode"> + </argument> + <description> + </description> + </method> + <method name="set_function"> + <return type="void"> + </return> + <argument index="0" name="function" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_rpc_call_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="VisualScriptFunctionCall.RPCCallMode"> + </argument> + <description> + </description> + </method> + <method name="set_singleton"> + <return type="void"> + </return> + <argument index="0" name="singleton" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_use_default_args"> + <return type="void"> + </return> + <argument index="0" name="amount" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_validate"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="argument_cache" type="Dictionary" setter="_set_argument_cache" getter="_get_argument_cache"> + </member> + <member name="base_script" type="String" setter="set_base_script" getter="get_base_script"> + </member> + <member name="base_type" type="String" setter="set_base_type" getter="get_base_type"> + </member> + <member name="basic_type" type="int" setter="set_basic_type" getter="get_basic_type" enum="Variant.Type"> + </member> + <member name="call_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptFunctionCall.CallMode"> + </member> + <member name="function" type="String" setter="set_function" getter="get_function"> + </member> + <member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path"> + </member> + <member name="rpc_call_mode" type="int" setter="set_rpc_call_mode" getter="get_rpc_call_mode" enum="VisualScriptFunctionCall.RPCCallMode"> + </member> + <member name="singleton" type="String" setter="set_singleton" getter="get_singleton"> + </member> + <member name="use_default_args" type="int" setter="set_use_default_args" getter="get_use_default_args"> + </member> + <member name="validate" type="bool" setter="set_validate" getter="get_validate"> + </member> + </members> + <constants> + <constant name="CALL_MODE_SELF" value="0"> + </constant> + <constant name="CALL_MODE_NODE_PATH" value="1"> + </constant> + <constant name="CALL_MODE_INSTANCE" value="2"> + </constant> + <constant name="CALL_MODE_BASIC_TYPE" value="3"> + </constant> + <constant name="CALL_MODE_SINGLETON" value="4"> + </constant> + <constant name="RPC_DISABLED" value="0"> + </constant> + <constant name="RPC_RELIABLE" value="1"> + </constant> + <constant name="RPC_UNRELIABLE" value="2"> + </constant> + <constant name="RPC_RELIABLE_TO_ID" value="3"> + </constant> + <constant name="RPC_UNRELIABLE_TO_ID" value="4"> + </constant> + </constants> +</class> diff --git a/doc/classes/VisualScriptFunctionState.xml b/doc/classes/VisualScriptFunctionState.xml new file mode 100644 index 0000000000..d5c06682ef --- /dev/null +++ b/doc/classes/VisualScriptFunctionState.xml @@ -0,0 +1,41 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptFunctionState" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="connect_to_signal"> + <return type="void"> + </return> + <argument index="0" name="obj" type="Object"> + </argument> + <argument index="1" name="signals" type="String"> + </argument> + <argument index="2" name="args" type="Array"> + </argument> + <description> + </description> + </method> + <method name="is_valid" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="resume"> + <return type="Variant"> + </return> + <argument index="0" name="args" type="Array" default="null"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptGlobalConstant.xml b/doc/classes/VisualScriptGlobalConstant.xml new file mode 100644 index 0000000000..52bf8c2821 --- /dev/null +++ b/doc/classes/VisualScriptGlobalConstant.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptGlobalConstant" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_global_constant"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_global_constant"> + <return type="void"> + </return> + <argument index="0" name="index" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="constant" type="int" setter="set_global_constant" getter="get_global_constant"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptIndexGet.xml b/doc/classes/VisualScriptIndexGet.xml new file mode 100644 index 0000000000..c0226b6677 --- /dev/null +++ b/doc/classes/VisualScriptIndexGet.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptIndexGet" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptIndexSet.xml b/doc/classes/VisualScriptIndexSet.xml new file mode 100644 index 0000000000..440b4801b4 --- /dev/null +++ b/doc/classes/VisualScriptIndexSet.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptIndexSet" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptInputAction.xml b/doc/classes/VisualScriptInputAction.xml new file mode 100644 index 0000000000..b555a0228b --- /dev/null +++ b/doc/classes/VisualScriptInputAction.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptInputAction" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_action_mode" qualifiers="const"> + <return type="int" enum="VisualScriptInputAction.Mode"> + </return> + <description> + </description> + </method> + <method name="get_action_name" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="set_action_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="VisualScriptInputAction.Mode"> + </argument> + <description> + </description> + </method> + <method name="set_action_name"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="action" type="String" setter="set_action_name" getter="get_action_name"> + </member> + <member name="mode" type="int" setter="set_action_mode" getter="get_action_mode" enum="VisualScriptInputAction.Mode"> + </member> + </members> + <constants> + <constant name="MODE_PRESSED" value="0"> + </constant> + <constant name="MODE_RELEASED" value="1"> + </constant> + <constant name="MODE_JUST_PRESSED" value="2"> + </constant> + <constant name="MODE_JUST_RELEASED" value="3"> + </constant> + </constants> +</class> diff --git a/doc/classes/VisualScriptIterator.xml b/doc/classes/VisualScriptIterator.xml new file mode 100644 index 0000000000..74309fcf00 --- /dev/null +++ b/doc/classes/VisualScriptIterator.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptIterator" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptLocalVar.xml b/doc/classes/VisualScriptLocalVar.xml new file mode 100644 index 0000000000..7db550d5fe --- /dev/null +++ b/doc/classes/VisualScriptLocalVar.xml @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptLocalVar" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_var_name" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_var_type" qualifiers="const"> + <return type="int" enum="Variant.Type"> + </return> + <description> + </description> + </method> + <method name="set_var_name"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_var_type"> + <return type="void"> + </return> + <argument index="0" name="type" type="int" enum="Variant.Type"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="type" type="int" setter="set_var_type" getter="get_var_type" enum="Variant.Type"> + </member> + <member name="var_name" type="String" setter="set_var_name" getter="get_var_name"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptLocalVarSet.xml b/doc/classes/VisualScriptLocalVarSet.xml new file mode 100644 index 0000000000..6e69f13383 --- /dev/null +++ b/doc/classes/VisualScriptLocalVarSet.xml @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptLocalVarSet" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_var_name" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_var_type" qualifiers="const"> + <return type="int" enum="Variant.Type"> + </return> + <description> + </description> + </method> + <method name="set_var_name"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_var_type"> + <return type="void"> + </return> + <argument index="0" name="type" type="int" enum="Variant.Type"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="type" type="int" setter="set_var_type" getter="get_var_type" enum="Variant.Type"> + </member> + <member name="var_name" type="String" setter="set_var_name" getter="get_var_name"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptMathConstant.xml b/doc/classes/VisualScriptMathConstant.xml new file mode 100644 index 0000000000..1ef7d71e10 --- /dev/null +++ b/doc/classes/VisualScriptMathConstant.xml @@ -0,0 +1,51 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptMathConstant" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_math_constant"> + <return type="int" enum="VisualScriptMathConstant.MathConstant"> + </return> + <description> + </description> + </method> + <method name="set_math_constant"> + <return type="void"> + </return> + <argument index="0" name="which" type="int" enum="VisualScriptMathConstant.MathConstant"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="constant" type="int" setter="set_math_constant" getter="get_math_constant" enum="VisualScriptMathConstant.MathConstant"> + </member> + </members> + <constants> + <constant name="MATH_CONSTANT_ONE" value="0"> + </constant> + <constant name="MATH_CONSTANT_PI" value="1"> + </constant> + <constant name="MATH_CONSTANT_2PI" value="2"> + </constant> + <constant name="MATH_CONSTANT_HALF_PI" value="3"> + </constant> + <constant name="MATH_CONSTANT_E" value="4"> + </constant> + <constant name="MATH_CONSTANT_SQRT2" value="5"> + </constant> + <constant name="MATH_CONSTANT_INF" value="6"> + </constant> + <constant name="MATH_CONSTANT_NAN" value="7"> + </constant> + <constant name="MATH_CONSTANT_MAX" value="8"> + </constant> + </constants> +</class> diff --git a/doc/classes/VisualScriptNode.xml b/doc/classes/VisualScriptNode.xml new file mode 100644 index 0000000000..dbb75e69fa --- /dev/null +++ b/doc/classes/VisualScriptNode.xml @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptNode" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_default_input_value" qualifiers="const"> + <return type="Variant"> + </return> + <argument index="0" name="port_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_visual_script" qualifiers="const"> + <return type="VisualScript"> + </return> + <description> + </description> + </method> + <method name="set_default_input_value"> + <return type="void"> + </return> + <argument index="0" name="port_idx" type="int"> + </argument> + <argument index="1" name="value" type="Variant"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="_default_input_values" type="Array" setter="_set_default_input_values" getter="_get_default_input_values"> + </member> + </members> + <signals> + <signal name="ports_changed"> + <description> + </description> + </signal> + </signals> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptOperator.xml b/doc/classes/VisualScriptOperator.xml new file mode 100644 index 0000000000..82951c9e0c --- /dev/null +++ b/doc/classes/VisualScriptOperator.xml @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptOperator" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_operator" qualifiers="const"> + <return type="int" enum="Variant.Operator"> + </return> + <description> + </description> + </method> + <method name="get_typed" qualifiers="const"> + <return type="int" enum="Variant.Type"> + </return> + <description> + </description> + </method> + <method name="set_operator"> + <return type="void"> + </return> + <argument index="0" name="op" type="int" enum="Variant.Operator"> + </argument> + <description> + </description> + </method> + <method name="set_typed"> + <return type="void"> + </return> + <argument index="0" name="type" type="int" enum="Variant.Type"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="operator" type="int" setter="set_operator" getter="get_operator" enum="Variant.Operator"> + </member> + <member name="type" type="int" setter="set_typed" getter="get_typed" enum="Variant.Type"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptPreload.xml b/doc/classes/VisualScriptPreload.xml new file mode 100644 index 0000000000..b68bf5546b --- /dev/null +++ b/doc/classes/VisualScriptPreload.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptPreload" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_preload" qualifiers="const"> + <return type="Resource"> + </return> + <description> + </description> + </method> + <method name="set_preload"> + <return type="void"> + </return> + <argument index="0" name="resource" type="Resource"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="resource" type="Resource" setter="set_preload" getter="get_preload"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptPropertyGet.xml b/doc/classes/VisualScriptPropertyGet.xml new file mode 100644 index 0000000000..c790a59b0c --- /dev/null +++ b/doc/classes/VisualScriptPropertyGet.xml @@ -0,0 +1,137 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptPropertyGet" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_base_path" qualifiers="const"> + <return type="NodePath"> + </return> + <description> + </description> + </method> + <method name="get_base_script" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_base_type" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_basic_type" qualifiers="const"> + <return type="int" enum="Variant.Type"> + </return> + <description> + </description> + </method> + <method name="get_call_mode" qualifiers="const"> + <return type="int" enum="VisualScriptPropertyGet.CallMode"> + </return> + <description> + </description> + </method> + <method name="get_index" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_property" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="set_base_path"> + <return type="void"> + </return> + <argument index="0" name="base_path" type="NodePath"> + </argument> + <description> + </description> + </method> + <method name="set_base_script"> + <return type="void"> + </return> + <argument index="0" name="base_script" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_base_type"> + <return type="void"> + </return> + <argument index="0" name="base_type" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_basic_type"> + <return type="void"> + </return> + <argument index="0" name="basic_type" type="int" enum="Variant.Type"> + </argument> + <description> + </description> + </method> + <method name="set_call_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="VisualScriptPropertyGet.CallMode"> + </argument> + <description> + </description> + </method> + <method name="set_index"> + <return type="void"> + </return> + <argument index="0" name="index" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_property"> + <return type="void"> + </return> + <argument index="0" name="property" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="base_script" type="String" setter="set_base_script" getter="get_base_script"> + </member> + <member name="base_type" type="String" setter="set_base_type" getter="get_base_type"> + </member> + <member name="basic_type" type="int" setter="set_basic_type" getter="get_basic_type" enum="Variant.Type"> + </member> + <member name="index" type="String" setter="set_index" getter="get_index"> + </member> + <member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path"> + </member> + <member name="property" type="String" setter="set_property" getter="get_property"> + </member> + <member name="set_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptPropertyGet.CallMode"> + </member> + <member name="type_cache" type="int" setter="_set_type_cache" getter="_get_type_cache" enum="Variant.Type"> + </member> + </members> + <constants> + <constant name="CALL_MODE_SELF" value="0"> + </constant> + <constant name="CALL_MODE_NODE_PATH" value="1"> + </constant> + <constant name="CALL_MODE_INSTANCE" value="2"> + </constant> + </constants> +</class> diff --git a/doc/classes/VisualScriptPropertySet.xml b/doc/classes/VisualScriptPropertySet.xml new file mode 100644 index 0000000000..88d47a7463 --- /dev/null +++ b/doc/classes/VisualScriptPropertySet.xml @@ -0,0 +1,177 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptPropertySet" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_assign_op" qualifiers="const"> + <return type="int" enum="VisualScriptPropertySet.AssignOp"> + </return> + <description> + </description> + </method> + <method name="get_base_path" qualifiers="const"> + <return type="NodePath"> + </return> + <description> + </description> + </method> + <method name="get_base_script" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_base_type" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_basic_type" qualifiers="const"> + <return type="int" enum="Variant.Type"> + </return> + <description> + </description> + </method> + <method name="get_call_mode" qualifiers="const"> + <return type="int" enum="VisualScriptPropertySet.CallMode"> + </return> + <description> + </description> + </method> + <method name="get_index" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_property" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="set_assign_op"> + <return type="void"> + </return> + <argument index="0" name="assign_op" type="int" enum="VisualScriptPropertySet.AssignOp"> + </argument> + <description> + </description> + </method> + <method name="set_base_path"> + <return type="void"> + </return> + <argument index="0" name="base_path" type="NodePath"> + </argument> + <description> + </description> + </method> + <method name="set_base_script"> + <return type="void"> + </return> + <argument index="0" name="base_script" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_base_type"> + <return type="void"> + </return> + <argument index="0" name="base_type" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_basic_type"> + <return type="void"> + </return> + <argument index="0" name="basic_type" type="int" enum="Variant.Type"> + </argument> + <description> + </description> + </method> + <method name="set_call_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="VisualScriptPropertySet.CallMode"> + </argument> + <description> + </description> + </method> + <method name="set_index"> + <return type="void"> + </return> + <argument index="0" name="index" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_property"> + <return type="void"> + </return> + <argument index="0" name="property" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="assign_op" type="int" setter="set_assign_op" getter="get_assign_op" enum="VisualScriptPropertySet.AssignOp"> + </member> + <member name="base_script" type="String" setter="set_base_script" getter="get_base_script"> + </member> + <member name="base_type" type="String" setter="set_base_type" getter="get_base_type"> + </member> + <member name="basic_type" type="int" setter="set_basic_type" getter="get_basic_type" enum="Variant.Type"> + </member> + <member name="index" type="String" setter="set_index" getter="get_index"> + </member> + <member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path"> + </member> + <member name="property" type="String" setter="set_property" getter="get_property"> + </member> + <member name="set_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptPropertySet.CallMode"> + </member> + <member name="type_cache" type="Dictionary" setter="_set_type_cache" getter="_get_type_cache"> + </member> + </members> + <constants> + <constant name="CALL_MODE_SELF" value="0"> + </constant> + <constant name="CALL_MODE_NODE_PATH" value="1"> + </constant> + <constant name="CALL_MODE_INSTANCE" value="2"> + </constant> + <constant name="CALL_MODE_BASIC_TYPE" value="3"> + </constant> + <constant name="ASSIGN_OP_NONE" value="0"> + </constant> + <constant name="ASSIGN_OP_ADD" value="1"> + </constant> + <constant name="ASSIGN_OP_SUB" value="2"> + </constant> + <constant name="ASSIGN_OP_MUL" value="3"> + </constant> + <constant name="ASSIGN_OP_DIV" value="4"> + </constant> + <constant name="ASSIGN_OP_MOD" value="5"> + </constant> + <constant name="ASSIGN_OP_SHIFT_LEFT" value="6"> + </constant> + <constant name="ASSIGN_OP_SHIFT_RIGHT" value="7"> + </constant> + <constant name="ASSIGN_OP_BIT_AND" value="8"> + </constant> + <constant name="ASSIGN_OP_BIT_OR" value="9"> + </constant> + <constant name="ASSIGN_OP_BIT_XOR" value="10"> + </constant> + </constants> +</class> diff --git a/doc/classes/VisualScriptResourcePath.xml b/doc/classes/VisualScriptResourcePath.xml new file mode 100644 index 0000000000..e4b881b659 --- /dev/null +++ b/doc/classes/VisualScriptResourcePath.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptResourcePath" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_resource_path"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="set_resource_path"> + <return type="void"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="path" type="String" setter="set_resource_path" getter="get_resource_path"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptReturn.xml b/doc/classes/VisualScriptReturn.xml new file mode 100644 index 0000000000..55c53e17a0 --- /dev/null +++ b/doc/classes/VisualScriptReturn.xml @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptReturn" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_return_type" qualifiers="const"> + <return type="int" enum="Variant.Type"> + </return> + <description> + </description> + </method> + <method name="is_return_value_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_enable_return_value"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_return_type"> + <return type="void"> + </return> + <argument index="0" name="type" type="int" enum="Variant.Type"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="return_enabled" type="bool" setter="set_enable_return_value" getter="is_return_value_enabled"> + </member> + <member name="return_type" type="int" setter="set_return_type" getter="get_return_type" enum="Variant.Type"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptSceneNode.xml b/doc/classes/VisualScriptSceneNode.xml new file mode 100644 index 0000000000..90a8f132c0 --- /dev/null +++ b/doc/classes/VisualScriptSceneNode.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptSceneNode" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_node_path"> + <return type="NodePath"> + </return> + <description> + </description> + </method> + <method name="set_node_path"> + <return type="void"> + </return> + <argument index="0" name="path" type="NodePath"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="node_path" type="NodePath" setter="set_node_path" getter="get_node_path"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptSceneTree.xml b/doc/classes/VisualScriptSceneTree.xml new file mode 100644 index 0000000000..55e27460ab --- /dev/null +++ b/doc/classes/VisualScriptSceneTree.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptSceneTree" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptSelect.xml b/doc/classes/VisualScriptSelect.xml new file mode 100644 index 0000000000..855da76e6c --- /dev/null +++ b/doc/classes/VisualScriptSelect.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptSelect" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_typed" qualifiers="const"> + <return type="int" enum="Variant.Type"> + </return> + <description> + </description> + </method> + <method name="set_typed"> + <return type="void"> + </return> + <argument index="0" name="type" type="int" enum="Variant.Type"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="type" type="int" setter="set_typed" getter="get_typed" enum="Variant.Type"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptSelf.xml b/doc/classes/VisualScriptSelf.xml new file mode 100644 index 0000000000..a60f7eee03 --- /dev/null +++ b/doc/classes/VisualScriptSelf.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptSelf" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptSequence.xml b/doc/classes/VisualScriptSequence.xml new file mode 100644 index 0000000000..a60c9e782b --- /dev/null +++ b/doc/classes/VisualScriptSequence.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptSequence" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_steps" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_steps"> + <return type="void"> + </return> + <argument index="0" name="steps" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="steps" type="int" setter="set_steps" getter="get_steps"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptSubCall.xml b/doc/classes/VisualScriptSubCall.xml new file mode 100644 index 0000000000..297ec96781 --- /dev/null +++ b/doc/classes/VisualScriptSubCall.xml @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptSubCall" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="_subcall" qualifiers="virtual"> + <return type="Variant"> + </return> + <argument index="0" name="arguments" type="Variant"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptSwitch.xml b/doc/classes/VisualScriptSwitch.xml new file mode 100644 index 0000000000..95ed737372 --- /dev/null +++ b/doc/classes/VisualScriptSwitch.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptSwitch" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptTypeCast.xml b/doc/classes/VisualScriptTypeCast.xml new file mode 100644 index 0000000000..3008426900 --- /dev/null +++ b/doc/classes/VisualScriptTypeCast.xml @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptTypeCast" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_base_script" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_base_type" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="set_base_script"> + <return type="void"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_base_type"> + <return type="void"> + </return> + <argument index="0" name="type" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="base_script" type="String" setter="set_base_script" getter="get_base_script"> + </member> + <member name="base_type" type="String" setter="set_base_type" getter="get_base_type"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptVariableGet.xml b/doc/classes/VisualScriptVariableGet.xml new file mode 100644 index 0000000000..8411933756 --- /dev/null +++ b/doc/classes/VisualScriptVariableGet.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptVariableGet" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_variable" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="set_variable"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="var_name" type="String" setter="set_variable" getter="get_variable"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptVariableSet.xml b/doc/classes/VisualScriptVariableSet.xml new file mode 100644 index 0000000000..fbe0f8e275 --- /dev/null +++ b/doc/classes/VisualScriptVariableSet.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptVariableSet" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_variable" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="set_variable"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="var_name" type="String" setter="set_variable" getter="get_variable"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptWhile.xml b/doc/classes/VisualScriptWhile.xml new file mode 100644 index 0000000000..b49678582e --- /dev/null +++ b/doc/classes/VisualScriptWhile.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptWhile" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualScriptYield.xml b/doc/classes/VisualScriptYield.xml new file mode 100644 index 0000000000..b8938daa67 --- /dev/null +++ b/doc/classes/VisualScriptYield.xml @@ -0,0 +1,55 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptYield" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_wait_time"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_yield_mode"> + <return type="int" enum="VisualScriptYield.YieldMode"> + </return> + <description> + </description> + </method> + <method name="set_wait_time"> + <return type="void"> + </return> + <argument index="0" name="sec" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_yield_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="VisualScriptYield.YieldMode"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="mode" type="int" setter="set_yield_mode" getter="get_yield_mode" enum="VisualScriptYield.YieldMode"> + </member> + <member name="wait_time" type="float" setter="set_wait_time" getter="get_wait_time"> + </member> + </members> + <constants> + <constant name="YIELD_FRAME" value="1"> + </constant> + <constant name="YIELD_FIXED_FRAME" value="2"> + </constant> + <constant name="YIELD_WAIT" value="3"> + </constant> + </constants> +</class> diff --git a/doc/classes/VisualScriptYieldSignal.xml b/doc/classes/VisualScriptYieldSignal.xml new file mode 100644 index 0000000000..f4202edf2b --- /dev/null +++ b/doc/classes/VisualScriptYieldSignal.xml @@ -0,0 +1,87 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualScriptYieldSignal" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_base_path" qualifiers="const"> + <return type="NodePath"> + </return> + <description> + </description> + </method> + <method name="get_base_type" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_call_mode" qualifiers="const"> + <return type="int" enum="VisualScriptYieldSignal.CallMode"> + </return> + <description> + </description> + </method> + <method name="get_signal" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="set_base_path"> + <return type="void"> + </return> + <argument index="0" name="base_path" type="NodePath"> + </argument> + <description> + </description> + </method> + <method name="set_base_type"> + <return type="void"> + </return> + <argument index="0" name="base_type" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_call_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int" enum="VisualScriptYieldSignal.CallMode"> + </argument> + <description> + </description> + </method> + <method name="set_signal"> + <return type="void"> + </return> + <argument index="0" name="signal" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="base_type" type="String" setter="set_base_type" getter="get_base_type"> + </member> + <member name="call_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptYieldSignal.CallMode"> + </member> + <member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path"> + </member> + <member name="signal" type="String" setter="set_signal" getter="get_signal"> + </member> + </members> + <constants> + <constant name="CALL_MODE_SELF" value="0"> + </constant> + <constant name="CALL_MODE_NODE_PATH" value="1"> + </constant> + <constant name="CALL_MODE_INSTANCE" value="2"> + </constant> + </constants> +</class> diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml new file mode 100644 index 0000000000..242fc18ab9 --- /dev/null +++ b/doc/classes/VisualServer.xml @@ -0,0 +1,82 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualServer" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Server for anything visible. + </brief_description> + <description> + Server for anything visible. The visual server is the API backend for everything visible. The whole scene system mounts on it to display. + The visual server is completely opaque, the internals are entirely implementation specific and cannot be accessed. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="force_draw"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="texture_create"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="texture_create_from_image"> + <return type="RID"> + </return> + <argument index="0" name="image" type="Image"> + </argument> + <argument index="1" name="flags" type="int" default="7"> + </argument> + <description> + </description> + </method> + <method name="texture_get_flags" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="texture" type="RID"> + </argument> + <description> + </description> + </method> + <method name="texture_get_height" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="texture" type="RID"> + </argument> + <description> + </description> + </method> + <method name="texture_get_width" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="texture" type="RID"> + </argument> + <description> + </description> + </method> + <method name="texture_set_flags"> + <return type="void"> + </return> + <argument index="0" name="texture" type="RID"> + </argument> + <argument index="1" name="flags" type="int"> + </argument> + <description> + </description> + </method> + <method name="texture_set_shrink_all_x2_on_set_data"> + <return type="void"> + </return> + <argument index="0" name="shrink" type="bool"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/WeakRef.xml b/doc/classes/WeakRef.xml new file mode 100644 index 0000000000..1071a40c3b --- /dev/null +++ b/doc/classes/WeakRef.xml @@ -0,0 +1,24 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="WeakRef" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Holds an [Object], but does not contribute to the reference count if the object is a reference. + </brief_description> + <description> + A weakref can hold a [Reference], without contributing to the reference counter. A weakref can be created from an [Object] using [method @GDScript.weakref]. If this object is not a reference, weakref still works, however, it does not have any effect on the object. Weakrefs are useful in cases where multiple classes have variables that refer to eachother. Without weakrefs, using these classes could lead to memory leaks, since both references keep eachother from being released. Making part of the variables a weakref can prevent this cyclic dependency, and allows the references to be released. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_ref" qualifiers="const"> + <return type="Variant"> + </return> + <description> + Returns the [Object] this weakref is referring to. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/WindowDialog.xml b/doc/classes/WindowDialog.xml new file mode 100644 index 0000000000..e57983c367 --- /dev/null +++ b/doc/classes/WindowDialog.xml @@ -0,0 +1,80 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="WindowDialog" inherits="Popup" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Base class for window dialogs. + </brief_description> + <description> + Windowdialog is the base class for all window-based dialogs. It's a by-default toplevel [Control] that draws a window decoration and allows motion and resizing. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_close_button"> + <return type="TextureButton"> + </return> + <description> + Return the close [TextureButton]. + </description> + </method> + <method name="get_resizable" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_title" qualifiers="const"> + <return type="String"> + </return> + <description> + Return the title of the window. + </description> + </method> + <method name="set_resizable"> + <return type="void"> + </return> + <argument index="0" name="resizable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_title"> + <return type="void"> + </return> + <argument index="0" name="title" type="String"> + </argument> + <description> + Set the title of the window. + </description> + </method> + </methods> + <members> + <member name="resizable" type="bool" setter="set_resizable" getter="get_resizable"> + </member> + <member name="window_title" type="String" setter="set_title" getter="get_title"> + </member> + </members> + <constants> + </constants> + <theme_items> + <theme_item name="close" type="Texture"> + </theme_item> + <theme_item name="close_h_ofs" type="int"> + </theme_item> + <theme_item name="close_highlight" type="Texture"> + </theme_item> + <theme_item name="close_v_ofs" type="int"> + </theme_item> + <theme_item name="panel" type="StyleBox"> + </theme_item> + <theme_item name="scaleborder_size" type="int"> + </theme_item> + <theme_item name="title_color" type="Color"> + </theme_item> + <theme_item name="title_font" type="Font"> + </theme_item> + <theme_item name="title_height" type="int"> + </theme_item> + </theme_items> +</class> diff --git a/doc/classes/World.xml b/doc/classes/World.xml new file mode 100644 index 0000000000..f4f5f5b756 --- /dev/null +++ b/doc/classes/World.xml @@ -0,0 +1,69 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="World" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Class that has everything pertaining to a world. + </brief_description> + <description> + Class that has everything pertaining to a world. A physics space, a visual scenario and a sound space. Spatial nodes register their resources into the current world. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_direct_space_state"> + <return type="PhysicsDirectSpaceState"> + </return> + <description> + </description> + </method> + <method name="get_environment" qualifiers="const"> + <return type="Environment"> + </return> + <description> + </description> + </method> + <method name="get_fallback_environment" qualifiers="const"> + <return type="Environment"> + </return> + <description> + </description> + </method> + <method name="get_scenario" qualifiers="const"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="get_space" qualifiers="const"> + <return type="RID"> + </return> + <description> + </description> + </method> + <method name="set_environment"> + <return type="void"> + </return> + <argument index="0" name="env" type="Environment"> + </argument> + <description> + </description> + </method> + <method name="set_fallback_environment"> + <return type="void"> + </return> + <argument index="0" name="env" type="Environment"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="environment" type="Environment" setter="set_environment" getter="get_environment"> + </member> + <member name="fallback_environment" type="Environment" setter="set_fallback_environment" getter="get_fallback_environment"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/World2D.xml b/doc/classes/World2D.xml new file mode 100644 index 0000000000..d57117fef0 --- /dev/null +++ b/doc/classes/World2D.xml @@ -0,0 +1,38 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="World2D" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Class that has everything pertaining to a 2D world. + </brief_description> + <description> + Class that has everything pertaining to a 2D world. A physics space, a visual scenario and a sound space. 2D nodes register their resources into the current 2D world. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_canvas"> + <return type="RID"> + </return> + <description> + Retrieve the [RID] of this world's canvas resource. Used by the [VisualServer] for 2D drawing. + </description> + </method> + <method name="get_direct_space_state"> + <return type="Physics2DDirectSpaceState"> + </return> + <description> + Retrieve the state of this world's physics space. This allows arbitrary querying for collision. + </description> + </method> + <method name="get_space"> + <return type="RID"> + </return> + <description> + Retrieve the [RID] of this world's physics space resource. Used by the [Physics2DServer] for 2D physics, treating it as both a space and an area. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/WorldEnvironment.xml b/doc/classes/WorldEnvironment.xml new file mode 100644 index 0000000000..a9450c1743 --- /dev/null +++ b/doc/classes/WorldEnvironment.xml @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="WorldEnvironment" inherits="Node" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Sets environment properties for the entire scene + </brief_description> + <description> + The [WorldEnvironment] node can be added to a scene in order to set default [Environment] variables for the scene. The [WorldEnvironment] can be overridden by an [Environment] node set on the current [Camera]. Additionally, only one [WorldEnvironment] may be instanced in a given scene at a time. The [WorldEnvironment] allows the user to specify default lighting parameters (e.g. ambient lighting), various post-processing effects (e.g. SSAO, DOF, Tonemapping), and how to draw the background (e.g. solid color, skybox). + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_environment" qualifiers="const"> + <return type="Environment"> + </return> + <description> + Return the [Environment] currently bound. + </description> + </method> + <method name="set_environment"> + <return type="void"> + </return> + <argument index="0" name="env" type="Environment"> + </argument> + <description> + Set the currently bound [Environment] to the one specified. + </description> + </method> + </methods> + <members> + <member name="environment" type="Environment" setter="set_environment" getter="get_environment"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/XMLParser.xml b/doc/classes/XMLParser.xml new file mode 100644 index 0000000000..6ab84ef345 --- /dev/null +++ b/doc/classes/XMLParser.xml @@ -0,0 +1,173 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="XMLParser" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Low-level class for creating parsers for XML files. + </brief_description> + <description> + This class can serve as base to make custom XML parsers. Since XML is a very flexible standard, this interface is low level so it can be applied to any possible schema. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_attribute_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Get the amount of attributes in the current element. + </description> + </method> + <method name="get_attribute_name" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Get the name of the attribute specified by the index in [code]idx[/code] argument. + </description> + </method> + <method name="get_attribute_value" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Get the value of the attribute specified by the index in [code]idx[/code] argument. + </description> + </method> + <method name="get_current_line" qualifiers="const"> + <return type="int"> + </return> + <description> + Get the current line in the parsed file (currently not implemented). + </description> + </method> + <method name="get_named_attribute_value" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Get the value of a certain attribute of the current element by name. This will raise an error if the element has no such attribute. + </description> + </method> + <method name="get_named_attribute_value_safe" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Get the value of a certain attribute of the current element by name. This will return an empty [String] if the attribute is not found. + </description> + </method> + <method name="get_node_data" qualifiers="const"> + <return type="String"> + </return> + <description> + Get the contents of a text node. This will raise an error in any other type of node. + </description> + </method> + <method name="get_node_name" qualifiers="const"> + <return type="String"> + </return> + <description> + Get the name of the current element node. This will raise an error if the current node type is not [code]NODE_ELEMENT[/code] nor [code]NODE_ELEMENT_END[/code] + </description> + </method> + <method name="get_node_offset" qualifiers="const"> + <return type="int"> + </return> + <description> + Get the byte offset of the current node since the beginning of the file or buffer. + </description> + </method> + <method name="get_node_type"> + <return type="int" enum="XMLParser.NodeType"> + </return> + <description> + Get the type of the current node. Compare with [code]NODE_*[/code] constants. + </description> + </method> + <method name="has_attribute" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Check whether or not the current element has a certain attribute. + </description> + </method> + <method name="is_empty" qualifiers="const"> + <return type="bool"> + </return> + <description> + Check whether the current element is empty (this only works for completely empty tags, e.g. <element \>). + </description> + </method> + <method name="open"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="file" type="String"> + </argument> + <description> + Open a XML file for parsing. This returns an error code. + </description> + </method> + <method name="open_buffer"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="buffer" type="PoolByteArray"> + </argument> + <description> + Open a XML raw buffer for parsing. This returns an error code. + </description> + </method> + <method name="read"> + <return type="int" enum="Error"> + </return> + <description> + Read the next node of the file. This returns an error code. + </description> + </method> + <method name="seek"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="pos" type="int"> + </argument> + <description> + Move the buffer cursor to a certain offset (since the beginning) and read the next node there. This returns an error code. + </description> + </method> + <method name="skip_section"> + <return type="void"> + </return> + <description> + Skips the current section. If the node contains other elements, they will be ignored and the cursor will go to the closing of the current element. + </description> + </method> + </methods> + <constants> + <constant name="NODE_NONE" value="0"> + There's no node (no file or buffer opened) + </constant> + <constant name="NODE_ELEMENT" value="1"> + Element (tag) + </constant> + <constant name="NODE_ELEMENT_END" value="2"> + End of element + </constant> + <constant name="NODE_TEXT" value="3"> + Text node + </constant> + <constant name="NODE_COMMENT" value="4"> + Comment node + </constant> + <constant name="NODE_CDATA" value="5"> + CDATA content + </constant> + <constant name="NODE_UNKNOWN" value="6"> + Unknown node + </constant> + </constants> +</class> diff --git a/doc/classes/YSort.xml b/doc/classes/YSort.xml new file mode 100644 index 0000000000..3c0c8b3d06 --- /dev/null +++ b/doc/classes/YSort.xml @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="YSort" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Sort all child nodes based on their Y positions. + </brief_description> + <description> + Sort all child nodes based on their Y positions. The child node must inherit from [CanvasItem] for it to be sorted. Nodes that have a higher Y position will be drawn later, so they will appear on top of nodes that have a lower Y position. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="is_sort_enabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns true if the children nodes are being sorted. + </description> + </method> + <method name="set_sort_enabled"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + Set whether the children nodes are sorted or not. (default true) + </description> + </method> + </methods> + <members> + <member name="sort_enabled" type="bool" setter="set_sort_enabled" getter="is_sort_enabled"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/bool.xml b/doc/classes/bool.xml new file mode 100644 index 0000000000..1d662ba946 --- /dev/null +++ b/doc/classes/bool.xml @@ -0,0 +1,44 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="bool" category="Built-In Types" version="3.0.alpha.custom_build"> + <brief_description> + Boolean built-in type + </brief_description> + <description> + Boolean built-in type. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="bool"> + <return type="bool"> + </return> + <argument index="0" name="from" type="int"> + </argument> + <description> + Cast an [int] value to a boolean value, this method will return true if called with an integer value different to 0 and false in other case. + </description> + </method> + <method name="bool"> + <return type="bool"> + </return> + <argument index="0" name="from" type="float"> + </argument> + <description> + Cast a [float] value to a boolean value, this method will return true if called with a floating point value different to 0 and false in other case. + </description> + </method> + <method name="bool"> + <return type="bool"> + </return> + <argument index="0" name="from" type="String"> + </argument> + <description> + Cast a [String] value to a boolean value, this method will return true if called with a non empty string and false in other case. Examples: [code]bool('False')[/code] returns true, [code]bool('')[/code]. returns false + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/float.xml b/doc/classes/float.xml new file mode 100644 index 0000000000..942aa4d55a --- /dev/null +++ b/doc/classes/float.xml @@ -0,0 +1,44 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="float" category="Built-In Types" version="3.0.alpha.custom_build"> + <brief_description> + Float built-in type + </brief_description> + <description> + Float built-in type. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="float"> + <return type="float"> + </return> + <argument index="0" name="from" type="bool"> + </argument> + <description> + Cast a [bool] value to a floating point value, [code]float(true)[/code] will be equals to 1.0 and [code]float(false)[/code] will be equals to 0.0. + </description> + </method> + <method name="float"> + <return type="float"> + </return> + <argument index="0" name="from" type="int"> + </argument> + <description> + Cast an [int] value to a floating point value, [code]float(1)[/code] will be equals to 1.0. + </description> + </method> + <method name="float"> + <return type="float"> + </return> + <argument index="0" name="from" type="String"> + </argument> + <description> + Cast a [String] value to a floating point value. This method accepts float value strings like [code] '1.23' [/code] and exponential notation strings for its parameter so calling [code] float('1e3') [/code] will return 1000.0 and calling [code] float('1e-3') [/code] will return -0.001. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/int.xml b/doc/classes/int.xml new file mode 100644 index 0000000000..7c2267ac9a --- /dev/null +++ b/doc/classes/int.xml @@ -0,0 +1,44 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="int" category="Built-In Types" version="3.0.alpha.custom_build"> + <brief_description> + Integer built-in type. + </brief_description> + <description> + Integer built-in type. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="int"> + <return type="int"> + </return> + <argument index="0" name="from" type="bool"> + </argument> + <description> + Cast a [bool] value to an integer value, [code]int(true)[/code] will be equals to 1 and [code]int(false)[/code] will be equals to 0. + </description> + </method> + <method name="int"> + <return type="int"> + </return> + <argument index="0" name="from" type="float"> + </argument> + <description> + Cast a float value to an integer value, this method simply removes the number fractions, so for example [code]int(2.7)[/code] will be equals to 2, [code]int(.1)[/code] will be equals to 0 and [code]int(-2.7)[/code] will be equals to -2. + </description> + </method> + <method name="int"> + <return type="int"> + </return> + <argument index="0" name="from" type="String"> + </argument> + <description> + Cast a [String] value to an integer value, this method is an integer parser from a string, so calling this method with an invalid integer string will return 0, a valid string will be something like [code]'1.7'[/code]. This method will ignore all non-number characters, so calling [code]int('1e3')[/code] will return 13. + </description> + </method> + </methods> + <constants> + </constants> +</class> |