From 11ccf225405eac5ce0f9e83df49d724593b96e55 Mon Sep 17 00:00:00 2001 From: Poommetee Ketson Date: Fri, 8 Sep 2017 11:40:13 +0700 Subject: [PATCH] ClassRef: fill in the blanks --- doc/base/classes.xml | 141 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 141 insertions(+) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 8d16585726..a097470306 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -31,6 +31,7 @@ + Make a color from color name (color_names.inc) and alpha ranging from 0 to 1. @@ -113,6 +114,7 @@ + Returns a character as String of the given ASCII code. @@ -309,6 +311,10 @@ + Returns a normalized value considering the given range. + [codeblock] + inverse_lerp(3, 5, 4) # return 0.5 + [/codeblock] @@ -335,6 +341,7 @@ + Returns the length of the given Variant if applicable. It will return character count of a String, element count of an Array, etc. @@ -551,6 +558,10 @@ + Maps a value from range [istart, istop] to [ostart, ostop]. + [codeblock] + range_lerp(75, 0, 100, -1, 1) # returns 0.5 + [/codeblock] @@ -667,6 +678,11 @@ + Returns whether the given class is exist in [ClassDB]. + [codeblock] + type_exists("Sprite") # returns true + type_exists("Variant") # returns false + [/codeblock] @@ -753,6 +769,7 @@ + [ARVRServer] singleton [AudioServer] singleton @@ -1944,18 +1961,25 @@ Variable is of type [Array]. + Variable is of type [PoolByteArray]. + Variable is of type [PoolIntArray]. + Variable is of type [PoolRealArray]. + Variable is of type [PoolStringArray]. + Variable is of type [PoolVector2Array]. + Variable is of type [PoolVector3Array]. + Variable is of type [PoolColorArray]. @@ -3477,6 +3501,7 @@ + Return the update mode of a value track. @@ -3487,6 +3512,7 @@ + Set the update mode (UPDATE_*) of a value track. @@ -3510,10 +3536,13 @@ Cubic interpolation. + Update between keyframes. + Update at the keyframes and hold the value. + Update at the keyframes. @@ -3551,6 +3580,7 @@ + Return the name of the next animation in the queue. @@ -3561,6 +3591,7 @@ + Set the name of an animation that will be played after. @@ -3933,6 +3964,7 @@ + Returns an animation given its name. @@ -3986,6 +4018,7 @@ + Returns whether node [code]id[/code] and [code]dst_id[/code] are connected at the specified slot. @@ -3994,6 +4027,7 @@ + Returns the blend amount of a Blend2 node given its name. @@ -4004,6 +4038,7 @@ + Sets the blend amount of a Blend2 node given its name and value. @@ -4024,6 +4059,7 @@ + Returns the blend amount of a Blend3 node given its name. @@ -4034,6 +4070,7 @@ + Sets the blend amount of a Blend3 node given its name and value. @@ -4042,6 +4079,7 @@ + Returns the blend amount of a Blend4 node given its name. @@ -4052,6 +4090,7 @@ + Sets the blend amount of a Blend4 node given its name and value. @@ -4064,6 +4103,7 @@ + Connects node [code]id[/code] to [code]dst_id[/code] at the specified input slot. @@ -4074,12 +4114,14 @@ + Disconnects nodes connected to [code]id[/code] at the specified input slot. + Returns playback process mode of this AnimationTreePlayer. @@ -4098,12 +4140,14 @@ + Returns a PoolStringArray containing the name of all nodes. + Returns whether this AnimationTreePlayer is active. @@ -4112,6 +4156,7 @@ + Returns mix amount of a Mix node given its name. @@ -4122,6 +4167,7 @@ + Sets mix amount of a Mix node given its name and value. @@ -4159,6 +4205,7 @@ + Returns position of a node in the graph given its name. @@ -4189,6 +4236,7 @@ + Sets position of a node in the graph given its name and position. @@ -4197,6 +4245,7 @@ + Returns autostart delay of a OneShot node given its name. @@ -4205,6 +4254,7 @@ + Returns autostart random delay of a OneShot node given its name. @@ -4213,6 +4263,7 @@ + Returns fade in time of a OneShot node given its name. @@ -4221,6 +4272,7 @@ + Returns fade out time of a OneShot node given its name. @@ -4229,6 +4281,7 @@ + Returns whether a OneShot node will auto restart given its name. @@ -4237,6 +4290,7 @@ + Returns whether a OneShot node is active given its name. @@ -4247,6 +4301,7 @@ + Sets autorestart property of a OneShot node given its name and value. @@ -4257,6 +4312,7 @@ + Sets autorestart delay of a OneShot node given its name and value in seconds. @@ -4267,6 +4323,7 @@ + Sets autorestart random delay of a OneShot node given its name and value in seconds. @@ -4277,6 +4334,7 @@ + Sets fade in time of a OneShot node given its name and value in seconds. @@ -4287,6 +4345,7 @@ + Sets fade out time of a OneShot node given its name and value in seconds. @@ -4307,6 +4366,7 @@ + Starts a OneShot node given its name. @@ -4315,6 +4375,7 @@ + Stops a OneShot node given its name. @@ -4335,6 +4396,7 @@ + Resets this AnimationTreePlayer. @@ -4343,6 +4405,7 @@ + Sets whether this AnimationTreePlayer is active. AnimationTreePlayer will start processing if set to active. @@ -4351,6 +4414,7 @@ + Sets process mode (ANIMATION_PROCESS_*) of this AnimationTreePlayer. @@ -4359,6 +4423,7 @@ + Sets base path of this AnimationTreePlayer. @@ -4375,6 +4440,7 @@ + Returns time scale value of a TimeScale node given its name. @@ -4385,6 +4451,7 @@ + Sets time scale value of a TimeScale node given its name and value. @@ -4395,6 +4462,7 @@ + Sets time seek value of a TimeSeek node given its name and value. @@ -4490,24 +4558,34 @@ + Output node. + Animation node. + OneShot node. + Mix node. + Blend2 node. + Blend3 node. + Blend4 node. + TimeScale node. + TimeSeek node. + Transition node. @@ -26534,6 +26612,7 @@ + Return the align mode of the [LineEdit]. @@ -26560,18 +26639,21 @@ + Return the [PopupMenu] of this [LineEdit]. + Return the placeholder text. + Return transparency of the placeholder text. @@ -26601,6 +26683,7 @@ + Execute a given action as defined in the MENU_* enum. @@ -26611,6 +26694,12 @@ + Select the text inside [LineEdit] by the given character positions. [code]from[/code] is default to the beginning. [code]to[/code] is default to the end. + [codeblock] + select() # select all + select(5) # select from the fifth character to the end. + select(2, 5) # select from the second to the fifth character. + [/codeblock] @@ -26626,6 +26715,7 @@ + Set text alignment of the [LineEdit]. @@ -26669,6 +26759,7 @@ + Set the placeholder text. @@ -26677,6 +26768,7 @@ + Set transparency of the placeholder text. @@ -26740,24 +26832,34 @@ + Align left. + Align center. + Align right. + Align fill. + Cut (Copy and clear). + Copy the selected text. + Paste the clipboard text over the selected text. + Clear the text. + Select all text. + Undo an action. @@ -26960,6 +27062,7 @@ + Called before the program exits. @@ -26968,12 +27071,14 @@ + Called each idle frame with time since last call as an only argument. + Called once during initialization. @@ -27100,6 +27205,7 @@ + Return [PoolByteArray] of a given base64 encoded String. @@ -27108,6 +27214,7 @@ + Return utf8 String of a given base64 encoded String. @@ -27116,6 +27223,7 @@ + Return [Variant] of a given base64 encoded String. @@ -27124,6 +27232,7 @@ + Return base64 encoded String of a given [PoolByteArray]. @@ -27132,6 +27241,7 @@ + Return base64 encoded String of a given utf8 String. @@ -27140,6 +27250,7 @@ + Return base64 encoded String of a given [Variant]. @@ -27219,6 +27330,7 @@ + Emitted when [PopupMenu] of this MenuButton is about to show. @@ -28621,6 +28733,7 @@ + Create client that connects to a server at address [code]ip[/code] using specified [code]port[/code]. @@ -28635,6 +28748,7 @@ + Create server that listens to connections via [code]port[/code]. @@ -28701,6 +28815,7 @@ + Return whether this [NetworkedMultiplayerPeer] is refusing new connections. @@ -28715,6 +28830,7 @@ + If [code]endable[/code] is true, this [NetworkedMultiplayerPeer] will refuse new connections. @@ -28737,26 +28853,31 @@ + Emitted when failed to connect to server. + Emitted when successfully connected to server. + Emitted by the server when a client is connected. + Emitted by the server when a client is disconnected. + Emitted by clients when server is disconnected. @@ -29125,6 +29246,7 @@ + Called when there is a change to input devices. Propagated through the node tree until a Node consumes it. @@ -29152,6 +29274,7 @@ + Propagated to all nodes when the previous InputEvent is not consumed by any nodes. @@ -29349,12 +29472,14 @@ + Return the pause mode (PAUSE_MODE_*) of this Node. + Return the order in the node tree branch, i.e. if called by the first child Node, return 0. @@ -29374,6 +29499,7 @@ + Return a [SceneTree] that this node is inside. @@ -29388,6 +29514,7 @@ + Return whether the node that a given [NodePath] points too exists. @@ -29441,12 +29568,14 @@ + Return whether this Node is in the specified group. + Return whether this Node is inside a [SceneTree]. @@ -29538,6 +29667,7 @@ + Destroy this Node and its children when they are not in use. @@ -29587,6 +29717,7 @@ + Request that [code]_ready[/code] be called again. @@ -29767,6 +29898,7 @@ + Set pause mode (PAUSE_MODE_*) of this Node. @@ -29837,10 +29969,12 @@ + Emitted when Node enters the tree. + Emitted when Node exits the tree. @@ -29885,18 +30019,25 @@ + Call a method remotely. + Call a method both remotely and locally. + Call a method if the Node is Master. + Call a method if the Node is Slave. + Inherits pause mode from parent. For root node, it is equivalent to PAUSE_MODE_STOP. + Stop processing when SceneTree is paused. + Continue to process regardless of SceneTree pause state.