diff --git a/class_@gdscript.md b/class_@gdscript.md index 599a911..701fb58 100644 --- a/class_@gdscript.md +++ b/class_@gdscript.md @@ -1,4 +1,5 @@ # @GDScript +####**Category:** Core ### Brief Description Built-in GDScript functions. diff --git a/class_@global scope.md b/class_@global scope.md index 60eaa3c..24c1948 100644 --- a/class_@global scope.md +++ b/class_@global scope.md @@ -1,4 +1,5 @@ # @Global Scope +####**Category:** Core ### Brief Description Global scope constants and variables. diff --git a/class_@multiscript.md b/class_@multiscript.md index 680f14b..33f52ef 100644 --- a/class_@multiscript.md +++ b/class_@multiscript.md @@ -1,4 +1,5 @@ # @MultiScript +####**Category:** Core ### Brief Description diff --git a/class_aabb.md b/class_aabb.md index 3771cab..d331fab 100644 --- a/class_aabb.md +++ b/class_aabb.md @@ -1,4 +1,5 @@ # AABB +####**Category:** Built-In Types ### Brief Description Axis-Aligned Bounding Box. @@ -40,58 +41,58 @@ AABB provides an 3D Axis-Aligned Bounding Box. It consists of a #### encloses * [bool](class_bool) **`encloses`** **(** [AABB](class_aabb) with **)** -Return true if this [[aabb|AABB]] completely encloses another +Return true if this [AABB](class_aabb) completely encloses another one. #### expand * [AABB](class_aabb) **`expand`** **(** [Vector3](class_vector3) to_point **)** -Return this [[aabb|AABB]] expanded to include a given +Return this [AABB](class_aabb) expanded to include a given point. #### get_area * [real](class_real) **`get_area`** **(** **)** -Get the area inside the [[aabb|AABB]] +Get the area inside the [AABB](class_aabb) #### get_endpoint * [Vector3](class_vector3) **`get_endpoint`** **(** [int](class_int) idx **)** -Get the position of the 8 endpoints of the [[aabb|AABB]] in space. +Get the position of the 8 endpoints of the [AABB](class_aabb) in space. #### get_longest_axis * [Vector3](class_vector3) **`get_longest_axis`** **(** **)** -Return the normalized longest axis of the [[aabb|AABB]] +Return the normalized longest axis of the [AABB](class_aabb) #### 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). +Return the index of the longest axis of the [AABB](class_aabb) + (according to [Vector3](class_vector3)::AXIS* enum). #### get_longest_axis_size * [real](class_real) **`get_longest_axis_size`** **(** **)** Return the scalar length of the longest axis of the - [[aabb|AABB]]. + [AABB](class_aabb). #### get_shortest_axis * [Vector3](class_vector3) **`get_shortest_axis`** **(** **)** -Return the normalized shortest axis of the [[aabb|AABB]] +Return the normalized shortest axis of the [AABB](class_aabb) #### 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). +Return the index of the shortest axis of the [AABB](class_aabb) + (according to [Vector3](class_vector3)::AXIS* enum). #### get_shortest_axis_size * [real](class_real) **`get_shortest_axis_size`** **(** **)** Return the scalar length of the shortest axis of the - [[aabb|AABB]]. + [AABB](class_aabb). #### get_support * [Vector3](class_vector3) **`get_support`** **(** [Vector3](class_vector3) dir **)** @@ -108,28 +109,28 @@ Return a copy of the AABB grown a given a mount of #### has_no_area * [bool](class_bool) **`has_no_area`** **(** **)** -Return true if the [[aabb|AABB]] is flat or empty. +Return true if the [AABB](class_aabb) is flat or empty. #### has_no_surface * [bool](class_bool) **`has_no_surface`** **(** **)** -Return true if the [[aabb|AABB]] is empty. +Return true if the [AABB](class_aabb) is empty. #### has_point * [bool](class_bool) **`has_point`** **(** [Vector3](class_vector3) point **)** -Return true if the [[aabb|AABB]] contains a point. +Return true if the [AABB](class_aabb) contains a point. #### intersection * [AABB](class_aabb) **`intersection`** **(** [AABB](class_aabb) with **)** -Return the intersection between two [[aabb|AABB]]s. An +Return the intersection between two [AABB](class_aabb)s. An empty AABB (size 0,0,0) is returned on failure. #### intersects * [bool](class_bool) **`intersects`** **(** [AABB](class_aabb) with **)** -Return true if the [[aabb|AABB]] overlaps with another. +Return true if the [AABB](class_aabb) overlaps with another. #### intersects_plane * [bool](class_bool) **`intersects_plane`** **(** [Plane](class_plane) plane **)** @@ -139,7 +140,7 @@ Return true if the AABB is at both sides of a plane. #### merge * [AABB](class_aabb) **`merge`** **(** [AABB](class_aabb) with **)** -Combine this [[aabb|AABB]] with another one, a larger one +Combine this [AABB](class_aabb) with another one, a larger one is returned that contains both. #### AABB diff --git a/class_acceptdialog.md b/class_acceptdialog.md index 7974a07..1c363f9 100644 --- a/class_acceptdialog.md +++ b/class_acceptdialog.md @@ -1,5 +1,6 @@ # AcceptDialog -#####**Inherits:** [WindowDialog](class_windowdialog) +####**Inherits:** [WindowDialog](class_windowdialog) +####**Category:** Core ### Brief Description Base dialog for user notification. @@ -50,7 +51,7 @@ Return true if the dialog will be hidden when #### register_text_enter * void **`register_text_enter`** **(** [Object](class_object) line_edit **)** -Register a [[lineedit|LineEdit]] in the dialog. When the enter +Register a [LineEdit](class_lineedit) in the dialog. When the enter key is pressed, the dialog will be accepted. #### set_text diff --git a/class_animatedsprite.md b/class_animatedsprite.md index 7e0ae80..166efa0 100644 --- a/class_animatedsprite.md +++ b/class_animatedsprite.md @@ -1,5 +1,6 @@ # AnimatedSprite -#####**Inherits:** [Node2D](class_node2d) +####**Inherits:** [Node2D](class_node2d) +####**Category:** Core ### Brief Description diff --git a/class_animation.md b/class_animation.md index 54839f4..c4c530b 100644 --- a/class_animation.md +++ b/class_animation.md @@ -1,5 +1,6 @@ # Animation -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description Contains data used to animate everything in the engine. @@ -51,8 +52,8 @@ Contains data used to animate everything in the engine. * **INTERPOLATION_CUBIC** = **2** - Cubic interpolation. ### Description -An Animation resource contains data used to animate everything in the engine. Animations are divided into tracks, and each track must be linked to a node. The state of that node can be changed through time, by adding timed keys (events) to the track. \\ - Animations are just data containers, and must be added to odes such as an [[animationplayer|AnimationPlayer]] or [[animationtreeplayer|AnimationTreePlayer]] to be played back. +An Animation resource contains data used to animate everything in the engine. Animations are divided into tracks, and each track must be linked to a node. The state of that node can be changed through time, by adding timed keys (events) to the track. + Animations are just data containers, and must be added to odes such as an [AnimationPlayer](class_animationplayer) or [AnimationTreePlayer](class_animationtreeplayer) to be played back. ### Member Function Description @@ -79,7 +80,7 @@ Get the type of a track. #### track_get_path * [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]] +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`** **(** [int](class_int) idx, [NodePath](class_nodepath) path **)** @@ -166,7 +167,7 @@ Return the interpolation type of a given track, from the INTERPOLATION_* enum. #### transform_track_interpolate * [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]]). +Return the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position ([Vector3](class_vector3)), rotation ([Quat](class_quat)) and scale ([Vector3](class_vector3)). #### value_track_set_continuous * void **`value_track_set_continuous`** **(** [int](class_int) idx, [bool](class_bool) continuous **)** diff --git a/class_animationplayer.md b/class_animationplayer.md index 0fb75ed..3b3c7ed 100644 --- a/class_animationplayer.md +++ b/class_animationplayer.md @@ -1,5 +1,6 @@ # AnimationPlayer -#####**Inherits:** [Node](class_node) +####**Inherits:** [Node](class_node) +####**Category:** Core ### Brief Description Container and player of [Animaton] resources. @@ -49,7 +50,7 @@ Container and player of [Animaton] resources. * **ANIMATION_PROCESS_IDLE** = **1** ### Description -An animation player is used for general purpose playback of [[animation|Animation]] resources. It contains a dictionary of animations (referenced by name) and custom blend times between their transitions. Additionally, animations can be played and blended in diferent channels. +An animation player is used for general purpose playback of [Animation](class_animation) resources. It contains a dictionary of animations (referenced by name) and custom blend times between their transitions. Additionally, animations can be played and blended in diferent channels. ### Member Function Description @@ -71,12 +72,12 @@ Rename an existing animation. #### has_animation * [bool](class_bool) **`has_animation`** **(** [String](class_string) name **)** const -Request wether an [[animation|Animation]] name exist within the player. +Request wether an [Animation](class_animation) name exist within the player. #### get_animation * [Animation](class_animation) **`get_animation`** **(** [String](class_string) name **)** const -Get an [[animation|Animation]] resource by requesting a name. +Get an [Animation](class_animation) resource by requesting a name. #### get_animation_list * [StringArray](class_stringarray) **`get_animation_list`** **(** **)** const @@ -141,12 +142,12 @@ Return true if the player is active. #### set_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). +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`** **(** **)** const -Get the speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is //1// (no scaling). +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`** **(** [String](class_string) name **)** @@ -186,4 +187,4 @@ Set the mode in which the animation player processes. By default, it processes o #### get_animation_process_mode * [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]]. +Return the mode in which the animation player processes. See [`set_animation_process_mode`](#set_animation_process_mode). diff --git a/class_animationtreeplayer.md b/class_animationtreeplayer.md index d0dd953..6c27d26 100644 --- a/class_animationtreeplayer.md +++ b/class_animationtreeplayer.md @@ -1,5 +1,6 @@ # AnimationTreePlayer -#####**Inherits:** [Node](class_node) +####**Inherits:** [Node](class_node) +####**Category:** Core ### Brief Description diff --git a/class_area.md b/class_area.md index 86138f5..9ebbad5 100644 --- a/class_area.md +++ b/class_area.md @@ -1,5 +1,6 @@ # Area -#####**Inherits:** [CollisionObject](class_collisionobject) +####**Inherits:** [CollisionObject](class_collisionobject) +####**Category:** Core ### Brief Description diff --git a/class_area2d.md b/class_area2d.md index e74e293..e7ebb59 100644 --- a/class_area2d.md +++ b/class_area2d.md @@ -1,5 +1,6 @@ # Area2D -#####**Inherits:** [CollisionObject2D](class_collisionobject2d) +####**Inherits:** [CollisionObject2D](class_collisionobject2d) +####**Category:** Core ### Brief Description General purpose area detection and influence for 2D Phisics. diff --git a/class_array.md b/class_array.md index 2080f07..8829998 100644 --- a/class_array.md +++ b/class_array.md @@ -1,4 +1,5 @@ # Array +####**Category:** Built-In Types ### Brief Description Generic array datatype. @@ -74,34 +75,34 @@ Return the amount of elements in the array. #### Array * void **`Array`** **(** [RawArray](class_rawarray) from **)** -Construct an array from a [[rawarray|RawArray]]. +Construct an array from a [RawArray](class_rawarray). #### Array * void **`Array`** **(** [IntArray](class_intarray) from **)** -Construct an array from a [[rawarray|RawArray]]. +Construct an array from a [RawArray](class_rawarray). #### Array * void **`Array`** **(** [RealArray](class_realarray) from **)** -Construct an array from a [[rawarray|RawArray]]. +Construct an array from a [RawArray](class_rawarray). #### Array * void **`Array`** **(** [StringArray](class_stringarray) from **)** -Construct an array from a [[rawarray|RawArray]]. +Construct an array from a [RawArray](class_rawarray). #### Array * void **`Array`** **(** [Vector2Array](class_vector2array) from **)** -Construct an array from a [[rawarray|RawArray]]. +Construct an array from a [RawArray](class_rawarray). #### Array * void **`Array`** **(** [Vector3Array](class_vector3array) from **)** -Construct an array from a [[rawarray|RawArray]]. +Construct an array from a [RawArray](class_rawarray). #### Array * void **`Array`** **(** [ColorArray](class_colorarray) from **)** -Construct an array from a [[rawarray|RawArray]]. +Construct an array from a [RawArray](class_rawarray). diff --git a/class_atlastexture.md b/class_atlastexture.md index 59ffcfc..5f44815 100644 --- a/class_atlastexture.md +++ b/class_atlastexture.md @@ -1,5 +1,6 @@ # AtlasTexture -#####**Inherits:** [Texture](class_texture) +####**Inherits:** [Texture](class_texture) +####**Category:** Core ### Brief Description diff --git a/class_audioserver.md b/class_audioserver.md index d866fad..7f1cc9a 100644 --- a/class_audioserver.md +++ b/class_audioserver.md @@ -1,5 +1,6 @@ # AudioServer -#####**Inherits:** [Object](class_object) +####**Inherits:** [Object](class_object) +####**Category:** Core ### Brief Description Server interface for low level audio access. @@ -78,7 +79,7 @@ AudioServer is a low level server interface for audio access. It is"#10;"#9;in c #### sample_create * [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. +Create an audio sample, return a [RID](class_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`** **(** [RID](class_rid) sample, [String](class_string) description **)** @@ -143,27 +144,27 @@ Return the loop format for a sample, as a value from"#10;"#9;"#9;"#9;the SAMPLE_ #### sample_set_loop_begin * 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]]. +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`** **(** [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]]. +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`** **(** [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]]. +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`** **(** [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]]. +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`** **(** **)** -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]]. +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`** **(** [RID](class_rid) voice, [RID](class_rid) sample **)** @@ -263,7 +264,7 @@ Return the current mix rate for a given voice. #### voice_is_positional * [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]]. +Return wether the current voice is positional. See"#10;"#9;"#9;"#9;[`voice_set_positional`](#voice_set_positional). #### voice_stop * void **`voice_stop`** **(** [RID](class_rid) voice **)** @@ -273,7 +274,7 @@ Stop a given voice. #### free * void **`free`** **(** [RID](class_rid) rid **)** -Free a [[rid|RID]] resource. +Free a [RID](class_rid) resource. #### set_stream_global_volume_scale * void **`set_stream_global_volume_scale`** **(** [real](class_real) scale **)** diff --git a/class_audioserversw.md b/class_audioserversw.md index 3b539d7..e89ec3c 100644 --- a/class_audioserversw.md +++ b/class_audioserversw.md @@ -1,5 +1,6 @@ # AudioServerSW -#####**Inherits:** [AudioServer](class_audioserver) +####**Inherits:** [AudioServer](class_audioserver) +####**Category:** Core ### Brief Description diff --git a/class_audiostream.md b/class_audiostream.md index 92fd24b..4a3a18b 100644 --- a/class_audiostream.md +++ b/class_audiostream.md @@ -1,5 +1,6 @@ # AudioStream -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description Base class for audio streams. @@ -24,7 +25,7 @@ Base class for audio streams. * **UPDATE_THREAD** = **2** - Stream is updated on its own thread. ### Description -Base class for audio streams. Audio streams are used for music"#10;"#9;playback, or other types of streamed sounds that don't fit or"#10;"#9;requiere more flexibility than a [[sample|Sample]]. +Base class for audio streams. Audio streams are used for music"#10;"#9;playback, or other types of streamed sounds that don't fit or"#10;"#9;requiere more flexibility than a [Sample](class_sample). ### Member Function Description @@ -51,7 +52,7 @@ Set the loop hint for the audio stream playback. if"#10;"#9;"#9;"#9;true, audio #### has_loop * [bool](class_bool) **`has_loop`** **(** **)** const -Return wether the audio stream loops. See [[#set_loop|set_loop]] +Return wether the audio stream loops. See [`set_loop`](#set_loop) #### get_stream_name * [String](class_string) **`get_stream_name`** **(** **)** const diff --git a/class_audiostreamgibberish.md b/class_audiostreamgibberish.md index 94216b6..5d7be52 100644 --- a/class_audiostreamgibberish.md +++ b/class_audiostreamgibberish.md @@ -1,5 +1,6 @@ # AudioStreamGibberish -#####**Inherits:** [AudioStream](class_audiostream) +####**Inherits:** [AudioStream](class_audiostream) +####**Category:** Core ### Brief Description Simple gibberish speech stream playback. diff --git a/class_audiostreammpc.md b/class_audiostreammpc.md index fb3e4ab..434e7e0 100644 --- a/class_audiostreammpc.md +++ b/class_audiostreammpc.md @@ -1,5 +1,6 @@ # AudioStreamMPC -#####**Inherits:** [AudioStreamResampled](class_audiostreamresampled) +####**Inherits:** [AudioStreamResampled](class_audiostreamresampled) +####**Category:** Core ### Brief Description MusePack audio stream driver. diff --git a/class_audiostreamoggvorbis.md b/class_audiostreamoggvorbis.md index 2476253..08c68cd 100644 --- a/class_audiostreamoggvorbis.md +++ b/class_audiostreamoggvorbis.md @@ -1,5 +1,6 @@ # AudioStreamOGGVorbis -#####**Inherits:** [AudioStreamResampled](class_audiostreamresampled) +####**Inherits:** [AudioStreamResampled](class_audiostreamresampled) +####**Category:** Core ### Brief Description OGG Vorbis audio stream driver. diff --git a/class_audiostreamresampled.md b/class_audiostreamresampled.md index 3338925..da24bc0 100644 --- a/class_audiostreamresampled.md +++ b/class_audiostreamresampled.md @@ -1,5 +1,6 @@ # AudioStreamResampled -#####**Inherits:** [AudioStream](class_audiostream) +####**Inherits:** [AudioStream](class_audiostream) +####**Category:** Core ### Brief Description Base class for resampled audio streams. diff --git a/class_audiostreamspeex.md b/class_audiostreamspeex.md index f93b117..29d139f 100644 --- a/class_audiostreamspeex.md +++ b/class_audiostreamspeex.md @@ -1,5 +1,6 @@ # AudioStreamSpeex -#####**Inherits:** [AudioStreamResampled](class_audiostreamresampled) +####**Inherits:** [AudioStreamResampled](class_audiostreamresampled) +####**Category:** Core ### Brief Description Speex audio stream driver. diff --git a/class_basebutton.md b/class_basebutton.md index d9196fe..d65db24 100644 --- a/class_basebutton.md +++ b/class_basebutton.md @@ -1,5 +1,6 @@ # BaseButton -#####**Inherits:** [Control](class_control) +####**Inherits:** [Control](class_control) +####**Category:** Core ### Brief Description Provides a base class for different kinds of buttons. @@ -41,7 +42,7 @@ Set the button toggle_mode property. Toggle mode makes the button flip state bet #### is_toggle_mode * [bool](class_bool) **`is_toggle_mode`** **(** **)** const -Return the toggle_mode property (see [[#set_toggle_mode|set_toggle_mode]]). +Return the toggle_mode property (see [`set_toggle_mode`](#set_toggle_mode)). #### set_disabled * void **`set_disabled`** **(** [bool](class_bool) disabled **)** @@ -51,7 +52,7 @@ Set the button into disabled state. When a button is disabled, it can"apos;t be #### is_disabled * [bool](class_bool) **`is_disabled`** **(** **)** const -Return wether the button is in disabled state (see [[#set_disabled|set_disabled]]). +Return wether the button is in disabled state (see [`set_disabled`](#set_disabled)). #### set_click_on_press * void **`set_click_on_press`** **(** [bool](class_bool) enable **)** @@ -61,4 +62,4 @@ Set the button click_on_press mode. This mode generates click events when a mous #### get_click_on_press * [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]]). +Return the state of the click_on_press property (see [`set_click_on_press`](#set_click_on_press)). diff --git a/class_bitmap.md b/class_bitmap.md index 8c4a3f6..f52e58c 100644 --- a/class_bitmap.md +++ b/class_bitmap.md @@ -1,5 +1,6 @@ # BitMap -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description diff --git a/class_boneattachment.md b/class_boneattachment.md index 0b49dbe..6d7022c 100644 --- a/class_boneattachment.md +++ b/class_boneattachment.md @@ -1,5 +1,6 @@ # BoneAttachment -#####**Inherits:** [Spatial](class_spatial) +####**Inherits:** [Spatial](class_spatial) +####**Category:** Core ### Brief Description diff --git a/class_bool.md b/class_bool.md index f025ee4..3e30b1d 100644 --- a/class_bool.md +++ b/class_bool.md @@ -1,4 +1,5 @@ # bool +####**Category:** Built-In Types ### Brief Description Boolean built-in type diff --git a/class_boxcontainer.md b/class_boxcontainer.md index 64dc2bd..11bb02f 100644 --- a/class_boxcontainer.md +++ b/class_boxcontainer.md @@ -1,5 +1,6 @@ # BoxContainer -#####**Inherits:** [Container](class_container) +####**Inherits:** [Container](class_container) +####**Category:** Core ### Brief Description Base class for Box containers. diff --git a/class_boxshape.md b/class_boxshape.md index 66d01e7..10e1506 100644 --- a/class_boxshape.md +++ b/class_boxshape.md @@ -1,5 +1,6 @@ # BoxShape -#####**Inherits:** [Shape](class_shape) +####**Inherits:** [Shape](class_shape) +####**Category:** Core ### Brief Description Box shape resource. @@ -9,7 +10,7 @@ Box shape resource. * [Vector3](class_vector3) **[`get_extents`](#get_extents)** **(** **)** const ### Description -Box shape resource, which can be set into a [[physicsbody|PhysicsBody]] or area. +Box shape resource, which can be set into a [PhysicsBody](class_physicsbody) or area. ### Member Function Description diff --git a/class_button.md b/class_button.md index 3f59924..92e2512 100644 --- a/class_button.md +++ b/class_button.md @@ -1,5 +1,6 @@ # Button -#####**Inherits:** [BaseButton](class_basebutton) +####**Inherits:** [BaseButton](class_basebutton) +####**Category:** Core ### Brief Description Standard themed Button. @@ -17,7 +18,7 @@ Standard themed Button. * [bool](class_bool) **[`is_flat`](#is_flat)** **(** **)** const ### Description -Button is just the standard themed button: [image src="images/button_example.png"/] It can contain text and an icon, and will display them according to the current [[theme|Theme]]. +Button is just the standard themed button: [image src="images/button_example.png"/] It can contain text and an icon, and will display them according to the current [Theme](class_theme). ### Member Function Description @@ -34,19 +35,19 @@ Return the button text. #### set_flat * 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 the _flat_ property of a Button. Flat buttons don"apos;t display decoration unless hoevered or pressed. #### set_clip_text * 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. +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`** **(** **)** const -Return the state of the //clip_text// property (see [[#set_clip_text|set_clip_text]]) +Return the state of the _clip_text_ property (see [`set_clip_text`](#set_clip_text)) #### is_flat * [bool](class_bool) **`is_flat`** **(** **)** const -Return the state of the //flat// property (see [[#set_flat|set_flat]]) +Return the state of the _flat_ property (see [`set_flat`](#set_flat)) diff --git a/class_buttonarray.md b/class_buttonarray.md index 86eb6c6..6eadc76 100644 --- a/class_buttonarray.md +++ b/class_buttonarray.md @@ -1,5 +1,6 @@ # ButtonArray -#####**Inherits:** [Control](class_control) +####**Inherits:** [Control](class_control) +####**Category:** Core ### Brief Description Array of Buttons. diff --git a/class_buttongroup.md b/class_buttongroup.md index 6761e43..18f0f48 100644 --- a/class_buttongroup.md +++ b/class_buttongroup.md @@ -1,5 +1,6 @@ # ButtonGroup -#####**Inherits:** [Control](class_control) +####**Inherits:** [Control](class_control) +####**Category:** Core ### Brief Description Group of Buttons. @@ -12,7 +13,7 @@ Group of Buttons. * void **[`set_pressed_button`](#set_pressed_button)** **(** [BaseButton](class_basebutton) button **)** ### Description -Group of [[button|Button]]s. All direct and indirect children buttons become radios. Only one allows being pressed. +Group of [Button](class_button)s. All direct and indirect children buttons become radios. Only one allows being pressed. ### Member Function Description diff --git a/class_camera.md b/class_camera.md index dff2c88..6b22462 100644 --- a/class_camera.md +++ b/class_camera.md @@ -1,5 +1,6 @@ # Camera -#####**Inherits:** [Spatial](class_spatial) +####**Inherits:** [Spatial](class_spatial) +####**Category:** Core ### Brief Description Camera node, displays from a point of view. @@ -35,46 +36,46 @@ Camera node, displays from a point of view. * **PROJECTION_ORTHOGONAL** = **1** - Orthogonal Projection (objects remain the same size on the screen no matter how far away they are). ### Description -Camera is a special node that displays what is visible from its current location. Cameras register themselves in the nearest [[viewport|Viewport]] node (when ascending the tree). Only one camera can be active per viewport. If no viewport is available ascending the tree, the Camera will register in the global viewport. In other words, a Camera just provides //3D// display capabilities to a [[viewport|Viewport]], and, without one, a [Scene] registered in that [[viewport|Viewport]] (or higher viewports) can't be displayed. +Camera is a special node that displays what is visible from its current location. Cameras register themselves in the nearest [Viewport](class_viewport) node (when ascending the tree). Only one camera can be active per viewport. If no viewport is available ascending the tree, the Camera will register in the global viewport. In other words, a Camera just provides _3D_ display capabilities to a [Viewport](class_viewport), and, without one, a [Scene] registered in that [Viewport](class_viewport) (or higher viewports) can't be displayed. ### Member Function Description #### project_ray_normal * [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. +Return a normal vector in worldspace, that is the result of projecting a point on the [Viewport](class_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`** **(** [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. +Return a 3D position in worldspace, that is the result of projecting a point on the [Viewport](class_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`** **(** [Vector3](class_vector3) world_point **)** const -Return how a 3D point in worldpsace maps to a 2D coordinate in the [[viewport|Viewport]] rectangle. +Return how a 3D point in worldpsace maps to a 2D coordinate in the [Viewport](class_viewport) rectangle. #### set_perspective * 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 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`** **(** [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) +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 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. +Make this camera the current Camera for the [Viewport](class_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`** **(** **)** const -Return wether the Camera is the current one in the [[viewport|Viewport]], or plans to become current (if outside the scene tree). +Return wether the Camera is the current one in the [Viewport](class_viewport), or plans to become current (if outside the scene tree). #### get_camera_transform * [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. +Get the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the [Node](class_node) transform. diff --git a/class_camera2d.md b/class_camera2d.md index 5d9bd08..db43c67 100644 --- a/class_camera2d.md +++ b/class_camera2d.md @@ -1,5 +1,6 @@ # Camera2D -#####**Inherits:** [Node2D](class_node2d) +####**Inherits:** [Node2D](class_node2d) +####**Category:** Core ### Brief Description Camera node for 2D scenes. @@ -32,12 +33,12 @@ Camera node for 2D scenes. * void **[`force_update_scroll`](#force_update_scroll)** **(** **)** ### Description -Camera node for 2D scenes. It forces the screen (current layer) to scroll following this node. This makes it easier (and faster) to program scrollable scenes than manually changing the position of [[canvasitem|CanvasItem]] based nodes. +Camera node for 2D scenes. It forces the screen (current layer) to scroll following this node. This makes it easier (and faster) to program scrollable scenes than manually changing the position of [CanvasItem](class_canvasitem) based nodes. This node is intended to be a simple helper get get things going quickly and it may happen often that more functionality is desired to change how the camera works. To make your own custom camera node, simply - inherit from [[node2d|Node2D]] and change the transform of the canvas by - calling get_viewport().set_canvas_transform(m) in [[viewport|Viewport]]. + inherit from [Node2D](class_node2d) and change the transform of the canvas by + calling get_viewport().set_canvas_transform(m) in [Viewport](class_viewport). ### Member Function Description @@ -70,7 +71,7 @@ Make this the current 2D camera for the scene (viewport and layer), in case ther #### is_current * [bool](class_bool) **`is_current`** **(** **)** const -Return true of this is the current camera (see [[camera2d#make_current|Camera2D.make_current]]). +Return true of this is the current camera (see [Camera2D.`make_current`](camera2d#make_current)). #### set_limit * void **`set_limit`** **(** [int](class_int) margin, [int](class_int) limit **)** @@ -90,7 +91,7 @@ Set the margins needed to drag the camera (relative to the screen size). Margin #### get_drag_margin * [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]]). +Return the margins needed to drag the camera (see [`set_drag_margin`](#set_drag_margin)). #### get_camera_pos * [Vector2](class_vector2) **`get_camera_pos`** **(** **)** const diff --git a/class_canvasitem.md b/class_canvasitem.md index 14f16cf..15cb40c 100644 --- a/class_canvasitem.md +++ b/class_canvasitem.md @@ -1,5 +1,6 @@ # CanvasItem -#####**Inherits:** [Node](class_node) +####**Inherits:** [Node](class_node) +####**Category:** Core ### Brief Description Base class of anything 2D. @@ -66,7 +67,7 @@ Base class of anything 2D. * **NOTIFICATION_TRANSFORM_CHANGED** = **29** - Canvas item transform has changed. Only received if requested. ### Description -Base class of anything 2D. Canvas items are laid out in a tree and children inherit and extend the transform of their parent. CanvasItem is extended by [[control|Control]], for anything GUI related, and by [[node2d|Node2D]] for anything 2D engine related. +Base class of anything 2D. Canvas items are laid out in a tree and children inherit and extend the transform of their parent. CanvasItem is extended by [Control](class_control), for anything GUI related, and by [Node2D](class_node2d) for anything 2D engine related. Any CanvasItem can draw. For this, the "update" function must be called, then NOTIFICATION_DRAW will be received on idle time to request redraw. Because of this, canvas items don't need to be redraw on every frame, improving the performance significantly. Several functions for drawing on the CanvasItem are provided (see draw_* functions). They can only be used inside the notification, signal or _draw() overrided function, though. Canvas items are draw in tree order. By default, children are on top of their parents so a root CanvasItem will be drawn behind everything (this can be changed per item though). Canvas items can also be hidden (hiding also their subtree). They provide many means for changing standard parameters such as opacity (for it and the subtree) and self opacity, blend mode. @@ -97,7 +98,7 @@ Return a rect containing the editable contents of the item. #### get_canvas_item * [RID](class_rid) **`get_canvas_item`** **(** **)** const -Return the canvas item RID used by [[visualserver|VisualServer]] for this item. +Return the canvas item RID used by [VisualServer](class_visualserver) for this item. #### is_visible * [bool](class_bool) **`is_visible`** **(** **)** const @@ -107,7 +108,7 @@ Return true if this CanvasItem is visible. It may be invisible because itself or #### is_hidden * [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. +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`** **(** **)** @@ -132,7 +133,7 @@ Set as toplevel. This means that it will not inherit transform from parent canva #### is_set_as_toplevel * [bool](class_bool) **`is_set_as_toplevel`** **(** **)** const -Return if set as toplevel. See [[#set_as_toplevel|set_as_toplevel]]/ +Return if set as toplevel. See [`set_as_toplevel`](#set_as_toplevel)/ #### set_blend_mode * void **`set_blend_mode`** **(** [int](class_int) blend_mode **)** diff --git a/class_canvaslayer.md b/class_canvaslayer.md index a314fe6..d8d872b 100644 --- a/class_canvaslayer.md +++ b/class_canvaslayer.md @@ -1,5 +1,6 @@ # CanvasLayer -#####**Inherits:** [Node](class_node) +####**Inherits:** [Node](class_node) +####**Category:** Core ### Brief Description Canvas Item layer. @@ -19,7 +20,7 @@ Canvas Item layer. * [RID](class_rid) **[`get_viewport`](#get_viewport)** **(** **)** const ### Description -Canvas Item layer. [[canvasitem|CanvasItem]] nodes that are direct or indirect children of a [[canvaslayer|CanvasLayer]] will be drawn in that layer. The layer is a numeric index that defines the draw order. The default 2D scene renders with index 0, so a [[canvaslayer|CanvasLayer]] with index -1 will be drawn below, and one with index 1 will be drawn above. This is very useful for HUDs (in layer 1+ or above), or backgrounds (in layer -1 or below). +Canvas Item layer. [CanvasItem](class_canvasitem) nodes that are direct or indirect children of a [CanvasLayer](class_canvaslayer) will be drawn in that layer. The layer is a numeric index that defines the draw order. The default 2D scene renders with index 0, so a [CanvasLayer](class_canvaslayer) with index -1 will be drawn below, and one with index 1 will be drawn above. This is very useful for HUDs (in layer 1+ or above), or backgrounds (in layer -1 or below). ### Member Function Description @@ -76,7 +77,7 @@ Return the base scale for this layer (helper). #### get_world_2d * Canvas **`get_world_2d`** **(** **)** const -Return the [[world2d|World2D]] used by this layer. +Return the [World2D](class_world2d) used by this layer. #### get_viewport * [RID](class_rid) **`get_viewport`** **(** **)** const diff --git a/class_capsuleshape.md b/class_capsuleshape.md index 1ca0104..0501735 100644 --- a/class_capsuleshape.md +++ b/class_capsuleshape.md @@ -1,5 +1,6 @@ # CapsuleShape -#####**Inherits:** [Shape](class_shape) +####**Inherits:** [Shape](class_shape) +####**Category:** Core ### Brief Description Capsule shape resource. @@ -11,7 +12,7 @@ Capsule shape resource. * [real](class_real) **[`get_height`](#get_height)** **(** **)** const ### Description -Capsule shape resource, which can be set into a [[physicsbody|PhysicsBody]] or area. +Capsule shape resource, which can be set into a [PhysicsBody](class_physicsbody) or area. ### Member Function Description diff --git a/class_capsuleshape2d.md b/class_capsuleshape2d.md index c8ea896..23bf43b 100644 --- a/class_capsuleshape2d.md +++ b/class_capsuleshape2d.md @@ -1,5 +1,6 @@ # CapsuleShape2D -#####**Inherits:** [Shape2D](class_shape2d) +####**Inherits:** [Shape2D](class_shape2d) +####**Category:** Core ### Brief Description Capsule 2D shape resource for physics. @@ -18,19 +19,19 @@ Capsule 2D shape resource for physics. A capsule (or sometimes called "pill") is #### set_radius * void **`set_radius`** **(** [real](class_real) radius **)** -Radius of the [[capsuleshape2d|CapsuleShape2D]]. +Radius of the [CapsuleShape2D](class_capsuleshape2d). #### get_radius * [real](class_real) **`get_radius`** **(** **)** const -Return the radius of the [[capsuleshape2d|CapsuleShape2D]]. +Return the radius of the [CapsuleShape2D](class_capsuleshape2d). #### set_height * void **`set_height`** **(** [real](class_real) height **)** -Height of the [[capsuleshape2d|CapsuleShape2D]]. +Height of the [CapsuleShape2D](class_capsuleshape2d). #### get_height * [real](class_real) **`get_height`** **(** **)** const -Return the height of the [[capsuleshape2d|CapsuleShape2D]]. +Return the height of the [CapsuleShape2D](class_capsuleshape2d). diff --git a/class_carbody.md b/class_carbody.md index 1571a28..3ed3a48 100644 --- a/class_carbody.md +++ b/class_carbody.md @@ -1,5 +1,6 @@ # CarBody -#####**Inherits:** [PhysicsBody](class_physicsbody) +####**Inherits:** [PhysicsBody](class_physicsbody) +####**Category:** Core ### Brief Description diff --git a/class_carwheel.md b/class_carwheel.md index db832a8..e1b78f9 100644 --- a/class_carwheel.md +++ b/class_carwheel.md @@ -1,5 +1,6 @@ # CarWheel -#####**Inherits:** [Spatial](class_spatial) +####**Inherits:** [Spatial](class_spatial) +####**Category:** Core ### Brief Description diff --git a/class_centercontainer.md b/class_centercontainer.md index 4c2dfd0..8fb0455 100644 --- a/class_centercontainer.md +++ b/class_centercontainer.md @@ -1,5 +1,6 @@ # CenterContainer -#####**Inherits:** [Container](class_container) +####**Inherits:** [Container](class_container) +####**Category:** Core ### Brief Description Keeps children controls centered. diff --git a/class_checkbutton.md b/class_checkbutton.md index 3009247..47e0ded 100644 --- a/class_checkbutton.md +++ b/class_checkbutton.md @@ -1,5 +1,6 @@ # CheckButton -#####**Inherits:** [Button](class_button) +####**Inherits:** [Button](class_button) +####**Category:** Core ### Brief Description Checkable button. diff --git a/class_circleshape2d.md b/class_circleshape2d.md index fc49081..f423315 100644 --- a/class_circleshape2d.md +++ b/class_circleshape2d.md @@ -1,5 +1,6 @@ # CircleShape2D -#####**Inherits:** [Shape2D](class_shape2d) +####**Inherits:** [Shape2D](class_shape2d) +####**Category:** Core ### Brief Description Circular Shape for 2D Physics. diff --git a/class_collisionobject.md b/class_collisionobject.md index 9f5631b..7b153e6 100644 --- a/class_collisionobject.md +++ b/class_collisionobject.md @@ -1,5 +1,6 @@ # CollisionObject -#####**Inherits:** [Spatial](class_spatial) +####**Inherits:** [Spatial](class_spatial) +####**Category:** Core ### Brief Description diff --git a/class_collisionobject2d.md b/class_collisionobject2d.md index aafad9e..12e977a 100644 --- a/class_collisionobject2d.md +++ b/class_collisionobject2d.md @@ -1,5 +1,6 @@ # CollisionObject2D -#####**Inherits:** [Node2D](class_node2d) +####**Inherits:** [Node2D](class_node2d) +####**Category:** Core ### Brief Description Base node for 2D collisionables. @@ -25,7 +26,7 @@ CollisionObject2D is the base class for 2D physics collisionables. They can hold #### add_shape * 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. +Add a [Shape2D](class_shape2d) to the collision body, with a given custom transform. #### get_shape_count * [int](class_int) **`get_shape_count`** **(** **)** const diff --git a/class_collisionpolygon2d.md b/class_collisionpolygon2d.md index c46346d..8deb42e 100644 --- a/class_collisionpolygon2d.md +++ b/class_collisionpolygon2d.md @@ -1,8 +1,9 @@ # CollisionPolygon2D -#####**Inherits:** [Node2D](class_node2d) +####**Inherits:** [Node2D](class_node2d) +####**Category:** Core ### Brief Description Editor-Only class. ### Description -Editor-Only class. This is not present when running the game. It's used in the editor to properly edit and position collision shapes in [[collisionobject2d|CollisionObject2D]]. This is not accessible from regular code. This class is for editing custom shape polygons. +Editor-Only class. This is not present when running the game. It's used in the editor to properly edit and position collision shapes in [CollisionObject2D](class_collisionobject2d). This is not accessible from regular code. This class is for editing custom shape polygons. diff --git a/class_collisionshape.md b/class_collisionshape.md index 386c295..55eb3b9 100644 --- a/class_collisionshape.md +++ b/class_collisionshape.md @@ -1,5 +1,6 @@ # CollisionShape -#####**Inherits:** [Spatial](class_spatial) +####**Inherits:** [Spatial](class_spatial) +####**Category:** Core ### Brief Description diff --git a/class_collisionshape2d.md b/class_collisionshape2d.md index 97c01e0..3f84df8 100644 --- a/class_collisionshape2d.md +++ b/class_collisionshape2d.md @@ -1,8 +1,9 @@ # CollisionShape2D -#####**Inherits:** [Node2D](class_node2d) +####**Inherits:** [Node2D](class_node2d) +####**Category:** Core ### Brief Description Editor-Only class. ### Description -Editor-Only class. This is not present when running the game. It's used in the editor to properly edit and position collision shapes in [[collisionobject2d|CollisionObject2D]]. This is not accessible from regular code. +Editor-Only class. This is not present when running the game. It's used in the editor to properly edit and position collision shapes in [CollisionObject2D](class_collisionobject2d). This is not accessible from regular code. diff --git a/class_color.md b/class_color.md index 800b1f8..6aca95d 100644 --- a/class_color.md +++ b/class_color.md @@ -1,4 +1,5 @@ # Color +####**Category:** Built-In Types ### Brief Description Color in RGBA format. diff --git a/class_colorarray.md b/class_colorarray.md index 4617e47..425d9fc 100644 --- a/class_colorarray.md +++ b/class_colorarray.md @@ -1,4 +1,5 @@ # ColorArray +####**Category:** Built-In Types ### Brief Description Array of Colors diff --git a/class_colorpicker.md b/class_colorpicker.md index 7302a54..23a2fa3 100644 --- a/class_colorpicker.md +++ b/class_colorpicker.md @@ -1,5 +1,6 @@ # ColorPicker -#####**Inherits:** [HBoxContainer](class_hboxcontainer) +####**Inherits:** [HBoxContainer](class_hboxcontainer) +####**Category:** Core ### Brief Description Color picker control. @@ -16,7 +17,7 @@ Color picker control. * **`color_changed`** **(** [Color](class_color) color **)** ### Description -This is a simple color picker [[control|Control]]. It's useful for selecting a color from an RGB/RGBA colorspace. +This is a simple color picker [Control](class_control). It's useful for selecting a color from an RGB/RGBA colorspace. ### Member Function Description diff --git a/class_colorpickerbutton.md b/class_colorpickerbutton.md index 2332b59..5d90d99 100644 --- a/class_colorpickerbutton.md +++ b/class_colorpickerbutton.md @@ -1,5 +1,6 @@ # ColorPickerButton -#####**Inherits:** [Button](class_button) +####**Inherits:** [Button](class_button) +####**Category:** Core ### Brief Description diff --git a/class_concavepolygonshape.md b/class_concavepolygonshape.md index 875f2db..8e18028 100644 --- a/class_concavepolygonshape.md +++ b/class_concavepolygonshape.md @@ -1,5 +1,6 @@ # ConcavePolygonShape -#####**Inherits:** [Shape](class_shape) +####**Inherits:** [Shape](class_shape) +####**Category:** Core ### Brief Description Concave polygon shape. @@ -9,7 +10,7 @@ Concave polygon shape. * [Vector3Array](class_vector3array) **[`get_faces`](#get_faces)** **(** **)** const ### Description -Concave polygon shape resource, which can be set into a [[physicsbody|PhysicsBody]] or area."#10; This shape is created by feeding a list of triangles. +Concave polygon shape resource, which can be set into a [PhysicsBody](class_physicsbody) or area."#10; This shape is created by feeding a list of triangles. ### Member Function Description diff --git a/class_concavepolygonshape2d.md b/class_concavepolygonshape2d.md index d12b5e1..f367276 100644 --- a/class_concavepolygonshape2d.md +++ b/class_concavepolygonshape2d.md @@ -1,5 +1,6 @@ # ConcavePolygonShape2D -#####**Inherits:** [Shape2D](class_shape2d) +####**Inherits:** [Shape2D](class_shape2d) +####**Category:** Core ### Brief Description Concave polygon 2D shape resource for physics. diff --git a/class_configfile.md b/class_configfile.md index 3ac5858..5d2c288 100644 --- a/class_configfile.md +++ b/class_configfile.md @@ -1,5 +1,6 @@ # ConfigFile -#####**Inherits:** [Reference](class_reference) +####**Inherits:** [Reference](class_reference) +####**Category:** Core ### Brief Description diff --git a/class_confirmationdialog.md b/class_confirmationdialog.md index 15c836b..ea23b0a 100644 --- a/class_confirmationdialog.md +++ b/class_confirmationdialog.md @@ -1,5 +1,6 @@ # ConfirmationDialog -#####**Inherits:** [AcceptDialog](class_acceptdialog) +####**Inherits:** [AcceptDialog](class_acceptdialog) +####**Category:** Core ### Brief Description Dialog for confirmation of actions. @@ -8,7 +9,7 @@ Dialog for confirmation of actions. * [Button](class_button) **[`get_cancel`](#get_cancel)** **(** **)** ### Description -Dialog for confirmation of actions. This dialog inherits from [[acceptdialog|AcceptDialog]], but has by default an OK and Cancel buton (in host OS order). +Dialog for confirmation of actions. This dialog inherits from [AcceptDialog](class_acceptdialog), but has by default an OK and Cancel buton (in host OS order). ### Member Function Description diff --git a/class_container.md b/class_container.md index 800d50f..bd5395c 100644 --- a/class_container.md +++ b/class_container.md @@ -1,5 +1,6 @@ # Container -#####**Inherits:** [Control](class_control) +####**Inherits:** [Control](class_control) +####**Category:** Core ### Brief Description Base node for containers. @@ -15,7 +16,7 @@ Base node for containers. * **NOTIFICATION_SORT_CHILDREN** = **50** - Notification for when sorting the children, it must be obeyed immediately. ### Description -Base node for conainers. A [[container|Container]] contains other controls and automatically arranges them in a certain way. +Base node for conainers. A [Container](class_container) contains other controls and automatically arranges them in a certain way. A Control can inherit this to reate custom container classes. ### Member Function Description diff --git a/class_control.md b/class_control.md index fd893cf..2172585 100644 --- a/class_control.md +++ b/class_control.md @@ -1,5 +1,6 @@ # Control -#####**Inherits:** [CanvasItem](class_canvasitem) +####**Inherits:** [CanvasItem](class_canvasitem) +####**Category:** Core ### Brief Description Control is the base node for all the GUI components. @@ -123,12 +124,12 @@ Control is the base node for all the GUI components. ### Description Control is the base class Node for all the GUI components. Every GUI component inherits from it, directly or indirectly. In this way, sections of the scene tree made of contiguous control nodes, become user interfaces. - Controls are relative to the parent position and size by using anchors and margins. This ensures that they can adapt easily in most situation to changing dialog and screen sizes. When more flexibility is desired, [[container|Container]] derived nodes can be used. + Controls are relative to the parent position and size by using anchors and margins. This ensures that they can adapt easily in most situation to changing dialog and screen sizes. When more flexibility is desired, [Container](class_container) derived nodes can be used. Anchors work by defining which margin do they follow, and a value relative to it. Allowed anchoring modes are ANCHOR_BEGIN, where the margin is relative to the top or left margins of the parent (in pixels), ANCHOR_END for the right and bottom margins of the parent and ANCHOR_RATIO, which is a ratio from 0 to 1 in the parent range. - Input device events ([[inputevent|InputEvent]]) are first sent to the root controls via the [[node#_input|Node._input]], which distribute it through the tree, then delivers them to the adequate one (under cursor or keyboard focus based) by calling [Node._input_event]. There is no need to enable input processing on controls to receive such events. To ensure that no one else will receive the event (not even [[node#_unhandled_input|Node._unhandled_input]]), the control can accept it by calling [[#accept_event|accept_event]]. - Only one control can hold the keyboard focus (receiving keyboard events), for that the control must define the focus mode with [[#set_focus_mode|set_focus_mode]]. Focus is lost when another control gains it, or the current focus owner is hidden. - It is sometimes desired for a control to ignore mouse/pointer events. This is often the case when placing other controls on top of a button, in such cases. Calling [[#set_ignore_mouse|set_ignore_mouse]] enables this function. - Finally, controls are skinned according to a [[theme|Theme]]. Setting a [[theme|Theme]] on a control will propagate all the skinning down the tree. Optionally, skinning can be overrided per each control by calling the add_*_override functions, or from the editor. + Input device events ([InputEvent](class_inputevent)) are first sent to the root controls via the [Node.`_input`](node#_input), which distribute it through the tree, then delivers them to the adequate one (under cursor or keyboard focus based) by calling [Node._input_event]. There is no need to enable input processing on controls to receive such events. To ensure that no one else will receive the event (not even [Node.`_unhandled_input`](node#_unhandled_input)), the control can accept it by calling [`accept_event`](#accept_event). + Only one control can hold the keyboard focus (receiving keyboard events), for that the control must define the focus mode with [`set_focus_mode`](#set_focus_mode). Focus is lost when another control gains it, or the current focus owner is hidden. + It is sometimes desired for a control to ignore mouse/pointer events. This is often the case when placing other controls on top of a button, in such cases. Calling [`set_ignore_mouse`](#set_ignore_mouse) enables this function. + Finally, controls are skinned according to a [Theme](class_theme). Setting a [Theme](class_theme) on a control will propagate all the skinning down the tree. Optionally, skinning can be overrided per each control by calling the add_*_override functions, or from the editor. ### Member Function Description @@ -145,7 +146,7 @@ Return the minimum size this Control can shrink to. A control will never be disp #### 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]]. +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`** **(** **)** const @@ -155,17 +156,17 @@ Return the minimum size this Control can shrink to. A control will never be disp #### is_window * [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. +Return wether this control is a _window_. Controls are considered windows when their parent [Node](class_node) is not a Control. #### get_window * [Object](class_object) **`get_window`** **(** **)** const -Return the //window// for this control, ascending the scene tree (see [[#is_window|is_window]]). +Return the _window_ for this control, ascending the scene tree (see [`is_window`](#is_window)). #### set_anchor * 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]]). +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`** **(** [int](class_int) margin **)** const @@ -180,32 +181,32 @@ Set a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT #### set_anchor_and_margin * 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]]). +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`** **(** [Vector2](class_vector2) pos **)** -Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [[#set_margin|set_margin]]). +Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [`set_margin`](#set_margin)). #### set_end * 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]]). +Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see [`set_margin`](#set_margin)). #### set_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]]). +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`** **(** [Vector2](class_vector2) size **)** -Changes MARGIN_RIGHT and MARGIN_BOTTOM to fit a given size. This is a helper (see [[#set_margin|set_margin]]). +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`** **(** [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]]). +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`** **(** [int](class_int) margin **)** const @@ -215,7 +216,7 @@ Return a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RI #### get_end * [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]]). +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`** **(** **)** const @@ -225,7 +226,7 @@ Returns the Control position, relative to the top-left corner of the parent Cont #### get_size * [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]]). +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`** **(** **)** const @@ -235,22 +236,22 @@ Returns the Control position, relative to the top-left corner of the parent Cont #### get_rect * [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]]). +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`** **(** **)** 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]]). +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`** **(** [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]]). +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`** **(** [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. +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`** **(** [int](class_int) mode **)** @@ -260,12 +261,12 @@ Set the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL). #### has_focus * [bool](class_bool) **`has_focus`** **(** **)** const -Return wether the Control is the current focused control (see [[#set_focus_mode|set_focus_mode]]). +Return wether the Control is the current focused control (see [`set_focus_mode`](#set_focus_mode)). #### grab_focus * void **`grab_focus`** **(** **)** -Steal the focus from another control and become the focused control (see [[#set_focus_mode|set_focus_mode]]). +Steal the focus from another control and become the focused control (see [`set_focus_mode`](#set_focus_mode)). #### release_focus * void **`release_focus`** **(** **)** @@ -310,17 +311,17 @@ Hint for containers, return vertical positioning flags. #### set_theme * void **`set_theme`** **(** [Theme](class_theme) theme **)** -Override whole the [[theme|Theme]] for this Control and all its children controls. +Override whole the [Theme](class_theme) for this Control and all its children controls. #### get_theme * [Theme](class_theme) **`get_theme`** **(** **)** const -Return a [[theme|Theme]] override, if one exists (see [[#set_theme|set_theme]]). +Return a [Theme](class_theme) override, if one exists (see [`set_theme`](#set_theme)). #### add_icon_override * 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. +Override a single icon ([Texture](class_texture)) in the theme of this Control. If texture is empty, override is cleared. #### add_style_override * void **`add_style_override`** **(** [String](class_string) name, [StyleBox](class_stylebox) stylebox **)** diff --git a/class_convexpolygonshape.md b/class_convexpolygonshape.md index 2a5c816..4f909bf 100644 --- a/class_convexpolygonshape.md +++ b/class_convexpolygonshape.md @@ -1,5 +1,6 @@ # ConvexPolygonShape -#####**Inherits:** [Shape](class_shape) +####**Inherits:** [Shape](class_shape) +####**Category:** Core ### Brief Description Convex Polygon Shape @@ -9,6 +10,6 @@ Convex Polygon Shape * [Vector3Array](class_vector3array) **[`get_points`](#get_points)** **(** **)** const ### Description -Convex polygon shape resource, which can be set into a [[physicsbody|PhysicsBody]] or area. +Convex polygon shape resource, which can be set into a [PhysicsBody](class_physicsbody) or area. ### Member Function Description diff --git a/class_convexpolygonshape2d.md b/class_convexpolygonshape2d.md index 55abb9c..c91541f 100644 --- a/class_convexpolygonshape2d.md +++ b/class_convexpolygonshape2d.md @@ -1,5 +1,6 @@ # ConvexPolygonShape2D -#####**Inherits:** [Shape2D](class_shape2d) +####**Inherits:** [Shape2D](class_shape2d) +####**Category:** Core ### Brief Description Convex Polygon Shape for 2D physics diff --git a/class_cubemap.md b/class_cubemap.md index c77409a..7ff1909 100644 --- a/class_cubemap.md +++ b/class_cubemap.md @@ -1,5 +1,6 @@ # CubeMap -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description diff --git a/class_curve2d.md b/class_curve2d.md index 7e7c14b..fa8e014 100644 --- a/class_curve2d.md +++ b/class_curve2d.md @@ -1,5 +1,6 @@ # Curve2D -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description diff --git a/class_curve3d.md b/class_curve3d.md index 0790d36..fd52efd 100644 --- a/class_curve3d.md +++ b/class_curve3d.md @@ -1,5 +1,6 @@ # Curve3D -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description diff --git a/class_dampedspringjoint2d.md b/class_dampedspringjoint2d.md index 4f1f73b..704ed80 100644 --- a/class_dampedspringjoint2d.md +++ b/class_dampedspringjoint2d.md @@ -1,5 +1,6 @@ # DampedSpringJoint2D -#####**Inherits:** [Joint2D](class_joint2d) +####**Inherits:** [Joint2D](class_joint2d) +####**Category:** Core ### Brief Description Damped sprint constraint for 2D physics. diff --git a/class_dictionary.md b/class_dictionary.md index 2f00085..4a2758e 100644 --- a/class_dictionary.md +++ b/class_dictionary.md @@ -1,4 +1,5 @@ # Dictionary +####**Category:** Built-In Types ### Brief Description Dictionary type. diff --git a/class_directionallight.md b/class_directionallight.md index d8c145f..bd0a06f 100644 --- a/class_directionallight.md +++ b/class_directionallight.md @@ -1,5 +1,6 @@ # DirectionalLight -#####**Inherits:** [Light](class_light) +####**Inherits:** [Light](class_light) +####**Category:** Core ### Brief Description Directional Light, such as the Sun or the Moon. @@ -19,6 +20,6 @@ Directional Light, such as the Sun or the Moon. * **SHADOW_PARAM_PSSM_ZOFFSET_SCALE** = **2** ### Description -A DirectionalLight is a type of [[light|Light]] node that emits light constantly in one direction (the negative z axis of the node). It is used lights with strong intensity that are located far away from the scene to model sunlight or moonlight. The worldpace location of the DirectionalLight transform (origin) is ignored, only the basis is used do determine light direction. +A DirectionalLight is a type of [Light](class_light) node that emits light constantly in one direction (the negative z axis of the node). It is used lights with strong intensity that are located far away from the scene to model sunlight or moonlight. The worldpace location of the DirectionalLight transform (origin) is ignored, only the basis is used do determine light direction. ### Member Function Description diff --git a/class_directory.md b/class_directory.md index aa450be..c7abe6f 100644 --- a/class_directory.md +++ b/class_directory.md @@ -1,5 +1,6 @@ # Directory -#####**Inherits:** [Reference](class_reference) +####**Inherits:** [Reference](class_reference) +####**Category:** Core ### Brief Description diff --git a/class_editableshape.md b/class_editableshape.md index 845bd73..9011916 100644 --- a/class_editableshape.md +++ b/class_editableshape.md @@ -1,5 +1,6 @@ # EditableShape -#####**Inherits:** [Spatial](class_spatial) +####**Inherits:** [Spatial](class_spatial) +####**Category:** Core ### Brief Description diff --git a/class_editablesphere.md b/class_editablesphere.md index fb0d932..31255bb 100644 --- a/class_editablesphere.md +++ b/class_editablesphere.md @@ -1,5 +1,6 @@ # EditableSphere -#####**Inherits:** [EditableShape](class_editableshape) +####**Inherits:** [EditableShape](class_editableshape) +####**Category:** Core ### Brief Description diff --git a/class_editorimportplugin.md b/class_editorimportplugin.md index 182e83a..d6b738c 100644 --- a/class_editorimportplugin.md +++ b/class_editorimportplugin.md @@ -1,5 +1,6 @@ # EditorImportPlugin -#####**Inherits:** [Reference](class_reference) +####**Inherits:** [Reference](class_reference) +####**Category:** Core ### Brief Description diff --git a/class_editorplugin.md b/class_editorplugin.md index 52e339a..77056d0 100644 --- a/class_editorplugin.md +++ b/class_editorplugin.md @@ -1,5 +1,6 @@ # EditorPlugin -#####**Inherits:** [Node](class_node) +####**Inherits:** [Node](class_node) +####**Category:** Core ### Brief Description diff --git a/class_editorscenepostimport.md b/class_editorscenepostimport.md index 8a2f54d..1b54266 100644 --- a/class_editorscenepostimport.md +++ b/class_editorscenepostimport.md @@ -1,5 +1,6 @@ # EditorScenePostImport -#####**Inherits:** [Reference](class_reference) +####**Inherits:** [Reference](class_reference) +####**Category:** Core ### Brief Description diff --git a/class_emptycontrol.md b/class_emptycontrol.md index e2f4a35..f8cda0d 100644 --- a/class_emptycontrol.md +++ b/class_emptycontrol.md @@ -1,5 +1,6 @@ # EmptyControl -#####**Inherits:** [Control](class_control) +####**Inherits:** [Control](class_control) +####**Category:** Core ### Brief Description diff --git a/class_environment.md b/class_environment.md index fb62b2e..003dfdf 100644 --- a/class_environment.md +++ b/class_environment.md @@ -1,5 +1,6 @@ # Environment -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description diff --git a/class_eventplayer.md b/class_eventplayer.md index bb56df9..43f7d97 100644 --- a/class_eventplayer.md +++ b/class_eventplayer.md @@ -1,5 +1,6 @@ # EventPlayer -#####**Inherits:** [Node](class_node) +####**Inherits:** [Node](class_node) +####**Category:** Core ### Brief Description diff --git a/class_eventstream.md b/class_eventstream.md index e49812d..d20ae54 100644 --- a/class_eventstream.md +++ b/class_eventstream.md @@ -1,5 +1,6 @@ # EventStream -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description diff --git a/class_eventstreamchibi.md b/class_eventstreamchibi.md index 54ec19b..86a5b2f 100644 --- a/class_eventstreamchibi.md +++ b/class_eventstreamchibi.md @@ -1,5 +1,6 @@ # EventStreamChibi -#####**Inherits:** [EventStream](class_eventstream) +####**Inherits:** [EventStream](class_eventstream) +####**Category:** Core ### Brief Description diff --git a/class_file.md b/class_file.md index 9e8d2d7..e07f694 100644 --- a/class_file.md +++ b/class_file.md @@ -1,5 +1,6 @@ # File -#####**Inherits:** [Reference](class_reference) +####**Inherits:** [Reference](class_reference) +####**Category:** Core ### Brief Description diff --git a/class_filedialog.md b/class_filedialog.md index 55608a2..4456ad3 100644 --- a/class_filedialog.md +++ b/class_filedialog.md @@ -1,5 +1,6 @@ # FileDialog -#####**Inherits:** [ConfirmationDialog](class_confirmationdialog) +####**Inherits:** [ConfirmationDialog](class_confirmationdialog) +####**Category:** Core ### Brief Description Dialog for selecting files or directories in the filesystem. diff --git a/class_fixedmaterial.md b/class_fixedmaterial.md index b4e3b70..5c5e4d2 100644 --- a/class_fixedmaterial.md +++ b/class_fixedmaterial.md @@ -1,5 +1,6 @@ # FixedMaterial -#####**Inherits:** [Material](class_material) +####**Inherits:** [Material](class_material) +####**Category:** Core ### Brief Description Simple Material with a fixed parameter set. @@ -39,7 +40,7 @@ Simple Material with a fixed parameter set. * **FLAG_USE_POINT_SIZE** = **2** ### Description -FixedMaterial is a simple type of material [[resource|Resource]], which contains a fixed amount of paramters. It is the only type of material supported in fixed-pipeline devices and APIs. It is also an often a better alternative to [[shadermaterial|ShaderMaterial]] for most simple use cases. +FixedMaterial is a simple type of material [Resource](class_resource), which contains a fixed amount of paramters. It is the only type of material supported in fixed-pipeline devices and APIs. It is also an often a better alternative to [ShaderMaterial](class_shadermaterial) for most simple use cases. ### Member Function Description @@ -56,12 +57,12 @@ Return a parameter, parameters are defined in the PARAM_* enum. The type of each #### set_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]]). +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`** **(** [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]]). +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`** **(** [int](class_int) param, [int](class_int) mode **)** diff --git a/class_flurry.md b/class_flurry.md index 860cdc7..717735a 100644 --- a/class_flurry.md +++ b/class_flurry.md @@ -1,5 +1,6 @@ # Flurry -#####**Inherits:** [Object](class_object) +####**Inherits:** [Object](class_object) +####**Category:** Core ### Brief Description diff --git a/class_followcamera.md b/class_followcamera.md index bb6834b..2b6d663 100644 --- a/class_followcamera.md +++ b/class_followcamera.md @@ -1,5 +1,6 @@ # FollowCamera -#####**Inherits:** [Camera](class_camera) +####**Inherits:** [Camera](class_camera) +####**Category:** Core ### Brief Description diff --git a/class_font.md b/class_font.md index 8ac4674..2898797 100644 --- a/class_font.md +++ b/class_font.md @@ -1,5 +1,6 @@ # Font -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description Internationalized font and text drawing support. @@ -53,7 +54,7 @@ Return the font descent (number of pixels below the baseline). #### add_kerning_pair * 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. +Add a kerning pair to the [Font](class_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`** **(** [int](class_int) arg0, [int](class_int) arg1 **)** const @@ -63,7 +64,7 @@ Return a kerning pair as a difference. Kerning pairs are special cases where a t #### add_texture * void **`add_texture`** **(** [Texture](class_texture) texture **)** -Add a texture to the [[font|Font]]. +Add a texture to the [Font](class_font). #### add_char * 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 **)** @@ -88,9 +89,9 @@ Clear all the font data. #### draw * 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 "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`** **(** [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. +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_gdnativeclass.md b/class_gdnativeclass.md index a917c1d..1c8549d 100644 --- a/class_gdnativeclass.md +++ b/class_gdnativeclass.md @@ -1,5 +1,6 @@ # GDNativeClass -#####**Inherits:** [Reference](class_reference) +####**Inherits:** [Reference](class_reference) +####**Category:** Core ### Brief Description diff --git a/class_gdscript.md b/class_gdscript.md index 8c3c783..f82cc2b 100644 --- a/class_gdscript.md +++ b/class_gdscript.md @@ -1,5 +1,6 @@ # GDScript -#####**Inherits:** [Script](class_script) +####**Inherits:** [Script](class_script) +####**Category:** Core ### Brief Description diff --git a/class_geometry.md b/class_geometry.md index 728e9b9..b4f9dba 100644 --- a/class_geometry.md +++ b/class_geometry.md @@ -1,5 +1,6 @@ # Geometry -#####**Inherits:** [Object](class_object) +####**Inherits:** [Object](class_object) +####**Category:** Core ### Brief Description diff --git a/class_geometryinstance.md b/class_geometryinstance.md index 606e240..4834145 100644 --- a/class_geometryinstance.md +++ b/class_geometryinstance.md @@ -1,5 +1,6 @@ # GeometryInstance -#####**Inherits:** [VisualInstance](class_visualinstance) +####**Inherits:** [VisualInstance](class_visualinstance) +####**Category:** Core ### Brief Description Base node for geometry based visual instances. diff --git a/class_globals.md b/class_globals.md index 4fad2a3..e7bc928 100644 --- a/class_globals.md +++ b/class_globals.md @@ -1,5 +1,6 @@ # Globals -#####**Inherits:** [Object](class_object) +####**Inherits:** [Object](class_object) +####**Category:** Core ### Brief Description Contains global variables accessible from everywhere. @@ -18,7 +19,7 @@ Contains global variables accessible from everywhere. * [Object](class_object) **[`get_singleton`](#get_singleton)** **(** [String](class_string) arg0 **)** const ### Description -Contains global variables accessible from everywhere. Use the normal [[object|Object]] API, such as "Globals.get(variable)", "Globals.set(variable,value)" or "Globals.has(variable)" to access them. Variables stored in engine.cfg are also loaded into globals, making this object very useful for reading custom game configuration options. +Contains global variables accessible from everywhere. Use the normal [Object](class_object) API, such as "Globals.get(variable)", "Globals.set(variable,value)" or "Globals.has(variable)" to access them. Variables stored in engine.cfg are also loaded into globals, making this object very useful for reading custom game configuration options. ### Member Function Description diff --git a/class_gridcontainer.md b/class_gridcontainer.md index 09900d2..85d38a5 100644 --- a/class_gridcontainer.md +++ b/class_gridcontainer.md @@ -1,5 +1,6 @@ # GridContainer -#####**Inherits:** [Container](class_container) +####**Inherits:** [Container](class_container) +####**Category:** Core ### Brief Description diff --git a/class_gridmap.md b/class_gridmap.md index f809446..ce854cb 100644 --- a/class_gridmap.md +++ b/class_gridmap.md @@ -1,5 +1,6 @@ # GridMap -#####**Inherits:** [Spatial](class_spatial) +####**Inherits:** [Spatial](class_spatial) +####**Category:** Core ### Brief Description diff --git a/class_groovejoint2d.md b/class_groovejoint2d.md index 98f8c40..9c9360d 100644 --- a/class_groovejoint2d.md +++ b/class_groovejoint2d.md @@ -1,5 +1,6 @@ # GrooveJoint2D -#####**Inherits:** [Joint2D](class_joint2d) +####**Inherits:** [Joint2D](class_joint2d) +####**Category:** Core ### Brief Description Groove constraint for 2D physics. diff --git a/class_hboxcontainer.md b/class_hboxcontainer.md index b935e4a..294992b 100644 --- a/class_hboxcontainer.md +++ b/class_hboxcontainer.md @@ -1,8 +1,9 @@ # HBoxContainer -#####**Inherits:** [BoxContainer](class_boxcontainer) +####**Inherits:** [BoxContainer](class_boxcontainer) +####**Category:** Core ### Brief Description Horizontal box container. ### Description -Horizontal box container. See [[boxcontainer|BoxContainer]]. +Horizontal box container. See [BoxContainer](class_boxcontainer). diff --git a/class_hbuttonarray.md b/class_hbuttonarray.md index 86acd2a..8e3ba55 100644 --- a/class_hbuttonarray.md +++ b/class_hbuttonarray.md @@ -1,8 +1,9 @@ # HButtonArray -#####**Inherits:** [ButtonArray](class_buttonarray) +####**Inherits:** [ButtonArray](class_buttonarray) +####**Category:** Core ### Brief Description Horizontal button array. ### Description -Horizontal button array. See [[buttonarray|ButtonArray]]. +Horizontal button array. See [ButtonArray](class_buttonarray). diff --git a/class_hscrollbar.md b/class_hscrollbar.md index 6e14f66..dafdbe5 100644 --- a/class_hscrollbar.md +++ b/class_hscrollbar.md @@ -1,8 +1,9 @@ # HScrollBar -#####**Inherits:** [ScrollBar](class_scrollbar) +####**Inherits:** [ScrollBar](class_scrollbar) +####**Category:** Core ### Brief Description Horizontal scroll bar. ### Description -Horizontal scroll bar. See [[scrollbar|ScrollBar]]. This one goes from left (min) to right (max). +Horizontal scroll bar. See [ScrollBar](class_scrollbar). This one goes from left (min) to right (max). diff --git a/class_hseparator.md b/class_hseparator.md index 2ee66a4..ae711b1 100644 --- a/class_hseparator.md +++ b/class_hseparator.md @@ -1,8 +1,9 @@ # HSeparator -#####**Inherits:** [Separator](class_separator) +####**Inherits:** [Separator](class_separator) +####**Category:** Core ### Brief Description Horizontal separator. ### Description -Horizontal separator. See [[separator|Separator]]. It is used to separate objects vertiacally, though (but it looks horizontal!). +Horizontal separator. See [Separator](class_separator). It is used to separate objects vertiacally, though (but it looks horizontal!). diff --git a/class_hslider.md b/class_hslider.md index 2c4d67c..d73d152 100644 --- a/class_hslider.md +++ b/class_hslider.md @@ -1,8 +1,9 @@ # HSlider -#####**Inherits:** [Slider](class_slider) +####**Inherits:** [Slider](class_slider) +####**Category:** Core ### Brief Description Horizontal slider. ### Description -Horizontal slider. See [[slider|Slider]]. This one goes from left (min) to right (max). +Horizontal slider. See [Slider](class_slider). This one goes from left (min) to right (max). diff --git a/class_hsplitcontainer.md b/class_hsplitcontainer.md index 0b9ecd3..09b7810 100644 --- a/class_hsplitcontainer.md +++ b/class_hsplitcontainer.md @@ -1,8 +1,9 @@ # HSplitContainer -#####**Inherits:** [SplitContainer](class_splitcontainer) +####**Inherits:** [SplitContainer](class_splitcontainer) +####**Category:** Core ### Brief Description Horizontal split container. ### Description -Horizontal split container. See [[splitcontainer|SplitContainer]]. This goes from left to right. +Horizontal split container. See [SplitContainer](class_splitcontainer). This goes from left to right. diff --git a/class_httpclient.md b/class_httpclient.md index 48dbad9..b794c57 100644 --- a/class_httpclient.md +++ b/class_httpclient.md @@ -1,5 +1,6 @@ # HTTPClient -#####**Inherits:** [Reference](class_reference) +####**Inherits:** [Reference](class_reference) +####**Category:** Core ### Brief Description diff --git a/class_image.md b/class_image.md index 59c7686..3dde32f 100644 --- a/class_image.md +++ b/class_image.md @@ -1,4 +1,5 @@ # Image +####**Category:** Built-In Types ### Brief Description Image datatype. diff --git a/class_imagepathfinder.md b/class_imagepathfinder.md index 14d2472..42dab1b 100644 --- a/class_imagepathfinder.md +++ b/class_imagepathfinder.md @@ -1,5 +1,6 @@ # ImagePathFinder -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description diff --git a/class_imagetexture.md b/class_imagetexture.md index d6c394a..faf8c23 100644 --- a/class_imagetexture.md +++ b/class_imagetexture.md @@ -1,5 +1,6 @@ # ImageTexture -#####**Inherits:** [Texture](class_texture) +####**Inherits:** [Texture](class_texture) +####**Category:** Core ### Brief Description diff --git a/class_input.md b/class_input.md index d88ba6e..e539095 100644 --- a/class_input.md +++ b/class_input.md @@ -1,5 +1,6 @@ # Input -#####**Inherits:** [Object](class_object) +####**Inherits:** [Object](class_object) +####**Category:** Core ### Brief Description @@ -28,4 +29,4 @@ Return the global, unscaled, screen pointer coordinates. If the 2D viewport has been scaled, it may not work well - with [[camera|Camera]] or controls. + with [Camera](class_camera) or controls. diff --git a/class_inputdefault.md b/class_inputdefault.md index e3542b1..69ecb71 100644 --- a/class_inputdefault.md +++ b/class_inputdefault.md @@ -1,5 +1,6 @@ # InputDefault -#####**Inherits:** [Input](class_input) +####**Inherits:** [Input](class_input) +####**Category:** Core ### Brief Description diff --git a/class_inputevent.md b/class_inputevent.md index 6342ff6..fd7d342 100644 --- a/class_inputevent.md +++ b/class_inputevent.md @@ -1,4 +1,5 @@ # InputEvent +####**Category:** Built-In Types ### Brief Description Built-in input event data. diff --git a/class_inputeventaction.md b/class_inputeventaction.md index 5874294..8d25efd 100644 --- a/class_inputeventaction.md +++ b/class_inputeventaction.md @@ -1,4 +1,5 @@ # InputEventAction +####**Category:** Built-In Types ### Brief Description diff --git a/class_inputeventjoybutton.md b/class_inputeventjoybutton.md index cf49b62..75c5f5a 100644 --- a/class_inputeventjoybutton.md +++ b/class_inputeventjoybutton.md @@ -1,4 +1,5 @@ # InputEventJoyButton +####**Category:** Built-In Types ### Brief Description diff --git a/class_inputeventjoymotion.md b/class_inputeventjoymotion.md index ddbbc74..4b7b56f 100644 --- a/class_inputeventjoymotion.md +++ b/class_inputeventjoymotion.md @@ -1,4 +1,5 @@ # InputEventJoyMotion +####**Category:** Built-In Types ### Brief Description diff --git a/class_inputeventkey.md b/class_inputeventkey.md index 6fe0c4f..66141fe 100644 --- a/class_inputeventkey.md +++ b/class_inputeventkey.md @@ -1,4 +1,5 @@ # InputEventKey +####**Category:** Built-In Types ### Brief Description diff --git a/class_inputeventmousebutton.md b/class_inputeventmousebutton.md index e54182b..e9bfab6 100644 --- a/class_inputeventmousebutton.md +++ b/class_inputeventmousebutton.md @@ -1,4 +1,5 @@ # InputEventMouseButton +####**Category:** Built-In Types ### Brief Description diff --git a/class_inputeventmousemotion.md b/class_inputeventmousemotion.md index 6eb803c..55dfa5b 100644 --- a/class_inputeventmousemotion.md +++ b/class_inputeventmousemotion.md @@ -1,4 +1,5 @@ # InputEventMouseMotion +####**Category:** Built-In Types ### Brief Description diff --git a/class_inputeventscreendrag.md b/class_inputeventscreendrag.md index 8b43a09..d2cba90 100644 --- a/class_inputeventscreendrag.md +++ b/class_inputeventscreendrag.md @@ -1,4 +1,5 @@ # InputEventScreenDrag +####**Category:** Built-In Types ### Brief Description diff --git a/class_inputeventscreentouch.md b/class_inputeventscreentouch.md index 6f10632..ee829a5 100644 --- a/class_inputeventscreentouch.md +++ b/class_inputeventscreentouch.md @@ -1,4 +1,5 @@ # InputEventScreenTouch +####**Category:** Built-In Types ### Brief Description diff --git a/class_inputmap.md b/class_inputmap.md index da52aa7..d3802af 100644 --- a/class_inputmap.md +++ b/class_inputmap.md @@ -1,5 +1,6 @@ # InputMap -#####**Inherits:** [Object](class_object) +####**Inherits:** [Object](class_object) +####**Category:** Core ### Brief Description Singleton that manages actions. diff --git a/class_int.md b/class_int.md index 925b6c3..07015f3 100644 --- a/class_int.md +++ b/class_int.md @@ -1,4 +1,5 @@ # int +####**Category:** Built-In Types ### Brief Description Integer built-in type. diff --git a/class_intarray.md b/class_intarray.md index 205d6ba..a8b627b 100644 --- a/class_intarray.md +++ b/class_intarray.md @@ -1,4 +1,5 @@ # IntArray +####**Category:** Built-In Types ### Brief Description Integer Array . diff --git a/class_interpolatedcamera.md b/class_interpolatedcamera.md index 93562b5..e5bab36 100644 --- a/class_interpolatedcamera.md +++ b/class_interpolatedcamera.md @@ -1,5 +1,6 @@ # InterpolatedCamera -#####**Inherits:** [Camera](class_camera) +####**Inherits:** [Camera](class_camera) +####**Category:** Core ### Brief Description diff --git a/class_ip.md b/class_ip.md index d5b55a1..17e133f 100644 --- a/class_ip.md +++ b/class_ip.md @@ -1,5 +1,6 @@ # IP -#####**Inherits:** [Object](class_object) +####**Inherits:** [Object](class_object) +####**Category:** Core ### Brief Description IP Protocol support functions. @@ -20,7 +21,7 @@ IP Protocol support functions. * **RESOLVER_INVALID_ID** = **-1** ### Description -IP contains some support functions for the IPv4 protocol. TCP/IP support is in different classes (see [TCP_Client], [[tcp_server|TCP_Server]]). IP provides hostname resolution support, both blocking and threaded. +IP contains some support functions for the IPv4 protocol. TCP/IP support is in different classes (see [TCP_Client], [TCP_Server](class_tcp_server)). IP provides hostname resolution support, both blocking and threaded. ### Member Function Description @@ -42,7 +43,7 @@ Return the status of hostname queued for resolving, given it"apos;s queue ID. Re #### get_resolve_item_address * [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]]). +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`** **(** [int](class_int) id **)** diff --git a/class_ip_unix.md b/class_ip_unix.md index fc0893d..d524c31 100644 --- a/class_ip_unix.md +++ b/class_ip_unix.md @@ -1,5 +1,6 @@ # IP_Unix -#####**Inherits:** [IP](class_ip) +####**Inherits:** [IP](class_ip) +####**Category:** Core ### Brief Description diff --git a/class_joint2d.md b/class_joint2d.md index e72e6aa..6c51d96 100644 --- a/class_joint2d.md +++ b/class_joint2d.md @@ -1,5 +1,6 @@ # Joint2D -#####**Inherits:** [Node2D](class_node2d) +####**Inherits:** [Node2D](class_node2d) +####**Category:** Core ### Brief Description Base node for all joint constraints in 2D phyisics. diff --git a/class_label.md b/class_label.md index 1d4401e..ddc37bf 100644 --- a/class_label.md +++ b/class_label.md @@ -1,5 +1,6 @@ # Label -#####**Inherits:** [Range](class_range) +####**Inherits:** [Range](class_range) +####**Category:** Core ### Brief Description Control that displays formatted text. @@ -33,7 +34,7 @@ Control that displays formatted text. * **VALIGN_FILL** = **3** - Align the whole text by spreading the rows. ### Description -Label is a control that displays formatted text, optionally autowrapping it to the [[control|Control]] area. It inherits from range to be able to scroll wrapped text vertically. +Label is a control that displays formatted text, optionally autowrapping it to the [Control](class_control) area. It inherits from range to be able to scroll wrapped text vertically. ### Member Function Description @@ -60,12 +61,12 @@ Return the label text. Text can contain newlines. #### set_autowrap * 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. +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`** **(** **)** const -Return the state of the //autowrap// mode (see [[#set_autowrap|set_autowrap]]). +Return the state of the _autowrap_ mode (see [`set_autowrap`](#set_autowrap)). #### get_line_height * [int](class_int) **`get_line_height`** **(** **)** const diff --git a/class_largetexture.md b/class_largetexture.md index 542857b..1fe7c9e 100644 --- a/class_largetexture.md +++ b/class_largetexture.md @@ -1,5 +1,6 @@ # LargeTexture -#####**Inherits:** [Texture](class_texture) +####**Inherits:** [Texture](class_texture) +####**Category:** Core ### Brief Description diff --git a/class_light.md b/class_light.md index 4446c78..9531dd8 100644 --- a/class_light.md +++ b/class_light.md @@ -1,5 +1,6 @@ # Light -#####**Inherits:** [VisualInstance](class_visualinstance) +####**Inherits:** [VisualInstance](class_visualinstance) +####**Category:** Core ### Brief Description Provides a base class for different kinds of light nodes. diff --git a/class_lineedit.md b/class_lineedit.md index 2767180..056ffa8 100644 --- a/class_lineedit.md +++ b/class_lineedit.md @@ -1,5 +1,6 @@ # LineEdit -#####**Inherits:** [Control](class_control) +####**Inherits:** [Control](class_control) +####**Category:** Core ### Brief Description Control that provides single line string editing. @@ -32,7 +33,7 @@ LineEdit provides a single line string editor, used for text fields. #### clear * void **`clear`** **(** **)** -Clear the [[lineedit|LineEdit]] text. +Clear the [LineEdit](class_lineedit) text. #### select_all * void **`select_all`** **(** **)** @@ -42,54 +43,54 @@ Select the whole string. #### set_text * void **`set_text`** **(** [String](class_string) text **)** -Set the text in the [[lineedit|LineEdit]], clearing the existing one and the selection. +Set the text in the [LineEdit](class_lineedit), clearing the existing one and the selection. #### get_text * [String](class_string) **`get_text`** **(** **)** const -Return the text in the [[lineedit|LineEdit]]. +Return the text in the [LineEdit](class_lineedit). #### set_cursor_pos * void **`set_cursor_pos`** **(** [int](class_int) pos **)** -Set the cursor position inside the [[lineedit|LineEdit]], causing it to scroll if needed. +Set the cursor position inside the [LineEdit](class_lineedit), causing it to scroll if needed. #### get_cursor_pos * [int](class_int) **`get_cursor_pos`** **(** **)** const -Return the cursor position inside the [[lineedit|LineEdit]]. +Return the cursor position inside the [LineEdit](class_lineedit). #### set_max_length * 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. +Set the maximum amount of characters the [LineEdit](class_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`** **(** **)** const -Return the maximum amount of characters the [[lineedit|LineEdit]] can edit. If 0 is returned, no limit exists. +Return the maximum amount of characters the [LineEdit](class_lineedit) can edit. If 0 is returned, no limit exists. #### append_at_cursor * void **`append_at_cursor`** **(** [String](class_string) text **)** -Append text at cursor, scrolling the [[lineedit|LineEdit]] when needed. +Append text at cursor, scrolling the [LineEdit](class_lineedit) when needed. #### set_editable * 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. +Set the _editable_ status of the [LineEdit](class_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`** **(** **)** const -Return the //editable// status of the [[lineedit|LineEdit]] (see [[#set_editable|set_editable]]). +Return the _editable_ status of the [LineEdit](class_lineedit) (see [`set_editable`](#set_editable)). #### set_secret * void **`set_secret`** **(** [bool](class_bool) enabled **)** -Set the //secret// status of the [[lineedit|LineEdit]]. When enabled, every character is displayed as "*". +Set the _secret_ status of the [LineEdit](class_lineedit). When enabled, every character is displayed as "*". #### is_secret * [bool](class_bool) **`is_secret`** **(** **)** const -Return the //secret// status of the [[lineedit|LineEdit]] (see [[#set_secret|set_secret]]). +Return the _secret_ status of the [LineEdit](class_lineedit) (see [`set_secret`](#set_secret)). diff --git a/class_lineshape2d.md b/class_lineshape2d.md index a24f439..8fe5c80 100644 --- a/class_lineshape2d.md +++ b/class_lineshape2d.md @@ -1,5 +1,6 @@ # LineShape2D -#####**Inherits:** [Shape2D](class_shape2d) +####**Inherits:** [Shape2D](class_shape2d) +####**Category:** Core ### Brief Description Line shape for 2D collision objects. diff --git a/class_mainloop.md b/class_mainloop.md index 7fd95ca..60775f2 100644 --- a/class_mainloop.md +++ b/class_mainloop.md @@ -1,5 +1,6 @@ # MainLoop -#####**Inherits:** [Object](class_object) +####**Inherits:** [Object](class_object) +####**Category:** Core ### Brief Description Main loop is the abstract main loop base class. @@ -14,6 +15,6 @@ Main loop is the abstract main loop base class. * **NOTIFICATION_WM_UNFOCUS_REQUEST** = **8** ### Description -Main loop is the abstract main loop base class. All other main loop classes are derived from it. Upon application start, a [[mainloop|MainLoop]] has to be provided to OS, else the application will exit. This happens automatically (and a [[scenemainloop|SceneMainLoop]] is created), unless a main [[script|Script]] is supplied, which may or not create and return a [[mainloop|MainLoop]]. +Main loop is the abstract main loop base class. All other main loop classes are derived from it. Upon application start, a [MainLoop](class_mainloop) has to be provided to OS, else the application will exit. This happens automatically (and a [SceneMainLoop](class_scenemainloop) is created), unless a main [Script](class_script) is supplied, which may or not create and return a [MainLoop](class_mainloop). ### Member Function Description diff --git a/class_margincontainer.md b/class_margincontainer.md index 51f7048..6c99a93 100644 --- a/class_margincontainer.md +++ b/class_margincontainer.md @@ -1,5 +1,6 @@ # MarginContainer -#####**Inherits:** [Container](class_container) +####**Inherits:** [Container](class_container) +####**Category:** Core ### Brief Description Simple margin container. diff --git a/class_marshalls.md b/class_marshalls.md index c2ccc8e..db4d44c 100644 --- a/class_marshalls.md +++ b/class_marshalls.md @@ -1,5 +1,6 @@ # Marshalls -#####**Inherits:** [Reference](class_reference) +####**Inherits:** [Reference](class_reference) +####**Category:** Core ### Brief Description diff --git a/class_material.md b/class_material.md index 98222d4..1733ea9 100644 --- a/class_material.md +++ b/class_material.md @@ -1,8 +1,9 @@ # Material -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description -Abstract base [[resource|Resource]] for coloring and shading geometry. +Abstract base [Resource](class_resource) for coloring and shading geometry. ### Member Functions * void **[`set_flag`](#set_flag)** **(** [int](class_int) flag, [bool](class_bool) enable **)** @@ -43,29 +44,29 @@ Abstract base [[resource|Resource]] for coloring and shading geometry. * **BLEND_MODE_SUB** = **2** - Use substractive blending equation, often used for some smoke effects or types of glass. ### Description -Material is a base [[resource|Resource]] used for coloring and shading geometry. All materials inherit from it and almost all [[visualinstance|VisualInstance]] derived nodes carry a Material. A few flags and parameters are shared between all material types and are configured here. +Material is a base [Resource](class_resource) used for coloring and shading geometry. All materials inherit from it and almost all [VisualInstance](class_visualinstance) derived nodes carry a Material. A few flags and parameters are shared between all material types and are configured here. ### Member Function Description #### set_flag * 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. +Set a [Material](class_material) flag, which toggles on or off a behavior when rendering. See enumeration FLAG_* for a list. #### get_flag * [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. +Return a [Material](class_material) flag, which toggles on or off a behavior when rendering. See enumeration FLAG_* for a list. #### set_blend_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. +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](class_visualserver) implementations. #### get_blend_mode * [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. +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](class_visualserver) implementations. #### set_line_width * void **`set_line_width`** **(** [real](class_real) width **)** diff --git a/class_matrix3.md b/class_matrix3.md index f91623f..21e3b43 100644 --- a/class_matrix3.md +++ b/class_matrix3.md @@ -1,4 +1,5 @@ # Matrix3 +####**Category:** Built-In Types ### Brief Description 3x3 matrix datatype. @@ -27,7 +28,7 @@ * [Vector3](class_vector3) **z** ### Description -3x3 matrix used for 3D rotation and scale. Contains 3 vector fields x,y and z. Can also be accessed as array of 3D vectors. Almost always used as orthogonal basis for a [[transform|Transform]]. +3x3 matrix used for 3D rotation and scale. Contains 3 vector fields x,y and z. Can also be accessed as array of 3D vectors. Almost always used as orthogonal basis for a [Transform](class_transform). ### Member Function Description diff --git a/class_matrix32.md b/class_matrix32.md index 4ed1cee..fa22985 100644 --- a/class_matrix32.md +++ b/class_matrix32.md @@ -1,4 +1,5 @@ # Matrix32 +####**Category:** Built-In Types ### Brief Description 3x2 Matrix for 2D transforms. diff --git a/class_menubutton.md b/class_menubutton.md index d393cca..ffd3491 100644 --- a/class_menubutton.md +++ b/class_menubutton.md @@ -1,8 +1,9 @@ # MenuButton -#####**Inherits:** [Button](class_button) +####**Inherits:** [Button](class_button) +####**Category:** Core ### Brief Description -Special button that brings up a [[popupmenu|PopupMenu]] when clicked. +Special button that brings up a [PopupMenu](class_popupmenu) when clicked. ### Member Functions * [Object](class_object) **[`get_popup`](#get_popup)** **(** **)** @@ -11,11 +12,11 @@ Special button that brings up a [[popupmenu|PopupMenu]] when clicked. * **`about_to_show`** **(** **)** ### Description -Special button that brings up a [[popupmenu|PopupMenu]] when clicked. That's pretty much all it does, as it's just a helper class when bulding GUIs. +Special button that brings up a [PopupMenu](class_popupmenu) when clicked. That's pretty much all it does, as it's just a helper class when bulding GUIs. ### Member Function Description #### get_popup * [Object](class_object) **`get_popup`** **(** **)** -Return the [[popupmenu|PopupMenu]] contained in this button. +Return the [PopupMenu](class_popupmenu) contained in this button. diff --git a/class_mesh.md b/class_mesh.md index 1a585fa..fefe7dc 100644 --- a/class_mesh.md +++ b/class_mesh.md @@ -1,8 +1,9 @@ # Mesh -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description -A [[resource|Resource]] that contains vertex-array based geometry. +A [Resource](class_resource) that contains vertex-array based geometry. ### Member Functions * void **[`add_morph_target`](#add_morph_target)** **(** [String](class_string) name **)** @@ -54,21 +55,21 @@ A [[resource|Resource]] that contains vertex-array based geometry. * **PRIMITIVE_TRIANGLE_FAN** = **6** - Render array as triangle fans. ### Description -Mesh is a type of [[resource|Resource]] that contains vertex-array based geometry, divided in //surfaces//. Each surface contains a completely separate array and a material used to draw it. Design wise, a mesh with multiple surfaces is prefered to a single surface, because objects created in 3D editing software commonly contain multiple materials. +Mesh is a type of [Resource](class_resource) that contains vertex-array based geometry, divided in _surfaces_. Each surface contains a completely separate array and a material used to draw it. Design wise, a mesh with multiple surfaces is prefered to a single surface, because objects created in 3D editing software commonly contain multiple materials. ### Member Function Description #### add_surface * 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).\\ +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`** **(** **)** const -Return the amount of surfaces that the [[mesh|Mesh]] holds. +Return the amount of surfaces that the [Mesh](class_mesh) holds. #### surface_remove * void **`surface_remove`** **(** [int](class_int) surf_idx **)** @@ -78,29 +79,29 @@ Remove a surface at position surf_idx, shifting greater surfaces one surf_idx sl #### surface_get_array_len * [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]]). +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`** **(** [int](class_int) surf_idx **)** const -Return the length in indices of the index array in the requested surface (see [[#add_surface|add_surface]]). +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`** **(** [int](class_int) surf_idx **)** const -Return the format mask of the requested surface (see [[#add_surface|add_surface]]). +Return the format mask of the requested surface (see [`add_surface`](#add_surface)). #### surface_get_primitive_type * [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]]). +Return the primitive type of the requested surface (see [`add_surface`](#add_surface)). #### surface_set_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. +Set a [Material](class_material) for a given surface. Surface will be rendered using this material. #### surface_get_material * [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. +Return a [Material](class_material) in a given surface. Surface is rendered using this material. diff --git a/class_meshdatatool.md b/class_meshdatatool.md index de05524..3e824d9 100644 --- a/class_meshdatatool.md +++ b/class_meshdatatool.md @@ -1,5 +1,6 @@ # MeshDataTool -#####**Inherits:** [Reference](class_reference) +####**Inherits:** [Reference](class_reference) +####**Category:** Core ### Brief Description diff --git a/class_meshinstance.md b/class_meshinstance.md index f387eb4..acbfab4 100644 --- a/class_meshinstance.md +++ b/class_meshinstance.md @@ -1,5 +1,6 @@ # MeshInstance -#####**Inherits:** [GeometryInstance](class_geometryinstance) +####**Inherits:** [GeometryInstance](class_geometryinstance) +####**Category:** Core ### Brief Description Node that instances meshes into a [Scenario]. @@ -12,19 +13,19 @@ Node that instances meshes into a [Scenario]. * void **[`create_convex_collision`](#create_convex_collision)** **(** **)** ### Description -MeshInstance is a [[node|Node]] that takes a [[mesh|Mesh]] resource and adds it to the current [Scenario] by creating an instance of it. This is the class most often used to get 3D geometry rendered and can be used to instance a sigle [[mesh|Mesh]] in many places. This allows to reuse geometry and save on resources. When a [[mesh|Mesh]] has to be instanced more than thousands of times at close proximity, consider using a [[multimesh|MultiMesh]] in a [[multimeshinstance|MultiMeshInstance]] instead. +MeshInstance is a [Node](class_node) that takes a [Mesh](class_mesh) resource and adds it to the current [Scenario] by creating an instance of it. This is the class most often used to get 3D geometry rendered and can be used to instance a sigle [Mesh](class_mesh) in many places. This allows to reuse geometry and save on resources. When a [Mesh](class_mesh) has to be instanced more than thousands of times at close proximity, consider using a [MultiMesh](class_multimesh) in a [MultiMeshInstance](class_multimeshinstance) instead. ### Member Function Description #### set_mesh * void **`set_mesh`** **(** [Mesh](class_mesh) mesh **)** -Set the [[mesh|Mesh]] resource for the instance. +Set the [Mesh](class_mesh) resource for the instance. #### get_mesh * [Mesh](class_mesh) **`get_mesh`** **(** **)** const -Return the current [[mesh|Mesh]] resource for the instance. +Return the current [Mesh](class_mesh) resource for the instance. #### get_aabb * [AABB](class_aabb) **`get_aabb`** **(** **)** const @@ -34,4 +35,4 @@ Return the AABB of the mesh, in local coordinates. #### 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. +This helper creates a [StaticBody](class_staticbody) child [Node](class_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 cd33b14..1360ece 100644 --- a/class_meshlibrary.md +++ b/class_meshlibrary.md @@ -1,5 +1,6 @@ # MeshLibrary -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description Library of meshes. @@ -18,7 +19,7 @@ Library of meshes. * [int](class_int) **[`get_last_unused_item_id`](#get_last_unused_item_id)** **(** **)** const ### Description -Library of meshes. Contains a list of [[mesh|Mesh]] resources, each with name and ID. Useful for GridMap or painting Terrain. +Library of meshes. Contains a list of [Mesh](class_mesh) resources, each with name and ID. Useful for GridMap or painting Terrain. ### Member Function Description diff --git a/class_multimesh.md b/class_multimesh.md index 39ec7cf..9a3f9be 100644 --- a/class_multimesh.md +++ b/class_multimesh.md @@ -1,5 +1,6 @@ # MultiMesh -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description Provides high perfomance mesh instancing. @@ -18,22 +19,22 @@ Provides high perfomance mesh instancing. * void **[`generate_aabb`](#generate_aabb)** **(** **)** ### Description -MultiMesh provides low level mesh instancing. If the amount of [[mesh|Mesh]] instances needed goes from hundreds to thousands (and most need to be visible at close proximity) creating such a large amount of [[meshinstance|MeshInstance]] nodes may affect performance by using too much CPU or video memory. \\ -For this case a MultiMesh becomes very useful, as it can draw thousands of instances with little API overhead.\\ - As a drawback, if the instances are too far away of each other, performance may be reduced as every sigle instance will always rendered (they are spatially indexed as one, for the whole object).\\ - Since instances may have any behavior, the AABB used for visibility must be provided by the user, or generated with [[#generate_aabb|generate_aabb]]. +MultiMesh provides low level mesh instancing. If the amount of [Mesh](class_mesh) instances needed goes from hundreds to thousands (and most need to be visible at close proximity) creating such a large amount of [MeshInstance](class_meshinstance) nodes may affect performance by using too much CPU or video memory. +For this case a MultiMesh becomes very useful, as it can draw thousands of instances with little API overhead. + As a drawback, if the instances are too far away of each other, performance may be reduced as every sigle instance will always rendered (they are spatially indexed as one, for the whole object). + Since instances may have any behavior, the AABB used for visibility must be provided by the user, or generated with [`generate_aabb`](#generate_aabb). ### Member Function Description #### set_mesh * void **`set_mesh`** **(** [Mesh](class_mesh) mesh **)** -Set the [[mesh|Mesh]] resource to be drawn in multiple instances. +Set the [Mesh](class_mesh) resource to be drawn in multiple instances. #### get_mesh * [Mesh](class_mesh) **`get_mesh`** **(** **)** const -Return the [[mesh|Mesh]] resource drawn as multiple instances. +Return the [Mesh](class_mesh) resource drawn as multiple instances. #### set_instance_count * void **`set_instance_count`** **(** [int](class_int) arg0 **)** @@ -78,4 +79,4 @@ Return the visibility 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. +Generate a new visibility AABB, using mesh AABB and instance transforms. Since instance information is stored in the [VisualServer](class_visualserver), this function is VERY SLOW and must NOT be used often. diff --git a/class_multimeshinstance.md b/class_multimeshinstance.md index 2ff174a..cbc0949 100644 --- a/class_multimeshinstance.md +++ b/class_multimeshinstance.md @@ -1,24 +1,25 @@ # MultiMeshInstance -#####**Inherits:** [GeometryInstance](class_geometryinstance) +####**Inherits:** [GeometryInstance](class_geometryinstance) +####**Category:** Core ### Brief Description -Node that instances a [[multimesh|MultiMesh]]. +Node that instances a [MultiMesh](class_multimesh). ### Member Functions * void **[`set_multimesh`](#set_multimesh)** **(** [Object](class_object) multimesh **)** * [Object](class_object) **[`get_multimesh`](#get_multimesh)** **(** **)** const ### Description -MultiMeshInstance is a [[node|Node]] that takes a [[multimesh|MultiMesh]] resource and adds it to the current [Scenario] by creating an instance of it (yes, this is an instance of instances). +MultiMeshInstance is a [Node](class_node) that takes a [MultiMesh](class_multimesh) resource and adds it to the current [Scenario] by creating an instance of it (yes, this is an instance of instances). ### Member Function Description #### set_multimesh * void **`set_multimesh`** **(** [Object](class_object) multimesh **)** -Set the [[multimesh|MultiMesh]] to be instance. +Set the [MultiMesh](class_multimesh) to be instance. #### get_multimesh * [Object](class_object) **`get_multimesh`** **(** **)** const -Return the [[multimesh|MultiMesh]] that is used for instancing. +Return the [MultiMesh](class_multimesh) that is used for instancing. diff --git a/class_multiscript.md b/class_multiscript.md index c8e3fba..775df85 100644 --- a/class_multiscript.md +++ b/class_multiscript.md @@ -1,5 +1,6 @@ # MultiScript -#####**Inherits:** [Script](class_script) +####**Inherits:** [Script](class_script) +####**Category:** Core ### Brief Description diff --git a/class_mutex.md b/class_mutex.md index ac10ab2..99870d3 100644 --- a/class_mutex.md +++ b/class_mutex.md @@ -1,5 +1,6 @@ # Mutex -#####**Inherits:** [Reference](class_reference) +####**Inherits:** [Reference](class_reference) +####**Category:** Core ### Brief Description diff --git a/class_nil.md b/class_nil.md index 4b1366f..436905d 100644 --- a/class_nil.md +++ b/class_nil.md @@ -1,4 +1,5 @@ # Nil +####**Category:** Built-In Types ### Brief Description diff --git a/class_node.md b/class_node.md index 20a81ac..ec6890c 100644 --- a/class_node.md +++ b/class_node.md @@ -1,5 +1,6 @@ # Node -#####**Inherits:** [Object](class_object) +####**Inherits:** [Object](class_object) +####**Category:** Core ### Brief Description Base class for all the "Scene" elements. @@ -87,11 +88,11 @@ Base class for all the "Scene" elements. ### Description Nodes can be set as children of other nodes, resulting in a tree arrangement. Any tree of nodes is called a "Scene". Scenes can be saved to disk, and then instanced into other scenes. This allows for very high flexibility in the architecture and data model of the projects. - [[scenemainloop|SceneMainLoop]] contains the "active" tree of nodes, and a node becomes active (receinving NOTIFICATION_ENTER_SCENE) when added to that tree. + [SceneMainLoop](class_scenemainloop) contains the "active" tree of nodes, and a node becomes active (receinving NOTIFICATION_ENTER_SCENE) when added to that tree. A node can contain any number of nodes as a children (but there is only one tree root) with the requirement that no two childrens with the same name can exist. Nodes can, optionally, be added to groups. This makes it easy to reach a number of nodes from the code (for example an "enemies" group). - Nodes can be set to "process" state, so they constantly receive a callback requesting them to process (do anything). Normal processing ([[#_process|_process]]) happens as fast as possible and is dependent on the frame rate, so the processing time delta is variable. Fixed processing ([[#_fixed_process|_fixed_process]]) happens a fixed amount of times per second (by default 60) and is useful to link itself to the physics. - Nodes can also process input events. When set, the [[#_input|_input]] function will be called with every input that the program receives. Since this is usually too overkill (unless used for simple projects), an [[#_unhandled_input|_unhandled_input]] function is called when the input was not handled by anyone else (usually, GUI [[control|Control]] nodes). + Nodes can be set to "process" state, so they constantly receive a callback requesting them to process (do anything). Normal processing ([`_process`](#_process)) happens as fast as possible and is dependent on the frame rate, so the processing time delta is variable. Fixed processing ([`_fixed_process`](#_fixed_process)) happens a fixed amount of times per second (by default 60) and is useful to link itself to the physics. + Nodes can also process input events. When set, the [`_input`](#_input) function will be called with every input that the program receives. Since this is usually too overkill (unless used for simple projects), an [`_unhandled_input`](#_unhandled_input) function is called when the input was not handled by anyone else (usually, GUI [Control](class_control) nodes). To keep track of the scene hieararchy (specially when instancing scenes into scenes) an "owner" can be set to a node. This keeps track of who instanced what. This is mostly useful when writing editors and tools, though. Finally, when a node is freed, it will free all its children nodes too. @@ -115,7 +116,7 @@ Called for fixed processing (synced to the physics). #### _input * 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). +Called when any input happens (also must enable with [`set_process_input`](#set_process_input) or the property). #### _process * void **`_process`** **(** [real](class_real) delta **)** virtual @@ -130,7 +131,7 @@ Called when ready (entered scene and children entered too). #### _unhandled_input * 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). +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`** **(** [InputEvent](class_inputevent) key_event **)** virtual @@ -140,22 +141,22 @@ Called when any key input happens that was not handled by something else. #### set_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. +Set the name of the [Node](class_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`** **(** **)** const -Return the name of the [[node|Node]]. Name is be unique within parent. +Return the name of the [Node](class_node). Name is be unique within parent. #### add_child * 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. +Add a child [Node](class_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`** **(** [Node](class_node) node **)** -Remove a child [[node|Node]]. Node is NOT deleted and will have to be deleted manually. +Remove a child [Node](class_node). Node is NOT deleted and will have to be deleted manually. #### get_child_count * [int](class_int) **`get_child_count`** **(** **)** const @@ -165,19 +166,19 @@ Return the amount of children nodes. #### get_child * [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. +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`** **(** [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]]). +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`** **(** **)** const -Return the parent [[node|Node]] of the current [[node|Node]], or an empty Object if the node lacks a parent. +Return the parent [Node](class_node) of the current [Node](class_node), or an empty Object if the node lacks a parent. #### is_inside_scene * [bool](class_bool) **`is_inside_scene`** **(** **)** const @@ -187,17 +188,17 @@ Return wether the node is inside a scene tree (a tree where the topmost node is #### is_a_parent_of * [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//. +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`** **(** [Node](class_node) node **)** const -Return //true// if "node" occurs later in the scene hierarchy than the current node, otherwise return //false//. +Return _true_ if "node" occurs later in the scene hierarchy than the current node, otherwise return _false_. #### get_path * [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]]). +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`** **(** [Node](class_node) node **)** const @@ -207,7 +208,7 @@ Return the relative path from the current node to the specified node in "node" a #### add_to_group * 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]]). +Add a node to a group. Groups are helpers to name and organize group of nodes, like for example: "Enemies" "Collectables", etc. A [Node](class_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`** **(** [String](class_string) group **)** @@ -222,7 +223,7 @@ Move a child node to a different position (order) amongst the other children. Si #### 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. +Move this node to the top of the array of nodes of the parent node. This is often useful on GUIs ([Control](class_control)), because their order of drawing fully depends on their order in the tree. #### set_owner * void **`set_owner`** **(** [Node](class_node) owner **)** @@ -232,7 +233,7 @@ Set the node owner. A node can have any other node as owner (as long as a valid #### get_owner * [Node](class_node) **`get_owner`** **(** **)** const -Get the node owner (see [[#set_node_owner|set_node_owner]]). +Get the node owner (see [`set_node_owner`](#set_node_owner)). #### remove_and_skip * void **`remove_and_skip`** **(** **)** @@ -257,7 +258,7 @@ A node can contain a filename. This filename should not be changed by the user, #### get_filename * [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]]). +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`** **(** [int](class_int) what **)** @@ -267,22 +268,22 @@ Notify the current node and all its chldren recursively by calling notification( #### set_fixed_process * 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]]. +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](class_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`** **(** **)** 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]]. +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](class_os). #### is_fixed_processing * [bool](class_bool) **`is_fixed_processing`** **(** **)** const -Return true if fixed processing is enabled (see [[#set_fixed_process|set_fixed_process]]). +Return true if fixed processing is enabled (see [`set_fixed_process`](#set_fixed_process)). #### set_process * 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]]. +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`** **(** **)** const @@ -292,27 +293,27 @@ Return the time elapsed (in seconds) since the last process callback. This is al #### is_processing * [bool](class_bool) **`is_processing`** **(** **)** const -Return wether processing is enabled in the current node (see [[#set_process|set_process]]). +Return wether processing is enabled in the current node (see [`set_process`](#set_process)). #### set_process_input * 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]]). +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`** **(** **)** const -Return true if the node is processing input (see [[#set_process_input|set_process_input]]). +Return true if the node is processing input (see [`set_process_input`](#set_process_input)). #### set_process_unhandled_input * 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]]). +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](class_control)). (see [`_unhandled_input`](#_unhandled_input)). #### is_processing_unhandled_input * [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]]). +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`** **(** **)** const diff --git a/class_node2d.md b/class_node2d.md index 43567c0..3c4fa57 100644 --- a/class_node2d.md +++ b/class_node2d.md @@ -1,5 +1,6 @@ # Node2D -#####**Inherits:** [CanvasItem](class_canvasitem) +####**Inherits:** [CanvasItem](class_canvasitem) +####**Category:** Core ### Brief Description Base node for 2D system. @@ -18,7 +19,7 @@ Base node for 2D system. ### Description Base node for 2D system. Node2D contains a position, rotation and scale, which is used to position and animate. - It can alternatively be used with a custom 2D transform ([[matrix32|Matrix32]]). + It can alternatively be used with a custom 2D transform ([Matrix32](class_matrix32)). A tree of Node2Ds allows complex hierachies for animation and positioning. ### Member Function Description diff --git a/class_nodepath.md b/class_nodepath.md index 0f97ebf..c0e0466 100644 --- a/class_nodepath.md +++ b/class_nodepath.md @@ -1,4 +1,5 @@ # NodePath +####**Category:** Built-In Types ### Brief Description Built-in type optimized for path traversing. diff --git a/class_object.md b/class_object.md index 4915429..eb6242f 100644 --- a/class_object.md +++ b/class_object.md @@ -1,4 +1,5 @@ # Object +####**Category:** Core ### Brief Description Base class for all non built-in types. @@ -51,10 +52,10 @@ Base class for all non built-in types. ### Description Base class for all non built-in types. Everything not a built-in type starts the inheritance chain from this class. - Objects do not manage memory, if inheriting from one the object will most likely have to be deleted manually (call the [[#free|free]] function from the script or delete from C++). - Some derivates add memory management, such as [[reference|Reference]] (which keps a reference count and deletes itself automatically when no longer referenced) and [[node|Node]], which deletes the children tree when deleted. - Objects export properties, which are mainly useful for storage and editing, but not really so much in programming. Properties are exported in [[#_get_property_list|_get_property_list]] and handled in [[#_get|_get]] and [_set]. However, scripting languages and C++ have simper means to export them. - Objects also receive notifications ([[#_notification|_notification]]). Notifications are a simple way to notify the object about simple events, so they can all be handled together. + Objects do not manage memory, if inheriting from one the object will most likely have to be deleted manually (call the [`free`](#free) function from the script or delete from C++). + Some derivates add memory management, such as [Reference](class_reference) (which keps a reference count and deletes itself automatically when no longer referenced) and [Node](class_node), which deletes the children tree when deleted. + Objects export properties, which are mainly useful for storage and editing, but not really so much in programming. Properties are exported in [`_get_property_list`](#_get_property_list) and handled in [`_get`](#_get) and [_set]. However, scripting languages and C++ have simper means to export them. + Objects also receive notifications ([`_notification`](#_notification)). Notifications are a simple way to notify the object about simple events, so they can all be handled together. ### Member Function Description @@ -126,7 +127,7 @@ Return the object script (or null if it doesn't have one). #### set_meta * void **`set_meta`** **(** [String](class_string) name, var value **)** -Set a metadata into the object. Medatada is serialized. Metadata can be //anything//. +Set a metadata into the object. Medatada is serialized. Metadata can be _anything_. #### get_meta * void **`get_meta`** **(** [String](class_string) name **)** const @@ -172,7 +173,7 @@ Return the list of signals as an array of dictionaries. * 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. + 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`** **(** [String](class_string) signal, [Object](class_object) target, [String](class_string) method **)** @@ -212,4 +213,4 @@ deprecated, will go away. #### tr * [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]]. +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_omnilight.md b/class_omnilight.md index 333bd5a..57d306b 100644 --- a/class_omnilight.md +++ b/class_omnilight.md @@ -1,8 +1,9 @@ # OmniLight -#####**Inherits:** [Light](class_light) +####**Inherits:** [Light](class_light) +####**Category:** Core ### Brief Description OmniDirectional Light, such as a lightbulb or a candle. ### Description -An OmniDirectional light is a type of [[light|Light]] node that emits lights in all directions. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of [[light|Light]]. TODO: Image of an omnilight. +An OmniDirectional light is a type of [Light](class_light) node that emits lights in all directions. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of [Light](class_light). TODO: Image of an omnilight. diff --git a/class_optionbutton.md b/class_optionbutton.md index 5a81a72..ae48591 100644 --- a/class_optionbutton.md +++ b/class_optionbutton.md @@ -1,5 +1,6 @@ # OptionButton -#####**Inherits:** [Button](class_button) +####**Inherits:** [Button](class_button) +####**Category:** Core ### Brief Description Button control that provides selectable options when pressed. @@ -87,7 +88,7 @@ Add a separator to the list of items. Separators help to group items. Separator #### clear * void **`clear`** **(** **)** -Clear all the items in the [[optionbutton|OptionButton]]. +Clear all the items in the [OptionButton](class_optionbutton). #### select * void **`select`** **(** [int](class_int) arg0 **)** diff --git a/class_os.md b/class_os.md index 5c0845a..2956c92 100644 --- a/class_os.md +++ b/class_os.md @@ -1,5 +1,6 @@ # OS -#####**Inherits:** [Object](class_object) +####**Inherits:** [Object](class_object) +####**Category:** Core ### Brief Description Operating System functions. @@ -187,7 +188,7 @@ Return the commandline passed to the engine. #### get_main_loop * [Object](class_object) **`get_main_loop`** **(** **)** const -Return the main loop object (see [[mainloop|MainLoop]]). +Return the main loop object (see [MainLoop](class_mainloop)). #### get_date * [Dictionary](class_dictionary) **`get_date`** **(** **)** const diff --git a/class_packeddatacontainer.md b/class_packeddatacontainer.md index 48fe56b..b24aa28 100644 --- a/class_packeddatacontainer.md +++ b/class_packeddatacontainer.md @@ -1,5 +1,6 @@ # PackedDataContainer -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description diff --git a/class_packeddatacontainerref.md b/class_packeddatacontainerref.md index 2d4ebcb..f8ebbca 100644 --- a/class_packeddatacontainerref.md +++ b/class_packeddatacontainerref.md @@ -1,5 +1,6 @@ # PackedDataContainerRef -#####**Inherits:** [Reference](class_reference) +####**Inherits:** [Reference](class_reference) +####**Category:** Core ### Brief Description diff --git a/class_packedscene.md b/class_packedscene.md index 0f7d8f9..9a49d02 100644 --- a/class_packedscene.md +++ b/class_packedscene.md @@ -1,5 +1,6 @@ # PackedScene -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description diff --git a/class_packetpeer.md b/class_packetpeer.md index 3cc9824..892a896 100644 --- a/class_packetpeer.md +++ b/class_packetpeer.md @@ -1,5 +1,6 @@ # PacketPeer -#####**Inherits:** [Reference](class_reference) +####**Inherits:** [Reference](class_reference) +####**Category:** Core ### Brief Description Abstraction and base class for packet-based protocols. diff --git a/class_packetpeerstream.md b/class_packetpeerstream.md index 98bbf4c..0afa965 100644 --- a/class_packetpeerstream.md +++ b/class_packetpeerstream.md @@ -1,5 +1,6 @@ # PacketPeerStream -#####**Inherits:** [PacketPeer](class_packetpeer) +####**Inherits:** [PacketPeer](class_packetpeer) +####**Category:** Core ### Brief Description Wrapper to use a PacketPeer over a StreamPeer. diff --git a/class_panel.md b/class_panel.md index 5880a7c..1a4735c 100644 --- a/class_panel.md +++ b/class_panel.md @@ -1,9 +1,10 @@ # Panel -#####**Inherits:** [Control](class_control) +####**Inherits:** [Control](class_control) +####**Category:** Core ### Brief Description -Provides an opaque background for [[control|Control]] children. +Provides an opaque background for [Control](class_control) children. ### Description -Panel is a [[control|Control]] that displays an opaque background. It's commoly used as a parent and container for other types of [[control|Control]] +Panel is a [Control](class_control) that displays an opaque background. It's commoly used as a parent and container for other types of [Control](class_control) nodes."#10;"#9;[img]images/panel_example.png[/img] diff --git a/class_panelcontainer.md b/class_panelcontainer.md index be99e7d..e27d78b 100644 --- a/class_panelcontainer.md +++ b/class_panelcontainer.md @@ -1,5 +1,6 @@ # PanelContainer -#####**Inherits:** [Container](class_container) +####**Inherits:** [Container](class_container) +####**Category:** Core ### Brief Description Panel container type. diff --git a/class_parallaxbackground.md b/class_parallaxbackground.md index 3e3575a..b6a8096 100644 --- a/class_parallaxbackground.md +++ b/class_parallaxbackground.md @@ -1,5 +1,6 @@ # ParallaxBackground -#####**Inherits:** [CanvasLayer](class_canvaslayer) +####**Inherits:** [CanvasLayer](class_canvaslayer) +####**Category:** Core ### Brief Description diff --git a/class_parallaxlayer.md b/class_parallaxlayer.md index fae7418..4239f40 100644 --- a/class_parallaxlayer.md +++ b/class_parallaxlayer.md @@ -1,5 +1,6 @@ # ParallaxLayer -#####**Inherits:** [Node2D](class_node2d) +####**Inherits:** [Node2D](class_node2d) +####**Category:** Core ### Brief Description diff --git a/class_particleattractor2d.md b/class_particleattractor2d.md index 3b1518c..eb6dcb0 100644 --- a/class_particleattractor2d.md +++ b/class_particleattractor2d.md @@ -1,5 +1,6 @@ # ParticleAttractor2D -#####**Inherits:** [Node2D](class_node2d) +####**Inherits:** [Node2D](class_node2d) +####**Category:** Core ### Brief Description diff --git a/class_particles.md b/class_particles.md index 9bb7e96..58ea8f6 100644 --- a/class_particles.md +++ b/class_particles.md @@ -1,5 +1,6 @@ # Particles -#####**Inherits:** [GeometryInstance](class_geometryinstance) +####**Inherits:** [GeometryInstance](class_geometryinstance) +####**Category:** Core ### Brief Description Particle system 3D Node @@ -55,7 +56,7 @@ Particle system 3D Node * **VAR_MAX** = **14** ### Description -Particles is a particle system 3D [[node|Node]] that is used to simulate several types of particle effects, such as explosions, rain, snow, fireflies, or other magical-like shinny sparkles. Particles are drawn using impostors, and given their dynamic behavior, the user must provide a visibility AABB (although helpers to create one automatically exist). +Particles is a particle system 3D [Node](class_node) that is used to simulate several types of particle effects, such as explosions, rain, snow, fireflies, or other magical-like shinny sparkles. Particles are drawn using impostors, and given their dynamic behavior, the user must provide a visibility AABB (although helpers to create one automatically exist). ### Member Function Description @@ -77,7 +78,7 @@ Set the "emitting" property state. When emitting, the particle system generates #### is_emitting * [bool](class_bool) **`is_emitting`** **(** **)** const -Return the "emitting" property state (see [[#set_emitting|set_emitting]]). +Return the "emitting" property state (see [`set_emitting`](#set_emitting)). #### set_visibility_aabb * void **`set_visibility_aabb`** **(** [AABB](class_aabb) aabb **)** diff --git a/class_particles2d.md b/class_particles2d.md index da81980..592b642 100644 --- a/class_particles2d.md +++ b/class_particles2d.md @@ -1,5 +1,6 @@ # Particles2D -#####**Inherits:** [Node2D](class_node2d) +####**Inherits:** [Node2D](class_node2d) +####**Category:** Core ### Brief Description diff --git a/class_particlesystemmaterial.md b/class_particlesystemmaterial.md index 6017807..40ccc82 100644 --- a/class_particlesystemmaterial.md +++ b/class_particlesystemmaterial.md @@ -1,5 +1,6 @@ # ParticleSystemMaterial -#####**Inherits:** [Material](class_material) +####**Inherits:** [Material](class_material) +####**Category:** Core ### Brief Description diff --git a/class_path.md b/class_path.md index 82af72f..0cbc03f 100644 --- a/class_path.md +++ b/class_path.md @@ -1,5 +1,6 @@ # Path -#####**Inherits:** [Spatial](class_spatial) +####**Inherits:** [Spatial](class_spatial) +####**Category:** Core ### Brief Description diff --git a/class_path2d.md b/class_path2d.md index 6541f0f..d13543d 100644 --- a/class_path2d.md +++ b/class_path2d.md @@ -1,5 +1,6 @@ # Path2D -#####**Inherits:** [Node2D](class_node2d) +####**Inherits:** [Node2D](class_node2d) +####**Category:** Core ### Brief Description diff --git a/class_pathfollow.md b/class_pathfollow.md index 19415b0..ca2a04b 100644 --- a/class_pathfollow.md +++ b/class_pathfollow.md @@ -1,5 +1,6 @@ # PathFollow -#####**Inherits:** [Spatial](class_spatial) +####**Inherits:** [Spatial](class_spatial) +####**Category:** Core ### Brief Description diff --git a/class_pathremap.md b/class_pathremap.md index 0f71e65..82efc8e 100644 --- a/class_pathremap.md +++ b/class_pathremap.md @@ -1,5 +1,6 @@ # PathRemap -#####**Inherits:** [Object](class_object) +####**Inherits:** [Object](class_object) +####**Category:** Core ### Brief Description Singleton containing the list of remapped resources. diff --git a/class_performance.md b/class_performance.md index 918becd..b1890b2 100644 --- a/class_performance.md +++ b/class_performance.md @@ -1,5 +1,6 @@ # Performance -#####**Inherits:** [Object](class_object) +####**Inherits:** [Object](class_object) +####**Category:** Core ### Brief Description diff --git a/class_phashtranslation.md b/class_phashtranslation.md index de30b50..a3aea92 100644 --- a/class_phashtranslation.md +++ b/class_phashtranslation.md @@ -1,5 +1,6 @@ # PHashTranslation -#####**Inherits:** [Translation](class_translation) +####**Inherits:** [Translation](class_translation) +####**Category:** Core ### Brief Description Optimized translation. diff --git a/class_physics2ddirectbodystate.md b/class_physics2ddirectbodystate.md index cd24ed2..3c52bbd 100644 --- a/class_physics2ddirectbodystate.md +++ b/class_physics2ddirectbodystate.md @@ -1,8 +1,9 @@ # Physics2DDirectBodyState -#####**Inherits:** [Object](class_object) +####**Inherits:** [Object](class_object) +####**Category:** Core ### Brief Description -Direct access object to a physics body in the [[physics2dserver|Physics2DServer]]. +Direct access object to a physics body in the [Physics2DServer](class_physics2dserver). ### Member Functions * [Vector2](class_vector2) **[`get_total_gravity`](#get_total_gravity)** **(** **)** const @@ -32,7 +33,7 @@ Direct access object to a physics body in the [[physics2dserver|Physics2DServer] * [Physics2DDirectSpaceState](class_physics2ddirectspacestate) **[`get_space_state`](#get_space_state)** **(** **)** ### Description -Direct access object to a physics body in the [[physics2dserver|Physics2DServer]]. This object is passed via the direct state callback of rigid/character bodies, and is intended for changing the direct state of that body. +Direct access object to a physics body in the [Physics2DServer](class_physics2dserver). This object is passed via the direct state callback of rigid/character bodies, and is intended for changing the direct state of that body. ### Member Function Description diff --git a/class_physics2ddirectbodystatesw.md b/class_physics2ddirectbodystatesw.md index 77b39b1..26778a2 100644 --- a/class_physics2ddirectbodystatesw.md +++ b/class_physics2ddirectbodystatesw.md @@ -1,5 +1,6 @@ # Physics2DDirectBodyStateSW -#####**Inherits:** [Physics2DDirectBodyState](class_physics2ddirectbodystate) +####**Inherits:** [Physics2DDirectBodyState](class_physics2ddirectbodystate) +####**Category:** Core ### Brief Description diff --git a/class_physics2ddirectspacestate.md b/class_physics2ddirectspacestate.md index 76c8b34..15bb2e6 100644 --- a/class_physics2ddirectspacestate.md +++ b/class_physics2ddirectspacestate.md @@ -1,40 +1,41 @@ # Physics2DDirectSpaceState -#####**Inherits:** [Object](class_object) +####**Inherits:** [Object](class_object) +####**Category:** Core ### Brief Description -Direct access object to a space in the [[physics2dserver|Physics2DServer]]. +Direct access object to a space in the [Physics2DServer](class_physics2dserver). ### Member Functions * 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_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 **)** ### Description -Direct access object to a space in the [[physics2dserver|Physics2DServer]]. It's used mainly to do queries against objects and areas residing in a given space. +Direct access object to a space in the [Physics2DServer](class_physics2dserver). It's used mainly to do queries against objects and areas residing in a given space. ### Member Function Description #### intersect_ray * 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: \\ +Intersect a ray in a given space, the returned object is a dictionary with the following fields: - position: place where ray is stopped\\ + position: place where ray is stopped - normal: normal of the object at the point where the ray was stopped \\ + normal: normal of the object at the point where the ray was stopped - shape: shape index of the object agaisnt which the ray was stopped\\ + shape: shape index of the object agaisnt which the ray was stopped - collider_: collider agaisnt which the ray was stopped\\ + collider_: collider agaisnt which the ray was stopped - collider_id: collider id of the object agaisnt which the ray was stopped\\ + collider_id: collider id of the object agaisnt which the ray was stopped - collider: collider object agaisnt which the ray was stopped\\ + collider: collider object agaisnt which the ray was stopped - rid: [[rid|RID]] of the object agaisnt which the ray was stopped\\ + rid: [RID](class_rid) of the object agaisnt which the ray was stopped - If the ray did not intersect anything, then null is returned instead of a [[dictionary|Dictionary]]. + If the ray did not intersect anything, then null is returned instead of a [Dictionary](class_dictionary). #### intersect_shape * 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. +Intersect a given shape (RID or [Shape2D](class_shape2d)) against the space, the intersected shapes are returned in a special result object. diff --git a/class_physics2dserver.md b/class_physics2dserver.md index cfb0690..94dd654 100644 --- a/class_physics2dserver.md +++ b/class_physics2dserver.md @@ -1,5 +1,6 @@ # Physics2DServer -#####**Inherits:** [Object](class_object) +####**Inherits:** [Object](class_object) +####**Category:** Core ### Brief Description Physics 2D Server. diff --git a/class_physics2dserversw.md b/class_physics2dserversw.md index 19b6e7d..980c78e 100644 --- a/class_physics2dserversw.md +++ b/class_physics2dserversw.md @@ -1,5 +1,6 @@ # Physics2DServerSW -#####**Inherits:** [Physics2DServer](class_physics2dserver) +####**Inherits:** [Physics2DServer](class_physics2dserver) +####**Category:** Core ### Brief Description diff --git a/class_physics2dshapequeryresult.md b/class_physics2dshapequeryresult.md index 4006db2..3622aeb 100644 --- a/class_physics2dshapequeryresult.md +++ b/class_physics2dshapequeryresult.md @@ -1,5 +1,6 @@ # Physics2DShapeQueryResult -#####**Inherits:** [Reference](class_reference) +####**Inherits:** [Reference](class_reference) +####**Category:** Core ### Brief Description diff --git a/class_physicsbody.md b/class_physicsbody.md index 4cbc060..3535ab6 100644 --- a/class_physicsbody.md +++ b/class_physicsbody.md @@ -1,5 +1,6 @@ # PhysicsBody -#####**Inherits:** [CollisionObject](class_collisionobject) +####**Inherits:** [CollisionObject](class_collisionobject) +####**Category:** Core ### Brief Description Base class for differnt types of Physics bodies. diff --git a/class_physicsbody2d.md b/class_physicsbody2d.md index cfe5fca..b2ac731 100644 --- a/class_physicsbody2d.md +++ b/class_physicsbody2d.md @@ -1,5 +1,6 @@ # PhysicsBody2D -#####**Inherits:** [CollisionObject2D](class_collisionobject2d) +####**Inherits:** [CollisionObject2D](class_collisionobject2d) +####**Category:** Core ### Brief Description diff --git a/class_physicsdirectbodystate.md b/class_physicsdirectbodystate.md index 27b8047..5b0bcff 100644 --- a/class_physicsdirectbodystate.md +++ b/class_physicsdirectbodystate.md @@ -1,5 +1,6 @@ # PhysicsDirectBodyState -#####**Inherits:** [Object](class_object) +####**Inherits:** [Object](class_object) +####**Category:** Core ### Brief Description diff --git a/class_physicsdirectbodystatesw.md b/class_physicsdirectbodystatesw.md index d63be2f..82c1d80 100644 --- a/class_physicsdirectbodystatesw.md +++ b/class_physicsdirectbodystatesw.md @@ -1,5 +1,6 @@ # PhysicsDirectBodyStateSW -#####**Inherits:** [PhysicsDirectBodyState](class_physicsdirectbodystate) +####**Inherits:** [PhysicsDirectBodyState](class_physicsdirectbodystate) +####**Category:** Core ### Brief Description diff --git a/class_physicsdirectspacestate.md b/class_physicsdirectspacestate.md index 08a2fd2..e8d3388 100644 --- a/class_physicsdirectspacestate.md +++ b/class_physicsdirectspacestate.md @@ -1,5 +1,6 @@ # PhysicsDirectSpaceState -#####**Inherits:** [Object](class_object) +####**Inherits:** [Object](class_object) +####**Category:** Core ### Brief Description diff --git a/class_physicsserver.md b/class_physicsserver.md index 5c8144d..94b344a 100644 --- a/class_physicsserver.md +++ b/class_physicsserver.md @@ -1,5 +1,6 @@ # PhysicsServer -#####**Inherits:** [Object](class_object) +####**Inherits:** [Object](class_object) +####**Category:** Core ### Brief Description diff --git a/class_physicsserversw.md b/class_physicsserversw.md index 094a8e5..0707f60 100644 --- a/class_physicsserversw.md +++ b/class_physicsserversw.md @@ -1,5 +1,6 @@ # PhysicsServerSW -#####**Inherits:** [PhysicsServer](class_physicsserver) +####**Inherits:** [PhysicsServer](class_physicsserver) +####**Category:** Core ### Brief Description diff --git a/class_physicsshapequeryresult.md b/class_physicsshapequeryresult.md index 8058d19..6a22ac8 100644 --- a/class_physicsshapequeryresult.md +++ b/class_physicsshapequeryresult.md @@ -1,5 +1,6 @@ # PhysicsShapeQueryResult -#####**Inherits:** [Reference](class_reference) +####**Inherits:** [Reference](class_reference) +####**Category:** Core ### Brief Description Result of a shape query in Physics2DServer. diff --git a/class_pinjoint2d.md b/class_pinjoint2d.md index 6e8ef03..5dafb6c 100644 --- a/class_pinjoint2d.md +++ b/class_pinjoint2d.md @@ -1,5 +1,6 @@ # PinJoint2D -#####**Inherits:** [Joint2D](class_joint2d) +####**Inherits:** [Joint2D](class_joint2d) +####**Category:** Core ### Brief Description Pin Joint for 2D Shapes. diff --git a/class_plane.md b/class_plane.md index 65394cb..2b5642a 100644 --- a/class_plane.md +++ b/class_plane.md @@ -1,4 +1,5 @@ # Plane +####**Category:** Built-In Types ### Brief Description Plane in hessian form. diff --git a/class_planeshape.md b/class_planeshape.md index a9c200a..bc02644 100644 --- a/class_planeshape.md +++ b/class_planeshape.md @@ -1,5 +1,6 @@ # PlaneShape -#####**Inherits:** [Shape](class_shape) +####**Inherits:** [Shape](class_shape) +####**Category:** Core ### Brief Description diff --git a/class_popup.md b/class_popup.md index fd4f080..87dd86e 100644 --- a/class_popup.md +++ b/class_popup.md @@ -1,5 +1,6 @@ # Popup -#####**Inherits:** [Control](class_control) +####**Inherits:** [Control](class_control) +####**Category:** Core ### Brief Description Base container control for popups and dialogs. @@ -19,7 +20,7 @@ Base container control for popups and dialogs. * **NOTIFICATION_POST_POPUP** = **80** ### Description -PopUp is a base [[control|Control]] used to show dialogs and popups. It's a subwindow and modal by default (see [[control|Control]]) and has helpers for custom popup behavior. +PopUp is a base [Control](class_control) used to show dialogs and popups. It's a subwindow and modal by default (see [Control](class_control)) and has helpers for custom popup behavior. ### Member Function Description diff --git a/class_popupdialog.md b/class_popupdialog.md index 2dcc8a4..16e964d 100644 --- a/class_popupdialog.md +++ b/class_popupdialog.md @@ -1,5 +1,6 @@ # PopupDialog -#####**Inherits:** [Popup](class_popup) +####**Inherits:** [Popup](class_popup) +####**Category:** Core ### Brief Description Base class for Popup Dialogs diff --git a/class_popupmenu.md b/class_popupmenu.md index 335c27d..262d727 100644 --- a/class_popupmenu.md +++ b/class_popupmenu.md @@ -1,5 +1,6 @@ # PopupMenu -#####**Inherits:** [Popup](class_popup) +####**Inherits:** [Popup](class_popup) +####**Category:** Core ### Brief Description PopupMenu displays a list of options. diff --git a/class_popuppanel.md b/class_popuppanel.md index 3afc3fa..729c0e8 100644 --- a/class_popuppanel.md +++ b/class_popuppanel.md @@ -1,5 +1,6 @@ # PopupPanel -#####**Inherits:** [Popup](class_popup) +####**Inherits:** [Popup](class_popup) +####**Category:** Core ### Brief Description Base class for Popup Panels diff --git a/class_portal.md b/class_portal.md index 1770833..deea6b2 100644 --- a/class_portal.md +++ b/class_portal.md @@ -1,5 +1,6 @@ # Portal -#####**Inherits:** [VisualInstance](class_visualinstance) +####**Inherits:** [VisualInstance](class_visualinstance) +####**Category:** Core ### Brief Description Portals provide virtual openings to rooms. @@ -45,22 +46,22 @@ Return wether the portal is active. When disabled it causes the parent [RoomInst #### set_disable_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]]). +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`** **(** **)** 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]]). +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`** **(** [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". +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`** **(** **)** const -Return the color for when the portal goes beyond the disable distance (see [[#set_disable_distance|set_disable_distance]]) and becomes disabled. +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`** **(** [real](class_real) range **)** diff --git a/class_position2d.md b/class_position2d.md index d241c91..6a89b1e 100644 --- a/class_position2d.md +++ b/class_position2d.md @@ -1,8 +1,9 @@ # Position2D -#####**Inherits:** [Node2D](class_node2d) +####**Inherits:** [Node2D](class_node2d) +####**Category:** Core ### Brief Description Generic 2D Position hint for editing. ### Description -Generic 2D Position hint for editing. It's just like a plain [[node2d|Node2D]] but displays as a cross in the 2D-Editor at all times. +Generic 2D Position hint for editing. It's just like a plain [Node2D](class_node2d) but displays as a cross in the 2D-Editor at all times. diff --git a/class_position3d.md b/class_position3d.md index 2e1bf4a..f23576b 100644 --- a/class_position3d.md +++ b/class_position3d.md @@ -1,8 +1,9 @@ # Position3D -#####**Inherits:** [Spatial](class_spatial) +####**Inherits:** [Spatial](class_spatial) +####**Category:** Core ### Brief Description Generic 3D Position hint for editing ### Description -Generic 3D Position hint for editing. It's just like a plain [[spatial|Spatial]] but displays as a cross in the 3D-Editor at all times. +Generic 3D Position hint for editing. It's just like a plain [Spatial](class_spatial) but displays as a cross in the 3D-Editor at all times. diff --git a/class_progressbar.md b/class_progressbar.md index 1da9a48..9cb1cde 100644 --- a/class_progressbar.md +++ b/class_progressbar.md @@ -1,5 +1,6 @@ # ProgressBar -#####**Inherits:** [Range](class_range) +####**Inherits:** [Range](class_range) +####**Category:** Core ### Brief Description General purpose progres bar. diff --git a/class_proximitygroup.md b/class_proximitygroup.md index 799e44a..e1db726 100644 --- a/class_proximitygroup.md +++ b/class_proximitygroup.md @@ -1,5 +1,6 @@ # ProximityGroup -#####**Inherits:** [Spatial](class_spatial) +####**Inherits:** [Spatial](class_spatial) +####**Category:** Core ### Brief Description General purpose proximity-detection node. diff --git a/class_quad.md b/class_quad.md index 004f0a6..2d14656 100644 --- a/class_quad.md +++ b/class_quad.md @@ -1,5 +1,6 @@ # Quad -#####**Inherits:** [GeometryInstance](class_geometryinstance) +####**Inherits:** [GeometryInstance](class_geometryinstance) +####**Category:** Core ### Brief Description diff --git a/class_quat.md b/class_quat.md index 53cbdc5..091af95 100644 --- a/class_quat.md +++ b/class_quat.md @@ -1,4 +1,5 @@ # Quat +####**Category:** Built-In Types ### Brief Description Quaternion. diff --git a/class_range.md b/class_range.md index 2ddaf8f..6f86624 100644 --- a/class_range.md +++ b/class_range.md @@ -1,5 +1,6 @@ # Range -#####**Inherits:** [Control](class_control) +####**Inherits:** [Control](class_control) +####**Category:** Core ### Brief Description Abstract base class for range-based controls. @@ -31,7 +32,7 @@ Abstract base class for range-based controls. * **`changed`** **(** **)** ### Description -Range is a base class for [[control|Control]] nodes that change a floating point //value// between a need a //minimum//, //maximum//, using //step// and //page//, for example a [[scrollbar|ScrollBar]]. +Range is a base class for [Control](class_control) nodes that change a floating point _value_ between a need a _minimum_, _maximum_, using _step_ and _page_, for example a [ScrollBar](class_scrollbar). ### Member Function Description diff --git a/class_rawarray.md b/class_rawarray.md index 3d52d6d..8f85c4b 100644 --- a/class_rawarray.md +++ b/class_rawarray.md @@ -1,4 +1,5 @@ # RawArray +####**Category:** Built-In Types ### Brief Description Raw byte array. diff --git a/class_raycast.md b/class_raycast.md index b05e73b..9c162e1 100644 --- a/class_raycast.md +++ b/class_raycast.md @@ -1,5 +1,6 @@ # RayCast -#####**Inherits:** [Spatial](class_spatial) +####**Inherits:** [Spatial](class_spatial) +####**Category:** Core ### Brief Description diff --git a/class_raycast2d.md b/class_raycast2d.md index 59d2f52..19fbbc2 100644 --- a/class_raycast2d.md +++ b/class_raycast2d.md @@ -1,5 +1,6 @@ # RayCast2D -#####**Inherits:** [Node2D](class_node2d) +####**Inherits:** [Node2D](class_node2d) +####**Category:** Core ### Brief Description diff --git a/class_rayshape.md b/class_rayshape.md index f463975..12c8e6c 100644 --- a/class_rayshape.md +++ b/class_rayshape.md @@ -1,5 +1,6 @@ # RayShape -#####**Inherits:** [Shape](class_shape) +####**Inherits:** [Shape](class_shape) +####**Category:** Core ### Brief Description diff --git a/class_rayshape2d.md b/class_rayshape2d.md index 81c6147..50d8842 100644 --- a/class_rayshape2d.md +++ b/class_rayshape2d.md @@ -1,5 +1,6 @@ # RayShape2D -#####**Inherits:** [Shape2D](class_shape2d) +####**Inherits:** [Shape2D](class_shape2d) +####**Category:** Core ### Brief Description Ray 2D shape resource for physics. diff --git a/class_real.md b/class_real.md index 2675269..e2ef9b2 100644 --- a/class_real.md +++ b/class_real.md @@ -1,4 +1,5 @@ # real +####**Category:** Built-In Types ### Brief Description Real (float) built-in type. diff --git a/class_realarray.md b/class_realarray.md index b4aa36d..8a5a7c9 100644 --- a/class_realarray.md +++ b/class_realarray.md @@ -1,4 +1,5 @@ # RealArray +####**Category:** Built-In Types ### Brief Description Real Array . diff --git a/class_rect2.md b/class_rect2.md index 94db820..6c4bb83 100644 --- a/class_rect2.md +++ b/class_rect2.md @@ -1,4 +1,5 @@ # Rect2 +####**Category:** Built-In Types ### Brief Description diff --git a/class_rectangleshape2d.md b/class_rectangleshape2d.md index 39f7af8..3d87877 100644 --- a/class_rectangleshape2d.md +++ b/class_rectangleshape2d.md @@ -1,5 +1,6 @@ # RectangleShape2D -#####**Inherits:** [Shape2D](class_shape2d) +####**Inherits:** [Shape2D](class_shape2d) +####**Category:** Core ### Brief Description Rectangle Shape for 2D Physics. diff --git a/class_reference.md b/class_reference.md index d777003..e60f062 100644 --- a/class_reference.md +++ b/class_reference.md @@ -1,5 +1,6 @@ # Reference -#####**Inherits:** [Object](class_object) +####**Inherits:** [Object](class_object) +####**Category:** Core ### Brief Description Base class for anything refcounted. diff --git a/class_referenceframe.md b/class_referenceframe.md index 292d250..c175ae2 100644 --- a/class_referenceframe.md +++ b/class_referenceframe.md @@ -1,5 +1,6 @@ # ReferenceFrame -#####**Inherits:** [Control](class_control) +####**Inherits:** [Control](class_control) +####**Category:** Core ### Brief Description Reference frame for GUI. diff --git a/class_regex.md b/class_regex.md index 4f95952..5ab9f60 100644 --- a/class_regex.md +++ b/class_regex.md @@ -1,5 +1,6 @@ # RegEx -#####**Inherits:** [Reference](class_reference) +####**Inherits:** [Reference](class_reference) +####**Category:** Core ### Brief Description diff --git a/class_remotetransform2d.md b/class_remotetransform2d.md index 58e624c..cc69ae9 100644 --- a/class_remotetransform2d.md +++ b/class_remotetransform2d.md @@ -1,5 +1,6 @@ # RemoteTransform2D -#####**Inherits:** [Node2D](class_node2d) +####**Inherits:** [Node2D](class_node2d) +####**Category:** Core ### Brief Description diff --git a/class_rendertargettexture.md b/class_rendertargettexture.md index 4202b77..73c5f89 100644 --- a/class_rendertargettexture.md +++ b/class_rendertargettexture.md @@ -1,5 +1,6 @@ # RenderTargetTexture -#####**Inherits:** [Texture](class_texture) +####**Inherits:** [Texture](class_texture) +####**Category:** Core ### Brief Description diff --git a/class_resource.md b/class_resource.md index 8331851..0cba96f 100644 --- a/class_resource.md +++ b/class_resource.md @@ -1,5 +1,6 @@ # Resource -#####**Inherits:** [Reference](class_reference) +####**Inherits:** [Reference](class_reference) +####**Category:** Core ### Brief Description Base class for all resources. @@ -18,7 +19,7 @@ Base class for all resources. * **`changed`** **(** **)** ### Description -Resource is the base class for all resource types. Resources are primarily data containers. They are reference counted and freed when no longer in use. They are also loaded only once from disk, and further attempts to load the resource will return the same reference (all this in contrast to a [[node|Node]], which is not reference counted and can be instanced from disk as many times as desred). Resources can be saved externally on disk or bundled into another object, such as a [[node|Node]] or another resource. +Resource is the base class for all resource types. Resources are primarily data containers. They are reference counted and freed when no longer in use. They are also loaded only once from disk, and further attempts to load the resource will return the same reference (all this in contrast to a [Node](class_node), which is not reference counted and can be instanced from disk as many times as desred). Resources can be saved externally on disk or bundled into another object, such as a [Node](class_node) or another resource. ### Member Function Description @@ -45,4 +46,4 @@ Return the name of the resources, any name is ok (it doesn"apos;t have to be uni #### get_rid * [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. +Return the RID of the resource (or an empty RID). Many resources (such as [Texture](class_texture), [Mesh](class_mesh), etc) are high level abstractions of resources stored in a server, so this function will return the original RID. diff --git a/class_resourceimportmetadata.md b/class_resourceimportmetadata.md index af92a91..b50f300 100644 --- a/class_resourceimportmetadata.md +++ b/class_resourceimportmetadata.md @@ -1,5 +1,6 @@ # ResourceImportMetadata -#####**Inherits:** [Reference](class_reference) +####**Inherits:** [Reference](class_reference) +####**Category:** Core ### Brief Description diff --git a/class_resourceinteractiveloader.md b/class_resourceinteractiveloader.md index ee2a6e2..372c56b 100644 --- a/class_resourceinteractiveloader.md +++ b/class_resourceinteractiveloader.md @@ -1,5 +1,6 @@ # ResourceInteractiveLoader -#####**Inherits:** [Reference](class_reference) +####**Inherits:** [Reference](class_reference) +####**Category:** Core ### Brief Description Interactive Resource Loader. diff --git a/class_resourceloader.md b/class_resourceloader.md index 46de7c4..58d7f0d 100644 --- a/class_resourceloader.md +++ b/class_resourceloader.md @@ -1,5 +1,6 @@ # ResourceLoader -#####**Inherits:** [Object](class_object) +####**Inherits:** [Object](class_object) +####**Category:** Core ### Brief Description Resource Loader. @@ -13,7 +14,7 @@ Resource Loader. * [bool](class_bool) **[`has`](#has)** **(** [String](class_string) arg0 **)** ### Description -Resource Loader. This is a static object accessible as [[resourceloader|ResourceLoader]]. GDScript has a simplified load() function, though. +Resource Loader. This is a static object accessible as [ResourceLoader](class_resourceloader). GDScript has a simplified load() function, though. ### Member Function Description diff --git a/class_resourcepreloader.md b/class_resourcepreloader.md index 8dfe4e3..bbc04e5 100644 --- a/class_resourcepreloader.md +++ b/class_resourcepreloader.md @@ -1,5 +1,6 @@ # ResourcePreloader -#####**Inherits:** [Node](class_node) +####**Inherits:** [Node](class_node) +####**Category:** Core ### Brief Description Resource Preloader Node. diff --git a/class_resourcesaver.md b/class_resourcesaver.md index 134de1b..5d0d1b1 100644 --- a/class_resourcesaver.md +++ b/class_resourcesaver.md @@ -1,5 +1,6 @@ # ResourceSaver -#####**Inherits:** [Object](class_object) +####**Inherits:** [Object](class_object) +####**Category:** Core ### Brief Description Resource Saving Interface. diff --git a/class_richtextlabel.md b/class_richtextlabel.md index 5126fdc..b6cf4e8 100644 --- a/class_richtextlabel.md +++ b/class_richtextlabel.md @@ -1,5 +1,6 @@ # RichTextLabel -#####**Inherits:** [Control](class_control) +####**Inherits:** [Control](class_control) +####**Category:** Core ### Brief Description Label that displays rich text. diff --git a/class_rid.md b/class_rid.md index cc9c717..85df583 100644 --- a/class_rid.md +++ b/class_rid.md @@ -1,4 +1,5 @@ # RID +####**Category:** Built-In Types ### Brief Description diff --git a/class_rigidbody.md b/class_rigidbody.md index 8a869ea..a02d0b6 100644 --- a/class_rigidbody.md +++ b/class_rigidbody.md @@ -1,5 +1,6 @@ # RigidBody -#####**Inherits:** [PhysicsBody](class_physicsbody) +####**Inherits:** [PhysicsBody](class_physicsbody) +####**Category:** Core ### Brief Description diff --git a/class_rigidbody2d.md b/class_rigidbody2d.md index 53bd51c..cc4dfbf 100644 --- a/class_rigidbody2d.md +++ b/class_rigidbody2d.md @@ -1,5 +1,6 @@ # RigidBody2D -#####**Inherits:** [PhysicsBody2D](class_physicsbody2d) +####**Inherits:** [PhysicsBody2D](class_physicsbody2d) +####**Category:** Core ### Brief Description Rigid body 2D node. @@ -51,7 +52,7 @@ Rigid body 2D node. ### Description Rigid body 2D node. This node is used for placing rigid bodies in the scene. It can contain a number of shapes, and also shift state between regular Rigid Body to Character or even Static. - Character mode forbids the node from being rotated. This node can have a custom force integrator function, for writing complex physics motion behavior per node.\\ + Character mode forbids the node from being rotated. This node can have a custom force integrator function, for writing complex physics motion behavior per node. As a warning, don't change this node position every frame or very often. Sporadic changes work fine, but physics runs at a different granularity (fixed hz) than usual rendering (process callback) and maybe even in a separate thread, so changing this from a process loop will yield strange behavior. diff --git a/class_room.md b/class_room.md index 3d43e1a..4fcac03 100644 --- a/class_room.md +++ b/class_room.md @@ -1,5 +1,6 @@ # Room -#####**Inherits:** [VisualInstance](class_visualinstance) +####**Inherits:** [VisualInstance](class_visualinstance) +####**Category:** Core ### Brief Description Room data resource. diff --git a/class_roombounds.md b/class_roombounds.md index 8f768a1..d8b277f 100644 --- a/class_roombounds.md +++ b/class_roombounds.md @@ -1,5 +1,6 @@ # RoomBounds -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description diff --git a/class_sample.md b/class_sample.md index 344c1e9..a6bc37d 100644 --- a/class_sample.md +++ b/class_sample.md @@ -1,5 +1,6 @@ # Sample -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description Audio Sample (sound) class. diff --git a/class_samplelibrary.md b/class_samplelibrary.md index 45879fe..bb04bc2 100644 --- a/class_samplelibrary.md +++ b/class_samplelibrary.md @@ -1,5 +1,6 @@ # SampleLibrary -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description Library that contains a collection of Samples. diff --git a/class_sampleplayer.md b/class_sampleplayer.md index 3e6b44d..99fd0d6 100644 --- a/class_sampleplayer.md +++ b/class_sampleplayer.md @@ -1,5 +1,6 @@ # SamplePlayer -#####**Inherits:** [Node](class_node) +####**Inherits:** [Node](class_node) +####**Category:** Core ### Brief Description Sample Player node. @@ -73,7 +74,7 @@ Sample Player node. * **REVERB_HALL** = **3** - Huge reverb room (cathedral, warehouse). ### Description -SamplePlayer is a [[node|Node]] meant for simple sample playback. A library of samples is loaded and played back "as is", without positioning or anything. +SamplePlayer is a [Node](class_node) meant for simple sample playback. A library of samples is loaded and played back "as is", without positioning or anything. ### Member Function Description @@ -95,7 +96,7 @@ Play back sample, given it"apos;s identifier "name". if "unique" is true, all ot #### stop * void **`stop`** **(** [int](class_int) voice **)** -Stop a voice "voice". (see [[#play|play]]). +Stop a voice "voice". (see [`play`](#play)). #### set_mix_rate * void **`set_mix_rate`** **(** [int](class_int) voice, [int](class_int) hz **)** @@ -125,7 +126,7 @@ Set and enable a filter of a voice, with type "type" (see FILTER_* enum), cutoff #### set_chorus * 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 the chorus send level of a voice (0 to 1). For setting chorus parameters, see [AudioServer](class_audioserver). #### set_reverb * void **`set_reverb`** **(** [int](class_int) voice, [int](class_int) room_type, [real](class_real) send **)** diff --git a/class_sampleplayer2d.md b/class_sampleplayer2d.md index 6e71586..f6c381a 100644 --- a/class_sampleplayer2d.md +++ b/class_sampleplayer2d.md @@ -1,5 +1,6 @@ # SamplePlayer2D -#####**Inherits:** [SoundPlayer2D](class_soundplayer2d) +####**Inherits:** [SoundPlayer2D](class_soundplayer2d) +####**Category:** Core ### Brief Description Sample player for Positional 2D Sound. diff --git a/class_sceneinteractiveloader.md b/class_sceneinteractiveloader.md index 494ad5e..1562559 100644 --- a/class_sceneinteractiveloader.md +++ b/class_sceneinteractiveloader.md @@ -1,5 +1,6 @@ # SceneInteractiveLoader -#####**Inherits:** [Reference](class_reference) +####**Inherits:** [Reference](class_reference) +####**Category:** Core ### Brief Description diff --git a/class_sceneio.md b/class_sceneio.md index b418f85..10a3122 100644 --- a/class_sceneio.md +++ b/class_sceneio.md @@ -1,5 +1,6 @@ # SceneIO -#####**Inherits:** [Object](class_object) +####**Inherits:** [Object](class_object) +####**Category:** Core ### Brief Description diff --git a/class_scenemainloop.md b/class_scenemainloop.md index b5b6b02..cc05321 100644 --- a/class_scenemainloop.md +++ b/class_scenemainloop.md @@ -1,5 +1,6 @@ # SceneMainLoop -#####**Inherits:** [MainLoop](class_mainloop) +####**Inherits:** [MainLoop](class_mainloop) +####**Category:** Core ### Brief Description Scene-Based implementation of the MainLoop. @@ -33,7 +34,7 @@ Scene-Based implementation of the MainLoop. * **GROUP_CALL_UNIQUE** = **4** - Call a group only once, even if call is performed many times. ### Description -Scene implementation of the MainLoop. All scenes edited using the editor are loaded with this main loop, which provides the base for the scene system.\\ +Scene implementation of the MainLoop. All scenes edited using the editor are loaded with this main loop, which provides the base for the scene system. All group operations (get nodes, call, etc) is performed here. All nodes in a group can be called a specific functions, set a property or notified. This happens in scene-order. diff --git a/class_scenepreloader.md b/class_scenepreloader.md index f1b1b36..d207c04 100644 --- a/class_scenepreloader.md +++ b/class_scenepreloader.md @@ -1,5 +1,6 @@ # ScenePreloader -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description diff --git a/class_script.md b/class_script.md index bade343..c7de42a 100644 --- a/class_script.md +++ b/class_script.md @@ -1,5 +1,6 @@ # Script -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description Base class for scripts. diff --git a/class_scrollbar.md b/class_scrollbar.md index cb8cdb8..f99f384 100644 --- a/class_scrollbar.md +++ b/class_scrollbar.md @@ -1,5 +1,6 @@ # ScrollBar -#####**Inherits:** [Range](class_range) +####**Inherits:** [Range](class_range) +####**Category:** Core ### Brief Description Base class for scroll bars. @@ -9,6 +10,6 @@ Base class for scroll bars. * [real](class_real) **[`get_custom_step`](#get_custom_step)** **(** **)** const ### Description -Scrollbars are a [[range|Range]] based [[control|Control]], that display a draggable area (the size of the page). Horizontal ([[hscrollbar|HScrollBar]]) and Vertical ([[vscrollbar|VScrollBar]]) versions are available. +Scrollbars are a [Range](class_range) based [Control](class_control), that display a draggable area (the size of the page). Horizontal ([HScrollBar](class_hscrollbar)) and Vertical ([VScrollBar](class_vscrollbar)) versions are available. ### Member Function Description diff --git a/class_scrollcontainer.md b/class_scrollcontainer.md index 7fb3f15..1f70afb 100644 --- a/class_scrollcontainer.md +++ b/class_scrollcontainer.md @@ -1,5 +1,6 @@ # ScrollContainer -#####**Inherits:** [Container](class_container) +####**Inherits:** [Container](class_container) +####**Category:** Core ### Brief Description diff --git a/class_segmentshape2d.md b/class_segmentshape2d.md index 5cca959..f519e62 100644 --- a/class_segmentshape2d.md +++ b/class_segmentshape2d.md @@ -1,5 +1,6 @@ # SegmentShape2D -#####**Inherits:** [Shape2D](class_shape2d) +####**Inherits:** [Shape2D](class_shape2d) +####**Category:** Core ### Brief Description Segment Shape for 2D Collision Detection. diff --git a/class_semaphore.md b/class_semaphore.md index 4568a46..4abcbd3 100644 --- a/class_semaphore.md +++ b/class_semaphore.md @@ -1,5 +1,6 @@ # Semaphore -#####**Inherits:** [Reference](class_reference) +####**Inherits:** [Reference](class_reference) +####**Category:** Core ### Brief Description diff --git a/class_separator.md b/class_separator.md index 2282548..4b71ac5 100644 --- a/class_separator.md +++ b/class_separator.md @@ -1,8 +1,9 @@ # Separator -#####**Inherits:** [Control](class_control) +####**Inherits:** [Control](class_control) +####**Category:** Core ### Brief Description Base class for separators. ### Description -Separator is a [[control|Control]] used for sepataring other controls. It's purely a visual decoration. Horizontal ([[hseparator|HSeparator]]) and Vertical ([[vseparator|VSeparator]]) versions are available. +Separator is a [Control](class_control) used for sepataring other controls. It's purely a visual decoration. Horizontal ([HSeparator](class_hseparator)) and Vertical ([VSeparator](class_vseparator)) versions are available. diff --git a/class_shader.md b/class_shader.md index ef6bf6b..5935c1c 100644 --- a/class_shader.md +++ b/class_shader.md @@ -1,5 +1,6 @@ # Shader -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description To be changed, ignore. diff --git a/class_shadermaterial.md b/class_shadermaterial.md index 196e445..714b619 100644 --- a/class_shadermaterial.md +++ b/class_shadermaterial.md @@ -1,5 +1,6 @@ # ShaderMaterial -#####**Inherits:** [Material](class_material) +####**Inherits:** [Material](class_material) +####**Category:** Core ### Brief Description diff --git a/class_shape.md b/class_shape.md index aa12e6d..ab6c7ce 100644 --- a/class_shape.md +++ b/class_shape.md @@ -1,5 +1,6 @@ # Shape -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description diff --git a/class_shape2d.md b/class_shape2d.md index b722884..3c90272 100644 --- a/class_shape2d.md +++ b/class_shape2d.md @@ -1,5 +1,6 @@ # Shape2D -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description Base class for all 2D Shapes. diff --git a/class_skeleton.md b/class_skeleton.md index 7267fdb..1d3b7b2 100644 --- a/class_skeleton.md +++ b/class_skeleton.md @@ -1,5 +1,6 @@ # Skeleton -#####**Inherits:** [Spatial](class_spatial) +####**Inherits:** [Spatial](class_spatial) +####**Category:** Core ### Brief Description Skeleton for characters and animated objects. @@ -27,14 +28,14 @@ Skeleton for characters and animated objects. * **NOTIFICATION_UPDATE_SKELETON** = **50** ### Description -Skeleton provides a hierachial interface for managing bones, including pose, rest and animation (see [[animation|Animation]]). Skeleton will support rag doll dynamics in the future. +Skeleton provides a hierachial interface for managing bones, including pose, rest and animation (see [Animation](class_animation)). Skeleton will support rag doll dynamics in the future. ### Member Function Description #### add_bone * void **`add_bone`** **(** [String](class_string) name **)** -Add a bone, with name "name". [[#get_bone_count|get_bone_count]] will become the bone index. +Add a bone, with name "name". [`get_bone_count`](#get_bone_count) will become the bone index. #### find_bone * [int](class_int) **`find_bone`** **(** [String](class_string) name **)** const diff --git a/class_slider.md b/class_slider.md index f42cb34..86a423b 100644 --- a/class_slider.md +++ b/class_slider.md @@ -1,5 +1,6 @@ # Slider -#####**Inherits:** [Range](class_range) +####**Inherits:** [Range](class_range) +####**Category:** Core ### Brief Description Base class for GUI Sliders. diff --git a/class_soundplayer2d.md b/class_soundplayer2d.md index c3ac7e0..ceb2536 100644 --- a/class_soundplayer2d.md +++ b/class_soundplayer2d.md @@ -1,5 +1,6 @@ # SoundPlayer2D -#####**Inherits:** [Node2D](class_node2d) +####**Inherits:** [Node2D](class_node2d) +####**Category:** Core ### Brief Description Base class for playing spatial 2D sound. diff --git a/class_soundroomparams.md b/class_soundroomparams.md index 7ffa959..38b2685 100644 --- a/class_soundroomparams.md +++ b/class_soundroomparams.md @@ -1,5 +1,6 @@ # SoundRoomParams -#####**Inherits:** [Node](class_node) +####**Inherits:** [Node](class_node) +####**Category:** Core ### Brief Description diff --git a/class_spatial.md b/class_spatial.md index d920791..1533a5d 100644 --- a/class_spatial.md +++ b/class_spatial.md @@ -1,5 +1,6 @@ # Spatial -#####**Inherits:** [Node](class_node) +####**Inherits:** [Node](class_node) +####**Category:** Core ### Brief Description Base class for all 3D nodes. @@ -30,7 +31,7 @@ Base class for all 3D nodes. * **NOTIFICATION_EXIT_WORLD** = **42** ### Description -Spatial is the base for every type of 3D [[node|Node]]. It contains a 3D [[transform|Transform]] which can be set or get as local or global. If a Spatial [[node|Node]] has Spatial children, their transforms will be relative to the parent. +Spatial is the base for every type of 3D [Node](class_node). It contains a 3D [Transform](class_transform) which can be set or get as local or global. If a Spatial [Node](class_node) has Spatial children, their transforms will be relative to the parent. ### Member Function Description @@ -57,4 +58,4 @@ Return the gloal transform, relative to worldspace. #### get_parent_spatial * [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. +Return the parent [Spatial](class_spatial), or an empty [Object](class_object) if no parent exists or parent is not of type [Spatial. diff --git a/class_spatialplayer.md b/class_spatialplayer.md index bb98a46..559adbe 100644 --- a/class_spatialplayer.md +++ b/class_spatialplayer.md @@ -1,5 +1,6 @@ # SpatialPlayer -#####**Inherits:** [Spatial](class_spatial) +####**Inherits:** [Spatial](class_spatial) +####**Category:** Core ### Brief Description diff --git a/class_spatialsampleplayer.md b/class_spatialsampleplayer.md index c5c01a2..060272c 100644 --- a/class_spatialsampleplayer.md +++ b/class_spatialsampleplayer.md @@ -1,5 +1,6 @@ # SpatialSamplePlayer -#####**Inherits:** [SpatialPlayer](class_spatialplayer) +####**Inherits:** [SpatialPlayer](class_spatialplayer) +####**Category:** Core ### Brief Description diff --git a/class_spatialsound2dserver.md b/class_spatialsound2dserver.md index 7140c0a..b5bcf0a 100644 --- a/class_spatialsound2dserver.md +++ b/class_spatialsound2dserver.md @@ -1,5 +1,6 @@ # SpatialSound2DServer -#####**Inherits:** [Object](class_object) +####**Inherits:** [Object](class_object) +####**Category:** Core ### Brief Description Server for Spatial 2D Sound. diff --git a/class_spatialsound2dserversw.md b/class_spatialsound2dserversw.md index 33df89d..91ac652 100644 --- a/class_spatialsound2dserversw.md +++ b/class_spatialsound2dserversw.md @@ -1,5 +1,6 @@ # SpatialSound2DServerSW -#####**Inherits:** [SpatialSound2DServer](class_spatialsound2dserver) +####**Inherits:** [SpatialSound2DServer](class_spatialsound2dserver) +####**Category:** Core ### Brief Description diff --git a/class_spatialsoundserver.md b/class_spatialsoundserver.md index 46414a5..b83dd4e 100644 --- a/class_spatialsoundserver.md +++ b/class_spatialsoundserver.md @@ -1,5 +1,6 @@ # SpatialSoundServer -#####**Inherits:** [Object](class_object) +####**Inherits:** [Object](class_object) +####**Category:** Core ### Brief Description diff --git a/class_spatialsoundserversw.md b/class_spatialsoundserversw.md index 0cf3848..9c7a49b 100644 --- a/class_spatialsoundserversw.md +++ b/class_spatialsoundserversw.md @@ -1,5 +1,6 @@ # SpatialSoundServerSW -#####**Inherits:** [SpatialSoundServer](class_spatialsoundserver) +####**Inherits:** [SpatialSoundServer](class_spatialsoundserver) +####**Category:** Core ### Brief Description diff --git a/class_spatialstreamplayer.md b/class_spatialstreamplayer.md index 8b0173a..9457780 100644 --- a/class_spatialstreamplayer.md +++ b/class_spatialstreamplayer.md @@ -1,5 +1,6 @@ # SpatialStreamPlayer -#####**Inherits:** [SpatialPlayer](class_spatialplayer) +####**Inherits:** [SpatialPlayer](class_spatialplayer) +####**Category:** Core ### Brief Description diff --git a/class_sphereshape.md b/class_sphereshape.md index 2e69ccc..68080a8 100644 --- a/class_sphereshape.md +++ b/class_sphereshape.md @@ -1,5 +1,6 @@ # SphereShape -#####**Inherits:** [Shape](class_shape) +####**Inherits:** [Shape](class_shape) +####**Category:** Core ### Brief Description diff --git a/class_spinbox.md b/class_spinbox.md index 9380414..10e5c4c 100644 --- a/class_spinbox.md +++ b/class_spinbox.md @@ -1,5 +1,6 @@ # SpinBox -#####**Inherits:** [Range](class_range) +####**Inherits:** [Range](class_range) +####**Category:** Core ### Brief Description Numerical input text field. diff --git a/class_splitcontainer.md b/class_splitcontainer.md index fd1bbe9..c2bd532 100644 --- a/class_splitcontainer.md +++ b/class_splitcontainer.md @@ -1,5 +1,6 @@ # SplitContainer -#####**Inherits:** [Container](class_container) +####**Inherits:** [Container](class_container) +####**Category:** Core ### Brief Description Container for splitting and adjusting. diff --git a/class_spotlight.md b/class_spotlight.md index baf81f0..887d4f5 100644 --- a/class_spotlight.md +++ b/class_spotlight.md @@ -1,8 +1,9 @@ # SpotLight -#####**Inherits:** [Light](class_light) +####**Inherits:** [Light](class_light) +####**Category:** Core ### Brief Description Spotlight Light, such as a reflector spotlight or a latern. ### Description -A SpotLight light is a type of [[light|Light]] node that emits lights in a specific direction, in the shape of a cone. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of [[light|Light]]. TODO: Image of a spotlight. +A SpotLight light is a type of [Light](class_light) node that emits lights in a specific direction, in the shape of a cone. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of [Light](class_light). TODO: Image of a spotlight. diff --git a/class_sprite.md b/class_sprite.md index 2dcfedf..0dc949a 100644 --- a/class_sprite.md +++ b/class_sprite.md @@ -1,5 +1,6 @@ # Sprite -#####**Inherits:** [Node2D](class_node2d) +####**Inherits:** [Node2D](class_node2d) +####**Category:** Core ### Brief Description General purpose Sprite node. diff --git a/class_spriteframes.md b/class_spriteframes.md index 3f75524..cc12f5b 100644 --- a/class_spriteframes.md +++ b/class_spriteframes.md @@ -1,5 +1,6 @@ # SpriteFrames -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description Sprite frame library for AnimatedSprite. @@ -13,7 +14,7 @@ Sprite frame library for AnimatedSprite. * void **[`clear`](#clear)** **(** **)** ### Description -Sprite frame library for [[animatedsprite|AnimatedSprite]]. +Sprite frame library for [AnimatedSprite](class_animatedsprite). ### Member Function Description diff --git a/class_staticbody.md b/class_staticbody.md index 77ebad6..53a1b56 100644 --- a/class_staticbody.md +++ b/class_staticbody.md @@ -1,5 +1,6 @@ # StaticBody -#####**Inherits:** [PhysicsBody](class_physicsbody) +####**Inherits:** [PhysicsBody](class_physicsbody) +####**Category:** Core ### Brief Description PhysicsBody for static collision objects. @@ -13,6 +14,6 @@ PhysicsBody for static collision objects. * [Vector3](class_vector3) **[`get_constant_angular_velocity`](#get_constant_angular_velocity)** **(** **)** const ### Description -StaticBody implements a static collision [[node|Node]], by utilizing a rigid body in the [[physicsserver|PhysicsServer]]. Static bodies are used for static collision. For more information on physics body nodes, see [[physicsbody|PhysicsBody]]. +StaticBody implements a static collision [Node](class_node), by utilizing a rigid body in the [PhysicsServer](class_physicsserver). Static bodies are used for static collision. For more information on physics body nodes, see [PhysicsBody](class_physicsbody). ### Member Function Description diff --git a/class_staticbody2d.md b/class_staticbody2d.md index 216e29e..e8ead4f 100644 --- a/class_staticbody2d.md +++ b/class_staticbody2d.md @@ -1,5 +1,6 @@ # StaticBody2D -#####**Inherits:** [PhysicsBody2D](class_physicsbody2d) +####**Inherits:** [PhysicsBody2D](class_physicsbody2d) +####**Category:** Core ### Brief Description Static body for 2D Physics. @@ -17,7 +18,7 @@ Static body for 2D Physics. * [real](class_real) **[`get_bounce`](#get_bounce)** **(** **)** const ### Description -Static body for 2D Physics. A static body is a simple body that is not intended to move. They don't consume any CPU resources in contrast to a [[rigidbody2d|RigidBody2D]] so they are great for scenaro collision.\\ +Static body for 2D Physics. A static body is a simple body that is not intended to move. They don't consume any CPU resources in contrast to a [RigidBody2D](class_rigidbody2d) so they are great for scenaro collision. A static body also can be animated by using simulated motion mode, this is useful for implementing functionalities such as moving platforms, when this mode is active the body can be animated and automatically compute linear and angular velocity to apply in that frame and to influence other bodies. Alternatively, a constant linear or angular velocity can be set for the static body, so even if it doesn't move, it affects other bodies as if it was moving (this is useful for simulating conveyor belts or conveyor wheels). diff --git a/class_streampeer.md b/class_streampeer.md index 81f136d..95518e5 100644 --- a/class_streampeer.md +++ b/class_streampeer.md @@ -1,5 +1,6 @@ # StreamPeer -#####**Inherits:** [Reference](class_reference) +####**Inherits:** [Reference](class_reference) +####**Category:** Core ### Brief Description Abstraction and base class for stream-based protocols. diff --git a/class_streampeertcp.md b/class_streampeertcp.md index 5a18300..3731515 100644 --- a/class_streampeertcp.md +++ b/class_streampeertcp.md @@ -1,5 +1,6 @@ # StreamPeerTCP -#####**Inherits:** [StreamPeer](class_streampeer) +####**Inherits:** [StreamPeer](class_streampeer) +####**Category:** Core ### Brief Description TCP Stream peer. diff --git a/class_streamplayer.md b/class_streamplayer.md index e2879bf..5c79f55 100644 --- a/class_streamplayer.md +++ b/class_streamplayer.md @@ -1,5 +1,6 @@ # StreamPlayer -#####**Inherits:** [Node](class_node) +####**Inherits:** [Node](class_node) +####**Category:** Core ### Brief Description Base class for audio stream playback. diff --git a/class_string.md b/class_string.md index 8f05a4f..f636cb5 100644 --- a/class_string.md +++ b/class_string.md @@ -1,4 +1,5 @@ # String +####**Category:** Built-In Types ### Brief Description Built-In string class. diff --git a/class_stringarray.md b/class_stringarray.md index 1881586..5ba4da8 100644 --- a/class_stringarray.md +++ b/class_stringarray.md @@ -1,4 +1,5 @@ # StringArray +####**Category:** Built-In Types ### Brief Description String Array . diff --git a/class_stylebox.md b/class_stylebox.md index a46eea3..bc9f05f 100644 --- a/class_stylebox.md +++ b/class_stylebox.md @@ -1,5 +1,6 @@ # StyleBox -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description Base class for dawing stylized boxes for the UI. @@ -15,7 +16,7 @@ Base class for dawing stylized boxes for the UI. * void **[`draw`](#draw)** **(** [RID](class_rid) arg0, [Rect2](class_rect2) arg1 **)** const ### Description -StyleBox is [[resource|Resource]] that provides an abstract base class for dawing stylized boxes for the UI. StyleBoxes are used for dawing the styles of buttons, line edit backgrounds, tree backgrounds, etc. and also for testing a transparency mask for pointer signals. If mask test fails on a StyleBox assigned as mask to a control, clicks and motion signals will go through it to the one below. +StyleBox is [Resource](class_resource) that provides an abstract base class for dawing stylized boxes for the UI. StyleBoxes are used for dawing the styles of buttons, line edit backgrounds, tree backgrounds, etc. and also for testing a transparency mask for pointer signals. If mask test fails on a StyleBox assigned as mask to a control, clicks and motion signals will go through it to the one below. ### Member Function Description diff --git a/class_styleboxempty.md b/class_styleboxempty.md index 5c2bc9f..0ba7ff0 100644 --- a/class_styleboxempty.md +++ b/class_styleboxempty.md @@ -1,5 +1,6 @@ # StyleBoxEmpty -#####**Inherits:** [StyleBox](class_stylebox) +####**Inherits:** [StyleBox](class_stylebox) +####**Category:** Core ### Brief Description Empty stylebox (does not display anything). diff --git a/class_styleboxflat.md b/class_styleboxflat.md index 2de7919..fd1383a 100644 --- a/class_styleboxflat.md +++ b/class_styleboxflat.md @@ -1,5 +1,6 @@ # StyleBoxFlat -#####**Inherits:** [StyleBox](class_stylebox) +####**Inherits:** [StyleBox](class_stylebox) +####**Category:** Core ### Brief Description Stylebox of a single color. diff --git a/class_styleboximagemask.md b/class_styleboximagemask.md index ed13a1d..b2de50e 100644 --- a/class_styleboximagemask.md +++ b/class_styleboximagemask.md @@ -1,5 +1,6 @@ # StyleBoxImageMask -#####**Inherits:** [StyleBox](class_stylebox) +####**Inherits:** [StyleBox](class_stylebox) +####**Category:** Core ### Brief Description Image mask based StyleBox, for mask test. @@ -13,7 +14,7 @@ Image mask based StyleBox, for mask test. * [real](class_real) **[`get_expand_margin_size`](#get_expand_margin_size)** **(** [int](class_int) arg0 **)** const ### Description -This StyleBox is similar to [[styleboxtexture|StyleBoxTexture]], but only meant to be used for mask testing. It takes an image and applies stretch rules to determine if the poit clicked is masked or not. +This StyleBox is similar to [StyleBoxTexture](class_styleboxtexture), but only meant to be used for mask testing. It takes an image and applies stretch rules to determine if the poit clicked is masked or not. ### Member Function Description @@ -25,17 +26,17 @@ Set the image used for mask testing. Pixels (converted to grey) that have a valu #### get_image * [Image](class_image) **`get_image`** **(** **)** const -Return the image used for mask testing. (see [[#set_imag|set_imag]]). +Return the image used for mask testing. (see [`set_imag`](#set_imag)). #### set_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. +Set the expand property (default). When expanding, the image will use the same rules as [StyleBoxTexture](class_styleboxtexture) for expand. If not expanding, the image will always be tested at its original size. #### get_expand * [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. +Return wether the expand property is set(default). When expanding, the image will use the same rules as [StyleBoxTexture](class_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`** **(** [int](class_int) margin, [real](class_real) size **)** diff --git a/class_styleboxtexture.md b/class_styleboxtexture.md index b6cd591..3db10cd 100644 --- a/class_styleboxtexture.md +++ b/class_styleboxtexture.md @@ -1,5 +1,6 @@ # StyleBoxTexture -#####**Inherits:** [StyleBox](class_stylebox) +####**Inherits:** [StyleBox](class_stylebox) +####**Category:** Core ### Brief Description Texture Based 3x3 scale style. diff --git a/class_surfacetool.md b/class_surfacetool.md index bcc3f2d..e9da601 100644 --- a/class_surfacetool.md +++ b/class_surfacetool.md @@ -1,5 +1,6 @@ # SurfaceTool -#####**Inherits:** [Reference](class_reference) +####**Inherits:** [Reference](class_reference) +####**Category:** Core ### Brief Description Helper tool to create geometry. diff --git a/class_tabcontainer.md b/class_tabcontainer.md index 98b3d30..3d15a82 100644 --- a/class_tabcontainer.md +++ b/class_tabcontainer.md @@ -1,5 +1,6 @@ # TabContainer -#####**Inherits:** [Control](class_control) +####**Inherits:** [Control](class_control) +####**Category:** Core ### Brief Description Tabbed Container. @@ -21,7 +22,7 @@ Tabbed Container. * **`tab_changed`** **(** [int](class_int) tab **)** ### Description -Tabbed Container. Contains several children controls, but shows only one at the same time. Clicking ont he top tabs allows to change the current visible one.\\ +Tabbed Container. Contains several children controls, but shows only one at the same time. Clicking ont he top tabs allows to change the current visible one. Children controls of this one automatically. diff --git a/class_tabs.md b/class_tabs.md index 4255b34..e7635d6 100644 --- a/class_tabs.md +++ b/class_tabs.md @@ -1,5 +1,6 @@ # Tabs -#####**Inherits:** [Control](class_control) +####**Inherits:** [Control](class_control) +####**Category:** Core ### Brief Description Tabs Control. @@ -18,6 +19,6 @@ Tabs Control. * **`tab_changed`** **(** [int](class_int) tab **)** ### Description -Simple tabs control, similar to [[tabcontainer|TabContainer]] but is only in charge of drawing tabs, not interact with children. +Simple tabs control, similar to [TabContainer](class_tabcontainer) but is only in charge of drawing tabs, not interact with children. ### Member Function Description diff --git a/class_tcp_server.md b/class_tcp_server.md index 1ac60a6..8d60304 100644 --- a/class_tcp_server.md +++ b/class_tcp_server.md @@ -1,5 +1,6 @@ # TCP_Server -#####**Inherits:** [Reference](class_reference) +####**Inherits:** [Reference](class_reference) +####**Category:** Core ### Brief Description TCP Server. diff --git a/class_testcube.md b/class_testcube.md index fd2f281..0b27e90 100644 --- a/class_testcube.md +++ b/class_testcube.md @@ -1,5 +1,6 @@ # TestCube -#####**Inherits:** [GeometryInstance](class_geometryinstance) +####**Inherits:** [GeometryInstance](class_geometryinstance) +####**Category:** Core ### Brief Description diff --git a/class_textedit.md b/class_textedit.md index 5ec1b61..e8614ec 100644 --- a/class_textedit.md +++ b/class_textedit.md @@ -1,5 +1,6 @@ # TextEdit -#####**Inherits:** [Control](class_control) +####**Inherits:** [Control](class_control) +####**Category:** Core ### Brief Description Multiline text editing control. diff --git a/class_texture.md b/class_texture.md index d7ff984..af0fb21 100644 --- a/class_texture.md +++ b/class_texture.md @@ -1,5 +1,6 @@ # Texture -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description Texture for 2D and 3D. @@ -24,7 +25,7 @@ Texture for 2D and 3D. * **FLAGS_DEFAULT** = **7** - Default flags ### Description -A texture works by registering an image in the video hardware, which then can be used in 3D models or 2D [[sprite|Sprite]] or GUI [[control|Control]]s. +A texture works by registering an image in the video hardware, which then can be used in 3D models or 2D [Sprite](class_sprite) or GUI [Control](class_control)s. ### Member Function Description @@ -46,7 +47,7 @@ Return the texture size. #### get_rid * [RID](class_rid) **`get_rid`** **(** **)** const -Return the texture RID as used in the [[visualserver|VisualServer]]. +Return the texture RID as used in the [VisualServer](class_visualserver). #### set_flags * void **`set_flags`** **(** [int](class_int) flags **)** @@ -61,4 +62,4 @@ Return the current texture flags. #### draw * 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. +Draw the texture into a a [VisualServer](class_visualserver) canvas item. diff --git a/class_texturebutton.md b/class_texturebutton.md index e529935..cce4cae 100644 --- a/class_texturebutton.md +++ b/class_texturebutton.md @@ -1,5 +1,6 @@ # TextureButton -#####**Inherits:** [BaseButton](class_basebutton) +####**Inherits:** [BaseButton](class_basebutton) +####**Category:** Core ### Brief Description Button that can be themed with textures. @@ -19,7 +20,7 @@ Button that can be themed with textures. * [BitMap](class_bitmap) **[`get_click_mask`](#get_click_mask)** **(** **)** const ### Description -Button that can be themed with textures. This is like a regular [[button|Button]] but can be themed by assigning textures to it. This button is intended to be easy to theme, however a regular button can expand (that uses styleboxes) and still be better if the interface is expect to have internationalization of texts.\\ +Button that can be themed with textures. This is like a regular [Button](class_button) but can be themed by assigning textures to it. This button is intended to be easy to theme, however a regular button can expand (that uses styleboxes) and still be better if the interface is expect to have internationalization of texts. Only the normal texture is required, the others are optional. diff --git a/class_textureframe.md b/class_textureframe.md index e23b31d..ff8fa91 100644 --- a/class_textureframe.md +++ b/class_textureframe.md @@ -1,5 +1,6 @@ # TextureFrame -#####**Inherits:** [Control](class_control) +####**Inherits:** [Control](class_control) +####**Category:** Core ### Brief Description Control Frame that draws a texture. diff --git a/class_textureprogress.md b/class_textureprogress.md index 76e1c99..ba55f76 100644 --- a/class_textureprogress.md +++ b/class_textureprogress.md @@ -1,5 +1,6 @@ # TextureProgress -#####**Inherits:** [Range](class_range) +####**Inherits:** [Range](class_range) +####**Category:** Core ### Brief Description Textured progress bar implementation. @@ -13,6 +14,6 @@ Textured progress bar implementation. * [Object](class_object) **[`get_over_texture`](#get_over_texture)** **(** **)** const ### Description -[[progressbar|ProgressBar]] implementation that is easier to theme (by just passing a few textures). +[ProgressBar](class_progressbar) implementation that is easier to theme (by just passing a few textures). ### Member Function Description diff --git a/class_theme.md b/class_theme.md index 14813c1..2523fcd 100644 --- a/class_theme.md +++ b/class_theme.md @@ -1,5 +1,6 @@ # Theme -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description Theme for controls. @@ -34,7 +35,7 @@ Theme for controls. * void **[`copy_default_theme`](#copy_default_theme)** **(** **)** ### Description -Theme for skinning controls. Controls can be skinned individually, but for complex applications it's more efficient to just create a global theme that defines everything. This theme can be applied to any [[control|Control]], and it and the children will automatically use it.\\ +Theme for skinning controls. Controls can be skinned individually, but for complex applications it's more efficient to just create a global theme that defines everything. This theme can be applied to any [Control](class_control), and it and the children will automatically use it. Theme resources can be alternatively loaded by writing them in a .theme file, see wiki for more info. diff --git a/class_thread.md b/class_thread.md index c93968d..430e7d0 100644 --- a/class_thread.md +++ b/class_thread.md @@ -1,5 +1,6 @@ # Thread -#####**Inherits:** [Reference](class_reference) +####**Inherits:** [Reference](class_reference) +####**Category:** Core ### Brief Description diff --git a/class_tilemap.md b/class_tilemap.md index 2379083..735becc 100644 --- a/class_tilemap.md +++ b/class_tilemap.md @@ -1,5 +1,6 @@ # TileMap -#####**Inherits:** [Node2D](class_node2d) +####**Inherits:** [Node2D](class_node2d) +####**Category:** Core ### Brief Description Node for 2D Tile-Based games. @@ -26,7 +27,7 @@ Node for 2D Tile-Based games. ### Description Node for 2D Tile-Based games. Tilemaps use a TileSet which contain a list of tiles (textures, their rect and a collision) and are used to create complex grid-based maps. - To optimize drawing and culling (sort of like [[gridmap|GridMap]]), you can specify a quadrant size, so chunks of the map will be batched together the time of drawing. + To optimize drawing and culling (sort of like [GridMap](class_gridmap)), you can specify a quadrant size, so chunks of the map will be batched together the time of drawing. ### Member Function Description diff --git a/class_tileset.md b/class_tileset.md index 383015b..64c8863 100644 --- a/class_tileset.md +++ b/class_tileset.md @@ -1,5 +1,6 @@ # TileSet -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description Tile library for tilemaps. @@ -24,7 +25,7 @@ Tile library for tilemaps. * [int](class_int) **[`find_tile_by_name`](#find_tile_by_name)** **(** [String](class_string) name **)** const ### Description -A TileSet is a library of tiles for a [[tilemap|TileMap]]. It contains a list of tiles, each consisting of a sprite and optional collision shapes. +A TileSet is a library of tiles for a [TileMap](class_tilemap). It contains a list of tiles, each consisting of a sprite and optional collision shapes. ### Member Function Description diff --git a/class_timer.md b/class_timer.md index cf905aa..fcc42f9 100644 --- a/class_timer.md +++ b/class_timer.md @@ -1,5 +1,6 @@ # Timer -#####**Inherits:** [Node](class_node) +####**Inherits:** [Node](class_node) +####**Category:** Core ### Brief Description diff --git a/class_touchscreenbutton.md b/class_touchscreenbutton.md index c8fd8a7..c63d01c 100644 --- a/class_touchscreenbutton.md +++ b/class_touchscreenbutton.md @@ -1,5 +1,6 @@ # TouchScreenButton -#####**Inherits:** [Node2D](class_node2d) +####**Inherits:** [Node2D](class_node2d) +####**Category:** Core ### Brief Description diff --git a/class_transform.md b/class_transform.md index 0989536..864329c 100644 --- a/class_transform.md +++ b/class_transform.md @@ -1,4 +1,5 @@ # Transform +####**Category:** Built-In Types ### Brief Description 3D Transformation. diff --git a/class_translation.md b/class_translation.md index 8106f64..441c0a6 100644 --- a/class_translation.md +++ b/class_translation.md @@ -1,5 +1,6 @@ # Translation -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description Language Translation. diff --git a/class_translationserver.md b/class_translationserver.md index 7959055..6a35b80 100644 --- a/class_translationserver.md +++ b/class_translationserver.md @@ -1,5 +1,6 @@ # TranslationServer -#####**Inherits:** [Object](class_object) +####**Inherits:** [Object](class_object) +####**Category:** Core ### Brief Description Server that manages all translations. Translations can be set to it and removed from it. diff --git a/class_tree.md b/class_tree.md index e2ecabb..d4d2146 100644 --- a/class_tree.md +++ b/class_tree.md @@ -1,5 +1,6 @@ # Tree -#####**Inherits:** [Control](class_control) +####**Inherits:** [Control](class_control) +####**Category:** Core ### Brief Description diff --git a/class_treeitem.md b/class_treeitem.md index 7eb4eec..953c92e 100644 --- a/class_treeitem.md +++ b/class_treeitem.md @@ -1,5 +1,6 @@ # TreeItem -#####**Inherits:** [Object](class_object) +####**Inherits:** [Object](class_object) +####**Category:** Core ### Brief Description diff --git a/class_unshadedmaterial.md b/class_unshadedmaterial.md index 59a4fdb..1e3fb78 100644 --- a/class_unshadedmaterial.md +++ b/class_unshadedmaterial.md @@ -1,5 +1,6 @@ # UnshadedMaterial -#####**Inherits:** [Material](class_material) +####**Inherits:** [Material](class_material) +####**Category:** Core ### Brief Description diff --git a/class_vboxcontainer.md b/class_vboxcontainer.md index 34a933b..c9c7318 100644 --- a/class_vboxcontainer.md +++ b/class_vboxcontainer.md @@ -1,8 +1,9 @@ # VBoxContainer -#####**Inherits:** [BoxContainer](class_boxcontainer) +####**Inherits:** [BoxContainer](class_boxcontainer) +####**Category:** Core ### Brief Description Vertical box container. ### Description -Vertical box container. See [[boxcontainer|BoxContainer]]. +Vertical box container. See [BoxContainer](class_boxcontainer). diff --git a/class_vbuttonarray.md b/class_vbuttonarray.md index 0154ceb..d1511d4 100644 --- a/class_vbuttonarray.md +++ b/class_vbuttonarray.md @@ -1,8 +1,9 @@ # VButtonArray -#####**Inherits:** [ButtonArray](class_buttonarray) +####**Inherits:** [ButtonArray](class_buttonarray) +####**Category:** Core ### Brief Description Vertical button array. ### Description -Vertical button array. See [[buttonarray|ButtonArray]]. +Vertical button array. See [ButtonArray](class_buttonarray). diff --git a/class_vector2.md b/class_vector2.md index 80e42e3..1d9c541 100644 --- a/class_vector2.md +++ b/class_vector2.md @@ -1,4 +1,5 @@ # Vector2 +####**Category:** Built-In Types ### Brief Description Vector used for 2D Math. diff --git a/class_vector2array.md b/class_vector2array.md index 67aaaea..dbd317d 100644 --- a/class_vector2array.md +++ b/class_vector2array.md @@ -1,4 +1,5 @@ # Vector2Array +####**Category:** Built-In Types ### Brief Description diff --git a/class_vector3.md b/class_vector3.md index 8cde57e..9918e3a 100644 --- a/class_vector3.md +++ b/class_vector3.md @@ -1,4 +1,5 @@ # Vector3 +####**Category:** Built-In Types ### Brief Description Vector class, which performs basic 3D vector math operations. diff --git a/class_vector3array.md b/class_vector3array.md index 17dd927..91f308d 100644 --- a/class_vector3array.md +++ b/class_vector3array.md @@ -1,4 +1,5 @@ # Vector3Array +####**Category:** Built-In Types ### Brief Description diff --git a/class_videoplayer.md b/class_videoplayer.md index 5046b36..d9985ec 100644 --- a/class_videoplayer.md +++ b/class_videoplayer.md @@ -1,5 +1,6 @@ # VideoPlayer -#####**Inherits:** [Control](class_control) +####**Inherits:** [Control](class_control) +####**Category:** Core ### Brief Description diff --git a/class_videostream.md b/class_videostream.md index 4bc0264..29f8088 100644 --- a/class_videostream.md +++ b/class_videostream.md @@ -1,5 +1,6 @@ # VideoStream -#####**Inherits:** [AudioStreamResampled](class_audiostreamresampled) +####**Inherits:** [AudioStreamResampled](class_audiostreamresampled) +####**Category:** Core ### Brief Description diff --git a/class_videostreamtheora.md b/class_videostreamtheora.md index b59be5a..dc68059 100644 --- a/class_videostreamtheora.md +++ b/class_videostreamtheora.md @@ -1,5 +1,6 @@ # VideoStreamTheora -#####**Inherits:** [VideoStream](class_videostream) +####**Inherits:** [VideoStream](class_videostream) +####**Category:** Core ### Brief Description diff --git a/class_viewport.md b/class_viewport.md index efce412..2732850 100644 --- a/class_viewport.md +++ b/class_viewport.md @@ -1,5 +1,6 @@ # Viewport -#####**Inherits:** [Node](class_node) +####**Inherits:** [Node](class_node) +####**Category:** Core ### Brief Description Creates a sub-view into the screen. @@ -35,15 +36,15 @@ Creates a sub-view into the screen. * **`size_changed`** **(** **)** ### Description -A Viewport creates a different view into the screen, or a sub-view inside another viewport. Children 2D Nodes will display on it, and children Camera 3D nodes will renderon it too.\\ +A Viewport creates a different view into the screen, or a sub-view inside another viewport. Children 2D Nodes will display on it, and children Camera 3D nodes will renderon it too. - Optionally, a viewport can have it's own 2D or 3D world, so they don't share what they draw with other viewports.\\ + Optionally, a viewport can have it's own 2D or 3D world, so they don't share what they draw with other viewports. - If a viewport is a child of a [[control|Control]], it will automatically take up it's same rect and position, otherwise they must be set manually.\\ + If a viewport is a child of a [Control](class_control), it will automatically take up it's same rect and position, otherwise they must be set manually. - Viewports can also choose to be audio listeners, so they generate positional audio depending on a 2D or 3D camera child of it.\\ + Viewports can also choose to be audio listeners, so they generate positional audio depending on a 2D or 3D camera child of it. - Also, viewports can be assigned to different screens in the situation while devices have multiple screens.\\ + Also, viewports can be assigned to different screens in the situation while devices have multiple screens. Finaly, viewports can also behave as render targets, in which case they will not be visible unless the associated texture is used to draw. diff --git a/class_visibilityenabler.md b/class_visibilityenabler.md index 651e778..902c70a 100644 --- a/class_visibilityenabler.md +++ b/class_visibilityenabler.md @@ -1,5 +1,6 @@ # VisibilityEnabler -#####**Inherits:** [VisibilityNotifier](class_visibilitynotifier) +####**Inherits:** [VisibilityNotifier](class_visibilitynotifier) +####**Category:** Core ### Brief Description diff --git a/class_visibilityenabler2d.md b/class_visibilityenabler2d.md index 65b7eae..6de36aa 100644 --- a/class_visibilityenabler2d.md +++ b/class_visibilityenabler2d.md @@ -1,5 +1,6 @@ # VisibilityEnabler2D -#####**Inherits:** [VisibilityNotifier2D](class_visibilitynotifier2d) +####**Inherits:** [VisibilityNotifier2D](class_visibilitynotifier2d) +####**Category:** Core ### Brief Description diff --git a/class_visibilitynotifier.md b/class_visibilitynotifier.md index 5e8ce4f..f7385d1 100644 --- a/class_visibilitynotifier.md +++ b/class_visibilitynotifier.md @@ -1,5 +1,6 @@ # VisibilityNotifier -#####**Inherits:** [Spatial](class_spatial) +####**Inherits:** [Spatial](class_spatial) +####**Category:** Core ### Brief Description diff --git a/class_visibilitynotifier2d.md b/class_visibilitynotifier2d.md index 4f682ef..1a6d8fe 100644 --- a/class_visibilitynotifier2d.md +++ b/class_visibilitynotifier2d.md @@ -1,5 +1,6 @@ # VisibilityNotifier2D -#####**Inherits:** [Node2D](class_node2d) +####**Inherits:** [Node2D](class_node2d) +####**Category:** Core ### Brief Description diff --git a/class_visualinstance.md b/class_visualinstance.md index c66793a..6a05e40 100644 --- a/class_visualinstance.md +++ b/class_visualinstance.md @@ -1,5 +1,6 @@ # VisualInstance -#####**Inherits:** [Spatial](class_spatial) +####**Inherits:** [Spatial](class_spatial) +####**Category:** Core ### Brief Description diff --git a/class_visualserver.md b/class_visualserver.md index 012ea47..8346ded 100644 --- a/class_visualserver.md +++ b/class_visualserver.md @@ -1,5 +1,6 @@ # VisualServer -#####**Inherits:** [Object](class_object) +####**Inherits:** [Object](class_object) +####**Category:** Core ### Brief Description Server for anything visible. @@ -282,7 +283,7 @@ Server for anything visible. * **INFO_VERTEX_MEM_USED** = **9** ### Description -Server for anything visible. The visual server is the API backend for everything visible. The whole scene system mounts on it to display.\\ +Server for anything visible. The visual server is the API backend for everything visible. The whole scene system mounts on it to display. The visual server is completely opaque, the internals are entirely implementation specific and cannot be accessed. diff --git a/class_vscrollbar.md b/class_vscrollbar.md index 92d25a2..fab7b59 100644 --- a/class_vscrollbar.md +++ b/class_vscrollbar.md @@ -1,5 +1,6 @@ # VScrollBar -#####**Inherits:** [ScrollBar](class_scrollbar) +####**Inherits:** [ScrollBar](class_scrollbar) +####**Category:** Core ### Brief Description -Vertical version of [[scrollbar|ScrollBar]], which goes from left (min) to right (max). +Vertical version of [ScrollBar](class_scrollbar), which goes from left (min) to right (max). diff --git a/class_vseparator.md b/class_vseparator.md index 1de244c..8b918c6 100644 --- a/class_vseparator.md +++ b/class_vseparator.md @@ -1,8 +1,9 @@ # VSeparator -#####**Inherits:** [Separator](class_separator) +####**Inherits:** [Separator](class_separator) +####**Category:** Core ### Brief Description -Vertical version of [[separator|Separator]]. +Vertical version of [Separator](class_separator). ### Description -Vertical version of [[separator|Separator]]. It is used to separate objects horizontally, though (but it looks vertical!). +Vertical version of [Separator](class_separator). It is used to separate objects horizontally, though (but it looks vertical!). diff --git a/class_vslider.md b/class_vslider.md index 7727321..bd86749 100644 --- a/class_vslider.md +++ b/class_vslider.md @@ -1,8 +1,9 @@ # VSlider -#####**Inherits:** [Slider](class_slider) +####**Inherits:** [Slider](class_slider) +####**Category:** Core ### Brief Description Vertical slider. ### Description -Vertical slider. See [[slider|Slider]]. This one goes from left (min) to right (max). +Vertical slider. See [Slider](class_slider). This one goes from left (min) to right (max). diff --git a/class_vsplitcontainer.md b/class_vsplitcontainer.md index 1020811..b7a0a97 100644 --- a/class_vsplitcontainer.md +++ b/class_vsplitcontainer.md @@ -1,8 +1,9 @@ # VSplitContainer -#####**Inherits:** [SplitContainer](class_splitcontainer) +####**Inherits:** [SplitContainer](class_splitcontainer) +####**Category:** Core ### Brief Description Vertical split container. ### Description -Vertical split container. See [[splitcontainer|SplitContainer]]. This goes from left to right. +Vertical split container. See [SplitContainer](class_splitcontainer). This goes from left to right. diff --git a/class_windowdialog.md b/class_windowdialog.md index 490ed93..116a7f1 100644 --- a/class_windowdialog.md +++ b/class_windowdialog.md @@ -1,5 +1,6 @@ # WindowDialog -#####**Inherits:** [Popup](class_popup) +####**Inherits:** [Popup](class_popup) +####**Category:** Core ### Brief Description Base class for window dialogs. @@ -10,7 +11,7 @@ Base class for window dialogs. * [TextureButton](class_texturebutton) **[`get_close_button`](#get_close_button)** **(** **)** ### Description -Windowdialog is the base class for all window-based dialogs. It's a by-default toplevel [[control|Control]] that draws a window decoration and allows motion and resizing. +Windowdialog is the base class for all window-based dialogs. It's a by-default toplevel [Control](class_control) that draws a window decoration and allows motion and resizing. ### Member Function Description @@ -27,4 +28,4 @@ Return the title of the window. #### get_close_button * [TextureButton](class_texturebutton) **`get_close_button`** **(** **)** -Return the close [[texturebutton|TextureButton]]. +Return the close [TextureButton](class_texturebutton). diff --git a/class_world.md b/class_world.md index df2945e..8f82b4c 100644 --- a/class_world.md +++ b/class_world.md @@ -1,5 +1,6 @@ # World -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description Class that has everything pertaining to a world. diff --git a/class_world2d.md b/class_world2d.md index b7396c8..039423e 100644 --- a/class_world2d.md +++ b/class_world2d.md @@ -1,5 +1,6 @@ # World2D -#####**Inherits:** [Resource](class_resource) +####**Inherits:** [Resource](class_resource) +####**Category:** Core ### Brief Description Class that has everything pertaining to a 2D world. diff --git a/class_worldenvironment.md b/class_worldenvironment.md index fd64277..f4c8c82 100644 --- a/class_worldenvironment.md +++ b/class_worldenvironment.md @@ -1,5 +1,6 @@ # WorldEnvironment -#####**Inherits:** [Spatial](class_spatial) +####**Inherits:** [Spatial](class_spatial) +####**Category:** Core ### Brief Description diff --git a/class_xmlparser.md b/class_xmlparser.md index 89ad818..28c7014 100644 --- a/class_xmlparser.md +++ b/class_xmlparser.md @@ -1,5 +1,6 @@ # XMLParser -#####**Inherits:** [Reference](class_reference) +####**Inherits:** [Reference](class_reference) +####**Category:** Core ### Brief Description