From 6adb5ed4406bb415b5b1728af64bb5fa7580151e Mon Sep 17 00:00:00 2001 From: Bojidar Marinov Date: Wed, 23 Sep 2015 17:34:07 +0300 Subject: Regenerate docs --- doc/base/classes.xml | 7362 +++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 6133 insertions(+), 1229 deletions(-) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 7488d93fe1..f41cc3ec56 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -1,5 +1,5 @@ - + Built-in GDScript functions. @@ -312,6 +312,14 @@ Random range, any floating point value between 'from' and 'to' + + + + + + + + @@ -402,7 +410,7 @@ - + @@ -411,7 +419,7 @@ - + @@ -476,6 +484,16 @@ Print one or more arguments to the console with a tab between each argument. + + + + + + + + + + @@ -508,9 +526,9 @@ - + - + Converts the value of a String to a variable. @@ -526,7 +544,7 @@ - + @@ -568,6 +586,14 @@ Print a stack track at code location, only works when running with debugger turned on. + + + + + + + + @@ -1178,6 +1204,8 @@ + + @@ -1379,51 +1407,53 @@ - + + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + No hint for edited property. @@ -1441,34 +1471,37 @@ - + - + Property hint for a bitmask description, for bits 0,1,2,3 and 5 the hint would be like "Bit0,Bit1,Bit2,Bit3,,Bit5". Valid only for integers. - + Property hint for a bitmask description that covers all 32 bits. Valid only for integers. - + String property is a file (so pop up a file dialog when edited). Hint string can be a set of wildcards like "*.doc". - + String property is a directory (so pop up a file dialog when edited). - + - + - + String property is a resource, so open the resource popup menu when edited. - + - + - + - + + + + Property will be used as storage (default). Property will be used as storage (default). @@ -1737,6 +1770,8 @@ + + @@ -1959,6 +1994,12 @@ + + + + + + @@ -1993,6 +2034,12 @@ + + + + + + @@ -2472,9 +2519,18 @@ Play a given animation by the animation name. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being true can play the animation backwards. + + + + + + + + + + - Stop the currently played animation. @@ -3123,6 +3179,18 @@ + + + + + + + + + + + + @@ -3191,6 +3259,18 @@ + + + + + + + + + + + + @@ -3215,13 +3295,25 @@ - - + + - + + + + + + + + + + + + + @@ -3239,6 +3331,18 @@ + + + + + + + + + + + + @@ -3257,6 +3361,28 @@ + + + + + + + + + + + + + + + + + + + + + + @@ -3277,6 +3403,24 @@ + + + + + + + + + + + + + + + + + + @@ -3295,6 +3439,24 @@ + + + + + + + + + + + + + + + + + + @@ -3333,6 +3495,18 @@ Return if gravity is a point. When overriding space parameters, areas can have a center of gravity as a point. + + + + + + + + + + + + @@ -3358,13 +3532,25 @@ - - + + + + + + + + + + + + + + - + @@ -3382,6 +3568,62 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -3394,12 +3636,46 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -3420,6 +3696,24 @@ + + + + + + + + + + + + + + + + + + @@ -3438,6 +3732,24 @@ + + + + + + + + + + + + + + + + + + @@ -3502,6 +3814,12 @@ + + + + + + @@ -3543,6 +3861,8 @@ + + @@ -3550,6 +3870,8 @@ + + @@ -3557,6 +3879,8 @@ + + @@ -3564,6 +3888,8 @@ + + @@ -3571,6 +3897,8 @@ + + @@ -3578,6 +3906,8 @@ + + @@ -3585,6 +3915,8 @@ + + @@ -4128,64 +4460,85 @@ Base class for audio streams. Audio streams are used for music playback, or other types of streamed sounds that don't fit or requiere more flexibility than a [Sample]. + + + + + + + + MusePack audio stream driver. + + + MusePack audio stream driver. + + + + + + + + + OGG Vorbis audio stream driver. + + + OGG Vorbis audio stream driver. + + + + + + + + + + + + + - Start playback of an audio stream. - Stop playback of an audio stream. - Return wether the audio stream is currently playing. - Set the loop hint for the audio stream playback. if true, audio stream will attempt to loop (restart) when finished. - Return wether the audio stream loops. See [method set_loop] - - - - - - - Return the name of the audio stream. Often the song title when the stream is music. - Return the amount of times that the stream has looped (if loop is supported). - Seek to a certain position (in seconds) in an audio stream. - Return the current playing position (in seconds) of the audio stream (if supported). Since this value is updated internally, it may not be exact or updated continuosly. Accuracy depends on the sample buffer size of the audio driver. @@ -4194,173 +4547,78 @@ - + - Return the type of update that the stream uses. Some types of stream may need manual polling. - + + + + + + + + + - Manually poll the audio stream (if it is requested to). - - Does not need update, or manual polling. - - - Stream is updated on the main thread, when idle. - - - Stream is updated on its own thread. - - + - Simple gibberish speech stream playback. + Speex audio stream driver. - AudioStream used for gibberish playback. It plays randomized phonemes, which can be used to accompany text dialogs. + Speex audio stream driver. Speex is very useful for compressed speech. It allows loading a very large amount of speech in memory at little IO/latency cost. - - - - - Set the phoneme library. - - - - - - - Return the phoneme library. - - - - - - - Set pitch scale for the speech. Animating this value holds amusing results. - - - - - - - Return the pitch scale. - - - - - - - Set the random scaling for the pitch. - - - - - - - Return the pitch random scaling. - - - - - - - Set the cross-fade time between random phonemes. - - - - - - - Return the cross-fade time between random phonemes. - - - + - MusePack audio stream driver. - MusePack audio stream driver. - - + + - Set the file to be played. - - + + - Return the file being played. - - - - - - - OGG Vorbis audio stream driver. - - - OGG Vorbis audio stream driver. - - - - - - - - - Base class for resampled audio streams. - - - Base class for resampled audio streams. - - - - - - - - - Speex audio stream driver. - - - Speex audio stream driver. Speex is very useful for compressed speech. It allows loading a very large amount of speech in memory at little IO/latency cost. - - - - + + - Set the speech file (which is loaded to memory). - - + + - Return the speech file. + + + + + + @@ -4739,6 +4997,16 @@ BaseButton is the abstract base class for buttons, so it shouldn't be used directly (It doesnt display anything). Other types of buttons inherit from it. + + + + + + + + + + @@ -5262,6 +5530,14 @@ Return how a 3D point in worldpsace maps to a 2D coordinate in the [Viewport] rectangle. + + + + + + + + @@ -5357,24 +5633,6 @@ - - - - - - - - - - - - - - - - - - @@ -5436,18 +5694,16 @@ Return the scroll offset. - - + + - Set to true if the camera is at the center of the screen (default: true). - - + + - Return true if the camera is at the center of the screen (default: true). @@ -5467,6 +5723,10 @@ Make this the current 2D camera for the scene (viewport and layer), in case there's many cameras in the scene. + + + + @@ -5602,6 +5862,10 @@ + + + + @@ -5716,6 +5980,18 @@ Return the current blending mode from enum BLEND_MODE_*. + + + + + + + + + + + + @@ -5745,7 +6021,7 @@ - + Sets whether the canvas item is drawn behind its parent. @@ -5805,7 +6081,7 @@ - + @@ -5935,6 +6211,12 @@ + + + + + + @@ -5947,6 +6229,24 @@ + + + + + + + + + + + + + + + + + + @@ -5959,6 +6259,38 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -6015,6 +6347,80 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Canvas Item layer. @@ -6111,6 +6517,28 @@ + + + + + + + + + + + + + + + + + + + + + + Capsule shape resource. @@ -6215,6 +6643,50 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Checkable button. @@ -6441,6 +6913,16 @@ CollisionObject2D is the base class for 2D physics collisionables. They can hold any number of 2D collision shapes. Usually, they are edited by placing CollisionBody2D and CollisionPolygon2D nodes as children. Such nodes are for reference ant not present outside the editor, so code should use the regular shape API. + + + + + + + + + + @@ -6528,7 +7010,39 @@ Return the RID of the object. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -6538,14 +7052,14 @@ - - + + - - + + @@ -6562,13 +7076,25 @@ - - + + - + + + + + + + + + + + + + @@ -6586,6 +7112,54 @@ 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]. This is not accessible from regular code. This class is for editing custom shape polygons. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -6596,6 +7170,46 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -6608,6 +7222,36 @@ 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]. This is not accessible from regular code. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -6684,6 +7328,8 @@ + + @@ -6697,6 +7343,8 @@ + + @@ -6708,6 +7356,8 @@ + + @@ -6715,6 +7365,8 @@ + + @@ -6789,6 +7441,8 @@ + + @@ -6936,6 +7590,40 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Concave polygon shape. @@ -7083,7 +7771,7 @@ - + @@ -7091,7 +7779,7 @@ - + @@ -7694,6 +8382,12 @@ + + + + + + @@ -7727,6 +8421,8 @@ + + Emitted when an input event is received. Connecting in realtime is recommended for accepting the events. @@ -8114,6 +8810,16 @@ + + + + + + + + + + @@ -8270,6 +8976,16 @@ + + + + + + + + + + @@ -8478,7 +9194,7 @@ - + @@ -8522,7 +9238,7 @@ - + @@ -8536,7 +9252,7 @@ - + @@ -8544,7 +9260,7 @@ - + @@ -8574,7 +9290,7 @@ - + @@ -8584,7 +9300,7 @@ - + @@ -8594,15 +9310,163 @@ - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -8734,7 +9598,7 @@ - + @@ -8823,28 +9687,6 @@ - - - - - - - - - - - - - - - - - - - - - - @@ -8919,23 +9761,23 @@ - + - + - + - + - + - + - + - + - + @@ -9376,7 +10218,7 @@ - + @@ -9504,7 +10346,7 @@ - Add a custom filter. Filter format is: "mask ; description", example (C++): dialog->add_filter("*.png ; PNG Images"); + Add a custom filter. Filter format is: "mask ; description", example (C++): dialog-<add_filter("*.png ; PNG Images"); @@ -9578,6 +10420,18 @@ + + + + + + + + + + + + @@ -9802,6 +10656,14 @@ Font contains an unicode compatible character set, as well as the ability to draw it with variable width, ascent, descent and kerning. For creating fonts from TTF files (or other font formats), see the editor support for fonts. TODO check wikipedia for graph of ascent/baseline/descent/height/etc. + + + + + + + + @@ -9881,6 +10743,20 @@ Add a character to the font, where "character" is the unicode value, "texture" is the texture index, "rect" is the region in the texture (in pixels!), "align" is the (optional) alignment for the character and "advance" is the (optional) advance. + + + + + + + + + + + + + + @@ -9901,6 +10777,18 @@ Return the size of a string, taking kerning and advance into account. + + + + + + + + + + + + Clear all the font data. @@ -10036,6 +10924,12 @@ + + + + + + @@ -10370,6 +11264,20 @@ + + + + + + + + + + + + + + @@ -10464,6 +11372,18 @@ + + + + + + + + + + + + @@ -10592,322 +11512,650 @@ - - - - - - - - - - - - - - - - - + + + - - - - - + - - - - - - - - + + - - - - - + + + + + + + - + + + + + + + + + - - + + + + + + + + - - + + - - + + - - + + - - - - + + + + - + - + - + - - - - - + + + - + - + + + + + + + + + + + + + + + + + + + - - + + - + + + + + - + - + + + + + + + + + - - + + - - - + - + - - - - - + - - + + + + - - + + + + - + - - - - - - - - - - - + - + - - - + - - + + - - - - - - - - - + - - - - + + - - + + - - - - + + - - - - - - - + + + - - + + - + - - - - + + + + - + - + - - + + + + - + + + - + + + + + - - + + - + - + + + - - - - - - - - - - Groove constraint for 2D physics. - - - Groove constraint for 2D physics. This is useful for making a body "slide" through a segment placed in another. - - - - + + + + + + + + + - Set the length of the groove. - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - Return the length of the groove. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Groove constraint for 2D physics. + + + Groove constraint for 2D physics. This is useful for making a body "slide" through a segment placed in another. + + + + + + + Set the length of the groove. + + + + + + + Return the length of the groove. @@ -11081,7 +12329,7 @@ - + @@ -11176,6 +12424,12 @@ + + + + + + @@ -11195,7 +12449,7 @@ - + @@ -11787,6 +13041,10 @@ + + + + @@ -11848,7 +13106,7 @@ - + @@ -11939,13 +13197,6 @@ - - - - - Return the global, unscaled, screen pointer coordinates. If the 2D viewport has been scaled, it may not work well with [Camera] or controls. - - @@ -11976,6 +13227,18 @@ + + + + + + + + + + + + @@ -12023,6 +13286,22 @@ Return if this input event matches a pre-defined action, no matter the type. + + + + + + + + + + + + + + + + @@ -12037,6 +13316,14 @@ Return if this input event is pressed (for key, mouse, joy button or screen press events). + + + + + + + + @@ -12087,6 +13374,22 @@ + + + + + + + + + + + + + + + + @@ -12099,6 +13402,14 @@ + + + + + + + + @@ -12143,6 +13454,22 @@ + + + + + + + + + + + + + + + + @@ -12155,6 +13482,14 @@ + + + + + + + + @@ -12205,62 +13540,18 @@ - + + + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -12277,6 +13568,14 @@ + + + + + + + + @@ -12285,21 +13584,9 @@ - - - - - - - - - - - - - + - + @@ -12323,7 +13610,7 @@ - + @@ -12337,86 +13624,18 @@ - + + + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -12433,6 +13652,14 @@ + + + + + + + + @@ -12449,31 +13676,235 @@ - - - - - - - - - - - - - - - - - - - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -12511,6 +13942,22 @@ + + + + + + + + + + + + + + + + @@ -12523,6 +13970,14 @@ + + + + + + + + @@ -12587,6 +14042,22 @@ + + + + + + + + + + + + + + + + @@ -12599,6 +14070,14 @@ + + + + + + + + @@ -12710,7 +14189,7 @@ - + @@ -12783,6 +14262,8 @@ + + @@ -12845,328 +14326,510 @@ - + - - + + + + + + - - - + + + + + - - + + + + - - + + + + - - + + + + - - + + + + - - - - - - - Base node for all joint constraints in 2D phyisics. - - - Base node for all joint constraints in 2D phyisics. Joints take 2 bodies and apply a custom constraint. - - - - + + + + - Set the path to the A node for the joint. Must be of type PhysicsBody2D. - - + + + + - Return the path to the A node for the joint. - - + + + + - Set the path to the B node for the joint. Must be of type PhysicsBody2D. - - + + + + - Return the path to the B node for the joint. - - + + + + - - - + + + - - - - - - - - - - - - - - + + + + - - + + - + - - - - + + - + - - + + + + - - - + + + + + - - - + + + - - + + + + - - - - - + - - + + - - - - - - - - - + - - - + - - + + - - + + - - + + - - + + - - + + - - + + - - - - - - - - - - - - - - + + - - + + - - - - - - - - + + - - - - - - - - + + - - - + + + - + - - - - - - - - - - - + - - + + + + - - - - - - - - - + + + + + - - - - + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Base node for all joint constraints in 2D phyisics. + + + Base node for all joint constraints in 2D phyisics. Joints take 2 bodies and apply a custom constraint. + + + + + + + Set the path to the A node for the joint. Must be of type PhysicsBody2D. + + + + + + + Return the path to the A node for the joint. + + + + + + + Set the path to the B node for the joint. Must be of type PhysicsBody2D. + + + + + + + Return the path to the B node for the joint. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -13207,6 +14870,100 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Control that displays formatted text. @@ -13551,7 +15308,7 @@ - + @@ -13571,226 +15328,554 @@ - + - Control that provides single line string editing. - LineEdit provides a single line string editor, used for text fields. - + + + - Clear the [LineEdit] text. - + + + - Select the whole string. - - + + - Set the text in the [LineEdit], clearing the existing one and the selection. - - + + - Return the text in the [LineEdit]. - - + + - Set the cursor position inside the [LineEdit], causing it to scroll if needed. - - + + - Return the cursor position inside the [LineEdit]. - - + + - Set the maximum amount of characters the [LineEdit] can edit, and cropping existing text in case it exceeds that limit. Setting 0 removes the limit. - - + + - Return the maximum amount of characters the [LineEdit] can edit. If 0 is returned, no limit exists. - - + + - Append text at cursor, scrolling the [LineEdit] when needed. - - + + + + + + + + - Set the [i]editable[/i] status of the [LineEdit]. When disabled, existing text can't be modified and new text can't be added. - - + + - Return the [i]editable[/i] status of the [LineEdit] (see [method set_editable]). - - + + - Set the [i]secret[/i] status of the [LineEdit]. When enabled, every character is displayed as "*". - - + + - Return the [i]secret[/i] status of the [LineEdit] (see [method set_secret]). - - + + - + + + + + + + + + + + - - - - + + + + + + + + - This signal is emitted when the user presses KEY_ENTER on the [LineEdit]. This signal is often used as an alternate confirmation mechanism in dialogs. - - - + + + + + + + + + - When the text changes, this signal is emitted. - - - - - - - - - - - - - - - - - - - - - - - - - - - - Line shape for 2D collision objects. - - - Line shape for 2D collision objects. It works like a 2D plane and will not allow any body to go to the negative side. Not recommended for rigid bodies, and usually not recommended for static bodies either because it forces checks against it on every frame. - - - - + + + + + + + + + - Set the line normal. - - + + - Return the line normal. - - + + - Set the line distance from the origin. - - + + - Return the line distance from the origin. - - - - - - - Main loop is the abstract main loop base class. - - - Main loop is the abstract main loop base class. All other main loop classes are derived from it. Upon application start, a [MainLoop] has to be provided to OS, else the application will exit. This happens automatically (and a [SceneMainLoop] is created), unless a main [Script] is supplied, which may or not create and return a [MainLoop]. - - - - + + - - - - - - - - - - - - - - - - - Simple margin container. - - - Simple margin container. Adds a left margin to anything contained. - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Control that provides single line string editing. + + + LineEdit provides a single line string editor, used for text fields. + + + + + Clear the [LineEdit] text. + + + + + Select the whole string. + + + + + + + Set the text in the [LineEdit], clearing the existing one and the selection. + + + + + + + Return the text in the [LineEdit]. + + + + + + + Set the cursor position inside the [LineEdit], causing it to scroll if needed. + + + + + + + Return the cursor position inside the [LineEdit]. + + + + + + + Set the maximum amount of characters the [LineEdit] can edit, and cropping existing text in case it exceeds that limit. Setting 0 removes the limit. + + + + + + + Return the maximum amount of characters the [LineEdit] can edit. If 0 is returned, no limit exists. + + + + + + + Append text at cursor, scrolling the [LineEdit] when needed. + + + + + + + Set the [i]editable[/i] status of the [LineEdit]. When disabled, existing text can't be modified and new text can't be added. + + + + + + + Return the [i]editable[/i] status of the [LineEdit] (see [method set_editable]). + + + + + + + Set the [i]secret[/i] status of the [LineEdit]. When enabled, every character is displayed as "*". + + + + + + + Return the [i]secret[/i] status of the [LineEdit] (see [method set_secret]). + + + + + + + + + + + + + + + + + This signal is emitted when the user presses KEY_ENTER on the [LineEdit]. This signal is often used as an alternate confirmation mechanism in dialogs. + + + + + + + When the text changes, this signal is emitted. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Line shape for 2D collision objects. + + + Line shape for 2D collision objects. It works like a 2D plane and will not allow any body to go to the negative side. Not recommended for rigid bodies, and usually not recommended for static bodies either because it forces checks against it on every frame. + + + + + + + Set the line normal. + + + + + + + Return the line normal. + + + + + + + Set the line distance from the origin. + + + + + + + Return the line distance from the origin. + + + + + + + + + Main loop is the abstract main loop base class. + + + Main loop is the abstract main loop base class. All other main loop classes are derived from it. Upon application start, a [MainLoop] has to be provided to OS, else the application will exit. This happens automatically (and a [SceneMainLoop] is created), unless a main [Script] is supplied, which may or not create and return a [MainLoop]. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Simple margin container. + + + Simple margin container. Adds a left margin to anything contained. + + + @@ -13818,6 +15903,38 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -13934,6 +16051,26 @@ + + + + + + + + + + + + + + + + + + + + 3x3 matrix datatype. @@ -14055,6 +16192,8 @@ + + @@ -14066,6 +16205,8 @@ + + @@ -14075,6 +16216,8 @@ + + @@ -14204,6 +16347,18 @@ + + + + + + + + + + + + @@ -14213,6 +16368,14 @@ + + + + + + + + @@ -14234,7 +16397,7 @@ - + Return the [PopupMenu] contained in this button. @@ -15105,7 +17268,7 @@ - + @@ -15169,6 +17332,8 @@ + + @@ -15188,6 +17353,14 @@ + + + + + + + + @@ -15204,6 +17377,70 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -15284,6 +17521,136 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -15554,12 +17921,6 @@ Remove a child [Node]. Node is NOT deleted and will have to be deleted manually. - - - - - - @@ -15621,6 +17982,14 @@ Return the parent [Node] of the current [Node], or an empty Object if the node lacks a parent. + + + + + + + + @@ -15893,8 +18262,9 @@ + + - Return a duplicate of the scene, with all nodes and parameters copied. Subscriptions will not be duplicated. @@ -16015,7 +18385,7 @@ - + @@ -16036,19 +18406,37 @@ - - - + + + + + + + + + + + + + + + - Return the global position of the 2D node. - + + + + + + Return the global position of the 2D node. + + @@ -16061,12 +18449,58 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -16133,6 +18567,8 @@ + + @@ -16222,6 +18658,124 @@ Return the list of fullscreen modes. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -16266,6 +18820,12 @@ + + + + + + @@ -16373,15 +18933,23 @@ + + - Return the current date. + + + + + + + + - Return the current time. @@ -16390,6 +18958,12 @@ + + + + + + @@ -16417,6 +18991,12 @@ Return the amount of time passed in milliseconds since the engine started. + + + + + + @@ -16519,12 +19099,26 @@ + + + + + + + + + + + + + + @@ -16548,9 +19142,9 @@ - + - + @@ -16569,12 +19163,44 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -16615,6 +19241,36 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -16663,6 +19319,10 @@ Set a property. Return true if the property was found. + + + + @@ -16702,6 +19362,12 @@ Return the list of properties as an array of dictionaries, dictionaries countain: name:String, type:int (see TYPE_* enum in globals) and optionally: hint:int (see PROPERTY_HINT_* in globals), hint_string:String, usage:int (see PROPERTY_USAGE_* in globals). + + + + + + @@ -16773,6 +19439,14 @@ Add a user signal (can be added anytime). Arguments are optional, but can be added as an array of dictionaries, each containing "name" and "type" (from [@GlobalScope] TYPE_*). + + + + + + + + @@ -16948,6 +19622,12 @@ Translate a message. Only works in message translation is enabled (which is by default). See [method set_message_translation]. + + + + + + @@ -16973,6 +19653,58 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + OmniDirectional Light, such as a lightbulb or a candle. @@ -17185,7 +19917,7 @@ - + @@ -17248,7 +19980,7 @@ - + @@ -17335,6 +20067,26 @@ + + + + + + + + + + + + + + + + + + + + @@ -17371,7 +20123,7 @@ - + @@ -17385,7 +20137,7 @@ - + @@ -17650,28 +20402,6 @@ - - - - - - - - - - - - - - - - - - - - - - Particle system 3D Node @@ -18062,6 +20792,30 @@ + + + + + + + + + + + + + + + + + + + + + + + + @@ -18242,6 +20996,8 @@ + + @@ -18250,18 +21006,88 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -18644,11 +21470,16 @@ Return the total gravity vector being currently applied to this body. - + + + + + + + - Return the space density currently being applied to this body. @@ -18855,6 +21686,22 @@ Direct access object to a space in the [Physics2DServer]. It's used mainly to do queries against objects and areas residing in a given space. + + + + + + + + + + + + + + + + @@ -18869,7 +21716,7 @@ - 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. 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. @@ -19131,6 +21978,22 @@ + + + + + + + + + + + + + + + + @@ -19388,8 +22251,6 @@ - - @@ -19406,8 +22267,6 @@ - - @@ -19499,6 +22358,38 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -19527,6 +22418,20 @@ + + + + + + + + + + + + + + @@ -19661,11 +22566,15 @@ - + + + - + - + + + @@ -19687,7 +22596,13 @@ - + + + + + + + @@ -19887,6 +22802,70 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Base class for differnt types of Physics bodies. @@ -19941,6 +22920,74 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -19969,7 +23016,13 @@ - + + + + + + + @@ -21249,11 +24302,15 @@ - + + + - + - + + + @@ -21275,7 +24332,13 @@ - + + + + + + + @@ -21591,6 +24654,8 @@ + + @@ -21604,6 +24669,8 @@ + + @@ -21615,6 +24682,8 @@ + + @@ -21751,18 +24820,6 @@ - - - - - - - - - - - - @@ -22613,6 +25670,8 @@ + + @@ -22625,6 +25684,18 @@ + + + + + + + + + + + + @@ -22657,6 +25728,8 @@ + + @@ -22875,6 +25948,8 @@ + + @@ -22944,6 +26019,34 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -23143,6 +26246,8 @@ + + @@ -23227,6 +26332,8 @@ + + @@ -23235,6 +26342,8 @@ + + @@ -23356,6 +26465,30 @@ + + + + + + + + + + + + + + + + + + + + + + + + @@ -23498,7 +26631,7 @@ - + @@ -23627,8 +26760,9 @@ + + - Load a resource. Optionally a hint can be given for the resource type to load. @@ -23883,6 +27017,12 @@ + + + + + + @@ -23925,6 +27065,48 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -23981,7 +27163,15 @@ - + + + + + + + + + @@ -24083,6 +27273,42 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -24324,6 +27550,42 @@ Return the body bounciness. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -24460,6 +27722,18 @@ Return true if the body has the ability to fall asleep when not moving. See [set_can_sleep]. + + + + + + + + + + + + @@ -25437,6 +28711,30 @@ + + + + + + + + + + + + + + + + + + + + + + + + @@ -25484,356 +28782,1254 @@ - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Base class for scripts. + + + Base class for scripts. Any script that is loaded becomes one of these resources, which can then create instances. + + + + + + + Return true if this script can be instance (ie not a library). + + + + + + + + + Return true if a given object uses an instance of this script. + + + + + + + Return true if the script contains source code. + + + + + + + Return the script source code (if available). + + + + + + + Set the script source code. + + + + + + + Reload the script. This will fail if there are existing instances. + + + + + + + + + Base class for scroll bars. + + + Scrollbars are a [Range] based [Control], that display a draggable area (the size of the page). Horizontal ([HScrollBar]) and Vertical ([VScrollBar]) versions are available. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Segment Shape for 2D Collision Detection. + + + Segment Shape for 2D Collision Detection, consists of two points, 'a' and 'b'. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Base class for separators. + + + Separator is a [Control] used for sepataring other controls. It's purely a visual decoration. Horizontal ([HSeparator]) and Vertical ([VSeparator]) versions are available. + + + + + + + + + To be changed, ignore. + + + To be changed, ignore. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - - + + + + + + - - + + - + - + - + + + + + + + - + - + + + + + - + - + - - - - - - - - + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Base class for scripts. - - - Base class for scripts. Any script that is loaded becomes one of these resources, which can then create instances. - - - - - + + + + + + + + - Return true if this script can be instance (ie not a library). - - + + - + + + - Return true if a given object uses an instance of this script. - - - + + + + + + + - Return true if the script contains source code. - + + + + + - Return the script source code (if available). - - + + + + + + - Set the script source code. - - + + + + + + - Reload the script. This will fail if there are existing instances. - - - - - - - Base class for scroll bars. - - - Scrollbars are a [Range] based [Control], that display a draggable area (the size of the page). Horizontal ([HScrollBar]) and Vertical ([VScrollBar]) versions are available. - - - - + + + + + + - - + + + + + + - - - - - - - - - - - - + + + + + + - - + + + + + + - - + + + + + + - - + + + + + + - - + + + + + + - - + + + + + + - - + + + + + + - - + + + + + + - - - - - - - Segment Shape for 2D Collision Detection. - - - Segment Shape for 2D Collision Detection, consists of two points, 'a' and 'b'. - - - - + + + + + + - - + + + + + + - - + + + + + + + + - - + + + + + + - - - - - - - - - - - - + + + + + + - - + + + + + + + + + + + + + + + + - - - - - - - Base class for separators. - - - Separator is a [Control] used for sepataring other controls. It's purely a visual decoration. Horizontal ([HSeparator]) and Vertical ([VSeparator]) versions are available. - - - - - - - - - To be changed, ignore. - - - To be changed, ignore. - - - - + + + + + + + + + + + + - - + + + + + + + + + + + + - - + + - + - + - + - + - - + + + + - - - + + + - - - + + + + + + + - - - - + + + + + + + + + + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -26474,6 +30670,90 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -26678,6 +30958,8 @@ + + @@ -26691,6 +30973,18 @@ + + + + + + + + + + + + @@ -26703,6 +30997,54 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -26727,6 +31069,24 @@ + + + + + + + + + + + + + + + + + + @@ -26865,6 +31225,14 @@ + + + + + + + + @@ -27043,6 +31411,12 @@ + + + + + + @@ -27125,6 +31499,12 @@ + + + + + + @@ -27518,7 +31898,7 @@ - + @@ -27526,7 +31906,7 @@ - + @@ -27572,7 +31952,7 @@ - + @@ -27638,6 +32018,8 @@ + + @@ -27699,6 +32081,30 @@ + + + + + + + + + + + + + + + + + + + + + + + + @@ -28110,6 +32516,12 @@ Return part of the string from "from", with length "len". + + + + + + @@ -28138,6 +32550,12 @@ Return the string converted to uppercase. + + + + + + @@ -28199,6 +32617,8 @@ + + @@ -28682,6 +33102,20 @@ Return the current tab that is being showed. + + + + + + + + + + + + + + @@ -28745,8 +33179,24 @@ + + + + + + + + + + + + + + + + @@ -28772,8 +33222,12 @@ + + + + @@ -28862,8 +33316,26 @@ + + + + + + + + + + + + + + + + + + @@ -28872,6 +33344,12 @@ + + + + + + @@ -28890,10 +33368,14 @@ + + + + @@ -29179,10 +33661,6 @@ - - - - @@ -29223,6 +33701,8 @@ + + @@ -29304,8 +33784,9 @@ + + - Draw the texture into a a [VisualServer] canvas item. @@ -29317,6 +33798,8 @@ + + @@ -29329,6 +33812,8 @@ + + @@ -29353,6 +33838,8 @@ + + @@ -29400,6 +33887,18 @@ + + + + + + + + + + + + @@ -29436,6 +33935,18 @@ + + + + + + + + + + + + @@ -29810,7 +34321,7 @@ - + @@ -29936,6 +34447,18 @@ Return the quadrant size, this optimizes drawing by batching chunks of map at draw/cull time. + + + + + + + + + + + + @@ -29964,13 +34487,49 @@ Return true if tiles are to be centered in y coordinate (by default this is false and they are drawn from upper left cell corner). - + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + @@ -30011,8 +34570,23 @@ + + + + + + + + + + + + + + + + - Set the contents of a cell. Cells can be optionally flipped in y or x. @@ -30053,6 +34627,12 @@ Clear all cells. + + + + + + @@ -30094,6 +34674,10 @@ + + + + @@ -30147,6 +34731,22 @@ Return the texture of the tile. + + + + + + + + + + + + + + + + @@ -30231,6 +34831,70 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -30335,6 +34999,18 @@ Return the time left for timeout if the timer is active. + + + + + + + + + + + + @@ -30346,6 +35022,40 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -30526,6 +35236,8 @@ + + @@ -30538,6 +35250,8 @@ + + @@ -30546,18 +35260,24 @@ + + + + + + @@ -31411,7 +36131,7 @@ - + @@ -31427,7 +36147,7 @@ - + @@ -31443,7 +36163,7 @@ - + @@ -31459,7 +36179,7 @@ - + @@ -31495,7 +36215,7 @@ - + @@ -31517,7 +36237,7 @@ - + @@ -31539,13 +36259,43 @@ - + + + + + + + + + - + - + - + + + + + + + + + + + + + + + + + + + + + + + @@ -31553,7 +36303,7 @@ - + @@ -31577,7 +36327,7 @@ - + @@ -31601,7 +36351,7 @@ - + @@ -31625,7 +36375,7 @@ - + @@ -31649,7 +36399,7 @@ - + @@ -31657,7 +36407,7 @@ - + @@ -31669,7 +36419,7 @@ - + @@ -31678,6 +36428,10 @@ + + + + @@ -31710,44 +36464,104 @@ - + - - + + + + - - - + - - + + + + + + + + + + + + + + - - - + + + + + + + + + + + + + + + - - + + + + + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -32019,7 +36833,7 @@ - + @@ -32035,7 +36849,7 @@ - + @@ -32057,6 +36871,8 @@ + + @@ -32119,6 +36935,8 @@ + + @@ -32280,6 +37098,8 @@ + + @@ -32348,6 +37168,8 @@ + + @@ -32869,6 +37691,22 @@ + + + + + + + + + + + + + + + + @@ -32994,6 +37832,18 @@ + + + + + + + + + + + + @@ -33130,7 +37980,13 @@ - + + + + + + + @@ -34478,6 +39334,8 @@ + + @@ -34492,6 +39350,8 @@ + + @@ -34625,7 +39485,7 @@ - + @@ -34877,6 +39737,20 @@ + + + + + + + + + + + + + + Base class for window dialogs. @@ -34914,10 +39788,10 @@ - - + + @@ -34968,6 +39842,12 @@ + + + + + + @@ -34998,6 +39878,12 @@ + + + + + + @@ -35195,18 +40081,24 @@ + + + + + + @@ -35223,18 +40115,24 @@ + + + + + + @@ -35253,18 +40151,24 @@ + + + + + + -- cgit v1.2.3 From f41ed99df20f8c436f64b159045f3be5acd86e2c Mon Sep 17 00:00:00 2001 From: Bojidar Marinov Date: Wed, 23 Sep 2015 17:41:02 +0300 Subject: Update descriptions for Vector2 and Vector2Array --- doc/base/classes.xml | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index f41cc3ec56..74cacb0919 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -10346,7 +10346,7 @@ - Add a custom filter. Filter format is: "mask ; description", example (C++): dialog-<add_filter("*.png ; PNG Images"); + Add a custom filter. Filter format is: "mask ; description", example (C++): dialog->add_filter("*.png ; PNG Images"); @@ -36726,6 +36726,7 @@ + Returns the angle in radians between the two vectors. @@ -36734,12 +36735,14 @@ + Returns the angle in radians between the line connecting the two points and the x coordinate. + Returns the result of atan2 when called with the Vector's x and y as parameters. @@ -36754,6 +36757,7 @@ + Cubicly interpolates between this Vector and "b", using "pre_a" and "post_b" as handles, and returning the result at position "t". @@ -36762,6 +36766,7 @@ + Returns the squared distance to vector "b". Prefer this function over "distance_to" if you need to sort vectors or need the squared distance for some formula. @@ -36799,6 +36804,7 @@ + Returns the ratio of X to Y. @@ -36812,6 +36818,7 @@ + Returns the squared length of the vector. Prefer this function over "length" if you need to sort vectors or need the squared length for some formula. @@ -36822,7 +36829,7 @@ - Returns the result of the linear interpolation between this vector and "b", by amount "i". + Returns the result of the linear interpolation between this vector and "b", by amount "t". @@ -36838,6 +36845,7 @@ + Reflects/mirrors the vector around another vector. @@ -36846,6 +36854,7 @@ + Rotates the vector by "phi" radians. @@ -36854,6 +36863,7 @@ + Slides the vector by the other vector. @@ -36862,12 +36872,14 @@ + Snaps the vector to a grid with the given size. + Returns a perpendicular vector. @@ -36878,6 +36890,7 @@ + Constructs a new Vector2 from the given x and y. @@ -36896,8 +36909,10 @@ + An Array of Vector2's. + An Array specifically designed to hold Vector2's. @@ -36906,18 +36921,21 @@ + Get the Vector2 at the given index. + Insert a new Vector2. + Set the size of the Vector2Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. @@ -36926,12 +36944,14 @@ + Set the Vector2 at the given index. + Returns the size of the array. @@ -36940,6 +36960,7 @@ + Constructs a new Vector2Array. Optionally, you can pass in an Array that will be converted. -- cgit v1.2.3