diff --git a/class_@gdscript.md b/class_@gdscript.md index 41a3014..80d2319 100644 --- a/class_@gdscript.md +++ b/class_@gdscript.md @@ -64,226 +64,226 @@ This contains the list of built-in gdscript functions. Mostly math functions and ### Member Function Description #### sin - * [real](class_real) **[sin](#sin)** **(** [real](class_real) s **)** -\\ + * [real](class_real) **sin** **(** [real](class_real) s **)** + Standard sine function. #### cos - * [real](class_real) **[cos](#cos)** **(** [real](class_real) s **)** -\\ + * [real](class_real) **cos** **(** [real](class_real) s **)** + Standard cosine function. #### tan - * [real](class_real) **[tan](#tan)** **(** [real](class_real) s **)** -\\ + * [real](class_real) **tan** **(** [real](class_real) s **)** + Standard tangent function. #### sinh - * [real](class_real) **[sinh](#sinh)** **(** [real](class_real) s **)** -\\ + * [real](class_real) **sinh** **(** [real](class_real) s **)** + Hyperbolic sine. #### tanh - * [real](class_real) **[tanh](#tanh)** **(** [real](class_real) s **)** -\\ + * [real](class_real) **tanh** **(** [real](class_real) s **)** + Hyperbolic tangent. #### asin - * [real](class_real) **[asin](#asin)** **(** [real](class_real) s **)** -\\ + * [real](class_real) **asin** **(** [real](class_real) s **)** + Arc-sine. #### acos - * [real](class_real) **[acos](#acos)** **(** [real](class_real) s **)** -\\ + * [real](class_real) **acos** **(** [real](class_real) s **)** + Arc-cosine. #### atan - * [real](class_real) **[atan](#atan)** **(** [real](class_real) s **)** -\\ + * [real](class_real) **atan** **(** [real](class_real) s **)** + Arc-tangent. #### atan2 - * [real](class_real) **[atan2](#atan2)** **(** [real](class_real) x, [real](class_real) y **)** -\\ + * [real](class_real) **atan2** **(** [real](class_real) x, [real](class_real) y **)** + Arc-tangent that takes a 2D vector as argument, retuns the full -pi to +pi range. #### sqrt - * [real](class_real) **[sqrt](#sqrt)** **(** [real](class_real) s **)** -\\ + * [real](class_real) **sqrt** **(** [real](class_real) s **)** + Square root. #### fmod - * [real](class_real) **[fmod](#fmod)** **(** [real](class_real) x, [real](class_real) y **)** -\\ + * [real](class_real) **fmod** **(** [real](class_real) x, [real](class_real) y **)** + Module (remainder of x/y). #### fposmod - * [real](class_real) **[fposmod](#fposmod)** **(** [real](class_real) x, [real](class_real) y **)** -\\ + * [real](class_real) **fposmod** **(** [real](class_real) x, [real](class_real) y **)** + Module (remainder of x/y) that wraps equally in positive and negative. #### floor - * [real](class_real) **[floor](#floor)** **(** [real](class_real) s **)** -\\ + * [real](class_real) **floor** **(** [real](class_real) s **)** + Floor (rounds down to nearest integer). #### ceil - * [real](class_real) **[ceil](#ceil)** **(** [real](class_real) s **)** -\\ + * [real](class_real) **ceil** **(** [real](class_real) s **)** + Ceiling (rounds up to nearest integer). #### round - * [real](class_real) **[round](#round)** **(** [real](class_real) s **)** -\\ + * [real](class_real) **round** **(** [real](class_real) s **)** + Round to nearest integer. #### abs - * [real](class_real) **[abs](#abs)** **(** [real](class_real) s **)** -\\ + * [real](class_real) **abs** **(** [real](class_real) s **)** + Remove sign (works for integer and float). #### sign - * [real](class_real) **[sign](#sign)** **(** [real](class_real) s **)** -\\ + * [real](class_real) **sign** **(** [real](class_real) s **)** + Return sign (-1 or +1). #### pow - * [real](class_real) **[pow](#pow)** **(** [real](class_real) x, [real](class_real) y **)** -\\ + * [real](class_real) **pow** **(** [real](class_real) x, [real](class_real) y **)** + Power function, x elevate to y. #### log - * [real](class_real) **[log](#log)** **(** [real](class_real) s **)** -\\ + * [real](class_real) **log** **(** [real](class_real) s **)** + Natural logarithm. #### exp - * [real](class_real) **[exp](#exp)** **(** [real](class_real) s **)** -\\ + * [real](class_real) **exp** **(** [real](class_real) s **)** + Exponential logarithm. #### isnan - * [real](class_real) **[isnan](#isnan)** **(** [real](class_real) s **)** -\\ + * [real](class_real) **isnan** **(** [real](class_real) s **)** + Return true if the float is not a number. #### isinf - * [real](class_real) **[isinf](#isinf)** **(** [real](class_real) s **)** -\\ + * [real](class_real) **isinf** **(** [real](class_real) s **)** + Return true if the float is infinite. #### ease - * [real](class_real) **[ease](#ease)** **(** [real](class_real) s, [real](class_real) curve **)** -\\ + * [real](class_real) **ease** **(** [real](class_real) s, [real](class_real) curve **)** + Easing function, based on exponent. 0 is constant, 1 is linear, 0 to 1 is ease-in, 1+ is ease out. Negative values are in-out/out in. #### decimals - * [real](class_real) **[decimals](#decimals)** **(** [real](class_real) step **)** -\\ + * [real](class_real) **decimals** **(** [real](class_real) step **)** + Return the amount of decimals in the floating point value. #### stepify - * [real](class_real) **[stepify](#stepify)** **(** [real](class_real) s, [real](class_real) step **)** -\\ + * [real](class_real) **stepify** **(** [real](class_real) s, [real](class_real) step **)** + Snap float value to a given step. #### rand - * [int](class_int) **[rand](#rand)** **(** **)** -\\ + * [int](class_int) **rand** **(** **)** + Random value (integer). #### randf - * [real](class_real) **[randf](#randf)** **(** **)** -\\ + * [real](class_real) **randf** **(** **)** + Random value (0 to 1 float). #### rand_range - * [real](class_real) **[rand_range](#rand_range)** **(** [real](class_real) from, [real](class_real) to **)** -\\ + * [real](class_real) **rand_range** **(** [real](class_real) from, [real](class_real) to **)** + Random range. #### rand_seed - * [Array](class_array) **[rand_seed](#rand_seed)** **(** [real](class_real) seed **)** -\\ + * [Array](class_array) **rand_seed** **(** [real](class_real) seed **)** + random from seed, pass a seed and an array with both number and new seed is returned. #### deg2rad - * [real](class_real) **[deg2rad](#deg2rad)** **(** [real](class_real) deg **)** -\\ + * [real](class_real) **deg2rad** **(** [real](class_real) deg **)** + Convert from degrees to radians. #### rad2deg - * [real](class_real) **[rad2deg](#rad2deg)** **(** [real](class_real) rad **)** -\\ + * [real](class_real) **rad2deg** **(** [real](class_real) rad **)** + Convert from radias to degrees. #### linear2db - * [real](class_real) **[linear2db](#linear2db)** **(** [real](class_real) nrg **)** -\\ + * [real](class_real) **linear2db** **(** [real](class_real) nrg **)** + Convert from linear energy to decibels (audio). #### db2linear - * [real](class_real) **[db2linear](#db2linear)** **(** [real](class_real) db **)** -\\ + * [real](class_real) **db2linear** **(** [real](class_real) db **)** + Convert from decibels to linear energy (audio). #### max - * [real](class_real) **[max](#max)** **(** [real](class_real) a, [real](class_real) b **)** -\\ + * [real](class_real) **max** **(** [real](class_real) a, [real](class_real) b **)** + Return the maximum of two values. #### min - * [real](class_real) **[min](#min)** **(** [real](class_real) a, [real](class_real) b **)** -\\ + * [real](class_real) **min** **(** [real](class_real) a, [real](class_real) b **)** + Return the minimum of two values. #### clamp - * [real](class_real) **[clamp](#clamp)** **(** [real](class_real) val, [real](class_real) min, [real](class_real) max **)** -\\ + * [real](class_real) **clamp** **(** [real](class_real) val, [real](class_real) min, [real](class_real) max **)** + Clamp both values to a range. #### nearest_po2 - * [int](class_int) **[nearest_po2](#nearest_po2)** **(** [int](class_int) val **)** -\\ + * [int](class_int) **nearest_po2** **(** [int](class_int) val **)** + Return the nearest larger power of 2 for an integer. #### weakref - * [Object](class_object) **[weakref](#weakref)** **(** [Object](class_object) obj **)** -\\ + * [Object](class_object) **weakref** **(** [Object](class_object) obj **)** + Return a weak reference to an object. #### convert - * [Object](class_object) **[convert](#convert)** **(** var what, [int](class_int) type **)** -\\ + * [Object](class_object) **convert** **(** var what, [int](class_int) type **)** + Convert from a type to another in the best way possible. The "type" parameter uses the enum TYPE_* in Global Scope. #### str - * [String](class_string) **[str](#str)** **(** var what, var ... **)** -\\ + * [String](class_string) **str** **(** var what, var ... **)** + Convert one or more arguments to strings in the best way possible. #### str - * [String](class_string) **[str](#str)** **(** var what, var ... **)** -\\ + * [String](class_string) **str** **(** var what, var ... **)** + Convert one or more arguments to strings in the best way possible. #### print - * [Nil](class_nil) **[print](#print)** **(** var what, var ... **)** -\\ + * [Nil](class_nil) **print** **(** var what, var ... **)** + Print one or more arguments to strings in the best way possible to a console line. #### printerr - * [Nil](class_nil) **[printerr](#printerr)** **(** var what, var ... **)** -\\ + * [Nil](class_nil) **printerr** **(** var what, var ... **)** + Print one or more arguments to strings in the best way possible to standard error line. #### printraw - * [Nil](class_nil) **[printraw](#printraw)** **(** var what, var ... **)** -\\ + * [Nil](class_nil) **printraw** **(** var what, var ... **)** + Print one or more arguments to strings in the best way possible to console. No newline is added at the end. #### range - * [Array](class_array) **[range](#range)** **(** var ... **)** -\\ + * [Array](class_array) **range** **(** var ... **)** + Return an array with the given range. Range can be 1 argument N (0 to N-1), two arguments (initial, final-1) or three arguments (initial,final-1,increment). diff --git a/class_aabb.md b/class_aabb.md index 6d222d1..6f9609c 100644 --- a/class_aabb.md +++ b/class_aabb.md @@ -38,111 +38,111 @@ AABB provides an 3D Axis-Aligned Bounding Box. It consists of a ### Member Function Description #### encloses - * [bool](class_bool) **[encloses](#encloses)** **(** [AABB](class_aabb) with **)** -\\ + * [bool](class_bool) **encloses** **(** [AABB](class_aabb) with **)** + Return true if this [[aabb|AABB]] completely encloses another one. #### expand - * [AABB](class_aabb) **[expand](#expand)** **(** [Vector3](class_vector3) to_point **)** -\\ + * [AABB](class_aabb) **expand** **(** [Vector3](class_vector3) to_point **)** + Return this [[aabb|AABB]] expanded to include a given point. #### get_area - * [real](class_real) **[get_area](#get_area)** **(** **)** -\\ + * [real](class_real) **get_area** **(** **)** + Get the area inside the [[aabb|AABB]] #### get_endpoint - * [Vector3](class_vector3) **[get_endpoint](#get_endpoint)** **(** [int](class_int) idx **)** -\\ + * [Vector3](class_vector3) **get_endpoint** **(** [int](class_int) idx **)** + Get the position of the 8 endpoints of the [[aabb|AABB]] in space. #### get_longest_axis - * [Vector3](class_vector3) **[get_longest_axis](#get_longest_axis)** **(** **)** -\\ + * [Vector3](class_vector3) **get_longest_axis** **(** **)** + Return the normalized longest axis of the [[aabb|AABB]] #### get_longest_axis_index - * [int](class_int) **[get_longest_axis_index](#get_longest_axis_index)** **(** **)** -\\ + * [int](class_int) **get_longest_axis_index** **(** **)** + Return the index of the longest axis of the [[aabb|AABB]] (according to [[vector3|Vector3]]::AXIS* enum). #### get_longest_axis_size - * [real](class_real) **[get_longest_axis_size](#get_longest_axis_size)** **(** **)** -\\ + * [real](class_real) **get_longest_axis_size** **(** **)** + Return the scalar length of the longest axis of the [[aabb|AABB]]. #### get_shortest_axis - * [Vector3](class_vector3) **[get_shortest_axis](#get_shortest_axis)** **(** **)** -\\ + * [Vector3](class_vector3) **get_shortest_axis** **(** **)** + Return the normalized shortest axis of the [[aabb|AABB]] #### get_shortest_axis_index - * [int](class_int) **[get_shortest_axis_index](#get_shortest_axis_index)** **(** **)** -\\ + * [int](class_int) **get_shortest_axis_index** **(** **)** + Return the index of the shortest axis of the [[aabb|AABB]] (according to [[vector3|Vector3]]::AXIS* enum). #### get_shortest_axis_size - * [real](class_real) **[get_shortest_axis_size](#get_shortest_axis_size)** **(** **)** -\\ + * [real](class_real) **get_shortest_axis_size** **(** **)** + Return the scalar length of the shortest axis of the [[aabb|AABB]]. #### get_support - * [Vector3](class_vector3) **[get_support](#get_support)** **(** [Vector3](class_vector3) dir **)** -\\ + * [Vector3](class_vector3) **get_support** **(** [Vector3](class_vector3) dir **)** + Return the support point in a given direction. This is useful for collision detection algorithms. #### grow - * [AABB](class_aabb) **[grow](#grow)** **(** [real](class_real) by **)** -\\ + * [AABB](class_aabb) **grow** **(** [real](class_real) by **)** + Return a copy of the AABB grown a given a mount of units towards all the sides. #### has_no_area - * [bool](class_bool) **[has_no_area](#has_no_area)** **(** **)** -\\ + * [bool](class_bool) **has_no_area** **(** **)** + Return true if the [[aabb|AABB]] is flat or empty. #### has_no_surface - * [bool](class_bool) **[has_no_surface](#has_no_surface)** **(** **)** -\\ + * [bool](class_bool) **has_no_surface** **(** **)** + Return true if the [[aabb|AABB]] is empty. #### has_point - * [bool](class_bool) **[has_point](#has_point)** **(** [Vector3](class_vector3) point **)** -\\ + * [bool](class_bool) **has_point** **(** [Vector3](class_vector3) point **)** + Return true if the [[aabb|AABB]] contains a point. #### intersection - * [AABB](class_aabb) **[intersection](#intersection)** **(** [AABB](class_aabb) with **)** -\\ + * [AABB](class_aabb) **intersection** **(** [AABB](class_aabb) with **)** + Return the intersection between two [[aabb|AABB]]s. An empty AABB (size 0,0,0) is returned on failure. #### intersects - * [bool](class_bool) **[intersects](#intersects)** **(** [AABB](class_aabb) with **)** -\\ + * [bool](class_bool) **intersects** **(** [AABB](class_aabb) with **)** + Return true if the [[aabb|AABB]] overlaps with another. #### intersects_plane - * [bool](class_bool) **[intersects_plane](#intersects_plane)** **(** [Plane](class_plane) plane **)** -\\ + * [bool](class_bool) **intersects_plane** **(** [Plane](class_plane) plane **)** + Return true if the AABB is at both sides of a plane. #### merge - * [AABB](class_aabb) **[merge](#merge)** **(** [AABB](class_aabb) with **)** -\\ + * [AABB](class_aabb) **merge** **(** [AABB](class_aabb) with **)** + Combine this [[aabb|AABB]] with another one, a larger one is returned that contains both. #### AABB - * void **[AABB](#AABB)** **(** [Vector3](class_vector3) pos, [Vector3](class_vector3) size **)** -\\ + * void **AABB** **(** [Vector3](class_vector3) pos, [Vector3](class_vector3) size **)** + Optional constructor, accepts position and size. diff --git a/class_acceptdialog.md b/class_acceptdialog.md index 691225a..f5b5952 100644 --- a/class_acceptdialog.md +++ b/class_acceptdialog.md @@ -25,39 +25,39 @@ This dialog is useful for small notifications to the user about an ### Member Function Description #### get_ok - * [Object](class_object) **[get_ok](#get_ok)** **(** **)** -\\ + * [Object](class_object) **get_ok** **(** **)** + Return the OK Button. #### get_label - * [Object](class_object) **[get_label](#get_label)** **(** **)** -\\ + * [Object](class_object) **get_label** **(** **)** + Return the label used for built-in text. #### set_hide_on_ok - * void **[set_hide_on_ok](#set_hide_on_ok)** **(** [bool](class_bool) enabled **)** -\\ + * void **set_hide_on_ok** **(** [bool](class_bool) enabled **)** + Set whether the dialog is hidden when accepted (default true). #### get_hide_on_ok - * [bool](class_bool) **[get_hide_on_ok](#get_hide_on_ok)** **(** **)** const -\\ + * [bool](class_bool) **get_hide_on_ok** **(** **)** const + Return true if the dialog will be hidden when accepted (default true). #### register_text_enter - * void **[register_text_enter](#register_text_enter)** **(** [Object](class_object) line_edit **)** -\\ + * void **register_text_enter** **(** [Object](class_object) line_edit **)** + Register a [[lineedit|LineEdit]] in the dialog. When the enter key is pressed, the dialog will be accepted. #### set_text - * void **[set_text](#set_text)** **(** [String](class_string) text **)** -\\ + * void **set_text** **(** [String](class_string) text **)** + Set the built-in label text. #### get_text - * [String](class_string) **[get_text](#get_text)** **(** **)** const -\\ + * [String](class_string) **get_text** **(** **)** const + Return the built-in label text. diff --git a/class_animation.md b/class_animation.md index ac4ce0a..2a1ef65 100644 --- a/class_animation.md +++ b/class_animation.md @@ -56,168 +56,168 @@ An Animation resource contains data used to animate everything in the engine. An ### Member Function Description #### add_track - * [int](class_int) **[add_track](#add_track)** **(** [int](class_int) type, [int](class_int) at_pos=-1 **)** -\\ + * [int](class_int) **add_track** **(** [int](class_int) type, [int](class_int) at_pos=-1 **)** + Add a track to the Animation. The track type must be specified as any of the values in te TYPE_* enumeration. #### remove_track - * void **[remove_track](#remove_track)** **(** [int](class_int) idx **)** -\\ + * void **remove_track** **(** [int](class_int) idx **)** + Remove a track by specifying the track index. #### get_track_count - * [int](class_int) **[get_track_count](#get_track_count)** **(** **)** const -\\ + * [int](class_int) **get_track_count** **(** **)** const + Return the amount of tracks in the animation. #### track_get_type - * [int](class_int) **[track_get_type](#track_get_type)** **(** [int](class_int) idx **)** const -\\ + * [int](class_int) **track_get_type** **(** [int](class_int) idx **)** const + Get the type of a track. #### track_get_path - * [NodePath](class_nodepath) **[track_get_path](#track_get_path)** **(** [int](class_int) idx **)** const -\\ + * [NodePath](class_nodepath) **track_get_path** **(** [int](class_int) idx **)** const + Get the path of a track. for more information on the path format, see [[#track_set_path|track_set_path]] #### track_set_path - * void **[track_set_path](#track_set_path)** **(** [int](class_int) idx, [NodePath](class_nodepath) path **)** -\\ + * void **track_set_path** **(** [int](class_int) idx, [NodePath](class_nodepath) path **)** + Set the path of a track. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by ":". Example: "character/skeleton:ankle" or "character/mesh:transform/local" #### track_move_up - * void **[track_move_up](#track_move_up)** **(** [int](class_int) idx **)** -\\ + * void **track_move_up** **(** [int](class_int) idx **)** + Move a track up. #### track_move_down - * void **[track_move_down](#track_move_down)** **(** [int](class_int) idx **)** -\\ + * void **track_move_down** **(** [int](class_int) idx **)** + Nove a track down. #### transform_track_insert_key - * [int](class_int) **[transform_track_insert_key](#transform_track_insert_key)** **(** [int](class_int) idx, [real](class_real) time, [Vector3](class_vector3) loc, [Quat](class_quat) rot, [Vector3](class_vector3) scale **)** -\\ + * [int](class_int) **transform_track_insert_key** **(** [int](class_int) idx, [real](class_real) time, [Vector3](class_vector3) loc, [Quat](class_quat) rot, [Vector3](class_vector3) scale **)** + Insert a transform key for a transform track. #### track_insert_key - * void **[track_insert_key](#track_insert_key)** **(** [int](class_int) idx, [real](class_real) time, var key, [real](class_real) transition=1 **)** -\\ + * void **track_insert_key** **(** [int](class_int) idx, [real](class_real) time, var key, [real](class_real) transition=1 **)** + Insert a generic key in a given track. #### track_remove_key - * void **[track_remove_key](#track_remove_key)** **(** [int](class_int) idx, [int](class_int) key_idx **)** -\\ + * void **track_remove_key** **(** [int](class_int) idx, [int](class_int) key_idx **)** + Remove a key by index in a given track. #### track_remove_key_at_pos - * void **[track_remove_key_at_pos](#track_remove_key_at_pos)** **(** [int](class_int) idx, [real](class_real) pos **)** -\\ + * void **track_remove_key_at_pos** **(** [int](class_int) idx, [real](class_real) pos **)** + Remove a key by position (seconds) in a given track. #### track_set_key_value - * void **[track_set_key_value](#track_set_key_value)** **(** [int](class_int) idx, [int](class_int) key, var value **)** -\\ + * void **track_set_key_value** **(** [int](class_int) idx, [int](class_int) key, var value **)** + Set the value of an existing key. #### track_set_key_transition - * void **[track_set_key_transition](#track_set_key_transition)** **(** [int](class_int) idx, [int](class_int) key_idx, [real](class_real) transition **)** -\\ + * void **track_set_key_transition** **(** [int](class_int) idx, [int](class_int) key_idx, [real](class_real) transition **)** + Set the transition curve (easing) for a specific key (see built-in math function "ease"). #### track_get_key_transition - * [real](class_real) **[track_get_key_transition](#track_get_key_transition)** **(** [int](class_int) idx, [int](class_int) key_idx **)** const -\\ + * [real](class_real) **track_get_key_transition** **(** [int](class_int) idx, [int](class_int) key_idx **)** const + Return the transition curve (easing) for a specific key (see built-in math function "ease"). #### track_get_key_count - * [int](class_int) **[track_get_key_count](#track_get_key_count)** **(** [int](class_int) idx **)** const -\\ + * [int](class_int) **track_get_key_count** **(** [int](class_int) idx **)** const + Return the amount of keys in a given track. #### track_get_key_value - * void **[track_get_key_value](#track_get_key_value)** **(** [int](class_int) idx, [int](class_int) key_idx **)** const -\\ + * void **track_get_key_value** **(** [int](class_int) idx, [int](class_int) key_idx **)** const + Return the value of a given key in a given track. #### track_get_key_time - * [real](class_real) **[track_get_key_time](#track_get_key_time)** **(** [int](class_int) idx, [int](class_int) key_idx **)** const -\\ + * [real](class_real) **track_get_key_time** **(** [int](class_int) idx, [int](class_int) key_idx **)** const + Return the time at which the key is located. #### track_find_key - * [int](class_int) **[track_find_key](#track_find_key)** **(** [int](class_int) idx, [real](class_real) time, [bool](class_bool) exact=false **)** const -\\ + * [int](class_int) **track_find_key** **(** [int](class_int) idx, [real](class_real) time, [bool](class_bool) exact=false **)** const + Find the key index by time in a given track. Optionally, only find it if the exact time is given. #### track_set_interpolation_type - * void **[track_set_interpolation_type](#track_set_interpolation_type)** **(** [int](class_int) idx, [int](class_int) interpolation **)** -\\ + * void **track_set_interpolation_type** **(** [int](class_int) idx, [int](class_int) interpolation **)** + Set the interpolation type of a given track, from the INTERPOLATION_* enum. #### track_get_interpolation_type - * [int](class_int) **[track_get_interpolation_type](#track_get_interpolation_type)** **(** [int](class_int) idx **)** const -\\ + * [int](class_int) **track_get_interpolation_type** **(** [int](class_int) idx **)** const + Return the interpolation type of a given track, from the INTERPOLATION_* enum. #### transform_track_interpolate - * [Array](class_array) **[transform_track_interpolate](#transform_track_interpolate)** **(** [int](class_int) idx, [real](class_real) time_sec **)** const -\\ + * [Array](class_array) **transform_track_interpolate** **(** [int](class_int) idx, [real](class_real) time_sec **)** const + Return the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position ([[vector3|Vector3]]), rotation ([[quat|Quat]]) and scale ([[vector3|Vector3]]). #### value_track_set_continuous - * void **[value_track_set_continuous](#value_track_set_continuous)** **(** [int](class_int) idx, [bool](class_bool) continuous **)** -\\ + * void **value_track_set_continuous** **(** [int](class_int) idx, [bool](class_bool) continuous **)** + Enable or disable interpolation for a whole track. By default tracks are interpolated. #### value_track_is_continuous - * [bool](class_bool) **[value_track_is_continuous](#value_track_is_continuous)** **(** [int](class_int) idx **)** const -\\ + * [bool](class_bool) **value_track_is_continuous** **(** [int](class_int) idx **)** const + Return wether interpolation is enabled or disabled for a whole track. By default tracks are interpolated. #### value_track_get_key_indices - * [IntArray](class_intarray) **[value_track_get_key_indices](#value_track_get_key_indices)** **(** [int](class_int) idx, [real](class_real) time_sec, [real](class_real) delta **)** const -\\ + * [IntArray](class_intarray) **value_track_get_key_indices** **(** [int](class_int) idx, [real](class_real) time_sec, [real](class_real) delta **)** const + Return all the key indices of a value track, given a position and delta time. #### method_track_get_key_indices - * [IntArray](class_intarray) **[method_track_get_key_indices](#method_track_get_key_indices)** **(** [int](class_int) idx, [real](class_real) time_sec, [real](class_real) delta **)** const -\\ + * [IntArray](class_intarray) **method_track_get_key_indices** **(** [int](class_int) idx, [real](class_real) time_sec, [real](class_real) delta **)** const + Return all the key indices of a method track, given a position and delta time. #### method_track_get_name - * [String](class_string) **[method_track_get_name](#method_track_get_name)** **(** [int](class_int) idx, [int](class_int) key_idx **)** const -\\ + * [String](class_string) **method_track_get_name** **(** [int](class_int) idx, [int](class_int) key_idx **)** const + Return the method name of a method track. #### method_track_get_params - * [Array](class_array) **[method_track_get_params](#method_track_get_params)** **(** [int](class_int) idx, [int](class_int) key_idx **)** const -\\ + * [Array](class_array) **method_track_get_params** **(** [int](class_int) idx, [int](class_int) key_idx **)** const + Return the arguments values to be called on a method track for a given key in a given track. #### set_length - * void **[set_length](#set_length)** **(** [real](class_real) time_sec **)** -\\ + * void **set_length** **(** [real](class_real) time_sec **)** + 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. #### get_length - * [real](class_real) **[get_length](#get_length)** **(** **)** const -\\ + * [real](class_real) **get_length** **(** **)** const + Return the total length of the animation (in seconds). #### set_loop - * void **[set_loop](#set_loop)** **(** [bool](class_bool) enabled **)** -\\ + * void **set_loop** **(** [bool](class_bool) enabled **)** + 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. #### has_loop - * [bool](class_bool) **[has_loop](#has_loop)** **(** **)** const -\\ + * [bool](class_bool) **has_loop** **(** **)** const + Return wether the animation has the loop flag set. #### clear - * void **[clear](#clear)** **(** **)** -\\ + * void **clear** **(** **)** + Clear the animation (clear all tracks and reset all). diff --git a/class_animationplayer.md b/class_animationplayer.md index aa83a77..5830206 100644 --- a/class_animationplayer.md +++ b/class_animationplayer.md @@ -53,136 +53,136 @@ An animation player is used for general purpose playback of [[animation|Animatio ### Member Function Description #### add_animation - * [int](class_int) **[add_animation](#add_animation)** **(** [String](class_string) name, [Animation](class_animation) animation **)** -\\ + * [int](class_int) **add_animation** **(** [String](class_string) name, [Animation](class_animation) animation **)** + Add an animation resource to the player, which will be later referenced by the "name" arguemnt. #### remove_animation - * void **[remove_animation](#remove_animation)** **(** [String](class_string) name **)** -\\ + * void **remove_animation** **(** [String](class_string) name **)** + Remove an animation from the player (by supplying the same name used to add it). #### rename_animation - * void **[rename_animation](#rename_animation)** **(** [String](class_string) name, [String](class_string) newname **)** -\\ + * void **rename_animation** **(** [String](class_string) name, [String](class_string) newname **)** + Rename an existing animation. #### has_animation - * [bool](class_bool) **[has_animation](#has_animation)** **(** [String](class_string) name **)** const -\\ + * [bool](class_bool) **has_animation** **(** [String](class_string) name **)** const + Request wether an [[animation|Animation]] name exist within the player. #### get_animation - * [Animation](class_animation) **[get_animation](#get_animation)** **(** [String](class_string) name **)** const -\\ + * [Animation](class_animation) **get_animation** **(** [String](class_string) name **)** const + Get an [[animation|Animation]] resource by requesting a name. #### get_animation_list - * [StringArray](class_stringarray) **[get_animation_list](#get_animation_list)** **(** **)** const -\\ + * [StringArray](class_stringarray) **get_animation_list** **(** **)** const + Get the list of names of the animations stored in the player. #### set_blend_time - * void **[set_blend_time](#set_blend_time)** **(** [String](class_string) anim_from, [String](class_string) anim_to, [real](class_real) sec **)** -\\ + * void **set_blend_time** **(** [String](class_string) anim_from, [String](class_string) anim_to, [real](class_real) sec **)** + Specify a blend time (in seconds) between two animations, referemced by their names. #### get_blend_time - * [real](class_real) **[get_blend_time](#get_blend_time)** **(** [String](class_string) anim_from, [String](class_string) anim_to **)** const -\\ + * [real](class_real) **get_blend_time** **(** [String](class_string) anim_from, [String](class_string) anim_to **)** const + Get the blend time between two animations, referemced by their names. #### set_default_blend_time - * void **[set_default_blend_time](#set_default_blend_time)** **(** [real](class_real) sec **)** -\\ + * void **set_default_blend_time** **(** [real](class_real) sec **)** + Set the default blend time between animations. #### get_default_blend_time - * [real](class_real) **[get_default_blend_time](#get_default_blend_time)** **(** **)** const -\\ + * [real](class_real) **get_default_blend_time** **(** **)** const + Return the default blend time between animations. #### stop_all - * void **[stop_all](#stop_all)** **(** **)** -\\ + * void **stop_all** **(** **)** + Stop playback on all animation channels. #### is_playing - * [bool](class_bool) **[is_playing](#is_playing)** **(** **)** const -\\ + * [bool](class_bool) **is_playing** **(** **)** const + Return wether an animation chanel is playing (or channel 0 if none is provided). #### set_current_animation - * void **[set_current_animation](#set_current_animation)** **(** [String](class_string) anim **)** -\\ + * void **set_current_animation** **(** [String](class_string) anim **)** + Set the current animation (even if no playback occurs). Using set_current_animation() and set_active() are similar to claling play(). #### get_current_animation - * [String](class_string) **[get_current_animation](#get_current_animation)** **(** **)** const -\\ + * [String](class_string) **get_current_animation** **(** **)** const + Return the name of the animation being played in a channel (or channel 0 if none is provided). #### queue - * void **[queue](#queue)** **(** [String](class_string) name **)** -\\ + * void **queue** **(** [String](class_string) name **)** + Queue an animation for playback once the current one is done. #### set_active - * void **[set_active](#set_active)** **(** [bool](class_bool) active **)** -\\ + * void **set_active** **(** [bool](class_bool) active **)** + Set the player as active (playing) #### is_active - * [bool](class_bool) **[is_active](#is_active)** **(** **)** const -\\ + * [bool](class_bool) **is_active** **(** **)** const + Return true if the player is active. #### set_speed - * void **[set_speed](#set_speed)** **(** [real](class_real) speed **)** -\\ + * void **set_speed** **(** [real](class_real) speed **)** + Set a speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is //1// (no scaling). #### get_speed - * [real](class_real) **[get_speed](#get_speed)** **(** **)** const -\\ + * [real](class_real) **get_speed** **(** **)** const + Get the speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is //1// (no scaling). #### set_autoplay - * void **[set_autoplay](#set_autoplay)** **(** [String](class_string) name **)** -\\ + * void **set_autoplay** **(** [String](class_string) name **)** + Set the name of the animation that will be automatically played when the scene is loaded. #### get_autoplay - * [String](class_string) **[get_autoplay](#get_autoplay)** **(** **)** const -\\ + * [String](class_string) **get_autoplay** **(** **)** const + Return the name of the animation that will be automatically played when the scene is loaded. #### seek - * void **[seek](#seek)** **(** [real](class_real) pos_sec, [bool](class_bool) update=false **)** -\\ + * void **seek** **(** [real](class_real) pos_sec, [bool](class_bool) update=false **)** + Seek the animation in an animation channel (or channel 0 if none is provided) to a specific position (in seconds). #### get_pos - * [real](class_real) **[get_pos](#get_pos)** **(** **)** const -\\ + * [real](class_real) **get_pos** **(** **)** const + Return the playback position (in seconds) in an animation channel (or channel 0 if none is provided) #### find_animation - * [String](class_string) **[find_animation](#find_animation)** **(** [Animation](class_animation) animation **)** const -\\ + * [String](class_string) **find_animation** **(** [Animation](class_animation) animation **)** const + Find an animation name by resource. #### clear_caches - * void **[clear_caches](#clear_caches)** **(** **)** -\\ + * void **clear_caches** **(** **)** + 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. #### set_animation_process_mode - * void **[set_animation_process_mode](#set_animation_process_mode)** **(** [int](class_int) mode **)** -\\ + * void **set_animation_process_mode** **(** [int](class_int) mode **)** + 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_*. #### get_animation_process_mode - * [int](class_int) **[get_animation_process_mode](#get_animation_process_mode)** **(** **)** const -\\ + * [int](class_int) **get_animation_process_mode** **(** **)** const + Return the mode in which the animation player processes. See [[#set_animation_process_mode|set_animation_process_mode]]. diff --git a/class_area2d.md b/class_area2d.md index 45488c0..4e69320 100644 --- a/class_area2d.md +++ b/class_area2d.md @@ -31,16 +31,16 @@ General purpose area detection for 2D Phisics. Areas can be used for detection o ### Member Function Description #### set_gravity_is_point - * void **[set_gravity_is_point](#set_gravity_is_point)** **(** [bool](class_bool) enable **)** -\\ + * void **set_gravity_is_point** **(** [bool](class_bool) enable **)** + When overriding space parameters, areas can have a center of gravity as a point. #### is_gravity_a_point - * [bool](class_bool) **[is_gravity_a_point](#is_gravity_a_point)** **(** **)** const -\\ + * [bool](class_bool) **is_gravity_a_point** **(** **)** const + Return if gravity is a point. When overriding space parameters, areas can have a center of gravity as a point. #### set_gravity_vector - * void **[set_gravity_vector](#set_gravity_vector)** **(** [Vector2](class_vector2) vector **)** -\\ + * void **set_gravity_vector** **(** [Vector2](class_vector2) vector **)** + Set gravity vector. If gravity is a point, this will be the attraction center diff --git a/class_array.md b/class_array.md index 9b227a1..d8afefa 100644 --- a/class_array.md +++ b/class_array.md @@ -32,76 +32,76 @@ Generic array, contains several elements of any type, accessible by numerical in ### Member Function Description #### clear - * void **[clear](#clear)** **(** **)** -\\ + * void **clear** **(** **)** + Clear the array (resize to 0). #### empty - * [bool](class_bool) **[empty](#empty)** **(** **)** -\\ + * [bool](class_bool) **empty** **(** **)** + Return true if the array is empty (size==0). #### hash - * [int](class_int) **[hash](#hash)** **(** **)** -\\ + * [int](class_int) **hash** **(** **)** + Return a hashed integer value representing the array contents. #### insert - * void **[insert](#insert)** **(** [int](class_int) pos, var value **)** -\\ + * void **insert** **(** [int](class_int) pos, var value **)** + Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). #### push_back - * void **[push_back](#push_back)** **(** var value **)** -\\ + * void **push_back** **(** var value **)** + Append an element at the end of the array. #### remove - * void **[remove](#remove)** **(** [int](class_int) pos **)** -\\ + * void **remove** **(** [int](class_int) pos **)** + Remove an element from the array by index. #### resize - * void **[resize](#resize)** **(** [int](class_int) pos **)** -\\ + * void **resize** **(** [int](class_int) pos **)** + 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. #### size - * [int](class_int) **[size](#size)** **(** **)** -\\ + * [int](class_int) **size** **(** **)** + Return the amount of elements in the array. #### Array - * void **[Array](#Array)** **(** [RawArray](class_rawarray) from **)** -\\ + * void **Array** **(** [RawArray](class_rawarray) from **)** + Construct an array from a [[rawarray|RawArray]]. #### Array - * void **[Array](#Array)** **(** [IntArray](class_intarray) from **)** -\\ + * void **Array** **(** [IntArray](class_intarray) from **)** + Construct an array from a [[rawarray|RawArray]]. #### Array - * void **[Array](#Array)** **(** [RealArray](class_realarray) from **)** -\\ + * void **Array** **(** [RealArray](class_realarray) from **)** + Construct an array from a [[rawarray|RawArray]]. #### Array - * void **[Array](#Array)** **(** [StringArray](class_stringarray) from **)** -\\ + * void **Array** **(** [StringArray](class_stringarray) from **)** + Construct an array from a [[rawarray|RawArray]]. #### Array - * void **[Array](#Array)** **(** [Vector2Array](class_vector2array) from **)** -\\ + * void **Array** **(** [Vector2Array](class_vector2array) from **)** + Construct an array from a [[rawarray|RawArray]]. #### Array - * void **[Array](#Array)** **(** [Vector3Array](class_vector3array) from **)** -\\ + * void **Array** **(** [Vector3Array](class_vector3array) from **)** + Construct an array from a [[rawarray|RawArray]]. #### Array - * void **[Array](#Array)** **(** [ColorArray](class_colorarray) from **)** -\\ + * void **Array** **(** [ColorArray](class_colorarray) from **)** + Construct an array from a [[rawarray|RawArray]]. diff --git a/class_audioserver.md b/class_audioserver.md index 037906b..4ba6877 100644 --- a/class_audioserver.md +++ b/class_audioserver.md @@ -75,211 +75,211 @@ AudioServer is a low level server interface for audio access. It is"#10;"#9;in c ### Member Function Description #### sample_create - * [RID](class_rid) **[sample_create](#sample_create)** **(** [int](class_int) format, [bool](class_bool) stereo, [int](class_int) length **)** -\\ + * [RID](class_rid) **sample_create** **(** [int](class_int) format, [bool](class_bool) stereo, [int](class_int) length **)** + Create an audio sample, return a [[rid|RID]] referencing"#10;"#9;"#9;"#9;it. The sample will be created with a given format"#10;"#9;"#9;"#9;(from the SAMPLE_FORMAT_* enum), a total length (in"#10;"#9;"#9;"#9;frames, not samples or bytes), in either stereo or"#10;"#9;"#9;"#9;mono. #### sample_set_description - * void **[sample_set_description](#sample_set_description)** **(** [RID](class_rid) sample, [String](class_string) description **)** -\\ + * void **sample_set_description** **(** [RID](class_rid) sample, [String](class_string) description **)** + Set the description of an audio sample. Mainly used"#10;"#9;"#9;"#9;for organization. #### sample_get_description - * [String](class_string) **[sample_get_description](#sample_get_description)** **(** [RID](class_rid) sample, [String](class_string) arg1 **)** const -\\ + * [String](class_string) **sample_get_description** **(** [RID](class_rid) sample, [String](class_string) arg1 **)** const + Return the description of an audio sample. Mainly"#10;"#9;"#9;"#9;used for organization. #### sample_get_format - * [int](class_int) **[sample_get_format](#sample_get_format)** **(** [RID](class_rid) sample **)** const -\\ + * [int](class_int) **sample_get_format** **(** [RID](class_rid) sample **)** const + Return the format of the audio sample, in the form"#10;"#9;"#9;"#9;of the SAMPLE_FORMAT_* enum. #### sample_is_stereo - * [bool](class_bool) **[sample_is_stereo](#sample_is_stereo)** **(** [RID](class_rid) sample **)** const -\\ + * [bool](class_bool) **sample_is_stereo** **(** [RID](class_rid) sample **)** const + Return wether the sample is stereo (2 channels) #### sample_get_length - * [int](class_int) **[sample_get_length](#sample_get_length)** **(** [RID](class_rid) sample **)** const -\\ + * [int](class_int) **sample_get_length** **(** [RID](class_rid) sample **)** const + Return the length in frames of the audio sample (not"#10;"#9;"#9;"#9;samples or bytes). #### sample_set_signed_data - * void **[sample_set_signed_data](#sample_set_signed_data)** **(** [RID](class_rid) sample, [RealArray](class_realarray) data **)** -\\ + * void **sample_set_signed_data** **(** [RID](class_rid) sample, [RealArray](class_realarray) data **)** + Set the sample data for a given sample as an array"#10;"#9;"#9;"#9;of floats. The length must be equal to the sample"#10;"#9;"#9;"#9;lenght or an error will be produced. #### sample_set_data - * void **[sample_set_data](#sample_set_data)** **(** [RID](class_rid) sample, [RawArray](class_rawarray) arg1 **)** -\\ + * void **sample_set_data** **(** [RID](class_rid) sample, [RawArray](class_rawarray) arg1 **)** + Set the sample data for a given sample as an array"#10;"#9;"#9;"#9;of bytes. The length must be equal to the sample"#10;"#9;"#9;"#9;lenght expected in bytes or an error will be produced. #### sample_get_data - * [RawArray](class_rawarray) **[sample_get_data](#sample_get_data)** **(** [RID](class_rid) sample **)** const -\\ + * [RawArray](class_rawarray) **sample_get_data** **(** [RID](class_rid) sample **)** const + Return the sample data as an array of bytes. The"#10;"#9;"#9;"#9;length will be the expected length in bytes. #### sample_set_mix_rate - * void **[sample_set_mix_rate](#sample_set_mix_rate)** **(** [RID](class_rid) sample, [int](class_int) mix_rate **)** -\\ + * void **sample_set_mix_rate** **(** [RID](class_rid) sample, [int](class_int) mix_rate **)** + Change the default mix rate of a given sample. #### sample_get_mix_rate - * [int](class_int) **[sample_get_mix_rate](#sample_get_mix_rate)** **(** [RID](class_rid) sample **)** const -\\ + * [int](class_int) **sample_get_mix_rate** **(** [RID](class_rid) sample **)** const + Return the mix rate of the given sample. #### sample_set_loop_format - * void **[sample_set_loop_format](#sample_set_loop_format)** **(** [RID](class_rid) sample, [int](class_int) loop_format **)** -\\ + * void **sample_set_loop_format** **(** [RID](class_rid) sample, [int](class_int) loop_format **)** + Set the loop format for a sample from the"#10;"#9;"#9;"#9;SAMPLE_LOOP_* enum. As a warning, Ping Pong loops"#10;"#9;"#9;"#9;may not be available on some hardware-mixing"#10;"#9;"#9;"#9;platforms. #### sample_get_loop_format - * [int](class_int) **[sample_get_loop_format](#sample_get_loop_format)** **(** [RID](class_rid) sample **)** const -\\ + * [int](class_int) **sample_get_loop_format** **(** [RID](class_rid) sample **)** const + Return the loop format for a sample, as a value from"#10;"#9;"#9;"#9;the SAMPLE_LOOP_* enum. #### sample_set_loop_begin - * void **[sample_set_loop_begin](#sample_set_loop_begin)** **(** [RID](class_rid) sample, [int](class_int) pos **)** -\\ + * void **sample_set_loop_begin** **(** [RID](class_rid) sample, [int](class_int) pos **)** + Set the initial loop point of a sample. Only has"#10;"#9;"#9;"#9;effect if sample loop is enabled. See [[#sample_set_loop_format|sample_set_loop_format]]. #### sample_get_loop_begin - * [int](class_int) **[sample_get_loop_begin](#sample_get_loop_begin)** **(** [RID](class_rid) sample **)** const -\\ + * [int](class_int) **sample_get_loop_begin** **(** [RID](class_rid) sample **)** const + Return the initial loop point of a sample. Only has"#10;"#9;"#9;"#9;effect if sample loop is enabled. See [[#sample_set_loop_format|sample_set_loop_format]]. #### sample_set_loop_end - * void **[sample_set_loop_end](#sample_set_loop_end)** **(** [RID](class_rid) sample, [int](class_int) pos **)** -\\ + * void **sample_set_loop_end** **(** [RID](class_rid) sample, [int](class_int) pos **)** + Set the final loop point of a sample. Only has"#10;"#9;"#9;"#9;effect if sample loop is enabled. See [[#sample_set_loop_format|sample_set_loop_format]]. #### sample_get_loop_end - * [int](class_int) **[sample_get_loop_end](#sample_get_loop_end)** **(** [RID](class_rid) sample **)** const -\\ + * [int](class_int) **sample_get_loop_end** **(** [RID](class_rid) sample **)** const + Return the final loop point of a sample. Only has"#10;"#9;"#9;"#9;effect if sample loop is enabled. See [[#sample_set_loop_format|sample_set_loop_format]]. #### voice_create - * [RID](class_rid) **[voice_create](#voice_create)** **(** **)** -\\ + * [RID](class_rid) **voice_create** **(** **)** + Allocate a voice for playback. Voices are"#10;"#9;"#9;"#9;persistent. A voice can play a single sample at the"#10;"#9;"#9;"#9;same time. See [[#sample_create|sample_create]]. #### voice_play - * void **[voice_play](#voice_play)** **(** [RID](class_rid) voice, [RID](class_rid) sample **)** -\\ + * void **voice_play** **(** [RID](class_rid) voice, [RID](class_rid) sample **)** + Start playback of a given voice using a given"#10;"#9;"#9;"#9;sample. If the voice was already playing it will be"#10;"#9;"#9;"#9;restarted. #### voice_set_volume - * void **[voice_set_volume](#voice_set_volume)** **(** [RID](class_rid) voice, [real](class_real) volume **)** -\\ + * void **voice_set_volume** **(** [RID](class_rid) voice, [real](class_real) volume **)** + Change the volume of a currently playing voice."#10;"#9;"#9;"#9;Volume is expressed as linear gain where 0.0 is mute"#10;"#9;"#9;"#9;and 1.0 is default. #### voice_set_pan - * void **[voice_set_pan](#voice_set_pan)** **(** [RID](class_rid) voice, [real](class_real) pan, [real](class_real) depth=0, [real](class_real) height=0 **)** -\\ + * void **voice_set_pan** **(** [RID](class_rid) voice, [real](class_real) pan, [real](class_real) depth=0, [real](class_real) height=0 **)** + Change the pan of a currently playing voice and,"#10;"#9;"#9;"#9;optionally, the depth and height for a positional/3D"#10;"#9;"#9;"#9;sound. Panning values are expressed within the -1 to"#10;"#9;"#9;"#9;+1 range. #### voice_set_filter - * void **[voice_set_filter](#voice_set_filter)** **(** [RID](class_rid) voice, [int](class_int) type, [real](class_real) cutoff, [real](class_real) resonance, [real](class_real) gain=0 **)** -\\ + * void **voice_set_filter** **(** [RID](class_rid) voice, [int](class_int) type, [real](class_real) cutoff, [real](class_real) resonance, [real](class_real) gain=0 **)** + Set a resonant filter post processing for the voice."#10;"#9;"#9;"#9;Filter type is a value from the FILTER_* enum. #### voice_set_chorus - * void **[voice_set_chorus](#voice_set_chorus)** **(** [RID](class_rid) voice, [real](class_real) chorus **)** -\\ + * void **voice_set_chorus** **(** [RID](class_rid) voice, [real](class_real) chorus **)** + Set chorus send post processing for the voice (from"#10;"#9;"#9;"#9;0 to 1). #### voice_set_reverb - * void **[voice_set_reverb](#voice_set_reverb)** **(** [RID](class_rid) voice, [int](class_int) room, [real](class_real) reverb **)** -\\ + * void **voice_set_reverb** **(** [RID](class_rid) voice, [int](class_int) room, [real](class_real) reverb **)** + Set the reverb send post processing for the voice (from"#10;"#9;"#9;"#9;0 to 1) and the reverb type, from the REVERB_* enum. #### voice_set_mix_rate - * void **[voice_set_mix_rate](#voice_set_mix_rate)** **(** [RID](class_rid) voice, [int](class_int) rate **)** -\\ + * void **voice_set_mix_rate** **(** [RID](class_rid) voice, [int](class_int) rate **)** + Set a different playback mix rate for the given"#10;"#9;"#9;"#9;voice. #### voice_set_positional - * void **[voice_set_positional](#voice_set_positional)** **(** [RID](class_rid) voice, [bool](class_bool) enabled **)** -\\ + * void **voice_set_positional** **(** [RID](class_rid) voice, [bool](class_bool) enabled **)** + Set wether a given voice is positional. This is only"#10;"#9;"#9;"#9;interpreted as a hint and used for backends that may"#10;"#9;"#9;"#9;support binaural encoding. #### voice_get_volume - * [real](class_real) **[voice_get_volume](#voice_get_volume)** **(** [RID](class_rid) voice **)** const -\\ + * [real](class_real) **voice_get_volume** **(** [RID](class_rid) voice **)** const + Return the current volume for a given voice. #### voice_get_pan - * [real](class_real) **[voice_get_pan](#voice_get_pan)** **(** [RID](class_rid) voice **)** const -\\ + * [real](class_real) **voice_get_pan** **(** [RID](class_rid) voice **)** const + Return the current pan for a given voice (-1 to +1"#10;"#9;"#9;"#9;range). #### voice_get_pan_height - * [real](class_real) **[voice_get_pan_height](#voice_get_pan_height)** **(** [RID](class_rid) voice **)** const -\\ + * [real](class_real) **voice_get_pan_height** **(** [RID](class_rid) voice **)** const + Return the current pan height for a given voice (-1 to +1"#10;"#9;"#9;"#9;range). #### voice_get_pan_depth - * [real](class_real) **[voice_get_pan_depth](#voice_get_pan_depth)** **(** [RID](class_rid) voice **)** const -\\ + * [real](class_real) **voice_get_pan_depth** **(** [RID](class_rid) voice **)** const + Return the current pan depth for a given voice (-1 to +1"#10;"#9;"#9;"#9;range). #### voice_get_filter_type - * [int](class_int) **[voice_get_filter_type](#voice_get_filter_type)** **(** [RID](class_rid) voice **)** const -\\ + * [int](class_int) **voice_get_filter_type** **(** [RID](class_rid) voice **)** const + Return the current selected filter type for a given"#10;"#9;"#9;"#9;voice, from the FILTER_* enum. #### voice_get_filter_cutoff - * [real](class_real) **[voice_get_filter_cutoff](#voice_get_filter_cutoff)** **(** [RID](class_rid) voice **)** const -\\ + * [real](class_real) **voice_get_filter_cutoff** **(** [RID](class_rid) voice **)** const + Return the current filter cutoff (in hz) for a given"#10;"#9;"#9;"#9;voice. #### voice_get_filter_resonance - * [real](class_real) **[voice_get_filter_resonance](#voice_get_filter_resonance)** **(** [RID](class_rid) voice **)** const -\\ + * [real](class_real) **voice_get_filter_resonance** **(** [RID](class_rid) voice **)** const + Return the current filter resonance for a given"#10;"#9;"#9;"#9;voice. #### voice_get_chorus - * [real](class_real) **[voice_get_chorus](#voice_get_chorus)** **(** [RID](class_rid) voice **)** const -\\ + * [real](class_real) **voice_get_chorus** **(** [RID](class_rid) voice **)** const + Return the current chorus send for a given"#10;"#9;"#9;"#9;voice (0 to 1). #### voice_get_reverb_type - * [int](class_int) **[voice_get_reverb_type](#voice_get_reverb_type)** **(** [RID](class_rid) voice **)** const -\\ + * [int](class_int) **voice_get_reverb_type** **(** [RID](class_rid) voice **)** const + Return the current reverb type for a given voice"#10;"#9;"#9;"#9;from the REVERB_* enum. #### voice_get_reverb - * [real](class_real) **[voice_get_reverb](#voice_get_reverb)** **(** [RID](class_rid) voice **)** const -\\ + * [real](class_real) **voice_get_reverb** **(** [RID](class_rid) voice **)** const + Return the current reverb send for a given voice"#10;"#9;"#9;"#9;(0 to 1). #### voice_get_mix_rate - * [int](class_int) **[voice_get_mix_rate](#voice_get_mix_rate)** **(** [RID](class_rid) voice **)** const -\\ + * [int](class_int) **voice_get_mix_rate** **(** [RID](class_rid) voice **)** const + Return the current mix rate for a given voice. #### voice_is_positional - * [bool](class_bool) **[voice_is_positional](#voice_is_positional)** **(** [RID](class_rid) voice **)** const -\\ + * [bool](class_bool) **voice_is_positional** **(** [RID](class_rid) voice **)** const + Return wether the current voice is positional. See"#10;"#9;"#9;"#9;[[#voice_set_positional|voice_set_positional]]. #### voice_stop - * void **[voice_stop](#voice_stop)** **(** [RID](class_rid) voice **)** -\\ + * void **voice_stop** **(** [RID](class_rid) voice **)** + Stop a given voice. #### free - * void **[free](#free)** **(** [RID](class_rid) rid **)** -\\ + * void **free** **(** [RID](class_rid) rid **)** + Free a [[rid|RID]] resource. #### set_stream_global_volume_scale - * void **[set_stream_global_volume_scale](#set_stream_global_volume_scale)** **(** [real](class_real) scale **)** -\\ + * void **set_stream_global_volume_scale** **(** [real](class_real) scale **)** + Set global scale for stream playback. Default is 1.0. #### get_stream_global_volume_scale - * [real](class_real) **[get_stream_global_volume_scale](#get_stream_global_volume_scale)** **(** **)** const -\\ + * [real](class_real) **get_stream_global_volume_scale** **(** **)** const + Return the global scale for stream playback. diff --git a/class_audiostream.md b/class_audiostream.md index 8e79665..f76c2cd 100644 --- a/class_audiostream.md +++ b/class_audiostream.md @@ -28,56 +28,56 @@ Base class for audio streams. Audio streams are used for music"#10;"#9;playback, ### Member Function Description #### play - * void **[play](#play)** **(** **)** -\\ + * void **play** **(** **)** + Start playback of an audio stream. #### stop - * void **[stop](#stop)** **(** **)** -\\ + * void **stop** **(** **)** + Stop playback of an audio stream. #### is_playing - * [bool](class_bool) **[is_playing](#is_playing)** **(** **)** const -\\ + * [bool](class_bool) **is_playing** **(** **)** const + Return wether the audio stream is currently playing. #### set_loop - * void **[set_loop](#set_loop)** **(** [bool](class_bool) enabled **)** -\\ + * void **set_loop** **(** [bool](class_bool) enabled **)** + Set the loop hint for the audio stream playback. if"#10;"#9;"#9;"#9;true, audio stream will attempt to loop (restart)"#10;"#9;"#9;"#9;when finished. #### has_loop - * [bool](class_bool) **[has_loop](#has_loop)** **(** **)** const -\\ + * [bool](class_bool) **has_loop** **(** **)** const + Return wether the audio stream loops. See [[#set_loop|set_loop]] #### get_stream_name - * [String](class_string) **[get_stream_name](#get_stream_name)** **(** **)** const -\\ + * [String](class_string) **get_stream_name** **(** **)** const + Return the name of the audio stream. Often the song"#10;"#9;"#9;"#9;title when the stream is music. #### get_loop_count - * [int](class_int) **[get_loop_count](#get_loop_count)** **(** **)** const -\\ + * [int](class_int) **get_loop_count** **(** **)** const + Return the amount of times that the stream has"#10;"#9;"#9;"#9;looped (if loop is supported). #### seek_pos - * void **[seek_pos](#seek_pos)** **(** [real](class_real) pos **)** -\\ + * void **seek_pos** **(** [real](class_real) pos **)** + Seek to a certain position (in seconds) in an audio"#10;"#9;"#9;"#9;stream. #### get_pos - * [real](class_real) **[get_pos](#get_pos)** **(** **)** const -\\ + * [real](class_real) **get_pos** **(** **)** const + Return the current playing position (in seconds) of the audio"#10;"#9;"#9;"#9;stream (if supported). Since this value is updated"#10;"#9;"#9;"#9;internally, it may not be exact or updated"#10;"#9;"#9;"#9;continuosly. Accuracy depends on the sample buffer"#10;"#9;"#9;"#9;size of the audio driver. #### get_update_mode - * [int](class_int) **[get_update_mode](#get_update_mode)** **(** **)** const -\\ + * [int](class_int) **get_update_mode** **(** **)** const + Return the type of update that the stream uses. Some"#10;"#9;"#9;"#9;types of stream may need manual polling. #### update - * void **[update](#update)** **(** **)** -\\ + * void **update** **(** **)** + Manually poll the audio stream (if it is requested"#10;"#9;"#9;"#9;to). diff --git a/class_audiostreamgibberish.md b/class_audiostreamgibberish.md index d80c9b8..ab0826c 100644 --- a/class_audiostreamgibberish.md +++ b/class_audiostreamgibberish.md @@ -19,41 +19,41 @@ AudioStream used for gibberish playback. It plays randomized phonemes, which can ### Member Function Description #### set_phonemes - * void **[set_phonemes](#set_phonemes)** **(** [Object](class_object) phonemes **)** -\\ + * void **set_phonemes** **(** [Object](class_object) phonemes **)** + Set the phoneme library. #### get_phonemes - * [Object](class_object) **[get_phonemes](#get_phonemes)** **(** **)** const -\\ + * [Object](class_object) **get_phonemes** **(** **)** const + Return the phoneme library. #### set_pitch_scale - * void **[set_pitch_scale](#set_pitch_scale)** **(** [real](class_real) pitch_scale **)** -\\ + * void **set_pitch_scale** **(** [real](class_real) pitch_scale **)** + Set pitch scale for the speech. Animating this value holds amusing results. #### get_pitch_scale - * [real](class_real) **[get_pitch_scale](#get_pitch_scale)** **(** **)** const -\\ + * [real](class_real) **get_pitch_scale** **(** **)** const + Return the pitch scale. #### set_pitch_random_scale - * void **[set_pitch_random_scale](#set_pitch_random_scale)** **(** [real](class_real) pitch_random_scale **)** -\\ + * void **set_pitch_random_scale** **(** [real](class_real) pitch_random_scale **)** + Set the random scaling for the pitch. #### get_pitch_random_scale - * [real](class_real) **[get_pitch_random_scale](#get_pitch_random_scale)** **(** **)** const -\\ + * [real](class_real) **get_pitch_random_scale** **(** **)** const + Return the pitch random scaling. #### set_xfade_time - * void **[set_xfade_time](#set_xfade_time)** **(** [real](class_real) sec **)** -\\ + * void **set_xfade_time** **(** [real](class_real) sec **)** + Set the cross-fade time between random phonemes. #### get_xfade_time - * [real](class_real) **[get_xfade_time](#get_xfade_time)** **(** **)** const -\\ + * [real](class_real) **get_xfade_time** **(** **)** const + Return the cross-fade time between random phonemes. diff --git a/class_audiostreammpc.md b/class_audiostreammpc.md index fd0aa7e..12890f8 100644 --- a/class_audiostreammpc.md +++ b/class_audiostreammpc.md @@ -13,11 +13,11 @@ MusePack audio stream driver. ### Member Function Description #### set_file - * void **[set_file](#set_file)** **(** [String](class_string) name **)** -\\ + * void **set_file** **(** [String](class_string) name **)** + Set the file to be played. #### get_file - * [String](class_string) **[get_file](#get_file)** **(** **)** const -\\ + * [String](class_string) **get_file** **(** **)** const + Return the file being played. diff --git a/class_audiostreamspeex.md b/class_audiostreamspeex.md index 0063d01..3ac0695 100644 --- a/class_audiostreamspeex.md +++ b/class_audiostreamspeex.md @@ -13,11 +13,11 @@ Speex audio stream driver. Speex is very useful for compressed speech. It allows ### Member Function Description #### set_file - * void **[set_file](#set_file)** **(** [String](class_string) file **)** -\\ + * void **set_file** **(** [String](class_string) file **)** + Set the speech file (which is loaded to memory). #### get_file - * [String](class_string) **[get_file](#get_file)** **(** **)** const -\\ + * [String](class_string) **get_file** **(** **)** const + Return the speech file. diff --git a/class_basebutton.md b/class_basebutton.md index 45c6d4a..885a741 100644 --- a/class_basebutton.md +++ b/class_basebutton.md @@ -23,41 +23,41 @@ BaseButton is the abstract base class for buttons, so it shouldn't be used direc ### Member Function Description #### set_pressed - * void **[set_pressed](#set_pressed)** **(** [bool](class_bool) pressed **)** -\\ + * void **set_pressed** **(** [bool](class_bool) pressed **)** + Set the button to pressed state (only if toggle_mode is active). #### is_pressed - * [bool](class_bool) **[is_pressed](#is_pressed)** **(** **)** const -\\ + * [bool](class_bool) **is_pressed** **(** **)** const + Return when the button is pressed (only if toggle_mode is active). #### set_toggle_mode - * void **[set_toggle_mode](#set_toggle_mode)** **(** [bool](class_bool) enabled **)** -\\ + * void **set_toggle_mode** **(** [bool](class_bool) enabled **)** + Set the button toggle_mode property. Toggle mode makes the button flip state between pressed and unpressed each time its area is clicked. #### is_toggle_mode - * [bool](class_bool) **[is_toggle_mode](#is_toggle_mode)** **(** **)** const -\\ + * [bool](class_bool) **is_toggle_mode** **(** **)** const + Return the toggle_mode property (see [[#set_toggle_mode|set_toggle_mode]]). #### set_disabled - * void **[set_disabled](#set_disabled)** **(** [bool](class_bool) disabled **)** -\\ + * void **set_disabled** **(** [bool](class_bool) disabled **)** + Set the button into disabled state. When a button is disabled, it can"apos;t be clicked or toggled. #### is_disabled - * [bool](class_bool) **[is_disabled](#is_disabled)** **(** **)** const -\\ + * [bool](class_bool) **is_disabled** **(** **)** const + Return wether the button is in disabled state (see [[#set_disabled|set_disabled]]). #### set_click_on_press - * void **[set_click_on_press](#set_click_on_press)** **(** [bool](class_bool) enable **)** -\\ + * void **set_click_on_press** **(** [bool](class_bool) enable **)** + Set the button click_on_press mode. This mode generates click events when a mousebutton or key is just pressed (by default events are generated when the button/keys are released and both press and release occur in the visual area of the Button). #### get_click_on_press - * [bool](class_bool) **[get_click_on_press](#get_click_on_press)** **(** **)** const -\\ + * [bool](class_bool) **get_click_on_press** **(** **)** const + Return the state of the click_on_press property (see [[#set_click_on_press|set_click_on_press]]). diff --git a/class_boxshape.md b/class_boxshape.md index 582e1e3..415a8b7 100644 --- a/class_boxshape.md +++ b/class_boxshape.md @@ -13,11 +13,11 @@ Box shape resource, which can be set into a [[physicsbody|PhysicsBody]] or area. ### Member Function Description #### set_extents - * void **[set_extents](#set_extents)** **(** [Vector3](class_vector3) extents **)** -\\ + * void **set_extents** **(** [Vector3](class_vector3) extents **)** + Set the half extents for the shape. #### get_extents - * [Vector3](class_vector3) **[get_extents](#get_extents)** **(** **)** const -\\ + * [Vector3](class_vector3) **get_extents** **(** **)** const + Return the half extents of the shape. diff --git a/class_button.md b/class_button.md index feb3980..4a4a09b 100644 --- a/class_button.md +++ b/class_button.md @@ -21,31 +21,31 @@ Button is just the standard themed button: [image src="images/button_example.png ### Member Function Description #### set_text - * void **[set_text](#set_text)** **(** [String](class_string) text **)** -\\ + * void **set_text** **(** [String](class_string) text **)** + Set the button text, which will be displayed inside the button area. #### get_text - * [String](class_string) **[get_text](#get_text)** **(** **)** const -\\ + * [String](class_string) **get_text** **(** **)** const + Return the button text. #### set_flat - * void **[set_flat](#set_flat)** **(** [bool](class_bool) enabled **)** -\\ + * void **set_flat** **(** [bool](class_bool) enabled **)** + Set the //flat// property of a Button. Flat buttons don"apos;t display decoration unless hoevered or pressed. #### set_clip_text - * void **[set_clip_text](#set_clip_text)** **(** [bool](class_bool) enabled **)** -\\ + * void **set_clip_text** **(** [bool](class_bool) enabled **)** + Set the //clip_text// property of a Button. When this property is enabled, text that is too large to fit the button is clipped, when disabled (default) the Button will always be wide enough to hold the text. #### get_clip_text - * [bool](class_bool) **[get_clip_text](#get_clip_text)** **(** **)** const -\\ + * [bool](class_bool) **get_clip_text** **(** **)** const + Return the state of the //clip_text// property (see [[#set_clip_text|set_clip_text]]) #### is_flat - * [bool](class_bool) **[is_flat](#is_flat)** **(** **)** const -\\ + * [bool](class_bool) **is_flat** **(** **)** const + Return the state of the //flat// property (see [[#set_flat|set_flat]]) diff --git a/class_buttonarray.md b/class_buttonarray.md index 48067e4..9a3a764 100644 --- a/class_buttonarray.md +++ b/class_buttonarray.md @@ -33,51 +33,51 @@ Array of Buttons. A Button array is useful to have an array of buttons laid out ### Member Function Description #### add_button - * void **[add_button](#add_button)** **(** [String](class_string) text **)** -\\ + * void **add_button** **(** [String](class_string) text **)** + Add a new button. #### set_button_icon - * void **[set_button_icon](#set_button_icon)** **(** [int](class_int) button, [Object](class_object) icon **)** -\\ + * void **set_button_icon** **(** [int](class_int) button, [Object](class_object) icon **)** + Set the icon of an existing button. #### get_button_text - * [String](class_string) **[get_button_text](#get_button_text)** **(** [int](class_int) button **)** const -\\ + * [String](class_string) **get_button_text** **(** [int](class_int) button **)** const + Return the text of an existing button. #### get_button_icon - * [Object](class_object) **[get_button_icon](#get_button_icon)** **(** [int](class_int) button **)** const -\\ + * [Object](class_object) **get_button_icon** **(** [int](class_int) button **)** const + Return the icon of an existing button. #### get_button_count - * [int](class_int) **[get_button_count](#get_button_count)** **(** **)** const -\\ + * [int](class_int) **get_button_count** **(** **)** const + Return the amount of buttons in the array. #### get_selected - * [int](class_int) **[get_selected](#get_selected)** **(** **)** const -\\ + * [int](class_int) **get_selected** **(** **)** const + Return the currently selected button in the array. #### get_hovered - * [int](class_int) **[get_hovered](#get_hovered)** **(** **)** const -\\ + * [int](class_int) **get_hovered** **(** **)** const + Return the currently hovered button in the array. #### set_selected - * void **[set_selected](#set_selected)** **(** [int](class_int) button **)** -\\ + * void **set_selected** **(** [int](class_int) button **)** + Sekect a button in the array. #### erase_button - * void **[erase_button](#erase_button)** **(** [int](class_int) button **)** -\\ + * void **erase_button** **(** [int](class_int) button **)** + Remove a button in the array, by index. #### clear - * void **[clear](#clear)** **(** **)** -\\ + * void **clear** **(** **)** + Clear the button array. diff --git a/class_buttongroup.md b/class_buttongroup.md index 9c93ddc..62b7867 100644 --- a/class_buttongroup.md +++ b/class_buttongroup.md @@ -16,26 +16,26 @@ Group of [[button|Button]]s. All direct and indirect children buttons become rad ### Member Function Description #### get_pressed_button - * [BaseButton](class_basebutton) **[get_pressed_button](#get_pressed_button)** **(** **)** const -\\ + * [BaseButton](class_basebutton) **get_pressed_button** **(** **)** const + Return the pressed button. #### get_pressed_button_index - * [int](class_int) **[get_pressed_button_index](#get_pressed_button_index)** **(** **)** const -\\ + * [int](class_int) **get_pressed_button_index** **(** **)** const + Return the index of the pressed button (by tree order). #### get_focused_button - * [BaseButton](class_basebutton) **[get_focused_button](#get_focused_button)** **(** **)** const -\\ + * [BaseButton](class_basebutton) **get_focused_button** **(** **)** const + Return the focused button. #### get_button_list - * [Array](class_array) **[get_button_list](#get_button_list)** **(** **)** const -\\ + * [Array](class_array) **get_button_list** **(** **)** const + Return the list of all the buttons in the group. #### set_pressed_button - * void **[set_pressed_button](#set_pressed_button)** **(** [BaseButton](class_basebutton) button **)** -\\ + * void **set_pressed_button** **(** [BaseButton](class_basebutton) button **)** + Set the button to be pressed. diff --git a/class_camera.md b/class_camera.md index 2bacd11..db7cada 100644 --- a/class_camera.md +++ b/class_camera.md @@ -39,41 +39,41 @@ Camera is a special node that displays what is visible from its current location ### Member Function Description #### project_ray_normal - * [Vector3](class_vector3) **[project_ray_normal](#project_ray_normal)** **(** [Vector2](class_vector2) screen_point **)** const -\\ + * [Vector3](class_vector3) **project_ray_normal** **(** [Vector2](class_vector2) screen_point **)** const + Return a normal vector in worldspace, that is the result of projecting a point on the [[viewport|Viewport]] rectangle by the camera proyection. This is useful for casting rays in the form of (origin,normal) for object intersection or picking. #### project_ray_origin - * [Vector3](class_vector3) **[project_ray_origin](#project_ray_origin)** **(** [Vector2](class_vector2) screen_point **)** const -\\ + * [Vector3](class_vector3) **project_ray_origin** **(** [Vector2](class_vector2) screen_point **)** const + Return a 3D position in worldspace, that is the result of projecting a point on the [[viewport|Viewport]] rectangle by the camera proyection. This is useful for casting rays in the form of (origin,normal) for object intersection or picking. #### unproject_position - * [Vector2](class_vector2) **[unproject_position](#unproject_position)** **(** [Vector3](class_vector3) world_point **)** const -\\ + * [Vector2](class_vector2) **unproject_position** **(** [Vector3](class_vector3) world_point **)** const + Return how a 3D point in worldpsace maps to a 2D coordinate in the [[viewport|Viewport]] rectangle. #### set_perspective - * void **[set_perspective](#set_perspective)** **(** [real](class_real) fov, [real](class_real) z_near, [real](class_real) z_far **)** -\\ + * void **set_perspective** **(** [real](class_real) fov, [real](class_real) z_near, [real](class_real) z_far **)** + Set the camera projection to perspective mode, by specifying a //FOV// Y angle in degrees (FOV means Field of View), and the //near// and //far// clip planes in worldspace units. #### set_orthogonal - * void **[set_orthogonal](#set_orthogonal)** **(** [real](class_real) size, [real](class_real) z_near, [real](class_real) z_far **)** -\\ + * void **set_orthogonal** **(** [real](class_real) size, [real](class_real) z_near, [real](class_real) z_far **)** + Set the camera projection to orthogonal mode, by specifying a"#10;"#9;"#9;"#9;width and the //near// and //far// clip planes in worldspace units. (As a hint, 2D games often use this projection, with values specified in pixels) #### make_current - * void **[make_current](#make_current)** **(** **)** -\\ + * void **make_current** **(** **)** + Make this camera the current Camera for the [[viewport|Viewport]] (see class description). If the Camera Node is outside the scene tree, it will attempt to become current once it"apos;s added. #### is_current - * [bool](class_bool) **[is_current](#is_current)** **(** **)** const -\\ + * [bool](class_bool) **is_current** **(** **)** const + Return wether the Camera is the current one in the [[viewport|Viewport]], or plans to become current (if outside the scene tree). #### get_camera_transform - * [Transform](class_transform) **[get_camera_transform](#get_camera_transform)** **(** **)** const -\\ + * [Transform](class_transform) **get_camera_transform** **(** **)** const + Get the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the [[node|Node]] transform. diff --git a/class_camera2d.md b/class_camera2d.md index 5fbc1fa..bca04ec 100644 --- a/class_camera2d.md +++ b/class_camera2d.md @@ -41,62 +41,62 @@ Camera node for 2D scenes. It forces the screen (current layer) to scroll follow ### Member Function Description #### set_offset - * void **[set_offset](#set_offset)** **(** [Vector2](class_vector2) offset **)** -\\ + * void **set_offset** **(** [Vector2](class_vector2) offset **)** + Set the scroll offset. Useful for looking around or camera shake animations. #### get_offset - * [Vector2](class_vector2) **[get_offset](#get_offset)** **(** **)** const -\\ + * [Vector2](class_vector2) **get_offset** **(** **)** const + Return the scroll offset. #### set_centered - * void **[set_centered](#set_centered)** **(** [bool](class_bool) centered **)** -\\ + * void **set_centered** **(** [bool](class_bool) centered **)** + Set to true if the camera is at the center of the screen (default: true). #### is_centered - * [bool](class_bool) **[is_centered](#is_centered)** **(** **)** const -\\ + * [bool](class_bool) **is_centered** **(** **)** const + Return true if the camera is at the center of the screen (default: true). #### make_current - * void **[make_current](#make_current)** **(** **)** -\\ + * void **make_current** **(** **)** + Make this the current 2D camera for the scene (viewport and layer), in case there's many cameras in the scene. #### is_current - * [bool](class_bool) **[is_current](#is_current)** **(** **)** const -\\ + * [bool](class_bool) **is_current** **(** **)** const + Return true of this is the current camera (see [[camera2d#make_current|Camera2D.make_current]]). #### set_limit - * void **[set_limit](#set_limit)** **(** [int](class_int) margin, [int](class_int) limit **)** -\\ + * void **set_limit** **(** [int](class_int) margin, [int](class_int) limit **)** + Set the scrolling limit in pixels #### get_limit - * [int](class_int) **[get_limit](#get_limit)** **(** [int](class_int) margin **)** const -\\ + * [int](class_int) **get_limit** **(** [int](class_int) margin **)** const + Return the scrolling limit in pixels #### set_drag_margin - * void **[set_drag_margin](#set_drag_margin)** **(** [int](class_int) margin, [real](class_real) drag_margin **)** -\\ + * void **set_drag_margin** **(** [int](class_int) margin, [real](class_real) drag_margin **)** + 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. #### get_drag_margin - * [real](class_real) **[get_drag_margin](#get_drag_margin)** **(** [int](class_int) margin **)** const -\\ + * [real](class_real) **get_drag_margin** **(** [int](class_int) margin **)** const + Return the margins needed to drag the camera (see [[#set_drag_margin|set_drag_margin]]). #### get_camera_pos - * [Vector2](class_vector2) **[get_camera_pos](#get_camera_pos)** **(** **)** const -\\ + * [Vector2](class_vector2) **get_camera_pos** **(** **)** const + Return the camera position. #### force_update_scroll - * void **[force_update_scroll](#force_update_scroll)** **(** **)** -\\ + * void **force_update_scroll** **(** **)** + Force the camera to update scroll immediately. diff --git a/class_canvasitem.md b/class_canvasitem.md index d8282a4..5541e36 100644 --- a/class_canvasitem.md +++ b/class_canvasitem.md @@ -74,161 +74,161 @@ Base class of anything 2D. Canvas items are laid out in a tree and children inhe ### Member Function Description #### _draw - * void **[_draw](#_draw)** **(** **)** virtual -\\ + * void **_draw** **(** **)** virtual + Called (if exists) to draw the canvas item. #### edit_set_state - * void **[edit_set_state](#edit_set_state)** **(** var state **)** -\\ + * void **edit_set_state** **(** var state **)** + Used for editing, returns an opaque value represeting the transform state. #### edit_rotate - * void **[edit_rotate](#edit_rotate)** **(** [real](class_real) degrees **)** -\\ + * void **edit_rotate** **(** [real](class_real) degrees **)** + Used for editing, handle rotation. #### get_item_rect - * [Rect2](class_rect2) **[get_item_rect](#get_item_rect)** **(** **)** const -\\ + * [Rect2](class_rect2) **get_item_rect** **(** **)** const + Return a rect containing the editable contents of the item. #### get_canvas_item - * [RID](class_rid) **[get_canvas_item](#get_canvas_item)** **(** **)** const -\\ + * [RID](class_rid) **get_canvas_item** **(** **)** const + Return the canvas item RID used by [[visualserver|VisualServer]] for this item. #### is_visible - * [bool](class_bool) **[is_visible](#is_visible)** **(** **)** const -\\ + * [bool](class_bool) **is_visible** **(** **)** const + Return true if this CanvasItem is visible. It may be invisible because itself or a parent canvas item is hidden. #### is_hidden - * [bool](class_bool) **[is_hidden](#is_hidden)** **(** **)** const -\\ + * [bool](class_bool) **is_hidden** **(** **)** const + Return true if this CanvasItem is hidden. Note that the CanvasItem may not be visible, but as long as it's not hidden ([[#hide|hide]] called) the function will return false. #### show - * void **[show](#show)** **(** **)** -\\ + * void **show** **(** **)** + Show the CanvasItem currently hidden. #### hide - * void **[hide](#hide)** **(** **)** -\\ + * void **hide** **(** **)** + Hide the CanvasItem currently visible. #### update - * void **[update](#update)** **(** **)** -\\ + * void **update** **(** **)** + Queue the CanvasItem for update. NOTIFICATION_DRAW will be called on idle time to request redraw. #### set_as_toplevel - * void **[set_as_toplevel](#set_as_toplevel)** **(** [bool](class_bool) enable **)** -\\ + * void **set_as_toplevel** **(** [bool](class_bool) enable **)** + Set as toplevel. This means that it will not inherit transform from parent canvas items. #### is_set_as_toplevel - * [bool](class_bool) **[is_set_as_toplevel](#is_set_as_toplevel)** **(** **)** const -\\ + * [bool](class_bool) **is_set_as_toplevel** **(** **)** const + Return if set as toplevel. See [[#set_as_toplevel|set_as_toplevel]]/ #### set_blend_mode - * void **[set_blend_mode](#set_blend_mode)** **(** [int](class_int) blend_mode **)** -\\ + * void **set_blend_mode** **(** [int](class_int) blend_mode **)** + Set the blending mode from enum BLEND_MODE_*. #### get_blend_mode - * [int](class_int) **[get_blend_mode](#get_blend_mode)** **(** **)** const -\\ + * [int](class_int) **get_blend_mode** **(** **)** const + Return the current blending mode from enum BLEND_MODE_*. #### set_opacity - * void **[set_opacity](#set_opacity)** **(** [real](class_real) opacity **)** -\\ + * void **set_opacity** **(** [real](class_real) opacity **)** + Set canvas item opacity. This will affect the canvas item and all the children. #### get_opacity - * [real](class_real) **[get_opacity](#get_opacity)** **(** **)** const -\\ + * [real](class_real) **get_opacity** **(** **)** const + Return the canvas item opacity. This affects the canvas item and all the children. #### get_self_opacity - * [real](class_real) **[get_self_opacity](#get_self_opacity)** **(** **)** const -\\ + * [real](class_real) **get_self_opacity** **(** **)** const + Set canvas item self-opacity. This does not affect the opacity of children items. #### set_on_top - * void **[set_on_top](#set_on_top)** **(** [bool](class_bool) on_top **)** -\\ + * void **set_on_top** **(** [bool](class_bool) on_top **)** + Set canvas item as drawing over the parent canvas item (default: true). #### is_on_top - * [bool](class_bool) **[is_on_top](#is_on_top)** **(** **)** const -\\ + * [bool](class_bool) **is_on_top** **(** **)** const + Return if the canvas item is drawing over the parent canvas item (default: true). #### draw_line - * void **[draw_line](#draw_line)** **(** [Vector2](class_vector2) from, [Vector2](class_vector2) to, [Color](class_color) color, [real](class_real) width=1 **)** -\\ + * void **draw_line** **(** [Vector2](class_vector2) from, [Vector2](class_vector2) to, [Color](class_color) color, [real](class_real) width=1 **)** + Draw a line from a 2D point to another, with a given color and width. #### draw_rect - * void **[draw_rect](#draw_rect)** **(** [Rect2](class_rect2) rect, [Color](class_color) color **)** -\\ + * void **draw_rect** **(** [Rect2](class_rect2) rect, [Color](class_color) color **)** + Draw a colored rectangle. #### draw_circle - * void **[draw_circle](#draw_circle)** **(** [Vector2](class_vector2) pos, [real](class_real) radius, [Color](class_color) color **)** -\\ + * void **draw_circle** **(** [Vector2](class_vector2) pos, [real](class_real) radius, [Color](class_color) color **)** + Draw a colored circle. #### draw_texture - * void **[draw_texture](#draw_texture)** **(** [Texture](class_texture) texture, [Vector2](class_vector2) pos **)** -\\ + * void **draw_texture** **(** [Texture](class_texture) texture, [Vector2](class_vector2) pos **)** + Draw a texture at a given position. #### draw_texture_rect - * void **[draw_texture_rect](#draw_texture_rect)** **(** [Texture](class_texture) texture, [Rect2](class_rect2) rect, [bool](class_bool) tile=false, [Color](class_color) modulate=Color(1,1,1,1) **)** -\\ + * void **draw_texture_rect** **(** [Texture](class_texture) texture, [Rect2](class_rect2) rect, [bool](class_bool) tile=false, [Color](class_color) modulate=Color(1,1,1,1) **)** + Draw a textured rectangle at a given position, optionally modulated by a color. #### draw_texture_rect_region - * void **[draw_texture_rect_region](#draw_texture_rect_region)** **(** [Texture](class_texture) texture, [Rect2](class_rect2) rect, [Rect2](class_rect2) src_rect, [Color](class_color) modulate=Color(1,1,1,1) **)** -\\ + * void **draw_texture_rect_region** **(** [Texture](class_texture) texture, [Rect2](class_rect2) rect, [Rect2](class_rect2) src_rect, [Color](class_color) modulate=Color(1,1,1,1) **)** + Draw a textured rectangle region at a given position, optionally modulated by a color. #### draw_style_box - * void **[draw_style_box](#draw_style_box)** **(** [StyleBox](class_stylebox) style_box, [Rect2](class_rect2) rect **)** -\\ + * void **draw_style_box** **(** [StyleBox](class_stylebox) style_box, [Rect2](class_rect2) rect **)** + Draw a styled rectangle. #### draw_primitive - * void **[draw_primitive](#draw_primitive)** **(** [Vector2Array](class_vector2array) points, [ColorArray](class_colorarray) colors, [Vector2Array](class_vector2array) uvs=Array(), [Texture](class_texture) texture=Object(), [real](class_real) width=1 **)** -\\ + * void **draw_primitive** **(** [Vector2Array](class_vector2array) points, [ColorArray](class_colorarray) colors, [Vector2Array](class_vector2array) uvs=Array(), [Texture](class_texture) texture=Object(), [real](class_real) width=1 **)** + 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. #### draw_polygon - * void **[draw_polygon](#draw_polygon)** **(** [Vector2Array](class_vector2array) points, [ColorArray](class_colorarray) colors, [Vector2Array](class_vector2array) uvs, [Texture](class_texture) texture=Array(), [real](class_real) arg4=Object() **)** -\\ + * void **draw_polygon** **(** [Vector2Array](class_vector2array) points, [ColorArray](class_colorarray) colors, [Vector2Array](class_vector2array) uvs, [Texture](class_texture) texture=Array(), [real](class_real) arg4=Object() **)** + Draw a polygon of any amount of points, convex or concave. #### draw_colored_polygon - * void **[draw_colored_polygon](#draw_colored_polygon)** **(** [Vector2Array](class_vector2array) points, [ColorArray](class_colorarray) color, [Vector2Array](class_vector2array) uvs, [Texture](class_texture) texture=Array(), [real](class_real) arg4=Object() **)** -\\ + * void **draw_colored_polygon** **(** [Vector2Array](class_vector2array) points, [ColorArray](class_colorarray) color, [Vector2Array](class_vector2array) uvs, [Texture](class_texture) texture=Array(), [real](class_real) arg4=Object() **)** + Draw a colored polygon of any amount of points, convex or concave. #### draw_string - * void **[draw_string](#draw_string)** **(** [Font](class_font) font, [Vector2](class_vector2) pos, [String](class_string) text, [Color](class_color) modulate=Color(1,1,1,1), [int](class_int) clip_w=-1 **)** -\\ + * void **draw_string** **(** [Font](class_font) font, [Vector2](class_vector2) pos, [String](class_string) text, [Color](class_color) modulate=Color(1,1,1,1), [int](class_int) clip_w=-1 **)** + Draw a string using a custom font. #### draw_char - * [real](class_real) **[draw_char](#draw_char)** **(** [Font](class_font) font, [Vector2](class_vector2) pos, [String](class_string) char, [String](class_string) next, [Color](class_color) modulate=Color(1,1,1,1) **)** -\\ + * [real](class_real) **draw_char** **(** [Font](class_font) font, [Vector2](class_vector2) pos, [String](class_string) char, [String](class_string) next, [Color](class_color) modulate=Color(1,1,1,1) **)** + Draw a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char. #### draw_set_transform - * void **[draw_set_transform](#draw_set_transform)** **(** [Vector2](class_vector2) pos, [real](class_real) rot, [Vector2](class_vector2) scale **)** -\\ + * void **draw_set_transform** **(** [Vector2](class_vector2) pos, [real](class_real) rot, [Vector2](class_vector2) scale **)** + Set a custom transform for drawing. Anything drawn afterwards will be transformed by this. diff --git a/class_canvaslayer.md b/class_canvaslayer.md index 7ac765e..f63cba5 100644 --- a/class_canvaslayer.md +++ b/class_canvaslayer.md @@ -23,61 +23,61 @@ Canvas Item layer. [[canvasitem|CanvasItem]] nodes that are direct or indirect c ### Member Function Description #### set_layer - * void **[set_layer](#set_layer)** **(** [int](class_int) layer **)** -\\ + * void **set_layer** **(** [int](class_int) layer **)** + Set the layer index, determines the draw order, a lower value will be below a higher one. #### get_layer - * [int](class_int) **[get_layer](#get_layer)** **(** **)** const -\\ + * [int](class_int) **get_layer** **(** **)** const + Return the layer index, determines the draw order, a lower value will be below a higher one. #### set_transform - * void **[set_transform](#set_transform)** **(** [Matrix32](class_matrix32) transform **)** -\\ + * void **set_transform** **(** [Matrix32](class_matrix32) transform **)** + Set the base transform for this layer. #### get_transform - * [Matrix32](class_matrix32) **[get_transform](#get_transform)** **(** **)** const -\\ + * [Matrix32](class_matrix32) **get_transform** **(** **)** const + Return the base transform for this layer. #### set_offset - * void **[set_offset](#set_offset)** **(** [Vector2](class_vector2) offset **)** -\\ + * void **set_offset** **(** [Vector2](class_vector2) offset **)** + Set the base offset for this layer (helper). #### get_offset - * [Vector2](class_vector2) **[get_offset](#get_offset)** **(** **)** const -\\ + * [Vector2](class_vector2) **get_offset** **(** **)** const + Return the base offset for this layer (helper). #### set_rotation - * void **[set_rotation](#set_rotation)** **(** [real](class_real) rotation **)** -\\ + * void **set_rotation** **(** [real](class_real) rotation **)** + Set the base rotation for this layer (helper). #### get_rotation - * [real](class_real) **[get_rotation](#get_rotation)** **(** **)** const -\\ + * [real](class_real) **get_rotation** **(** **)** const + Return the base rotation for this layer (helper). #### set_scale - * void **[set_scale](#set_scale)** **(** [Vector2](class_vector2) scale **)** -\\ + * void **set_scale** **(** [Vector2](class_vector2) scale **)** + Set the base scale for this layer (helper). #### get_scale - * [Vector2](class_vector2) **[get_scale](#get_scale)** **(** **)** const -\\ + * [Vector2](class_vector2) **get_scale** **(** **)** const + Return the base scale for this layer (helper). #### get_world_2d - * Canvas **[get_world_2d](#get_world_2d)** **(** **)** const -\\ + * Canvas **get_world_2d** **(** **)** const + Return the [[world2d|World2D]] used by this layer. #### get_viewport - * [RID](class_rid) **[get_viewport](#get_viewport)** **(** **)** const -\\ + * [RID](class_rid) **get_viewport** **(** **)** const + Return the viewport RID for this layer. diff --git a/class_capsuleshape.md b/class_capsuleshape.md index c5f47a6..3429a4e 100644 --- a/class_capsuleshape.md +++ b/class_capsuleshape.md @@ -15,21 +15,21 @@ Capsule shape resource, which can be set into a [[physicsbody|PhysicsBody]] or a ### Member Function Description #### set_radius - * void **[set_radius](#set_radius)** **(** [real](class_real) radius **)** -\\ + * void **set_radius** **(** [real](class_real) radius **)** + Set the capsule radius. #### get_radius - * [real](class_real) **[get_radius](#get_radius)** **(** **)** const -\\ + * [real](class_real) **get_radius** **(** **)** const + Return the capsule radius. #### set_height - * void **[set_height](#set_height)** **(** [real](class_real) height **)** -\\ + * void **set_height** **(** [real](class_real) height **)** + Set the capsule height. #### get_height - * [real](class_real) **[get_height](#get_height)** **(** **)** const -\\ + * [real](class_real) **get_height** **(** **)** const + Return the capsule height. diff --git a/class_capsuleshape2d.md b/class_capsuleshape2d.md index 39b209e..61c2a53 100644 --- a/class_capsuleshape2d.md +++ b/class_capsuleshape2d.md @@ -15,21 +15,21 @@ Capsule 2D shape resource for physics. A capsule (or sometimes called "pill") is ### Member Function Description #### set_radius - * void **[set_radius](#set_radius)** **(** [real](class_real) radius **)** -\\ + * void **set_radius** **(** [real](class_real) radius **)** + Radius of the [[capsuleshape2d|CapsuleShape2D]]. #### get_radius - * [real](class_real) **[get_radius](#get_radius)** **(** **)** const -\\ + * [real](class_real) **get_radius** **(** **)** const + Return the radius of the [[capsuleshape2d|CapsuleShape2D]]. #### set_height - * void **[set_height](#set_height)** **(** [real](class_real) height **)** -\\ + * void **set_height** **(** [real](class_real) height **)** + Height of the [[capsuleshape2d|CapsuleShape2D]]. #### get_height - * [real](class_real) **[get_height](#get_height)** **(** **)** const -\\ + * [real](class_real) **get_height** **(** **)** const + Return the height of the [[capsuleshape2d|CapsuleShape2D]]. diff --git a/class_circleshape2d.md b/class_circleshape2d.md index 4e52b50..3bb57c5 100644 --- a/class_circleshape2d.md +++ b/class_circleshape2d.md @@ -13,11 +13,11 @@ Circular Shape for 2D Physics. This shape is useful for modelling balls or small ### Member Function Description #### set_radius - * void **[set_radius](#set_radius)** **(** [real](class_real) radius **)** -\\ + * void **set_radius** **(** [real](class_real) radius **)** + Set the radius of the circle shape; #### get_radius - * [real](class_real) **[get_radius](#get_radius)** **(** **)** const -\\ + * [real](class_real) **get_radius** **(** **)** const + Return the radius of the circle shape. diff --git a/class_collisionobject2d.md b/class_collisionobject2d.md index 4b0151f..3b3cbcb 100644 --- a/class_collisionobject2d.md +++ b/class_collisionobject2d.md @@ -22,41 +22,41 @@ CollisionObject2D is the base class for 2D physics collisionables. They can hold ### Member Function Description #### add_shape - * void **[add_shape](#add_shape)** **(** [Shape2D](class_shape2d) shape, [Matrix32](class_matrix32) transform=1,0, 0,1, 0,0 **)** -\\ + * void **add_shape** **(** [Shape2D](class_shape2d) shape, [Matrix32](class_matrix32) transform=1,0, 0,1, 0,0 **)** + Add a [[shape2d|Shape2D]] to the collision body, with a given custom transform. #### get_shape_count - * [int](class_int) **[get_shape_count](#get_shape_count)** **(** **)** const -\\ + * [int](class_int) **get_shape_count** **(** **)** const + Return the amount of shapes in the collision body. #### set_shape - * void **[set_shape](#set_shape)** **(** [int](class_int) shape_idx, [Shape](class_shape) shape **)** -\\ + * void **set_shape** **(** [int](class_int) shape_idx, [Shape](class_shape) shape **)** + Change a shape in the collision body. #### set_shape_transform - * void **[set_shape_transform](#set_shape_transform)** **(** [int](class_int) shape_idx, [Matrix32](class_matrix32) transform **)** -\\ + * void **set_shape_transform** **(** [int](class_int) shape_idx, [Matrix32](class_matrix32) transform **)** + Change the shape transform in the collision body. #### get_shape - * [Shape2D](class_shape2d) **[get_shape](#get_shape)** **(** [int](class_int) shape_idx **)** const -\\ + * [Shape2D](class_shape2d) **get_shape** **(** [int](class_int) shape_idx **)** const + Return the shape in the given index. #### get_shape_transform - * [Matrix32](class_matrix32) **[get_shape_transform](#get_shape_transform)** **(** [int](class_int) shape_idx **)** const -\\ + * [Matrix32](class_matrix32) **get_shape_transform** **(** [int](class_int) shape_idx **)** const + Return the shape transform in the given index. #### remove_shape - * void **[remove_shape](#remove_shape)** **(** [int](class_int) shape_idx **)** -\\ + * void **remove_shape** **(** [int](class_int) shape_idx **)** + Remove the shape in the given index. #### clear_shapes - * void **[clear_shapes](#clear_shapes)** **(** **)** -\\ + * void **clear_shapes** **(** **)** + Remove all shapes. diff --git a/class_color.md b/class_color.md index 20593ae..af353ee 100644 --- a/class_color.md +++ b/class_color.md @@ -30,46 +30,46 @@ A color is represented as red, green and blue (r,g,b) components. Additionally, ### Member Function Description #### contrasted - * [Color](class_color) **[contrasted](#contrasted)** **(** **)** -\\ + * [Color](class_color) **contrasted** **(** **)** + Return the most contrasting color with this one. #### gray - * [real](class_real) **[gray](#gray)** **(** **)** -\\ + * [real](class_real) **gray** **(** **)** + Convert the color to gray. #### inverted - * [Color](class_color) **[inverted](#inverted)** **(** **)** -\\ + * [Color](class_color) **inverted** **(** **)** + Return the inverted color (1-r, 1-g, 1-b, 1-a). #### linear_interpolate - * [Color](class_color) **[linear_interpolate](#linear_interpolate)** **(** [Color](class_color) b, [real](class_real) t **)** -\\ + * [Color](class_color) **linear_interpolate** **(** [Color](class_color) b, [real](class_real) t **)** + Return the linear interpolation with another color. #### to_32 - * [int](class_int) **[to_32](#to_32)** **(** **)** -\\ + * [int](class_int) **to_32** **(** **)** + Convert the color to a 32 its integer (each byte represets a RGBA). #### to_ARGB32 - * [int](class_int) **[to_ARGB32](#to_ARGB32)** **(** **)** -\\ + * [int](class_int) **to_ARGB32** **(** **)** + Convert color to ARGB32, more compatible with DirectX. #### to_html - * [String](class_string) **[to_html](#to_html)** **(** [bool](class_bool) with_alpha=True **)** -\\ + * [String](class_string) **to_html** **(** [bool](class_bool) with_alpha=True **)** + Return the HTML hexadecimal color string. #### Color - * void **[Color](#Color)** **(** [real](class_real) r, [real](class_real) g, [real](class_real) b, [real](class_real) a **)** -\\ + * void **Color** **(** [real](class_real) r, [real](class_real) g, [real](class_real) b, [real](class_real) a **)** + Construct the color from an RGBA profile. #### Color - * void **[Color](#Color)** **(** [real](class_real) r, [real](class_real) g, [real](class_real) b **)** -\\ + * void **Color** **(** [real](class_real) r, [real](class_real) g, [real](class_real) b **)** + Construct the color from an RGBA profile. diff --git a/class_colorarray.md b/class_colorarray.md index e050d49..45d3c19 100644 --- a/class_colorarray.md +++ b/class_colorarray.md @@ -17,31 +17,31 @@ Array of Color, can only contains colors. Optimized for memory usage, cant fragm ### Member Function Description #### get - * [Color](class_color) **[get](#get)** **(** [int](class_int) idx **)** -\\ + * [Color](class_color) **get** **(** [int](class_int) idx **)** + Get an index in the array. #### push_back - * void **[push_back](#push_back)** **(** [Color](class_color) color **)** -\\ + * void **push_back** **(** [Color](class_color) color **)** + Append a value to the array. #### resize - * void **[resize](#resize)** **(** [int](class_int) idx **)** -\\ + * void **resize** **(** [int](class_int) idx **)** + Resize the array. #### set - * void **[set](#set)** **(** [int](class_int) idx, [Color](class_color) color **)** -\\ + * void **set** **(** [int](class_int) idx, [Color](class_color) color **)** + Set an index in the array. #### size - * [int](class_int) **[size](#size)** **(** **)** -\\ + * [int](class_int) **size** **(** **)** + Return the array size. #### ColorArray - * void **[ColorArray](#ColorArray)** **(** [Array](class_array) from **)** -\\ + * void **ColorArray** **(** [Array](class_array) from **)** + Create from a generic array. diff --git a/class_colorpicker.md b/class_colorpicker.md index c7094e6..fa4e780 100644 --- a/class_colorpicker.md +++ b/class_colorpicker.md @@ -20,11 +20,11 @@ This is a simple color picker [[control|Control]]. It's useful for selecting a c ### Member Function Description #### set_color - * void **[set_color](#set_color)** **(** [Color](class_color) color **)** -\\ + * void **set_color** **(** [Color](class_color) color **)** + Select the current color. #### get_color - * [Color](class_color) **[get_color](#get_color)** **(** **)** const -\\ + * [Color](class_color) **get_color** **(** **)** const + Return the current (edited) color. diff --git a/class_concavepolygonshape.md b/class_concavepolygonshape.md index 357099a..70ace0d 100644 --- a/class_concavepolygonshape.md +++ b/class_concavepolygonshape.md @@ -13,11 +13,11 @@ Concave polygon shape resource, which can be set into a [[physicsbody|PhysicsBod ### Member Function Description #### set_faces - * void **[set_faces](#set_faces)** **(** [Vector3Array](class_vector3array) faces **)** -\\ + * void **set_faces** **(** [Vector3Array](class_vector3array) faces **)** + Set the faces (an array of triangles). #### get_faces - * [Vector3Array](class_vector3array) **[get_faces](#get_faces)** **(** **)** const -\\ + * [Vector3Array](class_vector3array) **get_faces** **(** **)** const + Return the faces (an array of triangles). diff --git a/class_concavepolygonshape2d.md b/class_concavepolygonshape2d.md index 4944803..ef78d0e 100644 --- a/class_concavepolygonshape2d.md +++ b/class_concavepolygonshape2d.md @@ -13,11 +13,11 @@ Concave polygon 2D shape resource for physics. It is made out of segments and is ### Member Function Description #### set_segments - * void **[set_segments](#set_segments)** **(** [Vector2Array](class_vector2array) segments **)** -\\ + * void **set_segments** **(** [Vector2Array](class_vector2array) segments **)** + Set the array of segments. #### get_segments - * [Vector2Array](class_vector2array) **[get_segments](#get_segments)** **(** **)** const -\\ + * [Vector2Array](class_vector2array) **get_segments** **(** **)** const + Return the array of segments. diff --git a/class_confirmationdialog.md b/class_confirmationdialog.md index e59c745..da86c60 100644 --- a/class_confirmationdialog.md +++ b/class_confirmationdialog.md @@ -12,6 +12,6 @@ Dialog for confirmation of actions. This dialog inherits from [[acceptdialog|Acc ### Member Function Description #### get_cancel - * [Button](class_button) **[get_cancel](#get_cancel)** **(** **)** -\\ + * [Button](class_button) **get_cancel** **(** **)** + Return the cancel button. diff --git a/class_container.md b/class_container.md index 213eba9..4194b87 100644 --- a/class_container.md +++ b/class_container.md @@ -20,11 +20,11 @@ Base node for conainers. A [[container|Container]] contains other controls and a ### Member Function Description #### queue_sort - * void **[queue_sort](#queue_sort)** **(** **)** -\\ + * void **queue_sort** **(** **)** + Queue resort of the contained children. This is called automatically anyway, but can be called upon request. #### fit_child_in_rect - * void **[fit_child_in_rect](#fit_child_in_rect)** **(** [Control](class_control) child, [Rect2](class_rect2) rect **)** -\\ + * void **fit_child_in_rect** **(** [Control](class_control) child, [Rect2](class_rect2) rect **)** + Fit a child control in a given rect. This is mainly a helper for creating custom container classes. diff --git a/class_control.md b/class_control.md index 8ed2e5d..03d4d3d 100644 --- a/class_control.md +++ b/class_control.md @@ -132,251 +132,251 @@ Control is the base class Node for all the GUI components. Every GUI component i ### Member Function Description #### _input_event - * void **[_input_event](#_input_event)** **(** [InputEvent](class_inputevent) event **)** virtual -\\ + * void **_input_event** **(** [InputEvent](class_inputevent) event **)** virtual + Called when an input event reaches the control. #### get_minimum_size - * [Vector2](class_vector2) **[get_minimum_size](#get_minimum_size)** **(** **)** virtual -\\ + * [Vector2](class_vector2) **get_minimum_size** **(** **)** virtual + Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size. #### accept_event - * void **[accept_event](#accept_event)** **(** **)** -\\ + * void **accept_event** **(** **)** + Handles the event, no other control will receive it and it will not be sent to nodes waiting on [[node#_unhandled_input|Node._unhandled_input]] or [[node#_unhandled_key_input|Node._unhandled_key_input]]. #### get_minimum_size - * [Vector2](class_vector2) **[get_minimum_size](#get_minimum_size)** **(** **)** const -\\ + * [Vector2](class_vector2) **get_minimum_size** **(** **)** const + Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size. #### is_window - * [bool](class_bool) **[is_window](#is_window)** **(** **)** const -\\ + * [bool](class_bool) **is_window** **(** **)** const + Return wether this control is a //window//. Controls are considered windows when their parent [[node|Node]] is not a Control. #### get_window - * [Object](class_object) **[get_window](#get_window)** **(** **)** const -\\ + * [Object](class_object) **get_window** **(** **)** const + Return the //window// for this control, ascending the scene tree (see [[#is_window|is_window]]). #### set_anchor - * void **[set_anchor](#set_anchor)** **(** [int](class_int) margin, [int](class_int) anchor_mode **)** -\\ + * void **set_anchor** **(** [int](class_int) margin, [int](class_int) anchor_mode **)** + Change the anchor (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) type for a margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Changing the anchor mode converts the current margin offset from the previos anchor mode to the new one, so margin offsets ([[#set_margin|set_margin]]) must be done after setting anchors, or at the same time ([[#set_anchor_and_margin|set_anchor_and_margin]]). #### get_anchor - * [int](class_int) **[get_anchor](#get_anchor)** **(** [int](class_int) margin **)** const -\\ + * [int](class_int) **get_anchor** **(** [int](class_int) margin **)** const + Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). #### set_margin - * void **[set_margin](#set_margin)** **(** [int](class_int) margin, [real](class_real) offset **)** -\\ + * void **set_margin** **(** [int](class_int) margin, [real](class_real) offset **)** + 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. #### set_anchor_and_margin - * void **[set_anchor_and_margin](#set_anchor_and_margin)** **(** [int](class_int) margin, [int](class_int) anchor_mode, [real](class_real) offset **)** -\\ + * void **set_anchor_and_margin** **(** [int](class_int) margin, [int](class_int) anchor_mode, [real](class_real) offset **)** + Change the anchor (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) type for a margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM), and also set its offset. This is a helper (see [[#set_anchor|set_anchor]] and [[#set_margin|set_margin]]). #### set_begin - * void **[set_begin](#set_begin)** **(** [Vector2](class_vector2) pos **)** -\\ + * void **set_begin** **(** [Vector2](class_vector2) pos **)** + Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [[#set_margin|set_margin]]). #### set_end - * void **[set_end](#set_end)** **(** [Vector2](class_vector2) pos **)** -\\ + * void **set_end** **(** [Vector2](class_vector2) pos **)** + Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see [[#set_margin|set_margin]]). #### set_pos - * void **[set_pos](#set_pos)** **(** [Vector2](class_vector2) pos **)** -\\ + * void **set_pos** **(** [Vector2](class_vector2) pos **)** + 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 [[#set_margin|set_margin]]). #### set_size - * void **[set_size](#set_size)** **(** [Vector2](class_vector2) size **)** -\\ + * void **set_size** **(** [Vector2](class_vector2) size **)** + Changes MARGIN_RIGHT and MARGIN_BOTTOM to fit a given size. This is a helper (see [[#set_margin|set_margin]]). #### set_global_pos - * void **[set_global_pos](#set_global_pos)** **(** [Vector2](class_vector2) pos **)** -\\ + * void **set_global_pos** **(** [Vector2](class_vector2) pos **)** + Move the Control to a new position, relative to the top-left corner of the //window// Control, and without changing current anchor mode. (see [[#set_margin|set_margin]]). #### get_margin - * [real](class_real) **[get_margin](#get_margin)** **(** [int](class_int) margin **)** const -\\ + * [real](class_real) **get_margin** **(** [int](class_int) margin **)** const + 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. #### get_end - * [Vector2](class_vector2) **[get_end](#get_end)** **(** **)** const -\\ + * [Vector2](class_vector2) **get_end** **(** **)** const + Returns MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [[#set_margin|set_margin]]). #### get_pos - * [Vector2](class_vector2) **[get_pos](#get_pos)** **(** **)** const -\\ + * [Vector2](class_vector2) **get_pos** **(** **)** const + Returns the Control position, relative to the top-left corner of the parent Control and independly of the anchor mode. #### get_size - * [Vector2](class_vector2) **[get_size](#get_size)** **(** **)** const -\\ + * [Vector2](class_vector2) **get_size** **(** **)** const + Returns the size of the Control, computed from all margins, however the size returned will **never be smaller than the minimum size reported by [[#get_minimum_size|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, [[#get_minimum_size|get_minimum_size]], [[#set_margin|set_margin]], [[#set_anchor|set_anchor]]). #### get_global_pos - * [Vector2](class_vector2) **[get_global_pos](#get_global_pos)** **(** **)** const -\\ + * [Vector2](class_vector2) **get_global_pos** **(** **)** const + Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode. #### get_rect - * [Rect2](class_rect2) **[get_rect](#get_rect)** **(** **)** const -\\ + * [Rect2](class_rect2) **get_rect** **(** **)** const + Return position and size of the Control, relative to the top-left corner of the parent Control. This is a helper (see [[#get_pos|get_pos]],[[#get_size|get_size]]). #### get_global_rect - * [Rect2](class_rect2) **[get_global_rect](#get_global_rect)** **(** **)** const -\\ + * [Rect2](class_rect2) **get_global_rect** **(** **)** const + Return position and size of the Control, relative to the top-left corner of the //window// Control. This is a helper (see [[#get_global_pos|get_global_pos]],[[#get_size|get_size]]). #### set_area_as_parent_rect - * void **[set_area_as_parent_rect](#set_area_as_parent_rect)** **(** [int](class_int) margin=0 **)** -\\ + * void **set_area_as_parent_rect** **(** [int](class_int) margin=0 **)** + Change all margins and anchors, so this Control always takes up the same area as the parent Control. This is a helper (see [[#set_anchor|set_anchor]],[[#set_margin|set_margin]]). #### show_modal - * void **[show_modal](#show_modal)** **(** [bool](class_bool) exclusive=false **)** -\\ + * void **show_modal** **(** [bool](class_bool) exclusive=false **)** + Display a Control as modal. Control must be a subwindow (see [[#set_as_subwindow|set_as_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. #### set_focus_mode - * void **[set_focus_mode](#set_focus_mode)** **(** [int](class_int) mode **)** -\\ + * void **set_focus_mode** **(** [int](class_int) mode **)** + 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. #### has_focus - * [bool](class_bool) **[has_focus](#has_focus)** **(** **)** const -\\ + * [bool](class_bool) **has_focus** **(** **)** const + Return wether the Control is the current focused control (see [[#set_focus_mode|set_focus_mode]]). #### grab_focus - * void **[grab_focus](#grab_focus)** **(** **)** -\\ + * void **grab_focus** **(** **)** + Steal the focus from another control and become the focused control (see [[#set_focus_mode|set_focus_mode]]). #### release_focus - * void **[release_focus](#release_focus)** **(** **)** -\\ + * void **release_focus** **(** **)** + Give up the focus, no other control will be able to receive keyboard input. #### get_focus_owner - * [Control](class_control) **[get_focus_owner](#get_focus_owner)** **(** **)** const -\\ + * [Control](class_control) **get_focus_owner** **(** **)** const + Return which control is owning the keyboard focus, or null if no one. #### set_h_size_flags - * void **[set_h_size_flags](#set_h_size_flags)** **(** [int](class_int) flags **)** -\\ + * void **set_h_size_flags** **(** [int](class_int) flags **)** + Hint for containers, set horizontal positioning flags. #### get_h_size_flags - * [int](class_int) **[get_h_size_flags](#get_h_size_flags)** **(** **)** const -\\ + * [int](class_int) **get_h_size_flags** **(** **)** const + Hint for containers, return horizontal positioning flags. #### set_stretch_ratio - * void **[set_stretch_ratio](#set_stretch_ratio)** **(** [real](class_real) ratio **)** -\\ + * void **set_stretch_ratio** **(** [real](class_real) ratio **)** + 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. #### get_stretch_ratio - * [real](class_real) **[get_stretch_ratio](#get_stretch_ratio)** **(** **)** const -\\ + * [real](class_real) **get_stretch_ratio** **(** **)** const + 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. #### set_v_size_flags - * void **[set_v_size_flags](#set_v_size_flags)** **(** [int](class_int) flags **)** -\\ + * void **set_v_size_flags** **(** [int](class_int) flags **)** + Hint for containers, set vertical positioning flags. #### get_v_size_flags - * [int](class_int) **[get_v_size_flags](#get_v_size_flags)** **(** **)** const -\\ + * [int](class_int) **get_v_size_flags** **(** **)** const + Hint for containers, return vertical positioning flags. #### set_theme - * void **[set_theme](#set_theme)** **(** [Theme](class_theme) theme **)** -\\ + * void **set_theme** **(** [Theme](class_theme) theme **)** + Override whole the [[theme|Theme]] for this Control and all its children controls. #### get_theme - * [Theme](class_theme) **[get_theme](#get_theme)** **(** **)** const -\\ + * [Theme](class_theme) **get_theme** **(** **)** const + Return a [[theme|Theme]] override, if one exists (see [[#set_theme|set_theme]]). #### add_icon_override - * void **[add_icon_override](#add_icon_override)** **(** [String](class_string) name, [Texture](class_texture) texture **)** -\\ + * void **add_icon_override** **(** [String](class_string) name, [Texture](class_texture) texture **)** + Override a single icon ([[texture|Texture]]) in the theme of this Control. If texture is empty, override is cleared. #### add_style_override - * void **[add_style_override](#add_style_override)** **(** [String](class_string) name, [StyleBox](class_stylebox) stylebox **)** -\\ + * void **add_style_override** **(** [String](class_string) name, [StyleBox](class_stylebox) stylebox **)** + Override a single stylebox ([Stylebox]) in the theme of this Control. If stylebox is empty, override is cleared. #### add_font_override - * void **[add_font_override](#add_font_override)** **(** [String](class_string) name, [Font](class_font) font **)** -\\ + * void **add_font_override** **(** [String](class_string) name, [Font](class_font) font **)** + Override a single font (font) in the theme of this Control. If font is empty, override is cleared. #### add_constant_override - * void **[add_constant_override](#add_constant_override)** **(** [String](class_string) name, [int](class_int) constant **)** -\\ + * void **add_constant_override** **(** [String](class_string) name, [int](class_int) constant **)** + Override a single constant (integer) in the theme of this Control. If constant equals Theme.INVALID_CONSTANT, override is cleared. #### set_tooltip - * void **[set_tooltip](#set_tooltip)** **(** [String](class_string) tooltip **)** -\\ + * void **set_tooltip** **(** [String](class_string) tooltip **)** + Set a tooltip, which will appear when the cursor is resting over this control. #### get_tooltip - * [String](class_string) **[get_tooltip](#get_tooltip)** **(** [Vector2](class_vector2) atpos=Vector2(0,0) **)** const -\\ + * [String](class_string) **get_tooltip** **(** [Vector2](class_vector2) atpos=Vector2(0,0) **)** const + Return the tooltip, which will appear when the cursor is resting over this control. #### set_default_cursor_shape - * void **[set_default_cursor_shape](#set_default_cursor_shape)** **(** [int](class_int) shape **)** -\\ + * void **set_default_cursor_shape** **(** [int](class_int) shape **)** + Set the default cursor shape for this control. See enum CURSOR_* for the list of shapes. #### get_default_cursor_shape - * [int](class_int) **[get_default_cursor_shape](#get_default_cursor_shape)** **(** **)** const -\\ + * [int](class_int) **get_default_cursor_shape** **(** **)** const + Return the default cursor shape for this control. See enum CURSOR_* for the list of shapes. #### get_cursor_shape - * [int](class_int) **[get_cursor_shape](#get_cursor_shape)** **(** [Vector2](class_vector2) pos=Vector2(0,0) **)** const -\\ + * [int](class_int) **get_cursor_shape** **(** [Vector2](class_vector2) pos=Vector2(0,0) **)** const + Return the cursor shape at a certain position in the control. #### set_focus_neighbour - * void **[set_focus_neighbour](#set_focus_neighbour)** **(** [int](class_int) margin, [NodePath](class_nodepath) neighbour **)** -\\ + * void **set_focus_neighbour** **(** [int](class_int) margin, [NodePath](class_nodepath) neighbour **)** + 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. #### get_focus_neighbour - * [NodePath](class_nodepath) **[get_focus_neighbour](#get_focus_neighbour)** **(** [int](class_int) margin **)** const -\\ + * [NodePath](class_nodepath) **get_focus_neighbour** **(** [int](class_int) margin **)** const + 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. #### set_ignore_mouse - * void **[set_ignore_mouse](#set_ignore_mouse)** **(** [bool](class_bool) ignore **)** -\\ + * void **set_ignore_mouse** **(** [bool](class_bool) ignore **)** + Ignore mouse events on this control (even touchpad events send mouse events). #### is_ignoring_mouse - * [bool](class_bool) **[is_ignoring_mouse](#is_ignoring_mouse)** **(** **)** const -\\ + * [bool](class_bool) **is_ignoring_mouse** **(** **)** const + Return if the control is ignoring mouse events (even touchpad events send mouse events). diff --git a/class_convexpolygonshape2d.md b/class_convexpolygonshape2d.md index bf9a0d1..c287dea 100644 --- a/class_convexpolygonshape2d.md +++ b/class_convexpolygonshape2d.md @@ -14,16 +14,16 @@ Convex Polygon Shape for 2D physics. ### Member Function Description #### set_point_cloud - * void **[set_point_cloud](#set_point_cloud)** **(** [Vector2Array](class_vector2array) point_cloud **)** -\\ + * void **set_point_cloud** **(** [Vector2Array](class_vector2array) point_cloud **)** + Create the point set from a point cloud. The resulting convex hull will be set as the shape. #### set_points - * void **[set_points](#set_points)** **(** [Vector2Array](class_vector2array) points **)** -\\ + * void **set_points** **(** [Vector2Array](class_vector2array) points **)** + Set a list of points in either clockwise or counter clockwise order, forming a convex polygon. #### get_points - * [Vector2Array](class_vector2array) **[get_points](#get_points)** **(** **)** const -\\ + * [Vector2Array](class_vector2array) **get_points** **(** **)** const + Return a list of points in either clockwise or counter clockwise order, forming a convex polygon. diff --git a/class_dampedspringjoint2d.md b/class_dampedspringjoint2d.md index 6036d36..719e6f0 100644 --- a/class_dampedspringjoint2d.md +++ b/class_dampedspringjoint2d.md @@ -19,41 +19,41 @@ Damped sprint constraint for 2D physics. This resembles a sprint joint that alwa ### Member Function Description #### set_length - * void **[set_length](#set_length)** **(** [real](class_real) length **)** -\\ + * void **set_length** **(** [real](class_real) length **)** + Set the maximum length of the sprint joint. #### get_length - * [real](class_real) **[get_length](#get_length)** **(** **)** const -\\ + * [real](class_real) **get_length** **(** **)** const + Return the maximum length of the sprint joint. #### set_rest_length - * void **[set_rest_length](#set_rest_length)** **(** [real](class_real) rest_length **)** -\\ + * void **set_rest_length** **(** [real](class_real) rest_length **)** + Set the resting length of the sprint joint. The joint will always try to go to back this length when pulled apart. #### get_rest_length - * [real](class_real) **[get_rest_length](#get_rest_length)** **(** **)** const -\\ + * [real](class_real) **get_rest_length** **(** **)** const + Return the resting length of the sprint joint. The joint will always try to go to back this length when pulled apart. #### set_stiffness - * void **[set_stiffness](#set_stiffness)** **(** [real](class_real) stiffness **)** -\\ + * void **set_stiffness** **(** [real](class_real) stiffness **)** + Set the stiffness of the spring joint. #### get_stiffness - * [real](class_real) **[get_stiffness](#get_stiffness)** **(** **)** const -\\ + * [real](class_real) **get_stiffness** **(** **)** const + Return the stiffness of the spring joint. #### set_damping - * void **[set_damping](#set_damping)** **(** [real](class_real) damping **)** -\\ + * void **set_damping** **(** [real](class_real) damping **)** + Set the damping of the spring joint. #### get_damping - * [real](class_real) **[get_damping](#get_damping)** **(** **)** const -\\ + * [real](class_real) **get_damping** **(** **)** const + Return the damping of the spring joint. diff --git a/class_dictionary.md b/class_dictionary.md index 928c9ad..b70d1da 100644 --- a/class_dictionary.md +++ b/class_dictionary.md @@ -20,36 +20,36 @@ Dictionary type. Associative container which contains values referenced by uniqu ### Member Function Description #### clear - * void **[clear](#clear)** **(** **)** -\\ + * void **clear** **(** **)** + Clear the dictionary, removing all key/value pairs. #### empty - * [bool](class_bool) **[empty](#empty)** **(** **)** -\\ + * [bool](class_bool) **empty** **(** **)** + Return true if the dictionary is empty. #### erase - * void **[erase](#erase)** **(** var value **)** -\\ + * void **erase** **(** var value **)** + Erase a dictionary key/value pair by key. #### has - * [bool](class_bool) **[has](#has)** **(** var value **)** -\\ + * [bool](class_bool) **has** **(** var value **)** + Return true if the dictionary has a given key. #### hash - * [int](class_int) **[hash](#hash)** **(** **)** -\\ + * [int](class_int) **hash** **(** **)** + Return a hashed integer value representing the dictionary contents. #### keys - * [Array](class_array) **[keys](#keys)** **(** **)** -\\ + * [Array](class_array) **keys** **(** **)** + Return the list of keys in the dictionary. #### size - * [int](class_int) **[size](#size)** **(** **)** -\\ + * [int](class_int) **size** **(** **)** + Return the size of the dictionary (in pairs). diff --git a/class_filedialog.md b/class_filedialog.md index 3294941..ca07a59 100644 --- a/class_filedialog.md +++ b/class_filedialog.md @@ -39,36 +39,36 @@ FileDialog is a preset dialog used to choose files and directories in the filesy ### Member Function Description #### clear_filters - * void **[clear_filters](#clear_filters)** **(** **)** -\\ + * void **clear_filters** **(** **)** + Clear all the added filters in the dialog. #### add_filter - * void **[add_filter](#add_filter)** **(** [String](class_string) filter **)** -\\ + * void **add_filter** **(** [String](class_string) filter **)** + Add a custom filter. Filter format is: "mask ; description", example (C++): dialog-"lt;add_filter("*.png ; PNG Images"); #### get_current_dir - * [String](class_string) **[get_current_dir](#get_current_dir)** **(** **)** const -\\ + * [String](class_string) **get_current_dir** **(** **)** const + Get the current working directory of the file dialog. #### get_current_file - * [String](class_string) **[get_current_file](#get_current_file)** **(** **)** const -\\ + * [String](class_string) **get_current_file** **(** **)** const + Get the current selected file of the file dialog (empty if none). #### get_current_path - * [String](class_string) **[get_current_path](#get_current_path)** **(** **)** const -\\ + * [String](class_string) **get_current_path** **(** **)** const + Get the current selected path (directory and file) of the file dialog (empty if none). #### set_mode - * void **[set_mode](#set_mode)** **(** [int](class_int) mode **)** -\\ + * void **set_mode** **(** [int](class_int) mode **)** + Set the file dialog mode from the MODE_* enum. #### get_mode - * [int](class_int) **[get_mode](#get_mode)** **(** **)** const -\\ + * [int](class_int) **get_mode** **(** **)** const + Get the file dialog mode from the MODE_* enum. diff --git a/class_fixedmaterial.md b/class_fixedmaterial.md index 567653c..bc2d05d 100644 --- a/class_fixedmaterial.md +++ b/class_fixedmaterial.md @@ -43,41 +43,41 @@ FixedMaterial is a simple type of material [[resource|Resource]], which contains ### Member Function Description #### set_parameter - * void **[set_parameter](#set_parameter)** **(** [int](class_int) param, var value **)** -\\ + * void **set_parameter** **(** [int](class_int) param, var value **)** + Set a parameter, parameters are defined in the PARAM_* enum. The type of each parameter may change, so it"apos;s best to check the enum. #### get_parameter - * void **[get_parameter](#get_parameter)** **(** [int](class_int) param **)** const -\\ + * void **get_parameter** **(** [int](class_int) param **)** const + Return a parameter, parameters are defined in the PARAM_* enum. The type of each parameter may change, so it"apos;s best to check the enum. #### set_texture - * void **[set_texture](#set_texture)** **(** [int](class_int) param, [Texture](class_texture) texture **)** -\\ + * void **set_texture** **(** [int](class_int) param, [Texture](class_texture) texture **)** + Set a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see [[#set_texcoord_mode|set_texcoord_mode]]). #### get_texture - * [Texture](class_texture) **[get_texture](#get_texture)** **(** [int](class_int) param **)** const -\\ + * [Texture](class_texture) **get_texture** **(** [int](class_int) param **)** const + Return a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see [[#set_texcoord_mode|set_texcoord_mode]]). #### set_texcoord_mode - * void **[set_texcoord_mode](#set_texcoord_mode)** **(** [int](class_int) param, [int](class_int) mode **)** -\\ + * void **set_texcoord_mode** **(** [int](class_int) param, [int](class_int) mode **)** + Set the texture coordinate mode. Each texture param (from the PARAM_* enum) has one. It defines how the textures are mapped to the object. #### get_texcoord_mode - * [int](class_int) **[get_texcoord_mode](#get_texcoord_mode)** **(** [int](class_int) param **)** const -\\ + * [int](class_int) **get_texcoord_mode** **(** [int](class_int) param **)** const + Return the texture coordinate mode. Each texture param (from the PARAM_* enum) has one. It defines how the textures are mapped to the object. #### set_uv_transform - * void **[set_uv_transform](#set_uv_transform)** **(** [Transform](class_transform) transform **)** -\\ + * void **set_uv_transform** **(** [Transform](class_transform) transform **)** + Sets a special transform used to post-transform UV coordinates of the uv_xfrom tecoord mode: TEXCOORD_UV_TRANSFORM #### get_uv_transform - * [Transform](class_transform) **[get_uv_transform](#get_uv_transform)** **(** **)** const -\\ + * [Transform](class_transform) **get_uv_transform** **(** **)** const + Returns the special transform used to post-transform UV coordinates of the uv_xfrom tecoord mode: TEXCOORD_UV_TRANSFORM diff --git a/class_font.md b/class_font.md index 3fa905e..1ef5ad8 100644 --- a/class_font.md +++ b/class_font.md @@ -25,71 +25,71 @@ Font contains an unicode compatible character set, as well as the ability to dra ### Member Function Description #### set_height - * void **[set_height](#set_height)** **(** [real](class_real) px **)** -\\ + * void **set_height** **(** [real](class_real) px **)** + Set the total font height (ascent plus descent) in pixels. #### get_height - * [real](class_real) **[get_height](#get_height)** **(** **)** const -\\ + * [real](class_real) **get_height** **(** **)** const + Return the total font height (ascent plus descent) in pixels. #### set_ascent - * void **[set_ascent](#set_ascent)** **(** [real](class_real) px **)** -\\ + * void **set_ascent** **(** [real](class_real) px **)** + Set the font ascent (number of pixels above the baseline). #### get_ascent - * [real](class_real) **[get_ascent](#get_ascent)** **(** **)** const -\\ + * [real](class_real) **get_ascent** **(** **)** const + Return the font ascent (number of pixels above the baseline). #### get_descent - * [real](class_real) **[get_descent](#get_descent)** **(** **)** const -\\ + * [real](class_real) **get_descent** **(** **)** const + Return the font descent (number of pixels below the baseline). #### add_kerning_pair - * void **[add_kerning_pair](#add_kerning_pair)** **(** [int](class_int) char_a, [int](class_int) char_b, [int](class_int) kerning **)** -\\ + * void **add_kerning_pair** **(** [int](class_int) char_a, [int](class_int) char_b, [int](class_int) kerning **)** + Add a kerning pair to the [[font|Font]] as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character. #### get_kerning_pair - * [int](class_int) **[get_kerning_pair](#get_kerning_pair)** **(** [int](class_int) arg0, [int](class_int) arg1 **)** const -\\ + * [int](class_int) **get_kerning_pair** **(** [int](class_int) arg0, [int](class_int) arg1 **)** const + Return a kerning pair as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character. #### add_texture - * void **[add_texture](#add_texture)** **(** [Texture](class_texture) texture **)** -\\ + * void **add_texture** **(** [Texture](class_texture) texture **)** + Add a texture to the [[font|Font]]. #### add_char - * void **[add_char](#add_char)** **(** [int](class_int) character, [int](class_int) texture, [Rect2](class_rect2) rect, [Vector2](class_vector2) align=Vector2(0,0), [real](class_real) advance=-1 **)** -\\ + * void **add_char** **(** [int](class_int) character, [int](class_int) texture, [Rect2](class_rect2) rect, [Vector2](class_vector2) align=Vector2(0,0), [real](class_real) advance=-1 **)** + Add a character to the font, where "character" is the unicode value, "texture" is the texture index, "rect" is the region in the texture (in pixels!), "align" is the (optional) alignment for the character and "advance" is the (optional) advance. #### get_char_size - * [Vector2](class_vector2) **[get_char_size](#get_char_size)** **(** [int](class_int) char, [int](class_int) next=0 **)** const -\\ + * [Vector2](class_vector2) **get_char_size** **(** [int](class_int) char, [int](class_int) next=0 **)** const + Return the size of a character, optionally taking kerning into account if the next character is provided. #### get_string_size - * [Vector2](class_vector2) **[get_string_size](#get_string_size)** **(** [String](class_string) string **)** const -\\ + * [Vector2](class_vector2) **get_string_size** **(** [String](class_string) string **)** const + Return the size of a string, taking kerning and advance into account. #### clear - * void **[clear](#clear)** **(** **)** -\\ + * void **clear** **(** **)** + Clear all the font data. #### draw - * void **[draw](#draw)** **(** [RID](class_rid) canvas_item, [Vector2](class_vector2) pos, [String](class_string) string, [Color](class_color) modulate=Color(1,1,1,1), [int](class_int) clip_w=-1 **)** const -\\ + * void **draw** **(** [RID](class_rid) canvas_item, [Vector2](class_vector2) pos, [String](class_string) string, [Color](class_color) modulate=Color(1,1,1,1), [int](class_int) clip_w=-1 **)** const + Draw "string" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally clipping the width. "pos" specifies te baseline, not the top. To draw from the top, //ascent// must be added to the Y axis. #### draw_char - * [real](class_real) **[draw_char](#draw_char)** **(** [RID](class_rid) canvas_item, [Vector2](class_vector2) pos, [int](class_int) char, [int](class_int) next=-1, [Color](class_color) modulate=Color(1,1,1,1) **)** const -\\ + * [real](class_real) **draw_char** **(** [RID](class_rid) canvas_item, [Vector2](class_vector2) pos, [int](class_int) char, [int](class_int) next=-1, [Color](class_color) modulate=Color(1,1,1,1) **)** const + Draw character "char" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally kerning if "next" is apassed. clipping the width. "pos" specifies te baseline, not the top. To draw from the top, //ascent// must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character. diff --git a/class_geometryinstance.md b/class_geometryinstance.md index 9685b85..bdd2766 100644 --- a/class_geometryinstance.md +++ b/class_geometryinstance.md @@ -32,11 +32,11 @@ Base node for geometry based visual instances. Shares some common functionality ### Member Function Description #### set_material_override - * void **[set_material_override](#set_material_override)** **(** [Object](class_object) material **)** -\\ + * void **set_material_override** **(** [Object](class_object) material **)** + Set the material override for the whole geometry. #### get_material_override - * [Object](class_object) **[get_material_override](#get_material_override)** **(** **)** const -\\ + * [Object](class_object) **get_material_override** **(** **)** const + Return the material override for the whole geometry. diff --git a/class_globals.md b/class_globals.md index cb6cc7f..f6a2718 100644 --- a/class_globals.md +++ b/class_globals.md @@ -22,41 +22,41 @@ Contains global variables accessible from everywhere. Use the normal [[object|Ob ### Member Function Description #### has - * [bool](class_bool) **[has](#has)** **(** [String](class_string) name **)** const -\\ + * [bool](class_bool) **has** **(** [String](class_string) name **)** const + Return true if a configuration value is present. #### set_order - * void **[set_order](#set_order)** **(** [String](class_string) name, [int](class_int) pos **)** -\\ + * void **set_order** **(** [String](class_string) name, [int](class_int) pos **)** + Set the order of a configuration value (influences when saved to the config file). #### get_order - * [int](class_int) **[get_order](#get_order)** **(** [String](class_string) name **)** const -\\ + * [int](class_int) **get_order** **(** [String](class_string) name **)** const + Return the order of a configuration value (influences when saved to the config file). #### set_persisting - * void **[set_persisting](#set_persisting)** **(** [String](class_string) name, [bool](class_bool) enable **)** -\\ + * void **set_persisting** **(** [String](class_string) name, [bool](class_bool) enable **)** + If set to true, this value can be saved to the configuration file. This is useful for editors. #### is_persisting - * [bool](class_bool) **[is_persisting](#is_persisting)** **(** [String](class_string) name **)** const -\\ + * [bool](class_bool) **is_persisting** **(** [String](class_string) name **)** const + If returns true, this value can be saved to the configuration file. This is useful for editors. #### clear - * void **[clear](#clear)** **(** [String](class_string) name **)** -\\ + * void **clear** **(** [String](class_string) name **)** + Clear the whole configuration (not recommended, may break things). #### localize_path - * [String](class_string) **[localize_path](#localize_path)** **(** [String](class_string) path **)** const -\\ + * [String](class_string) **localize_path** **(** [String](class_string) path **)** const + Convert a path to a localized path (res:// path). #### globalize_path - * [String](class_string) **[globalize_path](#globalize_path)** **(** [String](class_string) path **)** const -\\ + * [String](class_string) **globalize_path** **(** [String](class_string) path **)** const + Convert a localized path (res://) to a full native OS path. diff --git a/class_groovejoint2d.md b/class_groovejoint2d.md index 4ee0f10..131de5f 100644 --- a/class_groovejoint2d.md +++ b/class_groovejoint2d.md @@ -15,21 +15,21 @@ Groove constraint for 2D physics. This is useful for making a body "slide" throu ### Member Function Description #### set_length - * void **[set_length](#set_length)** **(** [real](class_real) length **)** -\\ + * void **set_length** **(** [real](class_real) length **)** + Set the length of the groove. #### get_length - * [real](class_real) **[get_length](#get_length)** **(** **)** const -\\ + * [real](class_real) **get_length** **(** **)** const + Return the length of the groove. #### set_initial_offset - * void **[set_initial_offset](#set_initial_offset)** **(** [real](class_real) offset **)** -\\ + * void **set_initial_offset** **(** [real](class_real) offset **)** + Set the initial offset of the groove on body A. #### get_initial_offset - * [real](class_real) **[get_initial_offset](#get_initial_offset)** **(** **)** const -\\ + * [real](class_real) **get_initial_offset** **(** **)** const + Set the final offset of the groove on body A. diff --git a/class_input.md b/class_input.md index 67e2297..71c7805 100644 --- a/class_input.md +++ b/class_input.md @@ -23,8 +23,8 @@ ### Member Function Description #### get_mouse_pos - * [Vector2](class_vector2) **[get_mouse_pos](#get_mouse_pos)** **(** **)** const -\\ + * [Vector2](class_vector2) **get_mouse_pos** **(** **)** const + Return the global, unscaled, screen pointer coordinates. If the 2D viewport has been scaled, it may not work well with [[camera|Camera]] or controls. diff --git a/class_inputevent.md b/class_inputevent.md index d1145c5..0a484ba 100644 --- a/class_inputevent.md +++ b/class_inputevent.md @@ -30,16 +30,16 @@ Built-in input event data. InputEvent is a built-in engine datatype, given that ### Member Function Description #### is_action - * [bool](class_bool) **[is_action](#is_action)** **(** [String](class_string) action **)** -\\ + * [bool](class_bool) **is_action** **(** [String](class_string) action **)** + Return if this input event matches a pre-defined action, no matter the type. #### is_echo - * [bool](class_bool) **[is_echo](#is_echo)** **(** **)** -\\ + * [bool](class_bool) **is_echo** **(** **)** + Return if this input event is an echo event (usually for key events). #### is_pressed - * [bool](class_bool) **[is_pressed](#is_pressed)** **(** **)** -\\ + * [bool](class_bool) **is_pressed** **(** **)** + Return if this input event is pressed (for key, mouse, joy button or screen press events). diff --git a/class_intarray.md b/class_intarray.md index 5a51c96..2a9e98f 100644 --- a/class_intarray.md +++ b/class_intarray.md @@ -17,31 +17,31 @@ Integer Array. Array of integers. Can only contain integers. Optimized for memor ### Member Function Description #### get - * [int](class_int) **[get](#get)** **(** [int](class_int) idx **)** -\\ + * [int](class_int) **get** **(** [int](class_int) idx **)** + Get an index in the array. #### push_back - * void **[push_back](#push_back)** **(** [int](class_int) integer **)** -\\ + * void **push_back** **(** [int](class_int) integer **)** + Append a value to the array. #### resize - * void **[resize](#resize)** **(** [int](class_int) idx **)** -\\ + * void **resize** **(** [int](class_int) idx **)** + Resize the array. #### set - * void **[set](#set)** **(** [int](class_int) idx, [int](class_int) integer **)** -\\ + * void **set** **(** [int](class_int) idx, [int](class_int) integer **)** + Set an index in the array. #### size - * [int](class_int) **[size](#size)** **(** **)** -\\ + * [int](class_int) **size** **(** **)** + Return the array size. #### IntArray - * void **[IntArray](#IntArray)** **(** [Array](class_array) from **)** -\\ + * void **IntArray** **(** [Array](class_array) from **)** + Create from a generic array. diff --git a/class_ip.md b/class_ip.md index 61f6180..2a01064 100644 --- a/class_ip.md +++ b/class_ip.md @@ -24,26 +24,26 @@ IP contains some support functions for the IPv4 protocol. TCP/IP support is in d ### Member Function Description #### resolve_hostname - * [String](class_string) **[resolve_hostname](#resolve_hostname)** **(** [String](class_string) host **)** -\\ + * [String](class_string) **resolve_hostname** **(** [String](class_string) host **)** + Resolve a given hostname, blocking. Resolved hostname is returned as an IP. #### resolve_hostname_queue_item - * [int](class_int) **[resolve_hostname_queue_item](#resolve_hostname_queue_item)** **(** [String](class_string) host **)** -\\ + * [int](class_int) **resolve_hostname_queue_item** **(** [String](class_string) host **)** + Create a queue item for resolving a given hostname. The queue ID is returned, or RESOLVER_INVALID_ID on error. #### get_resolve_item_status - * [int](class_int) **[get_resolve_item_status](#get_resolve_item_status)** **(** [int](class_int) id **)** const -\\ + * [int](class_int) **get_resolve_item_status** **(** [int](class_int) id **)** const + Return the status of hostname queued for resolving, given it"apos;s queue ID. Returned status can be any of the RESOLVER_STATUS_* enumeration. #### get_resolve_item_address - * [String](class_string) **[get_resolve_item_address](#get_resolve_item_address)** **(** [int](class_int) id **)** const -\\ + * [String](class_string) **get_resolve_item_address** **(** [int](class_int) id **)** const + Return a resolved item address, or an empty string if an error happened or resolution didn"apos;t happen yet (see [[#get_resolve_item_status|get_resolve_item_status]]). #### erase_resolve_item - * void **[erase_resolve_item](#erase_resolve_item)** **(** [int](class_int) id **)** -\\ + * void **erase_resolve_item** **(** [int](class_int) id **)** + Erase a queue ID, removing it from the queue if needed. This should be used after a queue is completed to free it and enable more queries to happen. diff --git a/class_joint2d.md b/class_joint2d.md index 3f8dfe0..e473a1b 100644 --- a/class_joint2d.md +++ b/class_joint2d.md @@ -17,21 +17,21 @@ Base node for all joint constraints in 2D phyisics. Joints take 2 bodies and app ### Member Function Description #### set_node_a - * void **[set_node_a](#set_node_a)** **(** [NodePath](class_nodepath) node **)** -\\ + * void **set_node_a** **(** [NodePath](class_nodepath) node **)** + Set the path to the A node for the joint. Must be of type PhysicsBody2D. #### get_node_a - * [NodePath](class_nodepath) **[get_node_a](#get_node_a)** **(** **)** const -\\ + * [NodePath](class_nodepath) **get_node_a** **(** **)** const + Return the path to the A node for the joint. #### set_node_b - * void **[set_node_b](#set_node_b)** **(** [NodePath](class_nodepath) node **)** -\\ + * void **set_node_b** **(** [NodePath](class_nodepath) node **)** + Set the path to the B node for the joint. Must be of type PhysicsBody2D. #### get_node_b - * [NodePath](class_nodepath) **[get_node_b](#get_node_b)** **(** **)** const -\\ + * [NodePath](class_nodepath) **get_node_b** **(** **)** const + Return the path to the B node for the joint. diff --git a/class_label.md b/class_label.md index 3bd163c..ffab810 100644 --- a/class_label.md +++ b/class_label.md @@ -37,41 +37,41 @@ Label is a control that displays formatted text, optionally autowrapping it to t ### Member Function Description #### set_align - * void **[set_align](#set_align)** **(** [int](class_int) align **)** -\\ + * void **set_align** **(** [int](class_int) align **)** + Set the alignmend mode to any of the ALIGN_* enumeration values. #### get_align - * [int](class_int) **[get_align](#get_align)** **(** **)** const -\\ + * [int](class_int) **get_align** **(** **)** const + Return the alignmend mode (any of the ALIGN_* enumeration values). #### set_text - * void **[set_text](#set_text)** **(** [String](class_string) text **)** -\\ + * void **set_text** **(** [String](class_string) text **)** + Set the label text. Text can contain newlines. #### get_text - * [String](class_string) **[get_text](#get_text)** **(** **)** const -\\ + * [String](class_string) **get_text** **(** **)** const + Return the label text. Text can contain newlines. #### set_autowrap - * void **[set_autowrap](#set_autowrap)** **(** [bool](class_bool) enable **)** -\\ + * void **set_autowrap** **(** [bool](class_bool) enable **)** + Set //autowrap// 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. #### has_autowrap - * [bool](class_bool) **[has_autowrap](#has_autowrap)** **(** **)** const -\\ + * [bool](class_bool) **has_autowrap** **(** **)** const + Return the state of the //autowrap// mode (see [[#set_autowrap|set_autowrap]]). #### get_line_height - * [int](class_int) **[get_line_height](#get_line_height)** **(** **)** const -\\ + * [int](class_int) **get_line_height** **(** **)** const + Return the height of a line. #### get_line_count - * [int](class_int) **[get_line_count](#get_line_count)** **(** **)** const -\\ + * [int](class_int) **get_line_count** **(** **)** const + Return the amount of lines. diff --git a/class_lineedit.md b/class_lineedit.md index 3103a3f..72c83b2 100644 --- a/class_lineedit.md +++ b/class_lineedit.md @@ -29,66 +29,66 @@ LineEdit provides a single line string editor, used for text fields. ### Member Function Description #### clear - * void **[clear](#clear)** **(** **)** -\\ + * void **clear** **(** **)** + Clear the [[lineedit|LineEdit]] text. #### select_all - * void **[select_all](#select_all)** **(** **)** -\\ + * void **select_all** **(** **)** + Select the whole string. #### set_text - * void **[set_text](#set_text)** **(** [String](class_string) text **)** -\\ + * void **set_text** **(** [String](class_string) text **)** + Set the text in the [[lineedit|LineEdit]], clearing the existing one and the selection. #### get_text - * [String](class_string) **[get_text](#get_text)** **(** **)** const -\\ + * [String](class_string) **get_text** **(** **)** const + Return the text in the [[lineedit|LineEdit]]. #### set_cursor_pos - * void **[set_cursor_pos](#set_cursor_pos)** **(** [int](class_int) pos **)** -\\ + * void **set_cursor_pos** **(** [int](class_int) pos **)** + Set the cursor position inside the [[lineedit|LineEdit]], causing it to scroll if needed. #### get_cursor_pos - * [int](class_int) **[get_cursor_pos](#get_cursor_pos)** **(** **)** const -\\ + * [int](class_int) **get_cursor_pos** **(** **)** const + Return the cursor position inside the [[lineedit|LineEdit]]. #### set_max_length - * void **[set_max_length](#set_max_length)** **(** [int](class_int) chars **)** -\\ + * void **set_max_length** **(** [int](class_int) chars **)** + Set the maximum amount of characters the [[lineedit|LineEdit]] can edit, and cropping existing text in case it exceeds that limit. Setting 0 removes the limit. #### get_max_length - * [int](class_int) **[get_max_length](#get_max_length)** **(** **)** const -\\ + * [int](class_int) **get_max_length** **(** **)** const + Return the maximum amount of characters the [[lineedit|LineEdit]] can edit. If 0 is returned, no limit exists. #### append_at_cursor - * void **[append_at_cursor](#append_at_cursor)** **(** [String](class_string) text **)** -\\ + * void **append_at_cursor** **(** [String](class_string) text **)** + Append text at cursor, scrolling the [[lineedit|LineEdit]] when needed. #### set_editable - * void **[set_editable](#set_editable)** **(** [bool](class_bool) enabled **)** -\\ + * void **set_editable** **(** [bool](class_bool) enabled **)** + Set the //editable// status of the [[lineedit|LineEdit]]. When disabled, existing text can"apos;t be modified and new text can"apos;t be added. #### is_editable - * [bool](class_bool) **[is_editable](#is_editable)** **(** **)** const -\\ + * [bool](class_bool) **is_editable** **(** **)** const + Return the //editable// status of the [[lineedit|LineEdit]] (see [[#set_editable|set_editable]]). #### set_secret - * void **[set_secret](#set_secret)** **(** [bool](class_bool) enabled **)** -\\ + * void **set_secret** **(** [bool](class_bool) enabled **)** + Set the //secret// status of the [[lineedit|LineEdit]]. When enabled, every character is displayed as "*". #### is_secret - * [bool](class_bool) **[is_secret](#is_secret)** **(** **)** const -\\ + * [bool](class_bool) **is_secret** **(** **)** const + Return the //secret// status of the [[lineedit|LineEdit]] (see [[#set_secret|set_secret]]). diff --git a/class_lineshape2d.md b/class_lineshape2d.md index e7a73ae..73af6c5 100644 --- a/class_lineshape2d.md +++ b/class_lineshape2d.md @@ -15,21 +15,21 @@ Line shape for 2D collision objects. It works like a 2D plane and will not allow ### Member Function Description #### set_normal - * void **[set_normal](#set_normal)** **(** [Vector2](class_vector2) normal **)** -\\ + * void **set_normal** **(** [Vector2](class_vector2) normal **)** + Set the line normal. #### get_normal - * [Vector2](class_vector2) **[get_normal](#get_normal)** **(** **)** const -\\ + * [Vector2](class_vector2) **get_normal** **(** **)** const + Return the line normal. #### set_d - * void **[set_d](#set_d)** **(** [real](class_real) d **)** -\\ + * void **set_d** **(** [real](class_real) d **)** + Set the line distance from the origin. #### get_d - * [real](class_real) **[get_d](#get_d)** **(** **)** const -\\ + * [real](class_real) **get_d** **(** **)** const + Return the line distance from the origin. diff --git a/class_material.md b/class_material.md index 6bc7666..4c79a38 100644 --- a/class_material.md +++ b/class_material.md @@ -47,31 +47,31 @@ Material is a base [[resource|Resource]] used for coloring and shading geometry. ### Member Function Description #### set_flag - * void **[set_flag](#set_flag)** **(** [int](class_int) flag, [bool](class_bool) enable **)** -\\ + * void **set_flag** **(** [int](class_int) flag, [bool](class_bool) enable **)** + Set a [[material|Material]] flag, which toggles on or off a behavior when rendering. See enumeration FLAG_* for a list. #### get_flag - * [bool](class_bool) **[get_flag](#get_flag)** **(** [int](class_int) flag **)** const -\\ + * [bool](class_bool) **get_flag** **(** [int](class_int) flag **)** const + Return a [[material|Material]] flag, which toggles on or off a behavior when rendering. See enumeration FLAG_* for a list. #### set_blend_mode - * void **[set_blend_mode](#set_blend_mode)** **(** [int](class_int) mode **)** -\\ + * void **set_blend_mode** **(** [int](class_int) mode **)** + Set blend mode for the material, which can be one of BLEND_MODE_MIX (default), BLEND_MODE_ADD, BLEND_MODE_SUB. Keep in mind that only BLEND_MODE_MIX ensures that the material //may// be opaque, any other blend mode will render with alpha blending enabled in raster-based [[visualserver|VisualServer]] implementations. #### get_blend_mode - * [int](class_int) **[get_blend_mode](#get_blend_mode)** **(** **)** const -\\ + * [int](class_int) **get_blend_mode** **(** **)** const + Return blend mode for the material, which can be one of BLEND_MODE_MIX (default), BLEND_MODE_ADD, BLEND_MODE_SUB. Keep in mind that only BLEND_MODE_MIX ensures that the material //may// be opaque, any other blend mode will render with alpha blending enabled in raster-based [[visualserver|VisualServer]] implementations. #### set_line_width - * void **[set_line_width](#set_line_width)** **(** [real](class_real) width **)** -\\ + * void **set_line_width** **(** [real](class_real) width **)** + Set the line width for geometry drawn with FLAG_WIREFRAME enabled, or LINE primitives. Note that not all hardware or VisualServer backends support this (like DirectX). #### get_line_width - * [real](class_real) **[get_line_width](#get_line_width)** **(** **)** const -\\ + * [real](class_real) **get_line_width** **(** **)** const + Return the line width for geometry drawn with FLAG_WIREFRAME enabled, or LINE primitives. Note that not all hardware or VisualServer backends support this (like DirectX). diff --git a/class_matrix3.md b/class_matrix3.md index f48f52b..bb97ec3 100644 --- a/class_matrix3.md +++ b/class_matrix3.md @@ -32,76 +32,76 @@ ### Member Function Description #### determinant - * [real](class_real) **[determinant](#determinant)** **(** **)** -\\ + * [real](class_real) **determinant** **(** **)** + Return the determinant of the matrix. #### get_euler - * [Vector3](class_vector3) **[get_euler](#get_euler)** **(** **)** -\\ + * [Vector3](class_vector3) **get_euler** **(** **)** + Return euler angles from the matrix. #### inverse - * [Matrix3](class_matrix3) **[inverse](#inverse)** **(** **)** -\\ + * [Matrix3](class_matrix3) **inverse** **(** **)** + Return the affine inverse of the matrix. #### orthonormalized - * [Matrix3](class_matrix3) **[orthonormalized](#orthonormalized)** **(** **)** -\\ + * [Matrix3](class_matrix3) **orthonormalized** **(** **)** + Return the orthonormalized version of the matrix (useful to call from time to time to avoid rounding error). #### rotated - * [Matrix3](class_matrix3) **[rotated](#rotated)** **(** [Vector3](class_vector3) axis, [real](class_real) phi **)** -\\ + * [Matrix3](class_matrix3) **rotated** **(** [Vector3](class_vector3) axis, [real](class_real) phi **)** + Return the rotated version of the matrix, by a given axis and angle. #### scaled - * [Matrix3](class_matrix3) **[scaled](#scaled)** **(** [Vector3](class_vector3) scale **)** -\\ + * [Matrix3](class_matrix3) **scaled** **(** [Vector3](class_vector3) scale **)** + Return the scaled version of the matrix, by a 3D scale. #### tdotx - * [real](class_real) **[tdotx](#tdotx)** **(** [Vector3](class_vector3) with **)** -\\ + * [real](class_real) **tdotx** **(** [Vector3](class_vector3) with **)** + Transposed dot product with the x axis of the matrix. #### tdoty - * [real](class_real) **[tdoty](#tdoty)** **(** [Vector3](class_vector3) with **)** -\\ + * [real](class_real) **tdoty** **(** [Vector3](class_vector3) with **)** + Transposed dot product with the y axis of the matrix. #### tdotz - * [real](class_real) **[tdotz](#tdotz)** **(** [Vector3](class_vector3) with **)** -\\ + * [real](class_real) **tdotz** **(** [Vector3](class_vector3) with **)** + Transposed dot product with the z axis of the matrix. #### transposed - * [Matrix3](class_matrix3) **[transposed](#transposed)** **(** **)** -\\ + * [Matrix3](class_matrix3) **transposed** **(** **)** + Return the transposed version of the matrix. #### xform - * [Vector3](class_vector3) **[xform](#xform)** **(** [Vector3](class_vector3) v **)** -\\ + * [Vector3](class_vector3) **xform** **(** [Vector3](class_vector3) v **)** + Return a vector transformed by the matrix and return it. #### xform_inv - * [Vector3](class_vector3) **[xform_inv](#xform_inv)** **(** [Vector3](class_vector3) v **)** -\\ + * [Vector3](class_vector3) **xform_inv** **(** [Vector3](class_vector3) v **)** + Return a vector transformed by the transposed matrix and return it. #### Matrix3 - * void **[Matrix3](#Matrix3)** **(** [Vector3](class_vector3) x_axis, [Vector3](class_vector3) y_axis, [Vector3](class_vector3) z_axis **)** -\\ + * void **Matrix3** **(** [Vector3](class_vector3) x_axis, [Vector3](class_vector3) y_axis, [Vector3](class_vector3) z_axis **)** + Create a matrix from 3 axis vectors. #### Matrix3 - * void **[Matrix3](#Matrix3)** **(** [Vector3](class_vector3) axis, [real](class_real) phi **)** -\\ + * void **Matrix3** **(** [Vector3](class_vector3) axis, [real](class_real) phi **)** + Create a matrix from 3 axis vectors. #### Matrix3 - * void **[Matrix3](#Matrix3)** **(** [Quat](class_quat) from **)** -\\ + * void **Matrix3** **(** [Quat](class_quat) from **)** + Create a matrix from 3 axis vectors. diff --git a/class_menubutton.md b/class_menubutton.md index 15664fd..e8cc5af 100644 --- a/class_menubutton.md +++ b/class_menubutton.md @@ -15,6 +15,6 @@ Special button that brings up a [[popupmenu|PopupMenu]] when clicked. That's pre ### Member Function Description #### get_popup - * [Object](class_object) **[get_popup](#get_popup)** **(** **)** -\\ + * [Object](class_object) **get_popup** **(** **)** + Return the [[popupmenu|PopupMenu]] contained in this button. diff --git a/class_mesh.md b/class_mesh.md index 18566ae..63b3238 100644 --- a/class_mesh.md +++ b/class_mesh.md @@ -58,48 +58,48 @@ Mesh is a type of [[resource|Resource]] that contains vertex-array based geometr ### Member Function Description #### add_surface - * void **[add_surface](#add_surface)** **(** [int](class_int) primitive, [Array](class_array) arrays, [Array](class_array) morph_arrays, [bool](class_bool) arg3=Array() **)** -\\ + * void **add_surface** **(** [int](class_int) primitive, [Array](class_array) arrays, [Array](class_array) morph_arrays, [bool](class_bool) arg3=Array() **)** + Create a new surface ([[#get_surface_count|get_surface_count]] will become surf_idx for this.\\ "#10;"#9;"#9;"#9;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).\\ "#10;"#9;"#9;"#9;The format of a surface determines which arrays it will allocate and hold, so "format" is a combination of ARRAY_FORMAT_* mask constants ORed together. ARRAY_FORMAT_VERTEX must be always present. "array_len" determines the amount of vertices in the array (not primitives!). if ARRAY_FORMAT_INDEX is in the format mask, then it means that an index array will be allocated and "index_array_len" must be passed. #### get_surface_count - * [int](class_int) **[get_surface_count](#get_surface_count)** **(** **)** const -\\ + * [int](class_int) **get_surface_count** **(** **)** const + Return the amount of surfaces that the [[mesh|Mesh]] holds. #### surface_remove - * void **[surface_remove](#surface_remove)** **(** [int](class_int) surf_idx **)** -\\ + * void **surface_remove** **(** [int](class_int) surf_idx **)** + Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down. #### surface_get_array_len - * [int](class_int) **[surface_get_array_len](#surface_get_array_len)** **(** [int](class_int) surf_idx **)** const -\\ + * [int](class_int) **surface_get_array_len** **(** [int](class_int) surf_idx **)** const + Return the length in vertices of the vertex array in the requested surface (see [[#add_surface|add_surface]]). #### surface_get_array_index_len - * [int](class_int) **[surface_get_array_index_len](#surface_get_array_index_len)** **(** [int](class_int) surf_idx **)** const -\\ + * [int](class_int) **surface_get_array_index_len** **(** [int](class_int) surf_idx **)** const + Return the length in indices of the index array in the requested surface (see [[#add_surface|add_surface]]). #### surface_get_format - * [int](class_int) **[surface_get_format](#surface_get_format)** **(** [int](class_int) surf_idx **)** const -\\ + * [int](class_int) **surface_get_format** **(** [int](class_int) surf_idx **)** const + Return the format mask of the requested surface (see [[#add_surface|add_surface]]). #### surface_get_primitive_type - * [int](class_int) **[surface_get_primitive_type](#surface_get_primitive_type)** **(** [int](class_int) surf_idx **)** const -\\ + * [int](class_int) **surface_get_primitive_type** **(** [int](class_int) surf_idx **)** const + Return the primitive type of the requested surface (see [[#add_surface|add_surface]]). #### surface_set_material - * void **[surface_set_material](#surface_set_material)** **(** [int](class_int) surf_idx, [Material](class_material) material **)** -\\ + * void **surface_set_material** **(** [int](class_int) surf_idx, [Material](class_material) material **)** + Set a [[material|Material]] for a given surface. Surface will be rendered using this material. #### surface_get_material - * [Material](class_material) **[surface_get_material](#surface_get_material)** **(** [int](class_int) surf_idx **)** const -\\ + * [Material](class_material) **surface_get_material** **(** [int](class_int) surf_idx **)** const + Return a [[material|Material]] in a given surface. Surface is rendered using this material. diff --git a/class_meshinstance.md b/class_meshinstance.md index 2f26d10..bfefd37 100644 --- a/class_meshinstance.md +++ b/class_meshinstance.md @@ -16,21 +16,21 @@ MeshInstance is a [[node|Node]] that takes a [[mesh|Mesh]] resource and adds it ### Member Function Description #### set_mesh - * void **[set_mesh](#set_mesh)** **(** [Mesh](class_mesh) mesh **)** -\\ + * void **set_mesh** **(** [Mesh](class_mesh) mesh **)** + Set the [[mesh|Mesh]] resource for the instance. #### get_mesh - * [Mesh](class_mesh) **[get_mesh](#get_mesh)** **(** **)** const -\\ + * [Mesh](class_mesh) **get_mesh** **(** **)** const + Return the current [[mesh|Mesh]] resource for the instance. #### get_aabb - * [AABB](class_aabb) **[get_aabb](#get_aabb)** **(** **)** const -\\ + * [AABB](class_aabb) **get_aabb** **(** **)** const + Return the AABB of the mesh, in local coordinates. #### create_trimesh_collision - * void **[create_trimesh_collision](#create_trimesh_collision)** **(** **)** -\\ + * void **create_trimesh_collision** **(** **)** + This helper creates a [[staticbody|StaticBody]] child [[node|Node]] using the mesh geometry as collision. It"apos;s mainly used for testing. diff --git a/class_meshlibrary.md b/class_meshlibrary.md index 9c9c8a2..c3c296b 100644 --- a/class_meshlibrary.md +++ b/class_meshlibrary.md @@ -22,46 +22,46 @@ Library of meshes. Contains a list of [[mesh|Mesh]] resources, each with name an ### Member Function Description #### create_item - * void **[create_item](#create_item)** **(** [int](class_int) id **)** -\\ + * void **create_item** **(** [int](class_int) id **)** + Create a new item in the library, supplied an id. #### set_item_name - * void **[set_item_name](#set_item_name)** **(** [int](class_int) id, [String](class_string) name **)** -\\ + * void **set_item_name** **(** [int](class_int) id, [String](class_string) name **)** + Set the name of the item. #### set_item_mesh - * void **[set_item_mesh](#set_item_mesh)** **(** [int](class_int) id, [Mesh](class_mesh) mesh **)** -\\ + * void **set_item_mesh** **(** [int](class_int) id, [Mesh](class_mesh) mesh **)** + Set the mesh of the item. #### get_item_name - * [String](class_string) **[get_item_name](#get_item_name)** **(** [int](class_int) id **)** const -\\ + * [String](class_string) **get_item_name** **(** [int](class_int) id **)** const + Return the name of the item. #### get_item_mesh - * [Mesh](class_mesh) **[get_item_mesh](#get_item_mesh)** **(** [int](class_int) id **)** const -\\ + * [Mesh](class_mesh) **get_item_mesh** **(** [int](class_int) id **)** const + Return the mesh of the item. #### remove_item - * void **[remove_item](#remove_item)** **(** [int](class_int) id **)** -\\ + * void **remove_item** **(** [int](class_int) id **)** + Remove the item. #### clear - * void **[clear](#clear)** **(** **)** -\\ + * void **clear** **(** **)** + Clear the library. #### get_item_list - * [IntArray](class_intarray) **[get_item_list](#get_item_list)** **(** **)** const -\\ + * [IntArray](class_intarray) **get_item_list** **(** **)** const + Return the list of items. #### get_last_unused_item_id - * [int](class_int) **[get_last_unused_item_id](#get_last_unused_item_id)** **(** **)** const -\\ + * [int](class_int) **get_last_unused_item_id** **(** **)** const + Get an unused id for a new item. diff --git a/class_multimesh.md b/class_multimesh.md index 328f045..e3d9224 100644 --- a/class_multimesh.md +++ b/class_multimesh.md @@ -25,56 +25,56 @@ For this case a MultiMesh becomes very useful, as it can draw thousands of insta ### Member Function Description #### set_mesh - * void **[set_mesh](#set_mesh)** **(** [Mesh](class_mesh) mesh **)** -\\ + * void **set_mesh** **(** [Mesh](class_mesh) mesh **)** + Set the [[mesh|Mesh]] resource to be drawn in multiple instances. #### get_mesh - * [Mesh](class_mesh) **[get_mesh](#get_mesh)** **(** **)** const -\\ + * [Mesh](class_mesh) **get_mesh** **(** **)** const + Return the [[mesh|Mesh]] resource drawn as multiple instances. #### set_instance_count - * void **[set_instance_count](#set_instance_count)** **(** [int](class_int) arg0 **)** -\\ + * void **set_instance_count** **(** [int](class_int) arg0 **)** + Set the amount of instnces that is going to be drawn. Changing this number will erase all the existing instance transform and color data. #### get_instance_count - * [int](class_int) **[get_instance_count](#get_instance_count)** **(** **)** const -\\ + * [int](class_int) **get_instance_count** **(** **)** const + Return the amount of instnces that is going to be drawn. #### set_instance_transform - * void **[set_instance_transform](#set_instance_transform)** **(** [int](class_int) arg0, [Transform](class_transform) arg1 **)** -\\ + * void **set_instance_transform** **(** [int](class_int) arg0, [Transform](class_transform) arg1 **)** + Set the transform for a specific instance. #### get_instance_transform - * [Transform](class_transform) **[get_instance_transform](#get_instance_transform)** **(** [int](class_int) arg0 **)** const -\\ + * [Transform](class_transform) **get_instance_transform** **(** [int](class_int) arg0 **)** const + Return the transform of a specific instance. #### set_instance_color - * void **[set_instance_color](#set_instance_color)** **(** [int](class_int) arg0, [Color](class_color) arg1 **)** -\\ + * void **set_instance_color** **(** [int](class_int) arg0, [Color](class_color) arg1 **)** + Set the color of a specific instance. #### get_instance_color - * [Color](class_color) **[get_instance_color](#get_instance_color)** **(** [int](class_int) arg0 **)** const -\\ + * [Color](class_color) **get_instance_color** **(** [int](class_int) arg0 **)** const + Get the color of a specific instance. #### set_aabb - * void **[set_aabb](#set_aabb)** **(** [AABB](class_aabb) arg0 **)** -\\ + * void **set_aabb** **(** [AABB](class_aabb) arg0 **)** + Set the visibility AABB. If not provided, MultiMesh will not be visible. #### get_aabb - * [AABB](class_aabb) **[get_aabb](#get_aabb)** **(** **)** const -\\ + * [AABB](class_aabb) **get_aabb** **(** **)** const + Return the visibility AABB. #### generate_aabb - * void **[generate_aabb](#generate_aabb)** **(** **)** -\\ + * void **generate_aabb** **(** **)** + Generate a new visibility AABB, using mesh AABB and instance transforms. Since instance information is stored in the [[visualserver|VisualServer]], this function is VERY SLOW and must NOT be used often. diff --git a/class_multimeshinstance.md b/class_multimeshinstance.md index 5d642e0..38136b7 100644 --- a/class_multimeshinstance.md +++ b/class_multimeshinstance.md @@ -13,11 +13,11 @@ MultiMeshInstance is a [[node|Node]] that takes a [[multimesh|MultiMesh]] resour ### Member Function Description #### set_multimesh - * void **[set_multimesh](#set_multimesh)** **(** [Object](class_object) multimesh **)** -\\ + * void **set_multimesh** **(** [Object](class_object) multimesh **)** + Set the [[multimesh|MultiMesh]] to be instance. #### get_multimesh - * [Object](class_object) **[get_multimesh](#get_multimesh)** **(** **)** const -\\ + * [Object](class_object) **get_multimesh** **(** **)** const + Return the [[multimesh|MultiMesh]] that is used for instancing. diff --git a/class_node.md b/class_node.md index 46dff82..20f3b0d 100644 --- a/class_node.md +++ b/class_node.md @@ -97,238 +97,238 @@ Nodes can be set as children of other nodes, resulting in a tree arrangement. An ### Member Function Description #### _enter_scene - * void **[_enter_scene](#_enter_scene)** **(** **)** virtual -\\ + * void **_enter_scene** **(** **)** virtual + Called when entered the scene. #### _exit_scene - * void **[_exit_scene](#_exit_scene)** **(** **)** virtual -\\ + * void **_exit_scene** **(** **)** virtual + Called when being removed from the scene. #### _fixed_process - * void **[_fixed_process](#_fixed_process)** **(** [real](class_real) delta **)** virtual -\\ + * void **_fixed_process** **(** [real](class_real) delta **)** virtual + Called for fixed processing (synced to the physics). #### _input - * void **[_input](#_input)** **(** [InputEvent](class_inputevent) event **)** virtual -\\ + * void **_input** **(** [InputEvent](class_inputevent) event **)** virtual + Called when any input happens (also must enable with [[#set_process_input|set_process_input]] or the property). #### _process - * void **[_process](#_process)** **(** [real](class_real) delta **)** virtual -\\ + * void **_process** **(** [real](class_real) delta **)** virtual + Called for processing. This is called every frame, with the delta time from the previous frame. #### _ready - * void **[_ready](#_ready)** **(** **)** virtual -\\ + * void **_ready** **(** **)** virtual + Called when ready (entered scene and children entered too). #### _unhandled_input - * void **[_unhandled_input](#_unhandled_input)** **(** [InputEvent](class_inputevent) event **)** virtual -\\ + * void **_unhandled_input** **(** [InputEvent](class_inputevent) event **)** virtual + Called when any input happens that was not handled by something else (also must enable with [[#set_process_unhandled_input|set_process_unhandled_input]] or the property). #### _unhandled_key_input - * void **[_unhandled_key_input](#_unhandled_key_input)** **(** [InputEvent](class_inputevent) key_event **)** virtual -\\ + * void **_unhandled_key_input** **(** [InputEvent](class_inputevent) key_event **)** virtual + Called when any key input happens that was not handled by something else. #### set_name - * void **[set_name](#set_name)** **(** [String](class_string) name **)** -\\ + * void **set_name** **(** [String](class_string) name **)** + Set the name of the [[node|Node]]. Name must be unique within parent, and setting an already existing name will cause for the node to be automatically renamed. #### get_name - * [String](class_string) **[get_name](#get_name)** **(** **)** const -\\ + * [String](class_string) **get_name** **(** **)** const + Return the name of the [[node|Node]]. Name is be unique within parent. #### add_child - * void **[add_child](#add_child)** **(** [Node](class_node) node **)** -\\ + * void **add_child** **(** [Node](class_node) node **)** + Add a child [[node|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. #### remove_child - * void **[remove_child](#remove_child)** **(** [Node](class_node) node **)** -\\ + * void **remove_child** **(** [Node](class_node) node **)** + Remove a child [[node|Node]]. Node is NOT deleted and will have to be deleted manually. #### get_child_count - * [int](class_int) **[get_child_count](#get_child_count)** **(** **)** const -\\ + * [int](class_int) **get_child_count** **(** **)** const + Return the amount of children nodes. #### get_child - * [Node](class_node) **[get_child](#get_child)** **(** [int](class_int) idx **)** const -\\ + * [Node](class_node) **get_child** **(** [int](class_int) idx **)** const + Return a children node by it"apos;s index (see [[#get_child_count|get_child_count]]). This method is often used for iterating all children of a node. #### get_node - * [Node](class_node) **[get_node](#get_node)** **(** [NodePath](class_nodepath) path **)** const -\\ + * [Node](class_node) **get_node** **(** [NodePath](class_nodepath) path **)** const + Fetch a node. "path" must be valid (or else error will occur) and can be either the name of a child node, a relative path (from the current node to another node), or an absolute path to a node.\\ Examples ofa paths are: get_node("Sword") , get_node("../Swamp/Alligator") , get_node("/MyGame"). \\ Note: fetching absolute paths only works when the node is inside the scene tree (see [[#is_inside_scene|is_inside_scene]]). #### get_parent - * Parent **[get_parent](#get_parent)** **(** **)** const -\\ + * Parent **get_parent** **(** **)** const + Return the parent [[node|Node]] of the current [[node|Node]], or an empty Object if the node lacks a parent. #### is_inside_scene - * [bool](class_bool) **[is_inside_scene](#is_inside_scene)** **(** **)** const -\\ + * [bool](class_bool) **is_inside_scene** **(** **)** const + Return wether the node is inside a scene tree (a tree where the topmost node is a [RootNode]) #### is_a_parent_of - * [bool](class_bool) **[is_a_parent_of](#is_a_parent_of)** **(** [Node](class_node) node **)** const -\\ + * [bool](class_bool) **is_a_parent_of** **(** [Node](class_node) node **)** const + Return //true// if the "node" argument is a direct or indirect child of the current node, otherwise return //false//. #### is_greater_than - * [bool](class_bool) **[is_greater_than](#is_greater_than)** **(** [Node](class_node) node **)** const -\\ + * [bool](class_bool) **is_greater_than** **(** [Node](class_node) node **)** const + Return //true// if "node" occurs later in the scene hierarchy than the current node, otherwise return //false//. #### get_path - * [NodePath](class_nodepath) **[get_path](#get_path)** **(** **)** const -\\ + * [NodePath](class_nodepath) **get_path** **(** **)** const + Return the absolute path of the current node. This only works if the curent node is inside the scene tree (see [[#is_inside_scene|is_inside_scene]]). #### get_path_to - * [NodePath](class_nodepath) **[get_path_to](#get_path_to)** **(** [Node](class_node) node **)** const -\\ + * [NodePath](class_nodepath) **get_path_to** **(** [Node](class_node) node **)** const + 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. #### add_to_group - * void **[add_to_group](#add_to_group)** **(** [String](class_string) group, [bool](class_bool) arg1=false **)** -\\ + * void **add_to_group** **(** [String](class_string) group, [bool](class_bool) arg1=false **)** + Add a node to a group. Groups are helpers to name and organize group of nodes, like for example: "Enemies" "Collectables", etc. A [[node|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 [[#is_inside_scene|is_inside_scene]]). #### remove_from_group - * void **[remove_from_group](#remove_from_group)** **(** [String](class_string) group **)** -\\ + * void **remove_from_group** **(** [String](class_string) group **)** + Remove a node from a group. #### move_child - * void **[move_child](#move_child)** **(** [Node](class_node) child_node, [int](class_int) to_pos **)** -\\ + * void **move_child** **(** [Node](class_node) child_node, [int](class_int) to_pos **)** + 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 chilren nodes may be useful. #### raise - * void **[raise](#raise)** **(** **)** -\\ + * void **raise** **(** **)** + Move this node to the top of the array of nodes of the parent node. This is often useful on GUIs ([[control|Control]]), because their order of drawing fully depends on their order in the tree. #### set_owner - * void **[set_owner](#set_owner)** **(** [Node](class_node) owner **)** -\\ + * void **set_owner** **(** [Node](class_node) owner **)** + 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. #### get_owner - * [Node](class_node) **[get_owner](#get_owner)** **(** **)** const -\\ + * [Node](class_node) **get_owner** **(** **)** const + Get the node owner (see [[#set_node_owner|set_node_owner]]). #### remove_and_skip - * void **[remove_and_skip](#remove_and_skip)** **(** **)** -\\ + * void **remove_and_skip** **(** **)** + Remove a node and set all its children as childrens of the parent node (if exists). All even subscriptions that pass by the removed node will be unsubscribed. #### get_index - * [int](class_int) **[get_index](#get_index)** **(** **)** const -\\ + * [int](class_int) **get_index** **(** **)** const + Get the node index in the parent (assuming it has a parent). #### print_tree - * void **[print_tree](#print_tree)** **(** **)** -\\ + * void **print_tree** **(** **)** + Print the screne to stdout. Used mainly for debugging purposes. #### set_filename - * void **[set_filename](#set_filename)** **(** [String](class_string) filename **)** -\\ + * void **set_filename** **(** [String](class_string) filename **)** + 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. #### get_filename - * [String](class_string) **[get_filename](#get_filename)** **(** **)** const -\\ + * [String](class_string) **get_filename** **(** **)** const + Return a filename that may be containedA node can contained by the node. When a scene is instanced from a file, it topmost node contains the filename from where it was loaded (see [[#set_filename|set_filename]]). #### propagate_notification - * void **[propagate_notification](#propagate_notification)** **(** [int](class_int) what **)** -\\ + * void **propagate_notification** **(** [int](class_int) what **)** + Notify the current node and all its chldren recursively by calling notification() in all of them. #### set_fixed_process - * void **[set_fixed_process](#set_fixed_process)** **(** [bool](class_bool) enable **)** -\\ + * void **set_fixed_process** **(** [bool](class_bool) enable **)** + Enables or disables node fixed framerate processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS at a fixed (usually 60fps, check [[os|OS]] to change that) interval (and the [[#_fixed_process|_fixed_process]] callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling [[#get_fixed_process_time|get_fixed_process_time]]. #### get_fixed_process_delta_time - * [real](class_real) **[get_fixed_process_delta_time](#get_fixed_process_delta_time)** **(** **)** const -\\ + * [real](class_real) **get_fixed_process_delta_time** **(** **)** const + Return the time elapsed since the last fixed frame. This is always the same in fixed proecssing unless the frames per second is changed in [[os|OS]]. #### is_fixed_processing - * [bool](class_bool) **[is_fixed_processing](#is_fixed_processing)** **(** **)** const -\\ + * [bool](class_bool) **is_fixed_processing** **(** **)** const + Return true if fixed processing is enabled (see [[#set_fixed_process|set_fixed_process]]). #### set_process - * void **[set_process](#set_process)** **(** [bool](class_bool) enable **)** -\\ + * void **set_process** **(** [bool](class_bool) enable **)** + Enables or disables node processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS on every drawn frame (and the [[#_process|_process]] callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling [[#get_process_time|get_process_time]]. #### get_process_delta_time - * [real](class_real) **[get_process_delta_time](#get_process_delta_time)** **(** **)** const -\\ + * [real](class_real) **get_process_delta_time** **(** **)** const + Return the time elapsed (in seconds) since the last process callback. This is almost always different each time. #### is_processing - * [bool](class_bool) **[is_processing](#is_processing)** **(** **)** const -\\ + * [bool](class_bool) **is_processing** **(** **)** const + Return wether processing is enabled in the current node (see [[#set_process|set_process]]). #### set_process_input - * void **[set_process_input](#set_process_input)** **(** [bool](class_bool) enable **)** -\\ + * void **set_process_input** **(** [bool](class_bool) enable **)** + Enable input processing for node. This is not requiered for GUI controls! It hooks up the node to receive all input (see [[#_input|_input]]). #### is_processing_input - * [bool](class_bool) **[is_processing_input](#is_processing_input)** **(** **)** const -\\ + * [bool](class_bool) **is_processing_input** **(** **)** const + Return true if the node is processing input (see [[#set_process_input|set_process_input]]). #### set_process_unhandled_input - * void **[set_process_unhandled_input](#set_process_unhandled_input)** **(** [bool](class_bool) enable **)** -\\ + * void **set_process_unhandled_input** **(** [bool](class_bool) enable **)** + Enable unhandled input processing for node. This is not requiered for GUI controls! It hooks up the node to receive all input that was not previously handled before (usually by a [[control|Control]]). (see [[#_unhandled_input|_unhandled_input]]). #### is_processing_unhandled_input - * [bool](class_bool) **[is_processing_unhandled_input](#is_processing_unhandled_input)** **(** **)** const -\\ + * [bool](class_bool) **is_processing_unhandled_input** **(** **)** const + Return true if the node is processing unhandled input (see [[#set_process_unhandled_input|set_process_unhandled_input]]). #### can_process - * [bool](class_bool) **[can_process](#can_process)** **(** **)** const -\\ + * [bool](class_bool) **can_process** **(** **)** const + Return true if the node can process. #### get_scene - * [SceneMainLoop](class_scenemainloop) **[get_scene](#get_scene)** **(** **)** const -\\ + * [SceneMainLoop](class_scenemainloop) **get_scene** **(** **)** const + Get the current SceneMainLoop. Only returned if the node is inside the scene, else returns null. #### duplicate - * [Node](class_node) **[duplicate](#duplicate)** **(** **)** const -\\ + * [Node](class_node) **duplicate** **(** **)** const + Return a duplicate of the scene, with all nodes and parameters copied. Subscriptions will not be duplicated. #### replace_by - * void **[replace_by](#replace_by)** **(** [Node](class_node) node, [bool](class_bool) keep_data=false **)** -\\ + * void **replace_by** **(** [Node](class_node) node, [bool](class_bool) keep_data=false **)** + Replace a node in a scene by a given one. Subscriptions that pass through this node will be lost. diff --git a/class_node2d.md b/class_node2d.md index b2e70fe..f3f1244 100644 --- a/class_node2d.md +++ b/class_node2d.md @@ -23,36 +23,36 @@ Base node for 2D system. Node2D contains a position, rotation and scale, which i ### Member Function Description #### set_pos - * void **[set_pos](#set_pos)** **(** [Vector2](class_vector2) pos **)** -\\ + * void **set_pos** **(** [Vector2](class_vector2) pos **)** + Set the position of the 2d node. #### set_rot - * void **[set_rot](#set_rot)** **(** [real](class_real) rot **)** -\\ + * void **set_rot** **(** [real](class_real) rot **)** + Set the rotation of the 2d node. #### set_scale - * void **[set_scale](#set_scale)** **(** [Vector2](class_vector2) scale **)** -\\ + * void **set_scale** **(** [Vector2](class_vector2) scale **)** + Set the scale of the 2d node. #### get_pos - * [Vector2](class_vector2) **[get_pos](#get_pos)** **(** **)** const -\\ + * [Vector2](class_vector2) **get_pos** **(** **)** const + Return the position of the 2D node. #### get_rot - * [real](class_real) **[get_rot](#get_rot)** **(** **)** const -\\ + * [real](class_real) **get_rot** **(** **)** const + Return the rotation of the 2D node. #### get_scale - * [Vector2](class_vector2) **[get_scale](#get_scale)** **(** **)** const -\\ + * [Vector2](class_vector2) **get_scale** **(** **)** const + Return the scale of the 2D node. #### get_global_pos - * [Vector2](class_vector2) **[get_global_pos](#get_global_pos)** **(** **)** const -\\ + * [Vector2](class_vector2) **get_global_pos** **(** **)** const + Return the global position of the 2D node. diff --git a/class_nodepath.md b/class_nodepath.md index 5ac6f99..9d46398 100644 --- a/class_nodepath.md +++ b/class_nodepath.md @@ -20,36 +20,36 @@ Built-in type optimized for path traversing. A Node path is an optimized compile ### Member Function Description #### get_name - * [String](class_string) **[get_name](#get_name)** **(** [int](class_int) idx **)** -\\ + * [String](class_string) **get_name** **(** [int](class_int) idx **)** + Return a path level name. #### get_name_count - * [int](class_int) **[get_name_count](#get_name_count)** **(** **)** -\\ + * [int](class_int) **get_name_count** **(** **)** + Return the path level count. #### get_property - * [String](class_string) **[get_property](#get_property)** **(** **)** -\\ + * [String](class_string) **get_property** **(** **)** + Return the property associated (empty if none). #### get_subname - * [String](class_string) **[get_subname](#get_subname)** **(** [int](class_int) idx **)** -\\ + * [String](class_string) **get_subname** **(** [int](class_int) idx **)** + Return the subname level name. #### get_subname_count - * [int](class_int) **[get_subname_count](#get_subname_count)** **(** **)** -\\ + * [int](class_int) **get_subname_count** **(** **)** + Return the subname count. #### is_absolute - * [bool](class_bool) **[is_absolute](#is_absolute)** **(** **)** -\\ + * [bool](class_bool) **is_absolute** **(** **)** + Return true if the node path is absolute (not relative). #### is_empty - * [bool](class_bool) **[is_empty](#is_empty)** **(** **)** -\\ + * [bool](class_bool) **is_empty** **(** **)** + Return true if the node path is empty. diff --git a/class_object.md b/class_object.md index b9627a8..ff7ef18 100644 --- a/class_object.md +++ b/class_object.md @@ -59,157 +59,157 @@ Base class for all non built-in types. Everything not a built-in type starts the ### Member Function Description #### _get - * void **[_get](#_get)** **(** [String](class_string) property **)** virtual -\\ + * void **_get** **(** [String](class_string) property **)** virtual + Return a property, return null if the property does not exist. #### _get_property_list - * [Array](class_array) **[_get_property_list](#_get_property_list)** **(** **)** virtual -\\ + * [Array](class_array) **_get_property_list** **(** **)** virtual + Return the property list, array of dictionaries, dictionaries must countain: name:String, type:int (see TYPE_* enum in globals) and optionally: hint:int (see PROPERTY_HINT_* in globals), hint_string:String, usage:int (see PROPERTY_USAGE_* in globals). #### _notification - * void **[_notification](#_notification)** **(** [int](class_int) what **)** virtual -\\ + * void **_notification** **(** [int](class_int) what **)** virtual + Notification request, the notification id is received. #### _set - * void **[_set](#_set)** **(** [String](class_string) property, var value **)** virtual -\\ + * void **_set** **(** [String](class_string) property, var value **)** virtual + Set a property. Return true if the property was found. #### get_type - * [String](class_string) **[get_type](#get_type)** **(** **)** const -\\ + * [String](class_string) **get_type** **(** **)** const + Return the type of the object as a string. #### is_type - * [bool](class_bool) **[is_type](#is_type)** **(** [String](class_string) type **)** const -\\ + * [bool](class_bool) **is_type** **(** [String](class_string) type **)** const + Check the type of the obeject against a string (including inheritance). #### set - * void **[set](#set)** **(** [String](class_string) property, var value **)** -\\ + * void **set** **(** [String](class_string) property, var value **)** + Set property into the object. #### get - * void **[get](#get)** **(** [String](class_string) property **)** const -\\ + * void **get** **(** [String](class_string) property **)** const + Get a property from the object. #### get_property_list - * [Array](class_array) **[get_property_list](#get_property_list)** **(** **)** const -\\ + * [Array](class_array) **get_property_list** **(** **)** const + Return the list of properties as an array of dictionaries, dictionaries countain: name:String, type:int (see TYPE_* enum in globals) and optionally: hint:int (see PROPERTY_HINT_* in globals), hint_string:String, usage:int (see PROPERTY_USAGE_* in globals). #### notification - * void **[notification](#notification)** **(** [int](class_int) what, [bool](class_bool) arg1=false **)** -\\ + * void **notification** **(** [int](class_int) what, [bool](class_bool) arg1=false **)** + Notify the object of something. #### get_instance_ID - * [int](class_int) **[get_instance_ID](#get_instance_ID)** **(** **)** const -\\ + * [int](class_int) **get_instance_ID** **(** **)** const + Return the instance ID. All objects have a unique instance ID. #### set_script - * void **[set_script](#set_script)** **(** [Script](class_script) script **)** -\\ + * void **set_script** **(** [Script](class_script) script **)** + Set a script into the object, scripts extend the object functionality. #### get_script - * [Script](class_script) **[get_script](#get_script)** **(** **)** const -\\ + * [Script](class_script) **get_script** **(** **)** const + Return the object script (or null if it doesn't have one). #### set_meta - * void **[set_meta](#set_meta)** **(** [String](class_string) name, var value **)** -\\ + * void **set_meta** **(** [String](class_string) name, var value **)** + Set a metadata into the object. Medatada is serialized. Metadata can be //anything//. #### get_meta - * void **[get_meta](#get_meta)** **(** [String](class_string) name **)** const -\\ + * void **get_meta** **(** [String](class_string) name **)** const + Return a metadata from the object. #### has_meta - * [bool](class_bool) **[has_meta](#has_meta)** **(** [String](class_string) name **)** const -\\ + * [bool](class_bool) **has_meta** **(** [String](class_string) name **)** const + Return true if a metadata is found with the requested name. #### get_meta_list - * [StringArray](class_stringarray) **[get_meta_list](#get_meta_list)** **(** **)** const -\\ + * [StringArray](class_stringarray) **get_meta_list** **(** **)** const + Return the list of metadatas in the object. #### add_user_signal - * void **[add_user_signal](#add_user_signal)** **(** [String](class_string) signal, [Array](class_array) arguments=Array() **)** -\\ + * void **add_user_signal** **(** [String](class_string) signal, [Array](class_array) arguments=Array() **)** + 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 [@GlobalScope] TYPE_*). #### emit_signal - * void **[emit_signal](#emit_signal)** **(** [String](class_string) signal, var arg0=NULL, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL **)** -\\ + * void **emit_signal** **(** [String](class_string) signal, var arg0=NULL, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL **)** + Emit a signal. Arguments are passed in an array. #### call - * void **[call](#call)** **(** [String](class_string) method, var arg0=NULL, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL, var arg5=NULL, var arg6=NULL, var arg7=NULL, var arg8=NULL, var arg9=NULL **)** -\\ + * void **call** **(** [String](class_string) method, var arg0=NULL, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL, var arg5=NULL, var arg6=NULL, var arg7=NULL, var arg8=NULL, var arg9=NULL **)** + Call a function in the object, result is returned. #### call_deferred - * void **[call_deferred](#call_deferred)** **(** [String](class_string) method, var arg0=NULL, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL **)** -\\ + * void **call_deferred** **(** [String](class_string) method, var arg0=NULL, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL **)** + Create and store a function in the object. The call will take place on idle time. #### get_signal_list - * [Array](class_array) **[get_signal_list](#get_signal_list)** **(** **)** const -\\ + * [Array](class_array) **get_signal_list** **(** **)** const + Return the list of signals as an array of dictionaries. #### connect - * void **[connect](#connect)** **(** [String](class_string) signal, [Object](class_object) target, [String](class_string) method, [Array](class_array) binds=Array(), [int](class_int) flags=0 **)** -\\ + * void **connect** **(** [String](class_string) signal, [Object](class_object) target, [String](class_string) method, [Array](class_array) binds=Array(), [int](class_int) flags=0 **)** + 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 [[#is_connected|is_connected]] to check. #### disconnect - * void **[disconnect](#disconnect)** **(** [String](class_string) signal, [Object](class_object) target, [String](class_string) method **)** -\\ + * void **disconnect** **(** [String](class_string) signal, [Object](class_object) target, [String](class_string) method **)** + Disconnect a signal from a method. #### is_connected - * [bool](class_bool) **[is_connected](#is_connected)** **(** [String](class_string) signal, [Object](class_object) target, [String](class_string) method **)** const -\\ + * [bool](class_bool) **is_connected** **(** [String](class_string) signal, [Object](class_object) target, [String](class_string) method **)** const + Return true if a connection exists for a given signal and target/method. #### set_block_signals - * void **[set_block_signals](#set_block_signals)** **(** [bool](class_bool) enable **)** -\\ + * void **set_block_signals** **(** [bool](class_bool) enable **)** + If set to true, signal emission is blocked. #### is_blocking_signals - * [bool](class_bool) **[is_blocking_signals](#is_blocking_signals)** **(** **)** const -\\ + * [bool](class_bool) **is_blocking_signals** **(** **)** const + Return true if signal emission blocking is enabled. #### set_message_translation - * void **[set_message_translation](#set_message_translation)** **(** [bool](class_bool) enable **)** -\\ + * void **set_message_translation** **(** [bool](class_bool) enable **)** + Set true if this object can translate strings (in calls to tr() ). Default is true. #### can_translate_messages - * void **[can_translate_messages](#can_translate_messages)** **(** [bool](class_bool) arg0 **)** -\\ + * void **can_translate_messages** **(** [bool](class_bool) arg0 **)** + Return true if this object can translate strings. #### XL_MESSAGE - * [String](class_string) **[XL_MESSAGE](#XL_MESSAGE)** **(** [String](class_string) message **)** const -\\ + * [String](class_string) **XL_MESSAGE** **(** [String](class_string) message **)** const + deprecated, will go away. #### tr - * [String](class_string) **[tr](#tr)** **(** [String](class_string) message **)** const -\\ + * [String](class_string) **tr** **(** [String](class_string) message **)** const + Translate a message. Only works in message translation is enabled (which is by default). See [[#set_message_translation|set_message_translation]]. diff --git a/class_optionbutton.md b/class_optionbutton.md index f928c18..9cfd130 100644 --- a/class_optionbutton.md +++ b/class_optionbutton.md @@ -34,66 +34,66 @@ OptionButton is a type button that provides a selectable list of items when pres ### Member Function Description #### add_item - * void **[add_item](#add_item)** **(** [String](class_string) label, [int](class_int) id=-1 **)** -\\ + * void **add_item** **(** [String](class_string) label, [int](class_int) id=-1 **)** + Add an item, with text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end. #### add_icon_item - * void **[add_icon_item](#add_icon_item)** **(** [Texture](class_texture) texture, [String](class_string) label, [int](class_int) id **)** -\\ + * void **add_icon_item** **(** [Texture](class_texture) texture, [String](class_string) label, [int](class_int) id **)** + 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. #### set_item_text - * void **[set_item_text](#set_item_text)** **(** [int](class_int) idx, [String](class_string) text **)** -\\ + * void **set_item_text** **(** [int](class_int) idx, [String](class_string) text **)** + Set the text of an item at index "idx". #### set_item_icon - * void **[set_item_icon](#set_item_icon)** **(** [int](class_int) idx, [Texture](class_texture) texture **)** -\\ + * void **set_item_icon** **(** [int](class_int) idx, [Texture](class_texture) texture **)** + Set the icon of an item at index "idx". #### set_item_ID - * void **[set_item_ID](#set_item_ID)** **(** [int](class_int) idx, [int](class_int) id **)** -\\ + * void **set_item_ID** **(** [int](class_int) idx, [int](class_int) id **)** + Set the ID of an item at index "idx". #### get_item_text - * [String](class_string) **[get_item_text](#get_item_text)** **(** [int](class_int) idx **)** const -\\ + * [String](class_string) **get_item_text** **(** [int](class_int) idx **)** const + Return the text of the item at index "idx". #### get_item_icon - * [Texture](class_texture) **[get_item_icon](#get_item_icon)** **(** [int](class_int) idx **)** const -\\ + * [Texture](class_texture) **get_item_icon** **(** [int](class_int) idx **)** const + Return the icon of the item at index "idx". #### get_item_ID - * [int](class_int) **[get_item_ID](#get_item_ID)** **(** [int](class_int) idx **)** const -\\ + * [int](class_int) **get_item_ID** **(** [int](class_int) idx **)** const + Return the ID of the item at index "idx". #### get_item_count - * [int](class_int) **[get_item_count](#get_item_count)** **(** **)** const -\\ + * [int](class_int) **get_item_count** **(** **)** const + Return the amount of items in the OptionButton. #### add_separator - * void **[add_separator](#add_separator)** **(** **)** -\\ + * void **add_separator** **(** **)** + Add a separator to the list of items. Separators help to group items. Separator also takes up an index and is appended at the end. #### clear - * void **[clear](#clear)** **(** **)** -\\ + * void **clear** **(** **)** + Clear all the items in the [[optionbutton|OptionButton]]. #### select - * void **[select](#select)** **(** [int](class_int) arg0 **)** -\\ + * void **select** **(** [int](class_int) arg0 **)** + Select an item by index and make it the current item. #### get_selected - * [int](class_int) **[get_selected](#get_selected)** **(** **)** const -\\ + * [int](class_int) **get_selected** **(** **)** const + Return the current item index diff --git a/class_os.md b/class_os.md index 3df68ba..bfec144 100644 --- a/class_os.md +++ b/class_os.md @@ -88,157 +88,157 @@ Operating System functions. OS Wraps the most common functionality to communicat ### Member Function Description #### get_mouse_pos - * [Vector2](class_vector2) **[get_mouse_pos](#get_mouse_pos)** **(** **)** const -\\ + * [Vector2](class_vector2) **get_mouse_pos** **(** **)** const + Return the mouse pos. #### set_clipboard - * void **[set_clipboard](#set_clipboard)** **(** [String](class_string) clipboard **)** -\\ + * void **set_clipboard** **(** [String](class_string) clipboard **)** + Set clipboard to the OS. #### get_clipboard - * [String](class_string) **[get_clipboard](#get_clipboard)** **(** **)** const -\\ + * [String](class_string) **get_clipboard** **(** **)** const + Get clipboard from the host OS. #### set_video_mode - * void **[set_video_mode](#set_video_mode)** **(** [Vector2](class_vector2) size, [bool](class_bool) fullscreen, [bool](class_bool) resizable, [int](class_int) screen=0 **)** -\\ + * void **set_video_mode** **(** [Vector2](class_vector2) size, [bool](class_bool) fullscreen, [bool](class_bool) resizable, [int](class_int) screen=0 **)** + Change the video mode. #### get_video_mode_size - * [Vector2](class_vector2) **[get_video_mode_size](#get_video_mode_size)** **(** [int](class_int) screen=0 **)** const -\\ + * [Vector2](class_vector2) **get_video_mode_size** **(** [int](class_int) screen=0 **)** const + Return the current video mode size. #### is_video_mode_fullscreen - * [bool](class_bool) **[is_video_mode_fullscreen](#is_video_mode_fullscreen)** **(** [int](class_int) screen=0 **)** const -\\ + * [bool](class_bool) **is_video_mode_fullscreen** **(** [int](class_int) screen=0 **)** const + Return true if the current video mode is fullscreen. #### is_video_mode_resizable - * [bool](class_bool) **[is_video_mode_resizable](#is_video_mode_resizable)** **(** [int](class_int) screen=0 **)** const -\\ + * [bool](class_bool) **is_video_mode_resizable** **(** [int](class_int) screen=0 **)** const + Return true if the window is resizable. #### get_fullscreen_mode_list - * [Array](class_array) **[get_fullscreen_mode_list](#get_fullscreen_mode_list)** **(** [int](class_int) screen=0 **)** const -\\ + * [Array](class_array) **get_fullscreen_mode_list** **(** [int](class_int) screen=0 **)** const + Return the list of fullscreen modes. #### set_iterations_per_second - * void **[set_iterations_per_second](#set_iterations_per_second)** **(** [int](class_int) iterations_per_second **)** -\\ + * void **set_iterations_per_second** **(** [int](class_int) iterations_per_second **)** + Set the amount of fixed iterations per second (for fixed process and physics). #### get_iterations_per_second - * [int](class_int) **[get_iterations_per_second](#get_iterations_per_second)** **(** **)** const -\\ + * [int](class_int) **get_iterations_per_second** **(** **)** const + Return the amount of fixed iterations per second (for fixed process and physics). #### set_low_processor_usage_mode - * void **[set_low_processor_usage_mode](#set_low_processor_usage_mode)** **(** [bool](class_bool) enable **)** -\\ + * void **set_low_processor_usage_mode** **(** [bool](class_bool) enable **)** + 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. #### is_in_low_processor_usage_mode - * [bool](class_bool) **[is_in_low_processor_usage_mode](#is_in_low_processor_usage_mode)** **(** **)** const -\\ + * [bool](class_bool) **is_in_low_processor_usage_mode** **(** **)** const + Return true if low cpu usage mode is enabled. #### get_executable_path - * [String](class_string) **[get_executable_path](#get_executable_path)** **(** **)** const -\\ + * [String](class_string) **get_executable_path** **(** **)** const + Return the path tot he current engine executable. #### execute - * [int](class_int) **[execute](#execute)** **(** [String](class_string) path, [StringArray](class_stringarray) arguments, [bool](class_bool) blocking **)** -\\ + * [int](class_int) **execute** **(** [String](class_string) path, [StringArray](class_stringarray) arguments, [bool](class_bool) blocking **)** + Execute the binary file in given path, optionally blocking until it returns. A process ID is returned. #### kill - * [int](class_int) **[kill](#kill)** **(** [int](class_int) pid **)** -\\ + * [int](class_int) **kill** **(** [int](class_int) pid **)** + Kill a process ID. #### get_environment - * [String](class_string) **[get_environment](#get_environment)** **(** [String](class_string) environment **)** const -\\ + * [String](class_string) **get_environment** **(** [String](class_string) environment **)** const + Return an environment variable. #### has_environment - * [bool](class_bool) **[has_environment](#has_environment)** **(** [String](class_string) environment **)** const -\\ + * [bool](class_bool) **has_environment** **(** [String](class_string) environment **)** const + Return true if an envieronment variable exists. #### get_name - * [String](class_string) **[get_name](#get_name)** **(** **)** const -\\ + * [String](class_string) **get_name** **(** **)** const + Return the name of the host OS. #### get_cmdline_args - * [StringArray](class_stringarray) **[get_cmdline_args](#get_cmdline_args)** **(** **)** -\\ + * [StringArray](class_stringarray) **get_cmdline_args** **(** **)** + Return the commandline passed to the engine. #### get_main_loop - * [Object](class_object) **[get_main_loop](#get_main_loop)** **(** **)** const -\\ + * [Object](class_object) **get_main_loop** **(** **)** const + Return the main loop object (see [[mainloop|MainLoop]]). #### get_date - * [Dictionary](class_dictionary) **[get_date](#get_date)** **(** **)** const -\\ + * [Dictionary](class_dictionary) **get_date** **(** **)** const + Return the current date. #### get_time - * [Dictionary](class_dictionary) **[get_time](#get_time)** **(** **)** const -\\ + * [Dictionary](class_dictionary) **get_time** **(** **)** const + Return the current time. #### delay_usec - * void **[delay_usec](#delay_usec)** **(** [int](class_int) usec **)** const -\\ + * void **delay_usec** **(** [int](class_int) usec **)** const + Delay executing of the current thread by given usecs. #### get_ticks_msec - * [int](class_int) **[get_ticks_msec](#get_ticks_msec)** **(** **)** const -\\ + * [int](class_int) **get_ticks_msec** **(** **)** const + Return the amount of time passed in milliseconds since the engine started. #### get_locale - * [String](class_string) **[get_locale](#get_locale)** **(** **)** const -\\ + * [String](class_string) **get_locale** **(** **)** const + Return the host OS locale. #### can_draw - * [bool](class_bool) **[can_draw](#can_draw)** **(** **)** const -\\ + * [bool](class_bool) **can_draw** **(** **)** const + Return true if the host OS allows drawing. #### get_frames_drawn - * [int](class_int) **[get_frames_drawn](#get_frames_drawn)** **(** **)** -\\ + * [int](class_int) **get_frames_drawn** **(** **)** + Return the total amount of frames drawn. #### is_stdout_verbose - * [bool](class_bool) **[is_stdout_verbose](#is_stdout_verbose)** **(** **)** const -\\ + * [bool](class_bool) **is_stdout_verbose** **(** **)** const + Return true if the engine was executed with -v (verbose stdout). #### get_mouse_button_state - * [int](class_int) **[get_mouse_button_state](#get_mouse_button_state)** **(** **)** const -\\ + * [int](class_int) **get_mouse_button_state** **(** **)** const + Return the state of the mouse buttons (each button in each bit). #### get_static_memory_peak_usage - * [int](class_int) **[get_static_memory_peak_usage](#get_static_memory_peak_usage)** **(** **)** const -\\ + * [int](class_int) **get_static_memory_peak_usage** **(** **)** const + Return the max amount of static memory used (only works in debug). #### get_dynamic_memory_usage - * [int](class_int) **[get_dynamic_memory_usage](#get_dynamic_memory_usage)** **(** **)** const -\\ + * [int](class_int) **get_dynamic_memory_usage** **(** **)** const + Return the total amount of dynamic memory used (only works in debug). diff --git a/class_packedscene.md b/class_packedscene.md index d36eb97..75f7232 100644 --- a/class_packedscene.md +++ b/class_packedscene.md @@ -14,7 +14,7 @@ explain ownership, and that node does not need to own itself ### Member Function Description #### pack - * [int](class_int) **[pack](#pack)** **(** [Node](class_node) path **)** -\\ + * [int](class_int) **pack** **(** [Node](class_node) path **)** + Pack will ignore any sub-nodes not owned by given node. See [Node.set_owner]. diff --git a/class_packetpeerstream.md b/class_packetpeerstream.md index 414fc59..3837edf 100644 --- a/class_packetpeerstream.md +++ b/class_packetpeerstream.md @@ -12,6 +12,6 @@ PacketStreamPeer provides a wrapper for working using packets over a stream. Thi ### Member Function Description #### set_stream_peer - * void **[set_stream_peer](#set_stream_peer)** **(** [StreamPeer](class_streampeer) peer **)** -\\ + * void **set_stream_peer** **(** [StreamPeer](class_streampeer) peer **)** + Set the StreamPeer object to be wrapped diff --git a/class_particles.md b/class_particles.md index e4dc23c..670eb1a 100644 --- a/class_particles.md +++ b/class_particles.md @@ -59,101 +59,101 @@ Particles is a particle system 3D [[node|Node]] that is used to simulate several ### Member Function Description #### set_amount - * void **[set_amount](#set_amount)** **(** [int](class_int) amount **)** -\\ + * void **set_amount** **(** [int](class_int) amount **)** + Set total amount of particles in the system. #### get_amount - * [int](class_int) **[get_amount](#get_amount)** **(** **)** const -\\ + * [int](class_int) **get_amount** **(** **)** const + Return the total amount of particles in the system. #### set_emitting - * void **[set_emitting](#set_emitting)** **(** [bool](class_bool) enabled **)** -\\ + * void **set_emitting** **(** [bool](class_bool) enabled **)** + Set the "emitting" property state. When emitting, the particle system generates new particles at constant rate. #### is_emitting - * [bool](class_bool) **[is_emitting](#is_emitting)** **(** **)** const -\\ + * [bool](class_bool) **is_emitting** **(** **)** const + Return the "emitting" property state (see [[#set_emitting|set_emitting]]). #### set_visibility_aabb - * void **[set_visibility_aabb](#set_visibility_aabb)** **(** [AABB](class_aabb) aabb **)** -\\ + * void **set_visibility_aabb** **(** [AABB](class_aabb) aabb **)** + Set the visibility AABB for the particle system, since the default one will not work properly most of the time. #### get_visibility_aabb - * [AABB](class_aabb) **[get_visibility_aabb](#get_visibility_aabb)** **(** **)** const -\\ + * [AABB](class_aabb) **get_visibility_aabb** **(** **)** const + Return the current visibility AABB. #### set_emission_half_extents - * void **[set_emission_half_extents](#set_emission_half_extents)** **(** [Vector3](class_vector3) half_extents **)** -\\ + * void **set_emission_half_extents** **(** [Vector3](class_vector3) half_extents **)** + Set the half extents for the emission box. #### get_emission_half_extents - * [Vector3](class_vector3) **[get_emission_half_extents](#get_emission_half_extents)** **(** **)** const -\\ + * [Vector3](class_vector3) **get_emission_half_extents** **(** **)** const + Return the half extents for the emission box. #### set_gravity_normal - * void **[set_gravity_normal](#set_gravity_normal)** **(** [Vector3](class_vector3) normal **)** -\\ + * void **set_gravity_normal** **(** [Vector3](class_vector3) normal **)** + Set the normal vector towards where gravity is pulling (by default, negative Y). #### get_gravity_normal - * [Vector3](class_vector3) **[get_gravity_normal](#get_gravity_normal)** **(** **)** const -\\ + * [Vector3](class_vector3) **get_gravity_normal** **(** **)** const + Return the normal vector towards where gravity is pulling (by default, negative Y). #### set_variable - * void **[set_variable](#set_variable)** **(** [int](class_int) variable, [real](class_real) value **)** -\\ + * void **set_variable** **(** [int](class_int) variable, [real](class_real) value **)** + Set a specific variable for the particle system (see VAR_* enum). #### get_variable - * [real](class_real) **[get_variable](#get_variable)** **(** [int](class_int) variable **)** const -\\ + * [real](class_real) **get_variable** **(** [int](class_int) variable **)** const + Return a specific variable for the particle system (see VAR_* enum). #### set_randomness - * void **[set_randomness](#set_randomness)** **(** [int](class_int) variable, [real](class_real) randomness **)** -\\ + * void **set_randomness** **(** [int](class_int) variable, [real](class_real) randomness **)** + Set the randomness for a specific variable of the particle system. Randomness produces small changes from the default each time a particle is emitted. #### get_randomness - * [real](class_real) **[get_randomness](#get_randomness)** **(** [int](class_int) arg0 **)** const -\\ + * [real](class_real) **get_randomness** **(** [int](class_int) arg0 **)** const + Return the randomness for a specific variable of the particle system. Randomness produces small changes from the default each time a particle is emitted. #### set_color_phase_pos - * void **[set_color_phase_pos](#set_color_phase_pos)** **(** [int](class_int) phase, [real](class_real) pos **)** -\\ + * void **set_color_phase_pos** **(** [int](class_int) phase, [real](class_real) pos **)** + Set the position of a color phase (0 to 1) #### get_color_phase_pos - * [real](class_real) **[get_color_phase_pos](#get_color_phase_pos)** **(** [int](class_int) phase **)** const -\\ + * [real](class_real) **get_color_phase_pos** **(** [int](class_int) phase **)** const + Return the position of a color phase (0 to 1) #### set_color_phase_color - * void **[set_color_phase_color](#set_color_phase_color)** **(** [int](class_int) phase, [Color](class_color) color **)** -\\ + * void **set_color_phase_color** **(** [int](class_int) phase, [Color](class_color) color **)** + Set the color of a color phase. #### get_color_phase_color - * [Color](class_color) **[get_color_phase_color](#get_color_phase_color)** **(** [int](class_int) phase **)** const -\\ + * [Color](class_color) **get_color_phase_color** **(** [int](class_int) phase **)** const + Return the color of a color phase. #### set_material - * void **[set_material](#set_material)** **(** [Material](class_material) material **)** -\\ + * void **set_material** **(** [Material](class_material) material **)** + Set the material used to draw particles #### get_material - * [Material](class_material) **[get_material](#get_material)** **(** **)** const -\\ + * [Material](class_material) **get_material** **(** **)** const + Return the material used to draw particles diff --git a/class_pathremap.md b/class_pathremap.md index 69c41a4..21c1da9 100644 --- a/class_pathremap.md +++ b/class_pathremap.md @@ -16,26 +16,26 @@ When exporting, the types of some resources may change internally so they are co ### Member Function Description #### add_remap - * void **[add_remap](#add_remap)** **(** [String](class_string) from, [String](class_string) to, [String](class_string) locale="" **)** -\\ + * void **add_remap** **(** [String](class_string) from, [String](class_string) to, [String](class_string) locale="" **)** + Add a remap from a file to another. #### has_remap - * [bool](class_bool) **[has_remap](#has_remap)** **(** [String](class_string) path **)** const -\\ + * [bool](class_bool) **has_remap** **(** [String](class_string) path **)** const + Return true if a file is being remapped. #### get_remap - * [String](class_string) **[get_remap](#get_remap)** **(** [String](class_string) path **)** const -\\ + * [String](class_string) **get_remap** **(** [String](class_string) path **)** const + Return the remapped new path of a file. #### erase_remap - * void **[erase_remap](#erase_remap)** **(** [String](class_string) path **)** -\\ + * void **erase_remap** **(** [String](class_string) path **)** + Erase a remap. #### clear_remaps - * void **[clear_remaps](#clear_remaps)** **(** **)** -\\ + * void **clear_remaps** **(** **)** + Clear all remaps. diff --git a/class_physics2ddirectbodystate.md b/class_physics2ddirectbodystate.md index 0428d6d..c405984 100644 --- a/class_physics2ddirectbodystate.md +++ b/class_physics2ddirectbodystate.md @@ -36,121 +36,121 @@ Direct access object to a physics body in the [[physics2dserver|Physics2DServer] ### Member Function Description #### get_total_gravity - * [Vector2](class_vector2) **[get_total_gravity](#get_total_gravity)** **(** **)** const -\\ + * [Vector2](class_vector2) **get_total_gravity** **(** **)** const + Return the total gravity vector being currently applied to this body. #### get_total_density - * [real](class_real) **[get_total_density](#get_total_density)** **(** **)** const -\\ + * [real](class_real) **get_total_density** **(** **)** const + Return the space density currently being applied to this body. #### get_inverse_mass - * [real](class_real) **[get_inverse_mass](#get_inverse_mass)** **(** **)** const -\\ + * [real](class_real) **get_inverse_mass** **(** **)** const + Return the inverse of the mass of the body. #### get_inverse_inertia - * [real](class_real) **[get_inverse_inertia](#get_inverse_inertia)** **(** **)** const -\\ + * [real](class_real) **get_inverse_inertia** **(** **)** const + Return the inverse of the inertia of the body. #### set_linear_velocity - * void **[set_linear_velocity](#set_linear_velocity)** **(** [Vector2](class_vector2) velocity **)** -\\ + * void **set_linear_velocity** **(** [Vector2](class_vector2) velocity **)** + Change the linear velocity of the body. #### get_linear_velocity - * [Vector2](class_vector2) **[get_linear_velocity](#get_linear_velocity)** **(** **)** const -\\ + * [Vector2](class_vector2) **get_linear_velocity** **(** **)** const + Return the current linear velocity of the body. #### set_angular_velocity - * void **[set_angular_velocity](#set_angular_velocity)** **(** [real](class_real) velocity **)** -\\ + * void **set_angular_velocity** **(** [real](class_real) velocity **)** + Change the angular velocity of the body. #### get_angular_velocity - * [real](class_real) **[get_angular_velocity](#get_angular_velocity)** **(** **)** const -\\ + * [real](class_real) **get_angular_velocity** **(** **)** const + Return the angular velocity of the body. #### set_transform - * void **[set_transform](#set_transform)** **(** [Matrix32](class_matrix32) transform **)** -\\ + * void **set_transform** **(** [Matrix32](class_matrix32) transform **)** + Change the transform matrix of the body. #### get_transform - * [Matrix32](class_matrix32) **[get_transform](#get_transform)** **(** **)** const -\\ + * [Matrix32](class_matrix32) **get_transform** **(** **)** const + Return the transform matrix of the body. #### set_sleep_state - * void **[set_sleep_state](#set_sleep_state)** **(** [bool](class_bool) enabled **)** -\\ + * void **set_sleep_state** **(** [bool](class_bool) enabled **)** + Set the sleeping state of the body, only affects character/rigid bodies. #### is_sleeping - * [bool](class_bool) **[is_sleeping](#is_sleeping)** **(** **)** const -\\ + * [bool](class_bool) **is_sleeping** **(** **)** const + Return true if this body is currently sleeping (not active). #### get_contact_count - * [int](class_int) **[get_contact_count](#get_contact_count)** **(** **)** const -\\ + * [int](class_int) **get_contact_count** **(** **)** const + Return the amount of contacts this body has with other bodies. Note that by default this returns 0 unless bodies are configured to log contacts. #### get_contact_local_pos - * [Vector2](class_vector2) **[get_contact_local_pos](#get_contact_local_pos)** **(** [int](class_int) contact_idx **)** const -\\ + * [Vector2](class_vector2) **get_contact_local_pos** **(** [int](class_int) contact_idx **)** const + Return the local position (of this body) of the contact point. #### get_contact_local_shape - * [int](class_int) **[get_contact_local_shape](#get_contact_local_shape)** **(** [int](class_int) contact_idx **)** const -\\ + * [int](class_int) **get_contact_local_shape** **(** [int](class_int) contact_idx **)** const + Return the local shape index of the collision. #### get_contact_collider - * [RID](class_rid) **[get_contact_collider](#get_contact_collider)** **(** [int](class_int) contact_idx **)** const -\\ + * [RID](class_rid) **get_contact_collider** **(** [int](class_int) contact_idx **)** const + Return the RID of the collider. #### get_contact_collider_pos - * [Vector2](class_vector2) **[get_contact_collider_pos](#get_contact_collider_pos)** **(** [int](class_int) contact_idx **)** const -\\ + * [Vector2](class_vector2) **get_contact_collider_pos** **(** [int](class_int) contact_idx **)** const + Return the contact position in the collider. #### get_contact_collider_id - * [int](class_int) **[get_contact_collider_id](#get_contact_collider_id)** **(** [int](class_int) contact_idx **)** const -\\ + * [int](class_int) **get_contact_collider_id** **(** [int](class_int) contact_idx **)** const + Return the object id of the collider. #### get_contact_collider_object - * [Object](class_object) **[get_contact_collider_object](#get_contact_collider_object)** **(** [int](class_int) contact_idx **)** const -\\ + * [Object](class_object) **get_contact_collider_object** **(** [int](class_int) contact_idx **)** const + Return the collider object, this depends on how it was created (will return a scene node if such was used to create it). #### get_contact_collider_shape - * [int](class_int) **[get_contact_collider_shape](#get_contact_collider_shape)** **(** [int](class_int) contact_idx **)** const -\\ + * [int](class_int) **get_contact_collider_shape** **(** [int](class_int) contact_idx **)** const + Return the collider shape index. #### get_contact_collider_velocity_at_pos - * [Vector2](class_vector2) **[get_contact_collider_velocity_at_pos](#get_contact_collider_velocity_at_pos)** **(** [int](class_int) contact_idx **)** const -\\ + * [Vector2](class_vector2) **get_contact_collider_velocity_at_pos** **(** [int](class_int) contact_idx **)** const + Return the linear velocity vector at contact point of the collider. #### get_step - * [real](class_real) **[get_step](#get_step)** **(** **)** const -\\ + * [real](class_real) **get_step** **(** **)** const + Return the timestep (delta) used for the simulation. #### integrate_forces - * void **[integrate_forces](#integrate_forces)** **(** **)** -\\ + * void **integrate_forces** **(** **)** + Call the built-in force integration code. #### get_space_state - * [Physics2DDirectSpaceState](class_physics2ddirectspacestate) **[get_space_state](#get_space_state)** **(** **)** -\\ + * [Physics2DDirectSpaceState](class_physics2ddirectspacestate) **get_space_state** **(** **)** + Return the current state of space, useful for queries. diff --git a/class_physics2ddirectspacestate.md b/class_physics2ddirectspacestate.md index 1e86c0e..6284340 100644 --- a/class_physics2ddirectspacestate.md +++ b/class_physics2ddirectspacestate.md @@ -13,8 +13,8 @@ Direct access object to a space in the [[physics2dserver|Physics2DServer]]. It's ### Member Function Description #### intersect_ray - * void **[intersect_ray](#intersect_ray)** **(** [Vector2](class_vector2) from, [Vector2](class_vector2) to, [Array](class_array) exclude=Array(), [int](class_int) umask=0 **)** -\\ + * void **intersect_ray** **(** [Vector2](class_vector2) from, [Vector2](class_vector2) to, [Array](class_array) exclude=Array(), [int](class_int) umask=0 **)** + Intersect a ray in a given space, the returned object is a dictionary with the following fields: \\ position: place where ray is stopped\\ @@ -34,6 +34,6 @@ Intersect a ray in a given space, the returned object is a dictionary with the f If the ray did not intersect anything, then null is returned instead of a [[dictionary|Dictionary]]. #### intersect_shape - * void **[intersect_shape](#intersect_shape)** **(** [RID](class_rid) shape, [Matrix32](class_matrix32) xform, [int](class_int) result_max, [Array](class_array) exclude=Array(), [int](class_int) umask=0 **)** -\\ + * void **intersect_shape** **(** [RID](class_rid) shape, [Matrix32](class_matrix32) xform, [int](class_int) result_max, [Array](class_array) exclude=Array(), [int](class_int) umask=0 **)** + Intersect a given shape (RID or [[shape2d|Shape2D]]) against the space, the intersected shapes are returned in a special result object. diff --git a/class_plane.md b/class_plane.md index 1259b95..f432107 100644 --- a/class_plane.md +++ b/class_plane.md @@ -31,36 +31,36 @@ Plane represents a normalized plane equation. Basically, "normal" is the normal ### Member Function Description #### has_point - * [bool](class_bool) **[has_point](#has_point)** **(** [Vector3](class_vector3) point, [real](class_real) epsilon=0.00001 **)** -\\ + * [bool](class_bool) **has_point** **(** [Vector3](class_vector3) point, [real](class_real) epsilon=0.00001 **)** + Returns true if "p" is inside the plane (by a very minimum treshold). #### intersect_3 - * [Vector3](class_vector3) **[intersect_3](#intersect_3)** **(** [Plane](class_plane) b, [Plane](class_plane) c **)** -\\ + * [Vector3](class_vector3) **intersect_3** **(** [Plane](class_plane) b, [Plane](class_plane) c **)** + Returns true if this plane intersects with planes "a" and "b". The resulting intersectin is placed in "r". #### intersects_ray - * [Vector3](class_vector3) **[intersects_ray](#intersects_ray)** **(** [Vector3](class_vector3) from, [Vector3](class_vector3) dir **)** -\\ + * [Vector3](class_vector3) **intersects_ray** **(** [Vector3](class_vector3) from, [Vector3](class_vector3) dir **)** + Returns true if ray consiting of position "p" and direction normal "d" intersects this plane. If true, the result is placed in "r". #### intersects_segment - * [Vector3](class_vector3) **[intersects_segment](#intersects_segment)** **(** [Vector3](class_vector3) begin, [Vector3](class_vector3) end **)** -\\ + * [Vector3](class_vector3) **intersects_segment** **(** [Vector3](class_vector3) begin, [Vector3](class_vector3) end **)** + Returns true if segment from position "sa" to position "sb" intersects this plane. If true, the result is placed in "r". #### is_point_over - * [bool](class_bool) **[is_point_over](#is_point_over)** **(** [Vector3](class_vector3) point **)** -\\ + * [bool](class_bool) **is_point_over** **(** [Vector3](class_vector3) point **)** + Returns true if "p" is located above the plane. #### normalized - * [Plane](class_plane) **[normalized](#normalized)** **(** **)** -\\ + * [Plane](class_plane) **normalized** **(** **)** + Returns a copy of the plane, normalized. #### project - * [Vector3](class_vector3) **[project](#project)** **(** [Vector3](class_vector3) point **)** -\\ + * [Vector3](class_vector3) **project** **(** [Vector3](class_vector3) point **)** + Returns the orthogonal projection of point "p" into a point in the plane. diff --git a/class_popup.md b/class_popup.md index d821717..b746237 100644 --- a/class_popup.md +++ b/class_popup.md @@ -23,16 +23,16 @@ PopUp is a base [[control|Control]] used to show dialogs and popups. It's a subw ### Member Function Description #### popup_centered - * void **[popup_centered](#popup_centered)** **(** [Vector2](class_vector2) size=Vector2(0,0) **)** -\\ + * void **popup_centered** **(** [Vector2](class_vector2) size=Vector2(0,0) **)** + Popup (show the control in modal form) in the center of the screen, at the curent size, or at a size determined by "size". #### popup_centered_ratio - * void **[popup_centered_ratio](#popup_centered_ratio)** **(** [real](class_real) ratio=0.75 **)** -\\ + * void **popup_centered_ratio** **(** [real](class_real) ratio=0.75 **)** + Popup (show the control in modal form) in the center of the screen, scalled at a ratio of size of the screen. #### popup - * void **[popup](#popup)** **(** **)** -\\ + * void **popup** **(** **)** + Popup (show the control in modal form). diff --git a/class_popupmenu.md b/class_popupmenu.md index 56e38cc..7fb6f93 100644 --- a/class_popupmenu.md +++ b/class_popupmenu.md @@ -44,91 +44,91 @@ PopupMenu is the typical Control that displays a list of options. They are popul ### Member Function Description #### add_icon_item - * void **[add_icon_item](#add_icon_item)** **(** [Object](class_object) texture, [String](class_string) label, [int](class_int) id=-1, [int](class_int) accel=0 **)** -\\ + * void **add_icon_item** **(** [Object](class_object) texture, [String](class_string) label, [int](class_int) id=-1, [int](class_int) accel=0 **)** + Add a new item with text "label" and icon "texture. An id can optonally be provided, as well as an accelerator. If no id is provided, one will be created from the index. #### add_item - * void **[add_item](#add_item)** **(** [String](class_string) label, [int](class_int) id=-1, [int](class_int) accel=0 **)** -\\ + * void **add_item** **(** [String](class_string) label, [int](class_int) id=-1, [int](class_int) accel=0 **)** + Add a new item with text "label". An id can optonally be provided, as well as an accelerator. If no id is provided, one will be created from the index. #### add_icon_check_item - * void **[add_icon_check_item](#add_icon_check_item)** **(** [Object](class_object) texture, [String](class_string) label, [int](class_int) id=-1, [int](class_int) accel=0 **)** -\\ + * void **add_icon_check_item** **(** [Object](class_object) texture, [String](class_string) label, [int](class_int) id=-1, [int](class_int) accel=0 **)** + Add a new checkable item with text "label" and icon "texture. An id can optonally 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"apos;t have any built-in checking behavior and must be checked/unchecked manually. #### add_check_item - * void **[add_check_item](#add_check_item)** **(** [String](class_string) label, [int](class_int) id=-1, [int](class_int) accel=0 **)** -\\ + * void **add_check_item** **(** [String](class_string) label, [int](class_int) id=-1, [int](class_int) accel=0 **)** + Add a new checkable item with text "label". An id can optonally 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"apos;t have any built-in checking behavior and must be checked/unchecked manually. #### set_item_text - * void **[set_item_text](#set_item_text)** **(** [int](class_int) idx, [String](class_string) text **)** -\\ + * void **set_item_text** **(** [int](class_int) idx, [String](class_string) text **)** + Set the text of the item at index "idx". #### set_item_icon - * void **[set_item_icon](#set_item_icon)** **(** [int](class_int) idx, [Object](class_object) icon **)** -\\ + * void **set_item_icon** **(** [int](class_int) idx, [Object](class_object) icon **)** + Set the icon of the item at index "idx". #### set_item_accelerator - * void **[set_item_accelerator](#set_item_accelerator)** **(** [int](class_int) idx, [int](class_int) accel **)** -\\ + * void **set_item_accelerator** **(** [int](class_int) idx, [int](class_int) accel **)** + Set the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is fucused. #### set_item_checked - * void **[set_item_checked](#set_item_checked)** **(** [int](class_int) idx, [bool](class_bool) arg1 **)** -\\ + * void **set_item_checked** **(** [int](class_int) idx, [bool](class_bool) arg1 **)** + Set the checkstate status of the item at index "idx". #### set_item_ID - * void **[set_item_ID](#set_item_ID)** **(** [int](class_int) idx, [int](class_int) id **)** -\\ + * void **set_item_ID** **(** [int](class_int) idx, [int](class_int) id **)** + Set the id of the item at index "idx". #### get_item_text - * [String](class_string) **[get_item_text](#get_item_text)** **(** [int](class_int) idx **)** const -\\ + * [String](class_string) **get_item_text** **(** [int](class_int) idx **)** const + Return the text of the item at index "idx". #### get_item_icon - * [Object](class_object) **[get_item_icon](#get_item_icon)** **(** [int](class_int) idx **)** const -\\ + * [Object](class_object) **get_item_icon** **(** [int](class_int) idx **)** const + Return the icon of the item at index "idx". #### get_item_accelerator - * [int](class_int) **[get_item_accelerator](#get_item_accelerator)** **(** [int](class_int) idx **)** const -\\ + * [int](class_int) **get_item_accelerator** **(** [int](class_int) idx **)** const + Return the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is fucused. #### is_item_checked - * [bool](class_bool) **[is_item_checked](#is_item_checked)** **(** [int](class_int) idx **)** const -\\ + * [bool](class_bool) **is_item_checked** **(** [int](class_int) idx **)** const + Return the checkstate status of the item at index "idx". #### get_item_ID - * [int](class_int) **[get_item_ID](#get_item_ID)** **(** [int](class_int) idx **)** const -\\ + * [int](class_int) **get_item_ID** **(** [int](class_int) idx **)** const + Return the id of the item at index "idx". #### get_item_index - * [int](class_int) **[get_item_index](#get_item_index)** **(** [int](class_int) id **)** const -\\ + * [int](class_int) **get_item_index** **(** [int](class_int) id **)** const + Find and return the index of the item containing a given id. #### get_item_count - * [int](class_int) **[get_item_count](#get_item_count)** **(** **)** const -\\ + * [int](class_int) **get_item_count** **(** **)** const + Return the amount of items. #### add_separator - * void **[add_separator](#add_separator)** **(** **)** -\\ + * void **add_separator** **(** **)** + Add a separator between items. Separators also occupy an index. #### clear - * void **[clear](#clear)** **(** **)** -\\ + * void **clear** **(** **)** + Clear the popup menu. diff --git a/class_portal.md b/class_portal.md index 5d843d7..e84accf 100644 --- a/class_portal.md +++ b/class_portal.md @@ -22,51 +22,51 @@ Portals provide virtual openings to [RoomInstance] nodes, so cameras can look at ### Member Function Description #### set_shape - * void **[set_shape](#set_shape)** **(** [Vector2Array](class_vector2array) points **)** -\\ + * void **set_shape** **(** [Vector2Array](class_vector2array) points **)** + Set the portal shape. The shape is an array of [Point2] points, representing a convex polygon in the X,Y plane. #### get_shape - * [Vector2Array](class_vector2array) **[get_shape](#get_shape)** **(** **)** const -\\ + * [Vector2Array](class_vector2array) **get_shape** **(** **)** const + Return the portal shape. The shape is an array of [Point2] points, representing a convex polygon in the X,Y plane. #### set_enabled - * void **[set_enabled](#set_enabled)** **(** [bool](class_bool) enable **)** -\\ + * void **set_enabled** **(** [bool](class_bool) enable **)** + Enable the portal (it is enabled by defaul though), disabling it will cause the parent [RoomInstance] to not be visible any longer when looking through the portal. #### is_enabled - * [bool](class_bool) **[is_enabled](#is_enabled)** **(** **)** const -\\ + * [bool](class_bool) **is_enabled** **(** **)** const + Return wether the portal is active. When disabled it causes the parent [RoomInstance] to not be visible any longer when looking through the portal. #### set_disable_distance - * void **[set_disable_distance](#set_disable_distance)** **(** [real](class_real) distance **)** -\\ + * void **set_disable_distance** **(** [real](class_real) distance **)** + Set the distance threshold for disabling the portal. Every time that the portal goes beyond "distance", it disables itself, becoming the opaque color (see [[#set_disabled_color|set_disabled_color]]). #### get_disable_distance - * [real](class_real) **[get_disable_distance](#get_disable_distance)** **(** **)** const -\\ + * [real](class_real) **get_disable_distance** **(** **)** const + Return the distance threshold for disabling the portal. Every time that the portal goes beyond "distance", it disables itself, becoming the opaque color (see [[#set_disabled_color|set_disabled_color]]). #### set_disabled_color - * void **[set_disabled_color](#set_disabled_color)** **(** [Color](class_color) color **)** -\\ + * void **set_disabled_color** **(** [Color](class_color) color **)** + When the portal goes beyond the disable distance (see [[#set_disable_distance|set_disable_distance]]), it becomes opaque and displayed with color "color". #### get_disabled_color - * [Color](class_color) **[get_disabled_color](#get_disabled_color)** **(** **)** const -\\ + * [Color](class_color) **get_disabled_color** **(** **)** const + Return the color for when the portal goes beyond the disable distance (see [[#set_disable_distance|set_disable_distance]]) and becomes disabled. #### set_connect_range - * void **[set_connect_range](#set_connect_range)** **(** [real](class_real) range **)** -\\ + * void **set_connect_range** **(** [real](class_real) range **)** + Set the range for auto-connecting two portals from different rooms sharing the same space. #### get_connect_range - * [real](class_real) **[get_connect_range](#get_connect_range)** **(** **)** const -\\ + * [real](class_real) **get_connect_range** **(** **)** const + Return the range for auto-connecting two portals from different rooms sharing the same space. diff --git a/class_quat.md b/class_quat.md index 8f3bd1b..c9eb13e 100644 --- a/class_quat.md +++ b/class_quat.md @@ -27,31 +27,31 @@ Quaternion is a 4 dimensional vector that is used to represet a rotation. It mai ### Member Function Description #### dot - * [real](class_real) **[dot](#dot)** **(** [Quat](class_quat) b **)** -\\ + * [real](class_real) **dot** **(** [Quat](class_quat) b **)** + Returns the dot product between two quaternions. #### inverse - * [Quat](class_quat) **[inverse](#inverse)** **(** **)** -\\ + * [Quat](class_quat) **inverse** **(** **)** + Returns the inverse of the quaternion (applies to the inverse rotatio too). #### length - * [real](class_real) **[length](#length)** **(** **)** -\\ + * [real](class_real) **length** **(** **)** + Returns the length of the quaternion. #### length_squared - * [real](class_real) **[length_squared](#length_squared)** **(** **)** -\\ + * [real](class_real) **length_squared** **(** **)** + Returns the length of the quaternion, minus the square root. #### normalized - * [Quat](class_quat) **[normalized](#normalized)** **(** **)** -\\ + * [Quat](class_quat) **normalized** **(** **)** + Returns a copy of the quaternion, normalized to unit length. #### slerp - * [Quat](class_quat) **[slerp](#slerp)** **(** [Quat](class_quat) b, [real](class_real) t **)** -\\ + * [Quat](class_quat) **slerp** **(** [Quat](class_quat) b, [real](class_real) t **)** + Perform a spherical-linear interpolation with another quaternion. diff --git a/class_range.md b/class_range.md index 98600a6..8b97b2f 100644 --- a/class_range.md +++ b/class_range.md @@ -35,51 +35,51 @@ Range is a base class for [[control|Control]] nodes that change a floating point ### Member Function Description #### get_val - * [real](class_real) **[get_val](#get_val)** **(** **)** const -\\ + * [real](class_real) **get_val** **(** **)** const + Return the current value. #### get_min - * [real](class_real) **[get_min](#get_min)** **(** **)** const -\\ + * [real](class_real) **get_min** **(** **)** const + Return the minimum value. #### get_max - * [real](class_real) **[get_max](#get_max)** **(** **)** const -\\ + * [real](class_real) **get_max** **(** **)** const + Return the maximum value. #### get_step - * [real](class_real) **[get_step](#get_step)** **(** **)** const -\\ + * [real](class_real) **get_step** **(** **)** const + Return the stepping, if step is 0, stepping is disabled. #### get_page - * [real](class_real) **[get_page](#get_page)** **(** **)** const -\\ + * [real](class_real) **get_page** **(** **)** const + Return the page size, if page is 0, paging is disabled. #### get_unit_value - * [real](class_real) **[get_unit_value](#get_unit_value)** **(** **)** const -\\ + * [real](class_real) **get_unit_value** **(** **)** const + Return value mapped to 0 to 1 (unit) range. #### set_min - * void **[set_min](#set_min)** **(** [real](class_real) minimum **)** -\\ + * void **set_min** **(** [real](class_real) minimum **)** + Set minimum value, clamped range value to it if it"apos;s less. #### set_step - * void **[set_step](#set_step)** **(** [real](class_real) step **)** -\\ + * void **set_step** **(** [real](class_real) step **)** + Set step value. If step is 0, stepping will be disabled. #### set_page - * void **[set_page](#set_page)** **(** [real](class_real) pagesize **)** -\\ + * void **set_page** **(** [real](class_real) pagesize **)** + Set page size. Page is mainly used for scrollbars or anything that controls text scrolling. #### set_unit_value - * void **[set_unit_value](#set_unit_value)** **(** [real](class_real) value **)** -\\ + * void **set_unit_value** **(** [real](class_real) value **)** + Set value mapped to 0 to 1 (unit) range, it will then be converted to the actual value within min and max. diff --git a/class_rectangleshape2d.md b/class_rectangleshape2d.md index bb87dc8..bcef5a2 100644 --- a/class_rectangleshape2d.md +++ b/class_rectangleshape2d.md @@ -13,11 +13,11 @@ Rectangle Shape for 2D Physics. This shape is useful for modelling box-like 2D o ### Member Function Description #### set_extents - * void **[set_extents](#set_extents)** **(** [Vector2](class_vector2) extents **)** -\\ + * void **set_extents** **(** [Vector2](class_vector2) extents **)** + Set the half extents, the actual width and height of this shape is twice the half extents. #### get_extents - * [Vector2](class_vector2) **[get_extents](#get_extents)** **(** **)** const -\\ + * [Vector2](class_vector2) **get_extents** **(** **)** const + Return the half extents, the actual width and height of this shape is twice the half extents. diff --git a/class_reference.md b/class_reference.md index da309ad..6a2ff32 100644 --- a/class_reference.md +++ b/class_reference.md @@ -14,11 +14,11 @@ Base class for anything refcounted. Resource and many other helper objects inher ### Member Function Description #### reference - * void **[reference](#reference)** **(** **)** -\\ + * void **reference** **(** **)** + Increase the internal reference counter. Use this only if you really know what you are doing. #### unreference - * [bool](class_bool) **[unreference](#unreference)** **(** **)** -\\ + * [bool](class_bool) **unreference** **(** **)** + Decrease the internal reference counter. Use this only if you really know what you are doing. diff --git a/class_resource.md b/class_resource.md index a3bb725..37ba2ea 100644 --- a/class_resource.md +++ b/class_resource.md @@ -22,26 +22,26 @@ Resource is the base class for all resource types. Resources are primarily data ### Member Function Description #### set_path - * void **[set_path](#set_path)** **(** [String](class_string) path **)** -\\ + * void **set_path** **(** [String](class_string) path **)** + Set the path of the resource. This is useful mainly for editors when saving/loading, and shouldn"apos;t be changed by anything else. #### get_path - * [String](class_string) **[get_path](#get_path)** **(** **)** const -\\ + * [String](class_string) **get_path** **(** **)** const + Return the path of the resource. This is useful mainly for editors when saving/loading, and shouldn"apos;t be changed by anything else. #### set_name - * void **[set_name](#set_name)** **(** [String](class_string) name **)** -\\ + * void **set_name** **(** [String](class_string) name **)** + Set the name of the resources, any name is ok (it doesn"apos;t have to be unique). Name is for descriptive purposes only. #### get_name - * [String](class_string) **[get_name](#get_name)** **(** **)** const -\\ + * [String](class_string) **get_name** **(** **)** const + Return the name of the resources, any name is ok (it doesn"apos;t have to be unique). Name is for descriptive purposes only. #### get_rid - * [RID](class_rid) **[get_rid](#get_rid)** **(** **)** const -\\ + * [RID](class_rid) **get_rid** **(** **)** const + Return the RID of the resource (or an empty RID). Many resources (such as [[texture|Texture]], [[mesh|Mesh]], etc) are high level abstractions of resources stored in a server, so this function will return the original RID. diff --git a/class_resourceinteractiveloader.md b/class_resourceinteractiveloader.md index 888a8ce..230eee1 100644 --- a/class_resourceinteractiveloader.md +++ b/class_resourceinteractiveloader.md @@ -16,21 +16,21 @@ Interactive Resource Loader. This object is returned by ResourceLoader when perf ### Member Function Description #### get_resource - * [Object](class_object) **[get_resource](#get_resource)** **(** **)** -\\ + * [Object](class_object) **get_resource** **(** **)** + Return the loaded resource (only if loaded). Otherwise, returns null. #### poll - * [int](class_int) **[poll](#poll)** **(** **)** -\\ + * [int](class_int) **poll** **(** **)** + Poll the load. If OK is returned, this means poll will have to be called again. If ERR_EOF is returned, them the load has finished and the resource can be obtained by calling [get_resource]. #### get_stage - * [int](class_int) **[get_stage](#get_stage)** **(** **)** const -\\ + * [int](class_int) **get_stage** **(** **)** const + Return the load stage. The total amount of stages can be queried with [get_stage_count] #### get_stage_count - * [int](class_int) **[get_stage_count](#get_stage_count)** **(** **)** const -\\ + * [int](class_int) **get_stage_count** **(** **)** const + Return the total amount of stages (calls to [poll] ) needed to completely load this resource. diff --git a/class_resourceloader.md b/class_resourceloader.md index e649a12..2b00b74 100644 --- a/class_resourceloader.md +++ b/class_resourceloader.md @@ -17,21 +17,21 @@ Resource Loader. This is a static object accessible as [[resourceloader|Resource ### Member Function Description #### load_interactive - * [ResourceInteractiveLoader](class_resourceinteractiveloader) **[load_interactive](#load_interactive)** **(** [String](class_string) path, [String](class_string) type_hint="" **)** -\\ + * [ResourceInteractiveLoader](class_resourceinteractiveloader) **load_interactive** **(** [String](class_string) path, [String](class_string) type_hint="" **)** + Load a resource interactively, the returned object allows to load with high granularity. #### load - * [Resource](class_resource) **[load](#load)** **(** [String](class_string) path, [String](class_string) type_hint="" **)** -\\ + * [Resource](class_resource) **load** **(** [String](class_string) path, [String](class_string) type_hint="" **)** + Load a resource. Optionally a hint can be given for the resource type to load. #### get_recognized_extensions_for_type - * [StringArray](class_stringarray) **[get_recognized_extensions_for_type](#get_recognized_extensions_for_type)** **(** [String](class_string) type **)** -\\ + * [StringArray](class_stringarray) **get_recognized_extensions_for_type** **(** [String](class_string) type **)** + Return the list of recognized extensions for a resource type. #### set_abort_on_missing_resources - * void **[set_abort_on_missing_resources](#set_abort_on_missing_resources)** **(** [bool](class_bool) abort **)** -\\ + * void **set_abort_on_missing_resources** **(** [bool](class_bool) abort **)** + Change the behavior on missing sub-resources. Default is to abort load. diff --git a/class_resourcepreloader.md b/class_resourcepreloader.md index bd210f3..c0b3572 100644 --- a/class_resourcepreloader.md +++ b/class_resourcepreloader.md @@ -17,31 +17,31 @@ Resource Preloader Node. This node is used to preload sub-resources inside a sce ### Member Function Description #### add_resource - * void **[add_resource](#add_resource)** **(** [String](class_string) name, [Object](class_object) resource **)** -\\ + * void **add_resource** **(** [String](class_string) name, [Object](class_object) resource **)** + Add a resource to the preloader. Set the text-id that will be used to identify it (retrieve it/erase it/etc). #### remove_resource - * void **[remove_resource](#remove_resource)** **(** [String](class_string) name **)** -\\ + * void **remove_resource** **(** [String](class_string) name **)** + Remove a resource from the preloader by text id. #### rename_resource - * void **[rename_resource](#rename_resource)** **(** [String](class_string) name, [String](class_string) newname **)** -\\ + * void **rename_resource** **(** [String](class_string) name, [String](class_string) newname **)** + Rename a resource inside the preloader, from a text-id to a new text-id. #### has_resource - * [bool](class_bool) **[has_resource](#has_resource)** **(** [String](class_string) name **)** const -\\ + * [bool](class_bool) **has_resource** **(** [String](class_string) name **)** const + Return true if the preloader has a given resource. #### get_resource - * [Object](class_object) **[get_resource](#get_resource)** **(** [String](class_string) name **)** const -\\ + * [Object](class_object) **get_resource** **(** [String](class_string) name **)** const + Return the resource given a text-id. #### get_resource_list - * [StringArray](class_stringarray) **[get_resource_list](#get_resource_list)** **(** **)** const -\\ + * [StringArray](class_stringarray) **get_resource_list** **(** **)** const + Return the list of resources inside the preloader. diff --git a/class_resourcesaver.md b/class_resourcesaver.md index ce3966e..1cecf3c 100644 --- a/class_resourcesaver.md +++ b/class_resourcesaver.md @@ -13,11 +13,11 @@ Resource Saving Interface. This interface is used for saving resources to disk. ### Member Function Description #### save - * [int](class_int) **[save](#save)** **(** [String](class_string) path, [Resource](class_resource) resource, [int](class_int) arg2=0 **)** -\\ + * [int](class_int) **save** **(** [String](class_string) path, [Resource](class_resource) resource, [int](class_int) arg2=0 **)** + Save a resource to disk, to a given path. #### get_recognized_extensions - * [StringArray](class_stringarray) **[get_recognized_extensions](#get_recognized_extensions)** **(** [Object](class_object) type **)** -\\ + * [StringArray](class_stringarray) **get_recognized_extensions** **(** [Object](class_object) type **)** + Return the list of extensions available for saving a resource of a given type. diff --git a/class_richtextlabel.md b/class_richtextlabel.md index 87f8c7e..68071f3 100644 --- a/class_richtextlabel.md +++ b/class_richtextlabel.md @@ -56,11 +56,11 @@ Label that displays rich text. Rich text can contain custom text, fonts, images ### Member Function Description #### set_selection_enabled - * void **[set_selection_enabled](#set_selection_enabled)** **(** [bool](class_bool) enabled **)** -\\ + * void **set_selection_enabled** **(** [bool](class_bool) enabled **)** + Set to true if selecting the text inside this richtext is allowed. #### is_selection_enabled - * [bool](class_bool) **[is_selection_enabled](#is_selection_enabled)** **(** **)** const -\\ + * [bool](class_bool) **is_selection_enabled** **(** **)** const + Return true if selecting the text inside this richtext is allowed. diff --git a/class_rigidbody2d.md b/class_rigidbody2d.md index 6ef7eb9..4ea4f1c 100644 --- a/class_rigidbody2d.md +++ b/class_rigidbody2d.md @@ -57,146 +57,146 @@ Rigid body 2D node. This node is used for placing rigid bodies in the scene. It ### Member Function Description #### _integrate_forces - * void **[_integrate_forces](#_integrate_forces)** **(** [Physics2DDirectBodyState](class_physics2ddirectbodystate) state **)** virtual -\\ + * void **_integrate_forces** **(** [Physics2DDirectBodyState](class_physics2ddirectbodystate) state **)** virtual + Override this function to use a custom force integrator. This allows to hook up to the physics processing and alter the simulation state for the object on every frame. #### set_mode - * void **[set_mode](#set_mode)** **(** [int](class_int) mode **)** -\\ + * void **set_mode** **(** [int](class_int) mode **)** + Set the body mode, fromt he MODE_* enum. This allows to change to a static body or a character body. #### get_mode - * [int](class_int) **[get_mode](#get_mode)** **(** **)** const -\\ + * [int](class_int) **get_mode** **(** **)** const + Return the current body mode, see [set_mode]. #### set_mass - * void **[set_mass](#set_mass)** **(** [real](class_real) mass **)** -\\ + * void **set_mass** **(** [real](class_real) mass **)** + Set the body mass. #### get_mass - * [real](class_real) **[get_mass](#get_mass)** **(** **)** const -\\ + * [real](class_real) **get_mass** **(** **)** const + Return the body mass. #### set_weight - * void **[set_weight](#set_weight)** **(** [real](class_real) weight **)** -\\ + * void **set_weight** **(** [real](class_real) weight **)** + Set the body mass given standard earth-weight (gravity 9.8). Not really useful for 2D since most measuers for this node are in pixels. #### get_weight - * [real](class_real) **[get_weight](#get_weight)** **(** **)** const -\\ + * [real](class_real) **get_weight** **(** **)** const + Return the body mass given standard earth-weight (gravity 9.8). #### set_friction - * void **[set_friction](#set_friction)** **(** [real](class_real) friction **)** -\\ + * void **set_friction** **(** [real](class_real) friction **)** + Set the body friction, from 0 (friction less) to 1 (full friction). #### get_friction - * [real](class_real) **[get_friction](#get_friction)** **(** **)** const -\\ + * [real](class_real) **get_friction** **(** **)** const + Return the body friction. #### set_bounce - * void **[set_bounce](#set_bounce)** **(** [real](class_real) bounce **)** -\\ + * void **set_bounce** **(** [real](class_real) bounce **)** + Set the body bounciness, from 0 (no bounce) to 1 (bounce). #### get_bounce - * [real](class_real) **[get_bounce](#get_bounce)** **(** **)** const -\\ + * [real](class_real) **get_bounce** **(** **)** const + Return the body bouncyness. #### set_linear_velocity - * void **[set_linear_velocity](#set_linear_velocity)** **(** [Vector2](class_vector2) linear_velocity **)** -\\ + * void **set_linear_velocity** **(** [Vector2](class_vector2) linear_velocity **)** + Set the body linear velocity. Can be used sporadically, but** DONT SET THIS IN EVERY FRAME **, because physics may be running in another thread and definitely runs at a different granularity. Use [_integrate_forces] as your process loop if you want to have precise control of the body state. #### get_linear_velocity - * [Vector2](class_vector2) **[get_linear_velocity](#get_linear_velocity)** **(** **)** const -\\ + * [Vector2](class_vector2) **get_linear_velocity** **(** **)** const + Return the body linear velocity. This changes by physics granularity. See [set_linear_velocity]. #### set_angular_velocity - * void **[set_angular_velocity](#set_angular_velocity)** **(** [real](class_real) angular_velocity **)** -\\ + * void **set_angular_velocity** **(** [real](class_real) angular_velocity **)** + Set the body angular velocity. Can be used sporadically, but** DONT SET THIS IN EVERY FRAME **, because physics may be running in another thread and definitely runs at a different granularity. Use [_integrate_forces] as your process loop if you want to have precise control of the body state. #### get_angular_velocity - * [real](class_real) **[get_angular_velocity](#get_angular_velocity)** **(** **)** const -\\ + * [real](class_real) **get_angular_velocity** **(** **)** const + Return the body angular velocity. This changes by physics granularity. See [set_angular_velocity]. #### set_max_contacts_reported - * void **[set_max_contacts_reported](#set_max_contacts_reported)** **(** [int](class_int) amount **)** -\\ + * void **set_max_contacts_reported** **(** [int](class_int) amount **)** + 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. #### get_max_contacts_reported - * [int](class_int) **[get_max_contacts_reported](#get_max_contacts_reported)** **(** **)** const -\\ + * [int](class_int) **get_max_contacts_reported** **(** **)** const + Return the maximum contacts that can be reported. See [set_max_contacts_reported]. #### set_use_custom_integrator - * void **[set_use_custom_integrator](#set_use_custom_integrator)** **(** [bool](class_bool) enable **)** -\\ + * void **set_use_custom_integrator** **(** [bool](class_bool) enable **)** + Set to true if the body shall not do any internal force integration at all (like gravity or air friction). Only the [_integrate_forces] will be able to integrate them if overrided. #### is_using_custom_integrator - * [bool](class_bool) **[is_using_custom_integrator](#is_using_custom_integrator)** **(** **)** -\\ + * [bool](class_bool) **is_using_custom_integrator** **(** **)** + Return true if the body is not doing any built-in force integration. #### set_contact_monitor - * void **[set_contact_monitor](#set_contact_monitor)** **(** [bool](class_bool) enabled **)** -\\ + * void **set_contact_monitor** **(** [bool](class_bool) enabled **)** + Enable contact monitoring. (the signals to notify when a body entered/exited collision). #### is_contact_monitor_enabled - * [bool](class_bool) **[is_contact_monitor_enabled](#is_contact_monitor_enabled)** **(** **)** const -\\ + * [bool](class_bool) **is_contact_monitor_enabled** **(** **)** const + Return wether contact monitoring is enabled. #### set_use_continuous_collision_detection - * void **[set_use_continuous_collision_detection](#set_use_continuous_collision_detection)** **(** [bool](class_bool) enable **)** -\\ + * void **set_use_continuous_collision_detection** **(** [bool](class_bool) enable **)** + Enable continuos collision detection. This prevents very fast-moving bodies (such as bullets) to not go through objects. #### is_using_continuous_collision_detection - * [bool](class_bool) **[is_using_continuous_collision_detection](#is_using_continuous_collision_detection)** **(** **)** const -\\ + * [bool](class_bool) **is_using_continuous_collision_detection** **(** **)** const + Return true if continuous collision detection is in use. #### set_axis_velocity - * void **[set_axis_velocity](#set_axis_velocity)** **(** [Vector2](class_vector2) axis_velocity **)** -\\ + * void **set_axis_velocity** **(** [Vector2](class_vector2) axis_velocity **)** + Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. (This is useful for jumping behavior). #### apply_impulse - * void **[apply_impulse](#apply_impulse)** **(** [Vector2](class_vector2) pos, [Vector2](class_vector2) impulse **)** -\\ + * void **apply_impulse** **(** [Vector2](class_vector2) pos, [Vector2](class_vector2) impulse **)** + Apply a positioned impulse (which will be affected by the body mass and shape). #### set_active - * void **[set_active](#set_active)** **(** [bool](class_bool) active **)** -\\ + * void **set_active** **(** [bool](class_bool) active **)** + Change the body state between sleeping/active states. As a note, static bodies can never be active. #### is_active - * [bool](class_bool) **[is_active](#is_active)** **(** **)** const -\\ + * [bool](class_bool) **is_active** **(** **)** const + Return the body state. As a note, static bodies are never active. #### set_can_sleep - * void **[set_can_sleep](#set_can_sleep)** **(** [bool](class_bool) able_to_sleep **)** -\\ + * void **set_can_sleep** **(** [bool](class_bool) able_to_sleep **)** + 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. #### is_able_to_sleep - * [bool](class_bool) **[is_able_to_sleep](#is_able_to_sleep)** **(** **)** const -\\ + * [bool](class_bool) **is_able_to_sleep** **(** **)** const + Return true if the body has the ability to fall asleep when not moving. See [set_can_sleep]. diff --git a/class_sample.md b/class_sample.md index df517c7..135fc7d 100644 --- a/class_sample.md +++ b/class_sample.md @@ -33,71 +33,71 @@ Sample provides an audio sample class, containing audio data, together with some ### Member Function Description #### create - * void **[create](#create)** **(** [int](class_int) format, [bool](class_bool) stereo, [int](class_int) length **)** -\\ + * void **create** **(** [int](class_int) format, [bool](class_bool) stereo, [int](class_int) length **)** + Create new data for the sample, with format "format" (see FORMAT_* enum), stereo hint, and length in frames (not samples or bytes!) "frame". Calling create overrides previous existing data if it exists. Stereo samples are interleaved pairs of left and right (in that order) points #### get_format - * [int](class_int) **[get_format](#get_format)** **(** **)** const -\\ + * [int](class_int) **get_format** **(** **)** const + Return the sample format (see FORMAT_* enum). #### is_stereo - * [bool](class_bool) **[is_stereo](#is_stereo)** **(** **)** const -\\ + * [bool](class_bool) **is_stereo** **(** **)** const + Return true if the sample was created stereo. #### get_length - * [int](class_int) **[get_length](#get_length)** **(** **)** const -\\ + * [int](class_int) **get_length** **(** **)** const + Return the sample length in frames. #### set_data - * void **[set_data](#set_data)** **(** [RawArray](class_rawarray) data **)** -\\ + * void **set_data** **(** [RawArray](class_rawarray) data **)** + Set sample data. Data must be little endian, no matter the host platform, and exactly as long to fit all frames. Example, if data is Stereo, 16 bits, 256 frames, it will be 1024 bytes long. #### get_data - * [RawArray](class_rawarray) **[get_data](#get_data)** **(** **)** const -\\ + * [RawArray](class_rawarray) **get_data** **(** **)** const + Return sample data. Data will be endian, no matter with the host platform, and exactly as long to fit all frames. Example, if data is Stereo, 16 bits, 256 frames, it will be 1024 bytes long. #### set_mix_rate - * void **[set_mix_rate](#set_mix_rate)** **(** [int](class_int) hz **)** -\\ + * void **set_mix_rate** **(** [int](class_int) hz **)** + Set the mix rate for the sample (expected playback frequency). #### get_mix_rate - * [int](class_int) **[get_mix_rate](#get_mix_rate)** **(** **)** const -\\ + * [int](class_int) **get_mix_rate** **(** **)** const + Return the mix rate for the sample (expected playback frequency). #### set_loop_format - * void **[set_loop_format](#set_loop_format)** **(** [int](class_int) format **)** -\\ + * void **set_loop_format** **(** [int](class_int) format **)** + Set the loop format, see LOOP_* enum #### get_loop_format - * [int](class_int) **[get_loop_format](#get_loop_format)** **(** **)** const -\\ + * [int](class_int) **get_loop_format** **(** **)** const + Return the loop format, see LOOP_* enum. #### set_loop_begin - * void **[set_loop_begin](#set_loop_begin)** **(** [int](class_int) pos **)** -\\ + * void **set_loop_begin** **(** [int](class_int) pos **)** + Set the loop begin position, it must be a valid frame and less than the loop end position. #### get_loop_begin - * [int](class_int) **[get_loop_begin](#get_loop_begin)** **(** **)** const -\\ + * [int](class_int) **get_loop_begin** **(** **)** const + Return the loop begin position. #### set_loop_end - * void **[set_loop_end](#set_loop_end)** **(** [int](class_int) pos **)** -\\ + * void **set_loop_end** **(** [int](class_int) pos **)** + Set the loop end position, it must be a valid frame and greater than the loop begin position. #### get_loop_end - * [int](class_int) **[get_loop_end](#get_loop_end)** **(** **)** const -\\ + * [int](class_int) **get_loop_end** **(** **)** const + Return the loop begin position. diff --git a/class_samplelibrary.md b/class_samplelibrary.md index 7def7af..949af73 100644 --- a/class_samplelibrary.md +++ b/class_samplelibrary.md @@ -19,21 +19,21 @@ Library that contains a collection of Samples, each identified by an text id. Th ### Member Function Description #### add_sample - * void **[add_sample](#add_sample)** **(** [String](class_string) name, [Sample](class_sample) sample **)** -\\ + * void **add_sample** **(** [String](class_string) name, [Sample](class_sample) sample **)** + Add a sample to the library, with a given text id; #### get_sample - * [Sample](class_sample) **[get_sample](#get_sample)** **(** [String](class_string) name **)** const -\\ + * [Sample](class_sample) **get_sample** **(** [String](class_string) name **)** const + Return a sample from the library, from a given text-id. Return null if the sample is not found. #### has_sample - * [bool](class_bool) **[has_sample](#has_sample)** **(** [String](class_string) name **)** const -\\ + * [bool](class_bool) **has_sample** **(** [String](class_string) name **)** const + Return true if the sample text id exists in the library. #### remove_sample - * void **[remove_sample](#remove_sample)** **(** [String](class_string) name **)** -\\ + * void **remove_sample** **(** [String](class_string) name **)** + Remove a sample given a specific text id. diff --git a/class_sampleplayer.md b/class_sampleplayer.md index 83d51d8..a686eff 100644 --- a/class_sampleplayer.md +++ b/class_sampleplayer.md @@ -77,116 +77,116 @@ SamplePlayer is a [[node|Node]] meant for simple sample playback. A library of s ### Member Function Description #### set_voice_count - * void **[set_voice_count](#set_voice_count)** **(** [int](class_int) max_voices **)** -\\ + * void **set_voice_count** **(** [int](class_int) max_voices **)** + Set the amount of simultaneous voices that will be used for playback. #### get_voice_count - * [int](class_int) **[get_voice_count](#get_voice_count)** **(** **)** const -\\ + * [int](class_int) **get_voice_count** **(** **)** const + Return the amount of simultaneous voices that will be used for playback. #### play - * [int](class_int) **[play](#play)** **(** [String](class_string) name, [bool](class_bool) unique=false **)** -\\ + * [int](class_int) **play** **(** [String](class_string) name, [bool](class_bool) unique=false **)** + Play back sample, given it"apos;s identifier "name". if "unique" is true, all othere previous samples will be stopped. The voice allocated for playback will be returned. #### stop - * void **[stop](#stop)** **(** [int](class_int) voice **)** -\\ + * void **stop** **(** [int](class_int) voice **)** + Stop a voice "voice". (see [[#play|play]]). #### set_mix_rate - * void **[set_mix_rate](#set_mix_rate)** **(** [int](class_int) voice, [int](class_int) hz **)** -\\ + * void **set_mix_rate** **(** [int](class_int) voice, [int](class_int) hz **)** + Change the mix rate of a voice "voice" to given "hz". #### set_pitch_scale - * void **[set_pitch_scale](#set_pitch_scale)** **(** [int](class_int) voice, [real](class_real) ratio **)** -\\ + * void **set_pitch_scale** **(** [int](class_int) voice, [real](class_real) ratio **)** + Scale the pitch (mix rate) of a voice by a ratio value "ratio". A ratio of 1.0 means the voice is unscaled. #### set_volume - * void **[set_volume](#set_volume)** **(** [int](class_int) voice, [real](class_real) nrg **)** -\\ + * void **set_volume** **(** [int](class_int) voice, [real](class_real) nrg **)** + Set the volume of a voice, 0db is maximum volume (every about -6db, volume is reduced in half). "db" does in fact go from zero to negative. #### set_pan - * void **[set_pan](#set_pan)** **(** [int](class_int) voice, [real](class_real) pan, [real](class_real) depth=0, [real](class_real) height=0 **)** -\\ + * void **set_pan** **(** [int](class_int) voice, [real](class_real) pan, [real](class_real) depth=0, [real](class_real) height=0 **)** + Set the panning of a voice. Panning goes from -1 (left) to +1 (right). Optionally, if the hardware supports 3D sound, also set depth and height (also in range -1 to +1). #### set_filter - * void **[set_filter](#set_filter)** **(** [int](class_int) voice, [int](class_int) type, [real](class_real) cutoff_hz, [real](class_real) resonance, [real](class_real) gain=0 **)** -\\ + * void **set_filter** **(** [int](class_int) voice, [int](class_int) type, [real](class_real) cutoff_hz, [real](class_real) resonance, [real](class_real) gain=0 **)** + Set and enable a filter of a voice, with type "type" (see FILTER_* enum), cutoff (0 to 22khz) frequency and resonance (0+). #### set_chorus - * void **[set_chorus](#set_chorus)** **(** [int](class_int) voice, [real](class_real) send **)** -\\ + * void **set_chorus** **(** [int](class_int) voice, [real](class_real) send **)** + Set the chorus send level of a voice (0 to 1). For setting chorus parameters, see [[audioserver|AudioServer]]. #### set_reverb - * void **[set_reverb](#set_reverb)** **(** [int](class_int) voice, [int](class_int) room_type, [real](class_real) send **)** -\\ + * void **set_reverb** **(** [int](class_int) voice, [int](class_int) room_type, [real](class_real) send **)** + Set the reverb send level and type of a voice (0 to 1). (see REVERB_* enum for type). #### get_mix_rate - * [int](class_int) **[get_mix_rate](#get_mix_rate)** **(** [int](class_int) voice **)** const -\\ + * [int](class_int) **get_mix_rate** **(** [int](class_int) voice **)** const + Return the current mix rate for a given voice. #### get_pitch_scale - * [real](class_real) **[get_pitch_scale](#get_pitch_scale)** **(** [int](class_int) voice **)** const -\\ + * [real](class_real) **get_pitch_scale** **(** [int](class_int) voice **)** const + Return the current pitch scale for a given voice. #### get_volume - * [real](class_real) **[get_volume](#get_volume)** **(** [int](class_int) voice **)** const -\\ + * [real](class_real) **get_volume** **(** [int](class_int) voice **)** const + Return the current volume (in db) for a given voice. 0db is maximum volume (every about -6db, volume is reduced in half). "db" does in fact go from zero to negative. #### get_pan - * [real](class_real) **[get_pan](#get_pan)** **(** [int](class_int) voice **)** const -\\ + * [real](class_real) **get_pan** **(** [int](class_int) voice **)** const + Return the current panning for a given voice. Panning goes from -1 (left) to +1 (right). #### get_pan_depth - * [real](class_real) **[get_pan_depth](#get_pan_depth)** **(** [int](class_int) voice **)** const -\\ + * [real](class_real) **get_pan_depth** **(** [int](class_int) voice **)** const + Return the current pan depth for a given voice (not used unless the hardware supports 3D sound) #### get_pan_height - * [real](class_real) **[get_pan_height](#get_pan_height)** **(** [int](class_int) voice **)** const -\\ + * [real](class_real) **get_pan_height** **(** [int](class_int) voice **)** const + Return the current pan height for a given voice (not used unless the hardware supports 3D sound) #### get_filter_type - * [int](class_int) **[get_filter_type](#get_filter_type)** **(** [int](class_int) voice **)** const -\\ + * [int](class_int) **get_filter_type** **(** [int](class_int) voice **)** const + Return the current filter type in use (see FILTER_* enum) for a given voice. #### get_filter_cutoff - * [real](class_real) **[get_filter_cutoff](#get_filter_cutoff)** **(** [int](class_int) voice **)** const -\\ + * [real](class_real) **get_filter_cutoff** **(** [int](class_int) voice **)** const + Return the current filter cutoff for a given voice. Cutoff goes from 0 to 22khz. #### get_filter_resonance - * [real](class_real) **[get_filter_resonance](#get_filter_resonance)** **(** [int](class_int) voice **)** const -\\ + * [real](class_real) **get_filter_resonance** **(** [int](class_int) voice **)** const + Return the current filter resonance for a given voice. Resonance goes from 0 up. #### get_chorus - * [real](class_real) **[get_chorus](#get_chorus)** **(** [int](class_int) voice **)** const -\\ + * [real](class_real) **get_chorus** **(** [int](class_int) voice **)** const + Return the current chorus send level for a given voice. (0 to 1). #### get_reverb_room - * [real](class_real) **[get_reverb_room](#get_reverb_room)** **(** [int](class_int) voice **)** const -\\ + * [real](class_real) **get_reverb_room** **(** [int](class_int) voice **)** const + Return the current reverb room type for a given voice (see REVERB_* enum). #### get_reverb - * [real](class_real) **[get_reverb](#get_reverb)** **(** [int](class_int) voice **)** const -\\ + * [real](class_real) **get_reverb** **(** [int](class_int) voice **)** const + Return the current reverb send level for a given voice. (0 to 1). diff --git a/class_sampleplayer2d.md b/class_sampleplayer2d.md index 635a179..d8431f9 100644 --- a/class_sampleplayer2d.md +++ b/class_sampleplayer2d.md @@ -27,51 +27,51 @@ Sample player for Positional 2D Sound. Plays sound samples positionally, left an ### Member Function Description #### set_sample_library - * void **[set_sample_library](#set_sample_library)** **(** [SampleLibrary](class_samplelibrary) library **)** -\\ + * void **set_sample_library** **(** [SampleLibrary](class_samplelibrary) library **)** + Set the sample library for the player. #### get_sample_library - * [SampleLibrary](class_samplelibrary) **[get_sample_library](#get_sample_library)** **(** **)** const -\\ + * [SampleLibrary](class_samplelibrary) **get_sample_library** **(** **)** const + Return the sample library used for the player. #### set_polyphony - * void **[set_polyphony](#set_polyphony)** **(** [int](class_int) voices **)** -\\ + * void **set_polyphony** **(** [int](class_int) voices **)** + Set the polyphony of the player (maximum amount of simultaneous voices). #### get_polyphony - * [int](class_int) **[get_polyphony](#get_polyphony)** **(** **)** const -\\ + * [int](class_int) **get_polyphony** **(** **)** const + Return the polyphony of the player (maximum amount of simultaneous voices). #### play - * [int](class_int) **[play](#play)** **(** [String](class_string) sample, [int](class_int) voice=-2 **)** -\\ + * [int](class_int) **play** **(** [String](class_string) sample, [int](class_int) voice=-2 **)** + Play a sample, an internal polyphony id can be passed, or else it's assigned automatically. Returns a voice id which can be used to modify the voice parameters. #### voice_set_pitch_scale - * void **[voice_set_pitch_scale](#voice_set_pitch_scale)** **(** [int](class_int) voice, [real](class_real) ratio **)** -\\ + * void **voice_set_pitch_scale** **(** [int](class_int) voice, [real](class_real) ratio **)** + Change the pitch scale of a currently playing voice. #### voice_set_volume_scale_db - * void **[voice_set_volume_scale_db](#voice_set_volume_scale_db)** **(** [int](class_int) voice, [real](class_real) db **)** -\\ + * void **voice_set_volume_scale_db** **(** [int](class_int) voice, [real](class_real) db **)** + Change the volume scale of a currently playing voice (using dB). #### is_voice_active - * [bool](class_bool) **[is_voice_active](#is_voice_active)** **(** [int](class_int) voice **)** const -\\ + * [bool](class_bool) **is_voice_active** **(** [int](class_int) voice **)** const + Return true if a voice is still active (false if it stopped playing). #### stop_voice - * void **[stop_voice](#stop_voice)** **(** [int](class_int) voice **)** -\\ + * void **stop_voice** **(** [int](class_int) voice **)** + Stop a given voice. #### stop_all - * void **[stop_all](#stop_all)** **(** **)** -\\ + * void **stop_all** **(** **)** + Stop all playing voices. diff --git a/class_scenemainloop.md b/class_scenemainloop.md index cdaba4a..8d158d6 100644 --- a/class_scenemainloop.md +++ b/class_scenemainloop.md @@ -39,66 +39,66 @@ Scene implementation of the MainLoop. All scenes edited using the editor are loa ### Member Function Description #### notify_group - * void **[notify_group](#notify_group)** **(** [int](class_int) call_flags, [String](class_string) group, [int](class_int) notification **)** -\\ + * void **notify_group** **(** [int](class_int) call_flags, [String](class_string) group, [int](class_int) notification **)** + Call a notification in all the nodes belonging to a given group. See GROUP_CALL_* enum for options. #### set_group - * void **[set_group](#set_group)** **(** [int](class_int) call_flags, [String](class_string) group, [String](class_string) property, var value **)** -\\ + * void **set_group** **(** [int](class_int) call_flags, [String](class_string) group, [String](class_string) property, var value **)** + Set a property in all the nodes belonging to a given group. See GROUP_CALL_* enum for options. #### get_nodes_in_group - * [Array](class_array) **[get_nodes_in_group](#get_nodes_in_group)** **(** [String](class_string) arg0 **)** -\\ + * [Array](class_array) **get_nodes_in_group** **(** [String](class_string) arg0 **)** + Get all the nods belonging to a given group. #### set_auto_accept_quit - * void **[set_auto_accept_quit](#set_auto_accept_quit)** **(** [bool](class_bool) enabled **)** -\\ + * void **set_auto_accept_quit** **(** [bool](class_bool) enabled **)** + Set to true if the application will quit automatically when quit is requested (Alt-f4 or ctrl-c). #### set_editor_hint - * void **[set_editor_hint](#set_editor_hint)** **(** [bool](class_bool) enable **)** -\\ + * void **set_editor_hint** **(** [bool](class_bool) enable **)** + Set to true to tell nodes and the scene that it is being edited. This is used by editors, not release. #### is_editor_hint - * [bool](class_bool) **[is_editor_hint](#is_editor_hint)** **(** **)** const -\\ + * [bool](class_bool) **is_editor_hint** **(** **)** const + Return true if the scene is being run inside an editor. #### set_pause - * void **[set_pause](#set_pause)** **(** [bool](class_bool) enable **)** -\\ + * void **set_pause** **(** [bool](class_bool) enable **)** + Set pause. The built-in pause system is very basic and only meant to avoid processing nodes not allowed to work in pause mode. #### is_paused - * [bool](class_bool) **[is_paused](#is_paused)** **(** **)** const -\\ + * [bool](class_bool) **is_paused** **(** **)** const + Return true if the scene is paused. #### set_input_as_handled - * void **[set_input_as_handled](#set_input_as_handled)** **(** **)** -\\ + * void **set_input_as_handled** **(** **)** + Handle a current input event (avoid further processing of it). #### get_frame - * [int](class_int) **[get_frame](#get_frame)** **(** **)** const -\\ + * [int](class_int) **get_frame** **(** **)** const + Return the frame index (how many frames were drawn). #### quit - * void **[quit](#quit)** **(** **)** -\\ + * void **quit** **(** **)** + Quit the application. #### queue_delete - * void **[queue_delete](#queue_delete)** **(** [Object](class_object) obj **)** -\\ + * void **queue_delete** **(** [Object](class_object) obj **)** + Queue an object for deletion next time the loop goes idle. #### call_group - * void **[call_group](#call_group)** **(** [int](class_int) flags, [String](class_string) group, [String](class_string) method, var arg0=NULL, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL **)** -\\ + * void **call_group** **(** [int](class_int) flags, [String](class_string) group, [String](class_string) method, var arg0=NULL, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL **)** + Call a function for all the nodes in a given group. diff --git a/class_script.md b/class_script.md index c0abfe0..ac37a53 100644 --- a/class_script.md +++ b/class_script.md @@ -17,31 +17,31 @@ Base class for scripts. Any script that is loaded becomes one of these resources ### Member Function Description #### can_instance - * [bool](class_bool) **[can_instance](#can_instance)** **(** **)** const -\\ + * [bool](class_bool) **can_instance** **(** **)** const + Return true if this script can be instance (ie not a library). #### instance_has - * [bool](class_bool) **[instance_has](#instance_has)** **(** [Object](class_object) base_object **)** const -\\ + * [bool](class_bool) **instance_has** **(** [Object](class_object) base_object **)** const + Return true if a given object uses an instance of this script. #### has_source_code - * [bool](class_bool) **[has_source_code](#has_source_code)** **(** **)** const -\\ + * [bool](class_bool) **has_source_code** **(** **)** const + Return true if the script contains source code. #### get_source_code - * [String](class_string) **[get_source_code](#get_source_code)** **(** **)** const -\\ + * [String](class_string) **get_source_code** **(** **)** const + Return the script source code (if available). #### set_source_code - * void **[set_source_code](#set_source_code)** **(** [String](class_string) source **)** -\\ + * void **set_source_code** **(** [String](class_string) source **)** + Set the script source code. #### reload - * [int](class_int) **[reload](#reload)** **(** **)** -\\ + * [int](class_int) **reload** **(** **)** + Reload the script. This will fail if there are existing instances. diff --git a/class_shape2d.md b/class_shape2d.md index e0024d6..b61fd38 100644 --- a/class_shape2d.md +++ b/class_shape2d.md @@ -13,11 +13,11 @@ Base class for all 2D Shapes. All 2D shape types inherit from this. ### Member Function Description #### set_custom_solver_bias - * void **[set_custom_solver_bias](#set_custom_solver_bias)** **(** [real](class_real) bias **)** -\\ + * void **set_custom_solver_bias** **(** [real](class_real) bias **)** + Use a custom solver bias. No need to change this unless you really know what you are doing. #### get_custom_solver_bias - * [real](class_real) **[get_custom_solver_bias](#get_custom_solver_bias)** **(** **)** const -\\ + * [real](class_real) **get_custom_solver_bias** **(** **)** const + Return the custom solver bias. No need to change this unless you really know what you are doing. diff --git a/class_skeleton.md b/class_skeleton.md index dfdad91..4b3366e 100644 --- a/class_skeleton.md +++ b/class_skeleton.md @@ -31,71 +31,71 @@ Skeleton provides a hierachial interface for managing bones, including pose, res ### Member Function Description #### add_bone - * void **[add_bone](#add_bone)** **(** [String](class_string) name **)** -\\ + * void **add_bone** **(** [String](class_string) name **)** + Add a bone, with name "name". [[#get_bone_count|get_bone_count]] will become the bone index. #### find_bone - * [int](class_int) **[find_bone](#find_bone)** **(** [String](class_string) name **)** const -\\ + * [int](class_int) **find_bone** **(** [String](class_string) name **)** const + Return the bone index that matches "name" as its name. #### get_bone_name - * [String](class_string) **[get_bone_name](#get_bone_name)** **(** [int](class_int) bone_idx **)** const -\\ + * [String](class_string) **get_bone_name** **(** [int](class_int) bone_idx **)** const + Return the name of the bone at index "index" #### get_bone_parent - * [int](class_int) **[get_bone_parent](#get_bone_parent)** **(** [int](class_int) bone_idx **)** const -\\ + * [int](class_int) **get_bone_parent** **(** [int](class_int) bone_idx **)** const + Return the bone index which is the parent of the bone at "bone_idx". If -1, then bone has no parent. Note that the parent bone returned will always be less than "bone_idx". #### set_bone_parent - * void **[set_bone_parent](#set_bone_parent)** **(** [int](class_int) bone_idx, [int](class_int) parent_idx **)** -\\ + * void **set_bone_parent** **(** [int](class_int) bone_idx, [int](class_int) parent_idx **)** + Set the bone index "parent_idx" as the parent of the bone at "bone_idx". If -1, then bone has no parent. Note: "parent_idx" must be less than "bone_idx". #### get_bone_count - * [int](class_int) **[get_bone_count](#get_bone_count)** **(** **)** const -\\ + * [int](class_int) **get_bone_count** **(** **)** const + Return the amount of bones in the skeleton. #### get_bone_rest - * [Transform](class_transform) **[get_bone_rest](#get_bone_rest)** **(** [int](class_int) bone_idx **)** const -\\ + * [Transform](class_transform) **get_bone_rest** **(** [int](class_int) bone_idx **)** const + Return the rest transform for a bone "bone_idx". #### set_bone_rest - * void **[set_bone_rest](#set_bone_rest)** **(** [int](class_int) bone_idx, [Transform](class_transform) rest **)** -\\ + * void **set_bone_rest** **(** [int](class_int) bone_idx, [Transform](class_transform) rest **)** + Set the rest transform for bone "bone_idx" #### bind_child_node_to_bone - * void **[bind_child_node_to_bone](#bind_child_node_to_bone)** **(** [int](class_int) bone_idx, [Node](class_node) node **)** -\\ + * void **bind_child_node_to_bone** **(** [int](class_int) bone_idx, [Node](class_node) node **)** + Deprecated soon #### unbind_child_node_from_bone - * void **[unbind_child_node_from_bone](#unbind_child_node_from_bone)** **(** [int](class_int) bone_idx, [Node](class_node) node **)** -\\ + * void **unbind_child_node_from_bone** **(** [int](class_int) bone_idx, [Node](class_node) node **)** + Deprecated soon #### get_bound_child_nodes_to_bone - * [Array](class_array) **[get_bound_child_nodes_to_bone](#get_bound_child_nodes_to_bone)** **(** [int](class_int) bone_idx **)** const -\\ + * [Array](class_array) **get_bound_child_nodes_to_bone** **(** [int](class_int) bone_idx **)** const + Deprecated Soon #### clear_bones - * void **[clear_bones](#clear_bones)** **(** **)** -\\ + * void **clear_bones** **(** **)** + Clear all the bones in this skeleton. #### get_bone_pose - * [Transform](class_transform) **[get_bone_pose](#get_bone_pose)** **(** [int](class_int) bone_idx **)** const -\\ + * [Transform](class_transform) **get_bone_pose** **(** [int](class_int) bone_idx **)** const + Return the pose transform for bone "bone_idx". #### set_bone_pose - * void **[set_bone_pose](#set_bone_pose)** **(** [int](class_int) bone_idx, [Transform](class_transform) pose **)** -\\ + * void **set_bone_pose** **(** [int](class_int) bone_idx, [Transform](class_transform) pose **)** + Return the pose transform for bone "bone_idx". diff --git a/class_slider.md b/class_slider.md index 40ed76d..3ed87fe 100644 --- a/class_slider.md +++ b/class_slider.md @@ -15,21 +15,21 @@ Base class for GUI Sliders. ### Member Function Description #### set_ticks - * void **[set_ticks](#set_ticks)** **(** [int](class_int) count **)** -\\ + * void **set_ticks** **(** [int](class_int) count **)** + Set amount of ticks to display in slider. #### get_ticks - * [int](class_int) **[get_ticks](#get_ticks)** **(** **)** const -\\ + * [int](class_int) **get_ticks** **(** **)** const + Return amounts of ticks to display on slider. #### get_ticks_on_borders - * [bool](class_bool) **[get_ticks_on_borders](#get_ticks_on_borders)** **(** **)** const -\\ + * [bool](class_bool) **get_ticks_on_borders** **(** **)** const + Return true if ticks are visible on borders. #### set_ticks_on_borders - * void **[set_ticks_on_borders](#set_ticks_on_borders)** **(** [bool](class_bool) ticks_on_border **)** -\\ + * void **set_ticks_on_borders** **(** [bool](class_bool) ticks_on_border **)** + Set true if ticks are visible on borders. diff --git a/class_spatial.md b/class_spatial.md index f70d94b..bc795d3 100644 --- a/class_spatial.md +++ b/class_spatial.md @@ -34,26 +34,26 @@ Spatial is the base for every type of 3D [[node|Node]]. It contains a 3D [[trans ### Member Function Description #### set_transform - * void **[set_transform](#set_transform)** **(** [Transform](class_transform) local **)** -\\ + * void **set_transform** **(** [Transform](class_transform) local **)** + Set the transform locally, relative to the parent spatial node. #### get_transform - * [Transform](class_transform) **[get_transform](#get_transform)** **(** **)** const -\\ + * [Transform](class_transform) **get_transform** **(** **)** const + Return the local transform, relative to the bone parent. #### set_global_transform - * void **[set_global_transform](#set_global_transform)** **(** [Transform](class_transform) global **)** -\\ + * void **set_global_transform** **(** [Transform](class_transform) global **)** + Set the transform globally, relative to worldspace. #### get_global_transform - * [Transform](class_transform) **[get_global_transform](#get_global_transform)** **(** **)** const -\\ + * [Transform](class_transform) **get_global_transform** **(** **)** const + Return the gloal transform, relative to worldspace. #### get_parent_spatial - * [Object](class_object) **[get_parent_spatial](#get_parent_spatial)** **(** **)** const -\\ + * [Object](class_object) **get_parent_spatial** **(** **)** const + Return the parent [[spatial|Spatial]], or an empty [[object|Object]] if no parent exists or parent is not of type [Spatial. diff --git a/class_spinbox.md b/class_spinbox.md index 8fb19dc..b4d1476 100644 --- a/class_spinbox.md +++ b/class_spinbox.md @@ -18,26 +18,26 @@ SpinBox is a numerical input text field. It allows entering integers and floats. ### Member Function Description #### set_suffix - * void **[set_suffix](#set_suffix)** **(** [String](class_string) suffix **)** -\\ + * void **set_suffix** **(** [String](class_string) suffix **)** + Set a specific suffix. #### get_suffix - * [String](class_string) **[get_suffix](#get_suffix)** **(** **)** const -\\ + * [String](class_string) **get_suffix** **(** **)** const + Return the specific suffix. #### set_prefix - * void **[set_prefix](#set_prefix)** **(** [String](class_string) prefix **)** -\\ + * void **set_prefix** **(** [String](class_string) prefix **)** + Set a prefix. #### set_editable - * void **[set_editable](#set_editable)** **(** [bool](class_bool) editable **)** -\\ + * void **set_editable** **(** [bool](class_bool) editable **)** + Set whether the spinbox is editable. #### is_editable - * [bool](class_bool) **[is_editable](#is_editable)** **(** **)** const -\\ + * [bool](class_bool) **is_editable** **(** **)** const + Return if the spinbox is editable. diff --git a/class_splitcontainer.md b/class_splitcontainer.md index 1241bb1..bf32f4b 100644 --- a/class_splitcontainer.md +++ b/class_splitcontainer.md @@ -17,21 +17,21 @@ Container for splitting two controls vertically or horizontally, with a grabber ### Member Function Description #### set_split_offset - * void **[set_split_offset](#set_split_offset)** **(** [int](class_int) offset **)** -\\ + * void **set_split_offset** **(** [int](class_int) offset **)** + Set the split offset. #### get_split_offset - * [int](class_int) **[get_split_offset](#get_split_offset)** **(** **)** const -\\ + * [int](class_int) **get_split_offset** **(** **)** const + Return the spluit offset; #### set_collapsed - * void **[set_collapsed](#set_collapsed)** **(** [bool](class_bool) collapsed **)** -\\ + * void **set_collapsed** **(** [bool](class_bool) collapsed **)** + Set if the split must be collapsed. #### is_collapsed - * [bool](class_bool) **[is_collapsed](#is_collapsed)** **(** **)** const -\\ + * [bool](class_bool) **is_collapsed** **(** **)** const + Return if the split is collapsed; diff --git a/class_sprite.md b/class_sprite.md index 32b801f..55a8f62 100644 --- a/class_sprite.md +++ b/class_sprite.md @@ -33,111 +33,111 @@ General purpose Sprite node. This Sprite node can show any texture as a sprite. ### Member Function Description #### set_texture - * void **[set_texture](#set_texture)** **(** [Texture](class_texture) texture **)** -\\ + * void **set_texture** **(** [Texture](class_texture) texture **)** + Set the base texture for the sprite. #### get_texture - * [Texture](class_texture) **[get_texture](#get_texture)** **(** **)** const -\\ + * [Texture](class_texture) **get_texture** **(** **)** const + Return the base texture for the sprite. #### set_centered - * void **[set_centered](#set_centered)** **(** [bool](class_bool) centered **)** -\\ + * void **set_centered** **(** [bool](class_bool) centered **)** + Set whether the sprite should be centered on the origin. #### is_centered - * [bool](class_bool) **[is_centered](#is_centered)** **(** **)** const -\\ + * [bool](class_bool) **is_centered** **(** **)** const + Return if the sprite is centered at the local origin. #### set_offset - * void **[set_offset](#set_offset)** **(** [Vector2](class_vector2) offset **)** -\\ + * void **set_offset** **(** [Vector2](class_vector2) offset **)** + Set the sprite draw offset, useful for setting rotation pivots. #### get_offset - * [Vector2](class_vector2) **[get_offset](#get_offset)** **(** **)** const -\\ + * [Vector2](class_vector2) **get_offset** **(** **)** const + Return sprite draw offst. #### set_flip_h - * void **[set_flip_h](#set_flip_h)** **(** [bool](class_bool) flip_h **)** -\\ + * void **set_flip_h** **(** [bool](class_bool) flip_h **)** + Set true to flip the sprite horizontaly. #### is_flipped_h - * [bool](class_bool) **[is_flipped_h](#is_flipped_h)** **(** **)** const -\\ + * [bool](class_bool) **is_flipped_h** **(** **)** const + Return true if the sprite is flipped horizontally. #### set_flip_v - * void **[set_flip_v](#set_flip_v)** **(** [bool](class_bool) flip_v **)** -\\ + * void **set_flip_v** **(** [bool](class_bool) flip_v **)** + Set true to flip the sprite vertically. #### is_flipped_v - * [bool](class_bool) **[is_flipped_v](#is_flipped_v)** **(** **)** const -\\ + * [bool](class_bool) **is_flipped_v** **(** **)** const + Return true if the sprite is flipped vertically. #### set_region - * void **[set_region](#set_region)** **(** [bool](class_bool) enabled **)** -\\ + * void **set_region** **(** [bool](class_bool) enabled **)** + Set the sprite as a sub-region of a bigger texture. Useful for texture-atlases. #### is_region - * [bool](class_bool) **[is_region](#is_region)** **(** **)** const -\\ + * [bool](class_bool) **is_region** **(** **)** const + Return if the sprite reads from a region. #### set_region_rect - * void **[set_region_rect](#set_region_rect)** **(** [Rect2](class_rect2) rect **)** -\\ + * void **set_region_rect** **(** [Rect2](class_rect2) rect **)** + Set the region rect to read from. #### get_region_rect - * [Rect2](class_rect2) **[get_region_rect](#get_region_rect)** **(** **)** const -\\ + * [Rect2](class_rect2) **get_region_rect** **(** **)** const + Return the region rect to read from. #### set_frame - * void **[set_frame](#set_frame)** **(** [int](class_int) frame **)** -\\ + * void **set_frame** **(** [int](class_int) frame **)** + Set the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1. #### get_frame - * [int](class_int) **[get_frame](#get_frame)** **(** **)** const -\\ + * [int](class_int) **get_frame** **(** **)** const + Return the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1. #### set_vframes - * void **[set_vframes](#set_vframes)** **(** [int](class_int) vframes **)** -\\ + * void **set_vframes** **(** [int](class_int) vframes **)** + Set the amount of vertical frames and converts the sprite into a sprite-sheet. This is useful for animation. #### get_vframes - * [int](class_int) **[get_vframes](#get_vframes)** **(** **)** const -\\ + * [int](class_int) **get_vframes** **(** **)** const + Return the amount of vertical frames. See [set_vframes]. #### set_hframes - * void **[set_hframes](#set_hframes)** **(** [int](class_int) hframes **)** -\\ + * void **set_hframes** **(** [int](class_int) hframes **)** + Set the amount of horizontal frames and converts the sprite into a sprite-sheet. This is useful for animation. #### get_hframes - * [int](class_int) **[get_hframes](#get_hframes)** **(** **)** const -\\ + * [int](class_int) **get_hframes** **(** **)** const + Return the amount of horizontal frames. See [set_hframes]. #### set_modulate - * void **[set_modulate](#set_modulate)** **(** [Color](class_color) modulate **)** -\\ + * void **set_modulate** **(** [Color](class_color) modulate **)** + Set color modulation for the sprite. All sprite pixels are multiplied by this color. #### get_modulate - * [Color](class_color) **[get_modulate](#get_modulate)** **(** **)** const -\\ + * [Color](class_color) **get_modulate** **(** **)** const + Return color modulation for the sprite. All sprite pixels are multiplied by this color. diff --git a/class_spriteframes.md b/class_spriteframes.md index 1788750..f767967 100644 --- a/class_spriteframes.md +++ b/class_spriteframes.md @@ -17,26 +17,26 @@ Sprite frame library for [[animatedsprite|AnimatedSprite]]. ### Member Function Description #### add_frame - * void **[add_frame](#add_frame)** **(** [Object](class_object) frame, [int](class_int) atpos=-1 **)** -\\ + * void **add_frame** **(** [Object](class_object) frame, [int](class_int) atpos=-1 **)** + Add a frame (texture). #### get_frame_count - * [int](class_int) **[get_frame_count](#get_frame_count)** **(** **)** const -\\ + * [int](class_int) **get_frame_count** **(** **)** const + Return the amount of frames. #### get_frame - * [Object](class_object) **[get_frame](#get_frame)** **(** [int](class_int) idx **)** const -\\ + * [Object](class_object) **get_frame** **(** [int](class_int) idx **)** const + Return a texture (frame). #### remove_frame - * void **[remove_frame](#remove_frame)** **(** [int](class_int) idx **)** -\\ + * void **remove_frame** **(** [int](class_int) idx **)** + Remove a frame #### clear - * void **[clear](#clear)** **(** **)** -\\ + * void **clear** **(** **)** + Clear the frames. diff --git a/class_staticbody2d.md b/class_staticbody2d.md index ab8e271..8362289 100644 --- a/class_staticbody2d.md +++ b/class_staticbody2d.md @@ -24,31 +24,31 @@ Static body for 2D Physics. A static body is a simple body that is not intended ### Member Function Description #### set_simulate_motion - * void **[set_simulate_motion](#set_simulate_motion)** **(** [bool](class_bool) enabled **)** -\\ + * void **set_simulate_motion** **(** [bool](class_bool) enabled **)** + Enable or disable simulated motion mode. #### is_simulating_motion - * [bool](class_bool) **[is_simulating_motion](#is_simulating_motion)** **(** **)** const -\\ + * [bool](class_bool) **is_simulating_motion** **(** **)** const + Return true if simulated motion mode is enabled. #### set_constant_linear_velocity - * void **[set_constant_linear_velocity](#set_constant_linear_velocity)** **(** [Vector2](class_vector2) vel **)** -\\ + * void **set_constant_linear_velocity** **(** [Vector2](class_vector2) vel **)** + Set a constant linear velocity for the body. #### set_constant_angular_velocity - * void **[set_constant_angular_velocity](#set_constant_angular_velocity)** **(** [real](class_real) vel **)** -\\ + * void **set_constant_angular_velocity** **(** [real](class_real) vel **)** + Set a constant angular velocity for the body. #### get_constant_linear_velocity - * [Vector2](class_vector2) **[get_constant_linear_velocity](#get_constant_linear_velocity)** **(** **)** const -\\ + * [Vector2](class_vector2) **get_constant_linear_velocity** **(** **)** const + Return the constant linear velocity for the body. #### get_constant_angular_velocity - * [real](class_real) **[get_constant_angular_velocity](#get_constant_angular_velocity)** **(** **)** const -\\ + * [real](class_real) **get_constant_angular_velocity** **(** **)** const + Return the constant angular velocity for the body. diff --git a/class_streampeer.md b/class_streampeer.md index f4ea9a0..cdc7a79 100644 --- a/class_streampeer.md +++ b/class_streampeer.md @@ -15,21 +15,21 @@ StreamPeer is an abstration and base class for stream-based protocols (such as T ### Member Function Description #### put_data - * [int](class_int) **[put_data](#put_data)** **(** [RawArray](class_rawarray) data **)** -\\ + * [int](class_int) **put_data** **(** [RawArray](class_rawarray) data **)** + Send a chunk of data through the connection, blocking if necesary until the data is done sending. This function returns an [Error] code. #### put_partial_data - * [Array](class_array) **[put_partial_data](#put_partial_data)** **(** [RawArray](class_rawarray) data **)** -\\ + * [Array](class_array) **put_partial_data** **(** [RawArray](class_rawarray) data **)** + Send a chunk of data through the connection, if all the data could not be sent at once, only part of it will. This function returns two values, an [Error] code and an integer, describing how much data was actually sent. #### get_data - * [Array](class_array) **[get_data](#get_data)** **(** [int](class_int) bytes **)** -\\ + * [Array](class_array) **get_data** **(** [int](class_int) bytes **)** + Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an [Error] code and a data array. #### get_partial_data - * [Array](class_array) **[get_partial_data](#get_partial_data)** **(** [int](class_int) bytes **)** -\\ + * [Array](class_array) **get_partial_data** **(** [int](class_int) bytes **)** + Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an [Error] code, and a data array. diff --git a/class_string.md b/class_string.md index 25d124e..047ceef 100644 --- a/class_string.md +++ b/class_string.md @@ -58,161 +58,161 @@ This is the built in string class (and the one used by GDScript). It supports Un ### Member Function Description #### basename - * [String](class_string) **[basename](#basename)** **(** **)** -\\ + * [String](class_string) **basename** **(** **)** + If the string is a path to a file, return the path to the file without the extension. #### begins_with - * [bool](class_bool) **[begins_with](#begins_with)** **(** [String](class_string) text **)** -\\ + * [bool](class_bool) **begins_with** **(** [String](class_string) text **)** + Return true if the strings begins with the given string. #### capitalize - * [String](class_string) **[capitalize](#capitalize)** **(** **)** -\\ + * [String](class_string) **capitalize** **(** **)** + Return the string in uppercase. #### casecmp_to - * [int](class_int) **[casecmp_to](#casecmp_to)** **(** [String](class_string) to **)** -\\ + * [int](class_int) **casecmp_to** **(** [String](class_string) to **)** + Perform a case-sensitive comparison to antoher string, return -1 if less, 0 if equal and +1 if greater. #### empty - * [bool](class_bool) **[empty](#empty)** **(** **)** -\\ + * [bool](class_bool) **empty** **(** **)** + Return true if the string is empty. #### extension - * [String](class_string) **[extension](#extension)** **(** **)** -\\ + * [String](class_string) **extension** **(** **)** + If the string is a path to a file, return the extension. #### find - * [int](class_int) **[find](#find)** **(** [String](class_string) what, [int](class_int) from=0 **)** -\\ + * [int](class_int) **find** **(** [String](class_string) what, [int](class_int) from=0 **)** + Find the first occurence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. #### find_last - * [int](class_int) **[find_last](#find_last)** **(** [String](class_string) what **)** -\\ + * [int](class_int) **find_last** **(** [String](class_string) what **)** + Find the last occurence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. #### findn - * [int](class_int) **[findn](#findn)** **(** [String](class_string) what, [int](class_int) from=0 **)** -\\ + * [int](class_int) **findn** **(** [String](class_string) what, [int](class_int) from=0 **)** + Find the first occurence 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. #### get_base_dir - * [String](class_string) **[get_base_dir](#get_base_dir)** **(** **)** -\\ + * [String](class_string) **get_base_dir** **(** **)** + If the string is a path to a file, return the base directory. #### get_file - * [String](class_string) **[get_file](#get_file)** **(** **)** -\\ + * [String](class_string) **get_file** **(** **)** + If the string is a path to a file, return the file and ignore the base directory. #### hash - * [int](class_int) **[hash](#hash)** **(** **)** -\\ + * [int](class_int) **hash** **(** **)** + Hash the string and return a 32 bits integer. #### insert - * [String](class_string) **[insert](#insert)** **(** [int](class_int) pos, [String](class_string) what **)** -\\ + * [String](class_string) **insert** **(** [int](class_int) pos, [String](class_string) what **)** + Insert a substring at a given position. #### is_abs_path - * [bool](class_bool) **[is_abs_path](#is_abs_path)** **(** **)** -\\ + * [bool](class_bool) **is_abs_path** **(** **)** + If the string is a path to a file or directory, return true if the path is absolute. #### is_rel_path - * [bool](class_bool) **[is_rel_path](#is_rel_path)** **(** **)** -\\ + * [bool](class_bool) **is_rel_path** **(** **)** + If the string is a path to a file or directory, return true if the path is relative. #### left - * [String](class_string) **[left](#left)** **(** [int](class_int) pos **)** -\\ + * [String](class_string) **left** **(** [int](class_int) pos **)** + Return an amount of characters from the left of the string. #### length - * [int](class_int) **[length](#length)** **(** **)** -\\ + * [int](class_int) **length** **(** **)** + Return the length of the string in characters. #### match - * [bool](class_bool) **[match](#match)** **(** [String](class_string) expr **)** -\\ + * [bool](class_bool) **match** **(** [String](class_string) expr **)** + Do a simple expression matching, using ? and * wildcards. #### matchn - * [bool](class_bool) **[matchn](#matchn)** **(** [String](class_string) expr **)** -\\ + * [bool](class_bool) **matchn** **(** [String](class_string) expr **)** + Do a simple, case insensitive, expression matching, using ? and * wildcards. #### nocasecmp_to - * [int](class_int) **[nocasecmp_to](#nocasecmp_to)** **(** [String](class_string) to **)** -\\ + * [int](class_int) **nocasecmp_to** **(** [String](class_string) to **)** + Perform a case-insensitive comparison to antoher string, return -1 if less, 0 if equal and +1 if greater. #### replace - * [String](class_string) **[replace](#replace)** **(** [String](class_string) what, [String](class_string) forwhat **)** -\\ + * [String](class_string) **replace** **(** [String](class_string) what, [String](class_string) forwhat **)** + Replace occurrences of a substring for different ones inside the string. #### replacen - * [String](class_string) **[replacen](#replacen)** **(** [String](class_string) what, [String](class_string) forwhat **)** -\\ + * [String](class_string) **replacen** **(** [String](class_string) what, [String](class_string) forwhat **)** + Replace occurrences of a substring for different ones inside the string, but search case-insensitive. #### rfind - * [int](class_int) **[rfind](#rfind)** **(** [String](class_string) what, [int](class_int) from=-1 **)** -\\ + * [int](class_int) **rfind** **(** [String](class_string) what, [int](class_int) from=-1 **)** + Perform a search for a substring, but start from the end of the string instead of the begining. #### rfindn - * [int](class_int) **[rfindn](#rfindn)** **(** [String](class_string) what, [int](class_int) from=-1 **)** -\\ + * [int](class_int) **rfindn** **(** [String](class_string) what, [int](class_int) from=-1 **)** + Perform a search for a substring, but start from the end of the string instead of the begining. Also search case-insensitive. #### right - * [String](class_string) **[right](#right)** **(** [int](class_int) pos **)** -\\ + * [String](class_string) **right** **(** [int](class_int) pos **)** + Return the right side of the string from a given position. #### split - * [StringArray](class_stringarray) **[split](#split)** **(** [String](class_string) divisor, [bool](class_bool) allow_empty=True **)** -\\ + * [StringArray](class_stringarray) **split** **(** [String](class_string) divisor, [bool](class_bool) allow_empty=True **)** + 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 ",". #### split_floats - * [RealArray](class_realarray) **[split_floats](#split_floats)** **(** [String](class_string) divisor, [bool](class_bool) allow_empty=True **)** -\\ + * [RealArray](class_realarray) **split_floats** **(** [String](class_string) divisor, [bool](class_bool) allow_empty=True **)** + 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 ",". #### strip_edges - * [String](class_string) **[strip_edges](#strip_edges)** **(** **)** -\\ + * [String](class_string) **strip_edges** **(** **)** + Return a copy of the string stripped of any non-printable character at the begining and the end. #### to_lower - * [String](class_string) **[to_lower](#to_lower)** **(** **)** -\\ + * [String](class_string) **to_lower** **(** **)** + Return the string converted to lowercase. #### to_upper - * [String](class_string) **[to_upper](#to_upper)** **(** **)** -\\ + * [String](class_string) **to_upper** **(** **)** + Return the string converted to uppercase. #### xml_escape - * [String](class_string) **[xml_escape](#xml_escape)** **(** **)** -\\ + * [String](class_string) **xml_escape** **(** **)** + Perform XML escaping on the string. #### xml_unescape - * [String](class_string) **[xml_unescape](#xml_unescape)** **(** **)** -\\ + * [String](class_string) **xml_unescape** **(** **)** + Perform XML un-escaping of the string. diff --git a/class_stylebox.md b/class_stylebox.md index 66659bb..066c103 100644 --- a/class_stylebox.md +++ b/class_stylebox.md @@ -19,31 +19,31 @@ StyleBox is [[resource|Resource]] that provides an abstract base class for dawin ### Member Function Description #### test_mask - * [bool](class_bool) **[test_mask](#test_mask)** **(** [Vector2](class_vector2) point, [Rect2](class_rect2) rect **)** const -\\ + * [bool](class_bool) **test_mask** **(** [Vector2](class_vector2) point, [Rect2](class_rect2) rect **)** const + Test a position in a rectangle, return wether it pases the mask test. #### set_default_margin - * void **[set_default_margin](#set_default_margin)** **(** [int](class_int) margin, [real](class_real) offset **)** -\\ + * void **set_default_margin** **(** [int](class_int) margin, [real](class_real) offset **)** + 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. #### get_default_margin - * [real](class_real) **[get_default_margin](#get_default_margin)** **(** [int](class_int) margin **)** const -\\ + * [real](class_real) **get_default_margin** **(** [int](class_int) margin **)** const + 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. #### get_margin - * [real](class_real) **[get_margin](#get_margin)** **(** [int](class_int) margin **)** const -\\ + * [real](class_real) **get_margin** **(** [int](class_int) margin **)** const + Return the offset of margin "margin" (see MARGIN_* enum). #### get_minimum_size - * [Vector2](class_vector2) **[get_minimum_size](#get_minimum_size)** **(** **)** const -\\ + * [Vector2](class_vector2) **get_minimum_size** **(** **)** const + Return the minimum size that this stylebox can be shrunk to. #### get_offset - * [Vector2](class_vector2) **[get_offset](#get_offset)** **(** **)** const -\\ + * [Vector2](class_vector2) **get_offset** **(** **)** const + Return the "offset" of a stylebox, this is a helper function, like writing Point2( style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP) ) diff --git a/class_styleboximagemask.md b/class_styleboximagemask.md index cfb8c87..0b8ca8a 100644 --- a/class_styleboximagemask.md +++ b/class_styleboximagemask.md @@ -17,31 +17,31 @@ This StyleBox is similar to [[styleboxtexture|StyleBoxTexture]], but only meant ### Member Function Description #### set_image - * void **[set_image](#set_image)** **(** [Image](class_image) image **)** -\\ + * void **set_image** **(** [Image](class_image) image **)** + Set the image used for mask testing. Pixels (converted to grey) that have a value, less than 0.5 will fail the test. #### get_image - * [Image](class_image) **[get_image](#get_image)** **(** **)** const -\\ + * [Image](class_image) **get_image** **(** **)** const + Return the image used for mask testing. (see [[#set_imag|set_imag]]). #### set_expand - * void **[set_expand](#set_expand)** **(** [bool](class_bool) expand **)** -\\ + * void **set_expand** **(** [bool](class_bool) expand **)** + Set the expand property (default). When expanding, the image will use the same rules as [[styleboxtexture|StyleBoxTexture]] for expand. If not expanding, the image will always be tested at its original size. #### get_expand - * [bool](class_bool) **[get_expand](#get_expand)** **(** **)** const -\\ + * [bool](class_bool) **get_expand** **(** **)** const + Return wether the expand property is set(default). When expanding, the image will use the same rules as [[styleboxtexture|StyleBoxTexture]] for expand. If not expanding, the image will always be tested at its original size. #### set_expand_margin_size - * void **[set_expand_margin_size](#set_expand_margin_size)** **(** [int](class_int) margin, [real](class_real) size **)** -\\ + * void **set_expand_margin_size** **(** [int](class_int) margin, [real](class_real) size **)** + Set an expand margin size (from enum MARGIN_*). Parts of the image below the size of the margin (and in the direction of the margin) will not expand. #### get_expand_margin_size - * [real](class_real) **[get_expand_margin_size](#get_expand_margin_size)** **(** [int](class_int) arg0 **)** const -\\ + * [real](class_real) **get_expand_margin_size** **(** [int](class_int) arg0 **)** const + Return the expand margin size (from enum MARGIN_*). Parts of the image below the size of the margin (and in the direction of the margin) will not expand. diff --git a/class_tabcontainer.md b/class_tabcontainer.md index 70b8fcb..31d9dfb 100644 --- a/class_tabcontainer.md +++ b/class_tabcontainer.md @@ -27,51 +27,51 @@ Tabbed Container. Contains several children controls, but shows only one at the ### Member Function Description #### get_tab_count - * [int](class_int) **[get_tab_count](#get_tab_count)** **(** **)** const -\\ + * [int](class_int) **get_tab_count** **(** **)** const + Return the amount of tabs. #### set_current_tab - * void **[set_current_tab](#set_current_tab)** **(** [int](class_int) tab_idx **)** -\\ + * void **set_current_tab** **(** [int](class_int) tab_idx **)** + Bring a tab (and the Control it represents) to the front, and hide the rest. #### get_current_tab - * [int](class_int) **[get_current_tab](#get_current_tab)** **(** **)** const -\\ + * [int](class_int) **get_current_tab** **(** **)** const + Return the current tab that is being showed. #### set_tab_align - * void **[set_tab_align](#set_tab_align)** **(** [int](class_int) align **)** -\\ + * void **set_tab_align** **(** [int](class_int) align **)** + Set tab alignment, from the ALIGN_* enum. Moves tabs to the left, right or center. #### get_tab_align - * [int](class_int) **[get_tab_align](#get_tab_align)** **(** **)** const -\\ + * [int](class_int) **get_tab_align** **(** **)** const + Return tab alignment, from the ALIGN_* enum #### set_tabs_visible - * void **[set_tabs_visible](#set_tabs_visible)** **(** [bool](class_bool) visible **)** -\\ + * void **set_tabs_visible** **(** [bool](class_bool) visible **)** + Set whether the tabs should be visible or hidden. #### are_tabs_visible - * [bool](class_bool) **[are_tabs_visible](#are_tabs_visible)** **(** **)** const -\\ + * [bool](class_bool) **are_tabs_visible** **(** **)** const + Return whether the tabs should be visible or hidden. #### set_tab_title - * void **[set_tab_title](#set_tab_title)** **(** [int](class_int) tab_idx, [String](class_string) title **)** -\\ + * void **set_tab_title** **(** [int](class_int) tab_idx, [String](class_string) title **)** + Set a title for the tab. Tab titles are by default the children node name, but this can be overriden. #### get_tab_title - * [String](class_string) **[get_tab_title](#get_tab_title)** **(** [int](class_int) tab_idx **)** const -\\ + * [String](class_string) **get_tab_title** **(** [int](class_int) tab_idx **)** const + Return the title for the tab. Tab titles are by default the children node name, but this can be overriden. #### set_tab_icon - * void **[set_tab_icon](#set_tab_icon)** **(** [int](class_int) tab_idx, [Texture](class_texture) icon **)** -\\ + * void **set_tab_icon** **(** [int](class_int) tab_idx, [Texture](class_texture) icon **)** + Set an icon for a tab. diff --git a/class_tcp_server.md b/class_tcp_server.md index ae7c2b9..bc5e104 100644 --- a/class_tcp_server.md +++ b/class_tcp_server.md @@ -15,21 +15,21 @@ TCP Server class. Listens to connections on a port and returns a StreamPeerTCP w ### Member Function Description #### listen - * [int](class_int) **[listen](#listen)** **(** [int](class_int) port, [StringArray](class_stringarray) accepted_hosts=StringArray() **)** -\\ + * [int](class_int) **listen** **(** [int](class_int) port, [StringArray](class_stringarray) accepted_hosts=StringArray() **)** + Listen on a port, alternatively give a white-list of accepted hosts. #### is_connection_available - * [bool](class_bool) **[is_connection_available](#is_connection_available)** **(** **)** const -\\ + * [bool](class_bool) **is_connection_available** **(** **)** const + Return true if a connection is available for taking. #### take_connection - * [Object](class_object) **[take_connection](#take_connection)** **(** **)** -\\ + * [Object](class_object) **take_connection** **(** **)** + If a connection is available, return a StreamPeerTCP with the connection/ #### stop - * void **[stop](#stop)** **(** **)** -\\ + * void **stop** **(** **)** + Stop listening. diff --git a/class_textedit.md b/class_textedit.md index eb88d1d..f6e4933 100644 --- a/class_textedit.md +++ b/class_textedit.md @@ -55,171 +55,171 @@ TextEdit is meant for editing large, multiline text. It also has facilities for ### Member Function Description #### set_text - * void **[set_text](#set_text)** **(** [String](class_string) text **)** -\\ + * void **set_text** **(** [String](class_string) text **)** + Set the entire text. #### insert_text_at_cursor - * void **[insert_text_at_cursor](#insert_text_at_cursor)** **(** [String](class_string) text **)** -\\ + * void **insert_text_at_cursor** **(** [String](class_string) text **)** + Insert a given text at the cursor position. #### get_line_count - * [int](class_int) **[get_line_count](#get_line_count)** **(** **)** const -\\ + * [int](class_int) **get_line_count** **(** **)** const + Return the amount of total lines in the text. #### get_text - * [String](class_string) **[get_text](#get_text)** **(** **)** -\\ + * [String](class_string) **get_text** **(** **)** + Return the whole text. #### get_line - * [String](class_string) **[get_line](#get_line)** **(** [int](class_int) arg0 **)** const -\\ + * [String](class_string) **get_line** **(** [int](class_int) arg0 **)** const + Return the text of a specific line. #### cursor_set_column - * void **[cursor_set_column](#cursor_set_column)** **(** [int](class_int) column **)** -\\ + * void **cursor_set_column** **(** [int](class_int) column **)** + Set the current column of the text editor. #### cursor_set_line - * void **[cursor_set_line](#cursor_set_line)** **(** [int](class_int) line **)** -\\ + * void **cursor_set_line** **(** [int](class_int) line **)** + Set the current line of the text editor. #### cursor_get_column - * [int](class_int) **[cursor_get_column](#cursor_get_column)** **(** **)** const -\\ + * [int](class_int) **cursor_get_column** **(** **)** const + Return the column the editing cursor is at. #### cursor_get_line - * [int](class_int) **[cursor_get_line](#cursor_get_line)** **(** **)** const -\\ + * [int](class_int) **cursor_get_line** **(** **)** const + Return the line the editing cursor is at. #### set_readonly - * void **[set_readonly](#set_readonly)** **(** [bool](class_bool) enable **)** -\\ + * void **set_readonly** **(** [bool](class_bool) enable **)** + Set the text editor as read-only. Text can be displayed but not edited. #### set_wrap - * void **[set_wrap](#set_wrap)** **(** [bool](class_bool) enable **)** -\\ + * void **set_wrap** **(** [bool](class_bool) enable **)** + Enable text wrapping when it goes beyond he edge of what is visible. #### set_max_chars - * void **[set_max_chars](#set_max_chars)** **(** [int](class_int) amount **)** -\\ + * void **set_max_chars** **(** [int](class_int) amount **)** + Set the maximum amount of characters editable. #### cut - * void **[cut](#cut)** **(** **)** -\\ + * void **cut** **(** **)** + Cut the current selection. #### copy - * void **[copy](#copy)** **(** **)** -\\ + * void **copy** **(** **)** + Copy the current selection. #### paste - * void **[paste](#paste)** **(** **)** -\\ + * void **paste** **(** **)** + Paste the current selection. #### select_all - * void **[select_all](#select_all)** **(** **)** -\\ + * void **select_all** **(** **)** + Select all the text. #### select - * void **[select](#select)** **(** [int](class_int) from_line, [int](class_int) from_column, [int](class_int) to_line, [int](class_int) to_column **)** -\\ + * void **select** **(** [int](class_int) from_line, [int](class_int) from_column, [int](class_int) to_line, [int](class_int) to_column **)** + Perform selection, from line/column to line/column. #### is_selection_active - * [bool](class_bool) **[is_selection_active](#is_selection_active)** **(** **)** const -\\ + * [bool](class_bool) **is_selection_active** **(** **)** const + Return true if the selection is active. #### get_selection_from_line - * [int](class_int) **[get_selection_from_line](#get_selection_from_line)** **(** **)** const -\\ + * [int](class_int) **get_selection_from_line** **(** **)** const + Return the selection begin line. #### get_selection_from_column - * [int](class_int) **[get_selection_from_column](#get_selection_from_column)** **(** **)** const -\\ + * [int](class_int) **get_selection_from_column** **(** **)** const + Return the selection begin column. #### get_selection_to_line - * [int](class_int) **[get_selection_to_line](#get_selection_to_line)** **(** **)** const -\\ + * [int](class_int) **get_selection_to_line** **(** **)** const + Return the selection end line. #### get_selection_to_column - * [int](class_int) **[get_selection_to_column](#get_selection_to_column)** **(** **)** const -\\ + * [int](class_int) **get_selection_to_column** **(** **)** const + Return the selection end column. #### get_selection_text - * [String](class_string) **[get_selection_text](#get_selection_text)** **(** **)** const -\\ + * [String](class_string) **get_selection_text** **(** **)** const + Return the text inside the selection. #### search - * [IntArray](class_intarray) **[search](#search)** **(** [String](class_string) flags, [int](class_int) from_line, [int](class_int) from_column, [int](class_int) to_line **)** const -\\ + * [IntArray](class_intarray) **search** **(** [String](class_string) flags, [int](class_int) from_line, [int](class_int) from_column, [int](class_int) to_line **)** const + Perform a search inside the text. Search flags can be specified in the SEARCH_* enum. #### undo - * void **[undo](#undo)** **(** **)** -\\ + * void **undo** **(** **)** + Perform undo operation. #### redo - * void **[redo](#redo)** **(** **)** -\\ + * void **redo** **(** **)** + Perform redo operation. #### clear_undo_history - * void **[clear_undo_history](#clear_undo_history)** **(** **)** -\\ + * void **clear_undo_history** **(** **)** + Clear the undo history. #### set_syntax_coloring - * void **[set_syntax_coloring](#set_syntax_coloring)** **(** [bool](class_bool) enable **)** -\\ + * void **set_syntax_coloring** **(** [bool](class_bool) enable **)** + Set to enable the syntax coloring. #### is_syntax_coloring_enabled - * [bool](class_bool) **[is_syntax_coloring_enabled](#is_syntax_coloring_enabled)** **(** **)** const -\\ + * [bool](class_bool) **is_syntax_coloring_enabled** **(** **)** const + Return true if the syntax coloring is enabled. #### add_keyword_color - * void **[add_keyword_color](#add_keyword_color)** **(** [String](class_string) keyword, [Color](class_color) color **)** -\\ + * void **add_keyword_color** **(** [String](class_string) keyword, [Color](class_color) color **)** + Add a keyword and it's color. #### add_color_region - * void **[add_color_region](#add_color_region)** **(** [String](class_string) begin_key, [String](class_string) end_key, [Color](class_color) color, [bool](class_bool) line_only=false **)** -\\ + * void **add_color_region** **(** [String](class_string) begin_key, [String](class_string) end_key, [Color](class_color) color, [bool](class_bool) line_only=false **)** + Add color region (given the delimiters) and it's colors. #### set_symbol_color - * void **[set_symbol_color](#set_symbol_color)** **(** [Color](class_color) color **)** -\\ + * void **set_symbol_color** **(** [Color](class_color) color **)** + Set the color for symbols. #### set_custom_bg_color - * void **[set_custom_bg_color](#set_custom_bg_color)** **(** [Color](class_color) color **)** -\\ + * void **set_custom_bg_color** **(** [Color](class_color) color **)** + Set a custom background color. A background color with alpha==0 disables this. #### clear_colors - * void **[clear_colors](#clear_colors)** **(** **)** -\\ + * void **clear_colors** **(** **)** + Clear all the syntax coloring information. diff --git a/class_texture.md b/class_texture.md index 1fab6c6..cca2e7d 100644 --- a/class_texture.md +++ b/class_texture.md @@ -28,36 +28,36 @@ A texture works by registering an image in the video hardware, which then can be ### Member Function Description #### get_width - * [int](class_int) **[get_width](#get_width)** **(** **)** const -\\ + * [int](class_int) **get_width** **(** **)** const + Return the texture width. #### get_height - * [int](class_int) **[get_height](#get_height)** **(** **)** const -\\ + * [int](class_int) **get_height** **(** **)** const + Return the texture height. #### get_size - * [Vector2](class_vector2) **[get_size](#get_size)** **(** **)** const -\\ + * [Vector2](class_vector2) **get_size** **(** **)** const + Return the texture size. #### get_rid - * [RID](class_rid) **[get_rid](#get_rid)** **(** **)** const -\\ + * [RID](class_rid) **get_rid** **(** **)** const + Return the texture RID as used in the [[visualserver|VisualServer]]. #### set_flags - * void **[set_flags](#set_flags)** **(** [int](class_int) flags **)** -\\ + * void **set_flags** **(** [int](class_int) flags **)** + Change the texture flags. #### get_flags - * [int](class_int) **[get_flags](#get_flags)** **(** **)** const -\\ + * [int](class_int) **get_flags** **(** **)** const + Return the current texture flags. #### draw - * void **[draw](#draw)** **(** [RID](class_rid) canvas_item, [Vector2](class_vector2) pos, [Color](class_color) modulate=Color(1,1,1,1) **)** const -\\ + * void **draw** **(** [RID](class_rid) canvas_item, [Vector2](class_vector2) pos, [Color](class_color) modulate=Color(1,1,1,1) **)** const + Draw the texture into a a [[visualserver|VisualServer]] canvas item. diff --git a/class_tilemap.md b/class_tilemap.md index 48d7203..aa65733 100644 --- a/class_tilemap.md +++ b/class_tilemap.md @@ -30,76 +30,76 @@ Node for 2D Tile-Based games. Tilemaps use a TileSet which contain a list of til ### Member Function Description #### set_tileset - * void **[set_tileset](#set_tileset)** **(** [TileSet](class_tileset) tileset **)** -\\ + * void **set_tileset** **(** [TileSet](class_tileset) tileset **)** + Set the current tileset. #### get_tileset - * [TileSet](class_tileset) **[get_tileset](#get_tileset)** **(** **)** const -\\ + * [TileSet](class_tileset) **get_tileset** **(** **)** const + Return the current tileset. #### set_cell_size - * void **[set_cell_size](#set_cell_size)** **(** [int](class_int) size **)** -\\ + * void **set_cell_size** **(** [int](class_int) size **)** + Set the cell size. #### get_cell_size - * [int](class_int) **[get_cell_size](#get_cell_size)** **(** **)** const -\\ + * [int](class_int) **get_cell_size** **(** **)** const + Return the cell size. #### set_quadrant_size - * void **[set_quadrant_size](#set_quadrant_size)** **(** [int](class_int) size **)** -\\ + * void **set_quadrant_size** **(** [int](class_int) size **)** + Set the quadrant size, this optimizes drawing by batching chunks of map at draw/cull time. #### get_quadrant_size - * [int](class_int) **[get_quadrant_size](#get_quadrant_size)** **(** **)** const -\\ + * [int](class_int) **get_quadrant_size** **(** **)** const + Return the quadrant size, this optimizes drawing by batching chunks of map at draw/cull time. #### set_center_x - * void **[set_center_x](#set_center_x)** **(** [bool](class_bool) enable **)** -\\ + * void **set_center_x** **(** [bool](class_bool) enable **)** + Set tiles to be centered in x coordinate. (by default this is false and they are drawn from upper left cell corner). #### get_center_x - * [bool](class_bool) **[get_center_x](#get_center_x)** **(** **)** const -\\ + * [bool](class_bool) **get_center_x** **(** **)** const + 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). #### set_center_y - * void **[set_center_y](#set_center_y)** **(** [bool](class_bool) enable **)** -\\ + * void **set_center_y** **(** [bool](class_bool) enable **)** + Set tiles to be centered in y coordinate. (by default this is false and they are drawn from upper left cell corner). #### get_center_y - * [bool](class_bool) **[get_center_y](#get_center_y)** **(** **)** const -\\ + * [bool](class_bool) **get_center_y** **(** **)** const + 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). #### set_cell - * void **[set_cell](#set_cell)** **(** [int](class_int) x, [int](class_int) y, [int](class_int) tile, [bool](class_bool) flip_x=false, [bool](class_bool) flip_y=false **)** -\\ + * void **set_cell** **(** [int](class_int) x, [int](class_int) y, [int](class_int) tile, [bool](class_bool) flip_x=false, [bool](class_bool) flip_y=false **)** + Set the contents of a cell. Cells can be optionally flipped in y or x. #### get_cell - * [int](class_int) **[get_cell](#get_cell)** **(** [int](class_int) x, [int](class_int) y **)** const -\\ + * [int](class_int) **get_cell** **(** [int](class_int) x, [int](class_int) y **)** const + Return the contents of a cell. #### is_cell_x_flipped - * [bool](class_bool) **[is_cell_x_flipped](#is_cell_x_flipped)** **(** [int](class_int) x, [int](class_int) y **)** const -\\ + * [bool](class_bool) **is_cell_x_flipped** **(** [int](class_int) x, [int](class_int) y **)** const + Return if a given cell is flipped in x axis. #### is_cell_y_flipped - * [bool](class_bool) **[is_cell_y_flipped](#is_cell_y_flipped)** **(** [int](class_int) x, [int](class_int) y **)** const -\\ + * [bool](class_bool) **is_cell_y_flipped** **(** [int](class_int) x, [int](class_int) y **)** const + Return if a given cell is flipped in y axis. #### clear - * void **[clear](#clear)** **(** **)** -\\ + * void **clear** **(** **)** + Clear all cells. diff --git a/class_tileset.md b/class_tileset.md index 9466c04..3db90b1 100644 --- a/class_tileset.md +++ b/class_tileset.md @@ -28,76 +28,76 @@ A TileSet is a library of tiles for a [[tilemap|TileMap]]. It contains a list of ### Member Function Description #### create_tile - * void **[create_tile](#create_tile)** **(** [int](class_int) id **)** -\\ + * void **create_tile** **(** [int](class_int) id **)** + Create a new tile, the ID must be specified. #### tile_set_name - * void **[tile_set_name](#tile_set_name)** **(** [int](class_int) id, [String](class_string) name **)** -\\ + * void **tile_set_name** **(** [int](class_int) id, [String](class_string) name **)** + Set the name of a tile, for decriptive purposes. #### tile_get_name - * [String](class_string) **[tile_get_name](#tile_get_name)** **(** [int](class_int) id **)** const -\\ + * [String](class_string) **tile_get_name** **(** [int](class_int) id **)** const + Return the name of a tile, for decriptive purposes. #### tile_set_texture - * void **[tile_set_texture](#tile_set_texture)** **(** [int](class_int) id, [Texture](class_texture) texture **)** -\\ + * void **tile_set_texture** **(** [int](class_int) id, [Texture](class_texture) texture **)** + Set the texture of the tile. #### tile_get_texture - * [Texture](class_texture) **[tile_get_texture](#tile_get_texture)** **(** [int](class_int) id **)** const -\\ + * [Texture](class_texture) **tile_get_texture** **(** [int](class_int) id **)** const + Return the texture of the tile. #### tile_set_offset - * void **[tile_set_offset](#tile_set_offset)** **(** [int](class_int) id, [Vector2](class_vector2) offset **)** -\\ + * void **tile_set_offset** **(** [int](class_int) id, [Vector2](class_vector2) offset **)** + Set the offset to draw the tile. #### tile_get_offset - * [Vector2](class_vector2) **[tile_get_offset](#tile_get_offset)** **(** [int](class_int) id **)** const -\\ + * [Vector2](class_vector2) **tile_get_offset** **(** [int](class_int) id **)** const + Return the offset to draw the tile. #### tile_set_region - * void **[tile_set_region](#tile_set_region)** **(** [int](class_int) id, [Rect2](class_rect2) region **)** -\\ + * void **tile_set_region** **(** [int](class_int) id, [Rect2](class_rect2) region **)** + Set the tile sub-region in the texture. This is common in texture atlases. #### tile_get_region - * [Rect2](class_rect2) **[tile_get_region](#tile_get_region)** **(** [int](class_int) id **)** const -\\ + * [Rect2](class_rect2) **tile_get_region** **(** [int](class_int) id **)** const + Return the tile sub-region in the texture. This is common in texture atlases. #### tile_set_shape - * void **[tile_set_shape](#tile_set_shape)** **(** [int](class_int) id, [Shape2D](class_shape2d) shape **)** -\\ + * void **tile_set_shape** **(** [int](class_int) id, [Shape2D](class_shape2d) shape **)** + Set a shape for the tile, enabling physics to collide it. #### tile_get_shape - * [Shape2D](class_shape2d) **[tile_get_shape](#tile_get_shape)** **(** [int](class_int) id **)** const -\\ + * [Shape2D](class_shape2d) **tile_get_shape** **(** [int](class_int) id **)** const + Return the shape of the tile. #### remove_tile - * void **[remove_tile](#remove_tile)** **(** [int](class_int) id **)** -\\ + * void **remove_tile** **(** [int](class_int) id **)** + Remove a tile, by integer id. #### clear - * void **[clear](#clear)** **(** **)** -\\ + * void **clear** **(** **)** + Clear all tiles. #### get_last_unused_tile_id - * [int](class_int) **[get_last_unused_tile_id](#get_last_unused_tile_id)** **(** **)** const -\\ + * [int](class_int) **get_last_unused_tile_id** **(** **)** const + Find an empty id for creating a new tile. #### find_tile_by_name - * [int](class_int) **[find_tile_by_name](#find_tile_by_name)** **(** [String](class_string) name **)** const -\\ + * [int](class_int) **find_tile_by_name** **(** [String](class_string) name **)** const + Find the first tile with the given name. diff --git a/class_timer.md b/class_timer.md index 8f61021..de84453 100644 --- a/class_timer.md +++ b/class_timer.md @@ -23,46 +23,46 @@ Timer node. This is a simple node that will emit a timeout callback when the tim ### Member Function Description #### set_wait_time - * void **[set_wait_time](#set_wait_time)** **(** [real](class_real) time_sec **)** -\\ + * void **set_wait_time** **(** [real](class_real) time_sec **)** + Set wait time. When the time is over, it will emit timeout signal. #### get_wait_time - * [real](class_real) **[get_wait_time](#get_wait_time)** **(** **)** const -\\ + * [real](class_real) **get_wait_time** **(** **)** const + Return the wait time. When the time is over, it will emit timeout signal. #### set_one_shot - * void **[set_one_shot](#set_one_shot)** **(** [bool](class_bool) enable **)** -\\ + * void **set_one_shot** **(** [bool](class_bool) enable **)** + Set as one-shot. If true, timer will stop after timeout, otherwise it will automatically restart. #### is_one_shot - * [bool](class_bool) **[is_one_shot](#is_one_shot)** **(** **)** const -\\ + * [bool](class_bool) **is_one_shot** **(** **)** const + Return true if is set as one-shot. If true, timer will stop after timeout, otherwise it will automatically restart. #### set_autostart - * void **[set_autostart](#set_autostart)** **(** [bool](class_bool) enable **)** -\\ + * void **set_autostart** **(** [bool](class_bool) enable **)** + Set to automatically start when entering the scene. #### has_autostart - * [bool](class_bool) **[has_autostart](#has_autostart)** **(** **)** const -\\ + * [bool](class_bool) **has_autostart** **(** **)** const + Return true if set to automatically start when entering the scene. #### start - * void **[start](#start)** **(** **)** -\\ + * void **start** **(** **)** + Start the timer. #### stop - * void **[stop](#stop)** **(** **)** -\\ + * void **stop** **(** **)** + Stop (cancel) the timer. #### get_time_left - * [real](class_real) **[get_time_left](#get_time_left)** **(** **)** const -\\ + * [real](class_real) **get_time_left** **(** **)** const + Return the time left for timeout if the timer is active. diff --git a/class_transform.md b/class_transform.md index 2925a4c..378c796 100644 --- a/class_transform.md +++ b/class_transform.md @@ -29,16 +29,16 @@ Transform is used to store transformations, including translations. It consists ### Member Function Description #### inverse - * [Transform](class_transform) **[inverse](#inverse)** **(** **)** -\\ + * [Transform](class_transform) **inverse** **(** **)** + Returns the inverse of the transform. #### xform - * var **[xform](#xform)** **(** var v **)** -\\ + * var **xform** **(** var v **)** + Transforms vector "v" by this transform. #### xform_inv - * var **[xform_inv](#xform_inv)** **(** var v **)** -\\ + * var **xform_inv** **(** var v **)** + Inverse-transforms vector "v" by this transform. diff --git a/class_translation.md b/class_translation.md index 58c832f..fd7cbdc 100644 --- a/class_translation.md +++ b/class_translation.md @@ -17,31 +17,31 @@ Translations are resources that can be loaded/unloaded on demand. They map a str ### Member Function Description #### set_locale - * void **[set_locale](#set_locale)** **(** [String](class_string) locale **)** -\\ + * void **set_locale** **(** [String](class_string) locale **)** + Set the locale of the translation. #### get_locale - * [String](class_string) **[get_locale](#get_locale)** **(** **)** const -\\ + * [String](class_string) **get_locale** **(** **)** const + Return the locale of the translation. #### add_message - * void **[add_message](#add_message)** **(** [String](class_string) src_message, [String](class_string) xlated_message **)** -\\ + * void **add_message** **(** [String](class_string) src_message, [String](class_string) xlated_message **)** + Add a message for translation. #### get_message - * [String](class_string) **[get_message](#get_message)** **(** [String](class_string) src_message **)** const -\\ + * [String](class_string) **get_message** **(** [String](class_string) src_message **)** const + Return a message for translation. #### erase_message - * void **[erase_message](#erase_message)** **(** [String](class_string) src_message **)** -\\ + * void **erase_message** **(** [String](class_string) src_message **)** + Erase a message. #### get_message_list - * [StringArray](class_stringarray) **[get_message_list](#get_message_list)** **(** **)** const -\\ + * [StringArray](class_stringarray) **get_message_list** **(** **)** const + Return all the messages (keys). diff --git a/class_vector2.md b/class_vector2.md index 248bf88..31a96ee 100644 --- a/class_vector2.md +++ b/class_vector2.md @@ -30,31 +30,31 @@ Vector used for 2D Math. ### Member Function Description #### distance_to - * [real](class_real) **[distance_to](#distance_to)** **(** [Vector2](class_vector2) to **)** -\\ + * [real](class_real) **distance_to** **(** [Vector2](class_vector2) to **)** + Returns the distance to vector "b". #### dot - * [real](class_real) **[dot](#dot)** **(** [Vector2](class_vector2) with **)** -\\ + * [real](class_real) **dot** **(** [Vector2](class_vector2) with **)** + Returns the dot product with vector "b". #### floor - * [Vector2](class_vector2) **[floor](#floor)** **(** **)** -\\ + * [Vector2](class_vector2) **floor** **(** **)** + Remove the fractional part of x and y. #### length - * [real](class_real) **[length](#length)** **(** **)** -\\ + * [real](class_real) **length** **(** **)** + Returns the length of the vector. #### linear_interpolate - * [Vector2](class_vector2) **[linear_interpolate](#linear_interpolate)** **(** [Vector2](class_vector2) b, [real](class_real) t **)** -\\ + * [Vector2](class_vector2) **linear_interpolate** **(** [Vector2](class_vector2) b, [real](class_real) t **)** + Returns the result of the linear interpolation between this vector and "b", by amount "i". #### normalized - * [Vector2](class_vector2) **[normalized](#normalized)** **(** **)** -\\ + * [Vector2](class_vector2) **normalized** **(** **)** + Returns a normalized vector to unit length. diff --git a/class_vector3.md b/class_vector3.md index dccdc16..14b5d9a 100644 --- a/class_vector3.md +++ b/class_vector3.md @@ -37,56 +37,56 @@ Vector3 is one of the core classes of the engine, and includes several built-in ### Member Function Description #### cross - * [Vector3](class_vector3) **[cross](#cross)** **(** [Vector3](class_vector3) b **)** -\\ + * [Vector3](class_vector3) **cross** **(** [Vector3](class_vector3) b **)** + Return the cross product with b. #### cubic_interpolate - * [Vector3](class_vector3) **[cubic_interpolate](#cubic_interpolate)** **(** [Vector3](class_vector3) b, [Vector3](class_vector3) pre_a, [Vector3](class_vector3) post_b, [real](class_real) t **)** -\\ + * [Vector3](class_vector3) **cubic_interpolate** **(** [Vector3](class_vector3) b, [Vector3](class_vector3) pre_a, [Vector3](class_vector3) post_b, [real](class_real) t **)** + Perform a cubic interpolation between vectors a,b,c,d (b is current), by the given amount (i). #### distance_squared_to - * [real](class_real) **[distance_squared_to](#distance_squared_to)** **(** [Vector3](class_vector3) b **)** -\\ + * [real](class_real) **distance_squared_to** **(** [Vector3](class_vector3) b **)** + Return the squared distance (distance minus the last square root) to b. #### distance_to - * [real](class_real) **[distance_to](#distance_to)** **(** [Vector3](class_vector3) b **)** -\\ + * [real](class_real) **distance_to** **(** [Vector3](class_vector3) b **)** + Return the distance to b. #### dot - * [real](class_real) **[dot](#dot)** **(** [Vector3](class_vector3) b **)** -\\ + * [real](class_real) **dot** **(** [Vector3](class_vector3) b **)** + Return the dot product with b. #### inverse - * [Vector3](class_vector3) **[inverse](#inverse)** **(** **)** -\\ + * [Vector3](class_vector3) **inverse** **(** **)** + Returns the inverse of the vector. this is the same as Vector3( 1.0 / v.x, 1.0 / v.y, 1.0 / v.z ) #### length - * [real](class_real) **[length](#length)** **(** **)** -\\ + * [real](class_real) **length** **(** **)** + Return the length of the vector. #### length_squared - * [real](class_real) **[length_squared](#length_squared)** **(** **)** -\\ + * [real](class_real) **length_squared** **(** **)** + Return the length of the vector, without the square root step. #### linear_interpolate - * [Vector3](class_vector3) **[linear_interpolate](#linear_interpolate)** **(** [Vector3](class_vector3) b, [real](class_real) t **)** -\\ + * [Vector3](class_vector3) **linear_interpolate** **(** [Vector3](class_vector3) b, [real](class_real) t **)** + Linearly interpolates the vector to a given one (b), by the given amount (i) #### normalized - * [Vector3](class_vector3) **[normalized](#normalized)** **(** **)** -\\ + * [Vector3](class_vector3) **normalized** **(** **)** + Return a copy of the normalized vector to unit length. This is the same as v / v.length() #### snapped - * [Vector3](class_vector3) **[snapped](#snapped)** **(** [real](class_real) by **)** -\\ + * [Vector3](class_vector3) **snapped** **(** [real](class_real) by **)** + Return a copy of the vector, snapped to the lowest neared multiple. diff --git a/class_viewport.md b/class_viewport.md index 6a9bdf7..cba5d33 100644 --- a/class_viewport.md +++ b/class_viewport.md @@ -49,31 +49,31 @@ A Viewport creates a different view into the screen, or a sub-view inside anothe ### Member Function Description #### set_rect - * void **[set_rect](#set_rect)** **(** [Rect2](class_rect2) rect **)** -\\ + * void **set_rect** **(** [Rect2](class_rect2) rect **)** + Set the viewport rect. If the viewport is child of a control, it will use the same as the parent. #### get_rect - * [Rect2](class_rect2) **[get_rect](#get_rect)** **(** **)** const -\\ + * [Rect2](class_rect2) **get_rect** **(** **)** const + Return the viewport rect. If the viewport is child of a control, it will use the same as the parent, otherwise if the rect is empty, the viewport will use all the allowed space. #### get_visible_rect - * [Rect2](class_rect2) **[get_visible_rect](#get_visible_rect)** **(** **)** const -\\ + * [Rect2](class_rect2) **get_visible_rect** **(** **)** const + Return the final, visuble rect in global screen coordinates. #### set_transparent_background - * void **[set_transparent_background](#set_transparent_background)** **(** [bool](class_bool) enable **)** -\\ + * void **set_transparent_background** **(** [bool](class_bool) enable **)** + Keep whathver the parent viewport has drawn #### has_transparent_background - * [bool](class_bool) **[has_transparent_background](#has_transparent_background)** **(** **)** const -\\ + * [bool](class_bool) **has_transparent_background** **(** **)** const + If this viewport is a child of another viewport, keep the previously drawn background visible. #### get_viewport - * [RID](class_rid) **[get_viewport](#get_viewport)** **(** **)** const -\\ + * [RID](class_rid) **get_viewport** **(** **)** const + Get the viewport RID from the visual server. diff --git a/class_windowdialog.md b/class_windowdialog.md index 0bb8496..9ed5dd5 100644 --- a/class_windowdialog.md +++ b/class_windowdialog.md @@ -14,16 +14,16 @@ Windowdialog is the base class for all window-based dialogs. It's a by-default t ### Member Function Description #### set_title - * void **[set_title](#set_title)** **(** [String](class_string) title **)** -\\ + * void **set_title** **(** [String](class_string) title **)** + Set the title of the window. #### get_title - * [String](class_string) **[get_title](#get_title)** **(** **)** const -\\ + * [String](class_string) **get_title** **(** **)** const + Return the title of the window. #### get_close_button - * [TextureButton](class_texturebutton) **[get_close_button](#get_close_button)** **(** **)** -\\ + * [TextureButton](class_texturebutton) **get_close_button** **(** **)** + Return the close [[texturebutton|TextureButton]].