diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 0c823ff18..20b0e219c 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -361,6 +361,8 @@ Random range, any floating point value between 'from' and 'to' - :ref:`Nil` **seed** **(** :ref:`float` seed **)** +Set seed for the random number generator. + .. _class_@GDScript_rand_seed: - :ref:`Array` **rand_seed** **(** :ref:`float` seed **)** @@ -425,7 +427,7 @@ Return a weak reference to an object. - :ref:`FuncRef` **funcref** **(** :ref:`Object` instance, :ref:`String` funcname **)** -Returns a reference to the specified function +Return a reference to the specified function. .. _class_@GDScript_convert: @@ -437,7 +439,7 @@ Convert from a type to another in the best way possible. The "type" parameter us - :ref:`int` **typeof** **(** Variant what **)** -Returns the internal type of the given Variant object, using the TYPE\_\* enum in :ref:`@Global Scope`. +Return the internal type of the given Variant object, using the TYPE\_\* enum in :ref:`@Global Scope`. .. _class_@GDScript_str: @@ -461,6 +463,8 @@ Print one or more arguments to the console with a tab between each argument. - :ref:`Nil` **prints** **(** Variant what, Variant ... **)** +Print one or more arguments to the console with a space between each argument. + .. _class_@GDScript_printerr: - :ref:`Nil` **printerr** **(** Variant what, Variant ... **)** @@ -477,25 +481,31 @@ Print one or more arguments to strings in the best way possible to console. No n - :ref:`String` **var2str** **(** Variant var **)** -Converts the value of a variable to a String. +Convert a value to a formatted string that can later be parsed using :ref:`str2var`. .. _class_@GDScript_str2var: - Variant **str2var** **(** :ref:`String` string **)** +Convert a formatted string that was returned by :ref:`var2str` to the original value. + .. _class_@GDScript_var2bytes: - :ref:`RawArray` **var2bytes** **(** Variant var **)** +Encode a variable value to a byte array. + .. _class_@GDScript_bytes2var: - Variant **bytes2var** **(** :ref:`RawArray` bytes **)** +Decode a byte array back to a value. + .. _class_@GDScript_range: - :ref:`Array` **range** **(** Variant ... **)** -Return an array with the given range. Range can be 1 argument N (0 to N-1), two arguments (initial, final-1) or three arguments (initial,final-1,increment). +Return an array with the given range. Range can be 1 argument N (0 to N-1), two arguments (initial, final-1) or three arguments (initial, final-1, increment). .. _class_@GDScript_load: @@ -519,12 +529,14 @@ Convert a previously converted instances to dictionary back into an instance. Us - :ref:`int` **hash** **(** Variant var:Variant **)** -Hashes the variable passed and returns an integer. +Hash the variable passed and return an integer. .. _class_@GDScript_Color8: - :ref:`Color` **Color8** **(** :ref:`int` r8, :ref:`int` g8, :ref:`int` b8, :ref:`int` a8 **)** +Make a color from red, green, blue and alpha. Arguments can range from 0 to 255. + .. _class_@GDScript_print_stack: - :ref:`Nil` **print_stack** **(** **)** @@ -535,16 +547,28 @@ Print a stack track at code location, only works when running with debugger turn - :ref:`Object` **instance_from_id** **(** :ref:`int` instance_id **)** +Get an object by its ID. + .. _class_@GDScript_preload: - :ref:`Resource` **preload** **(** :ref:`String` path **)** +Preload a resource from the filesystem. The resource is loaded during script parsing. + .. _class_@GDScript_yield: - :ref:`Nil` **yield** **(** :ref:`Object` object, :ref:`String` signal **)** +Stop the function execution and return the current state. Call resume on the state to resume execution. This makes the state invalid. + +Returns anything that was passed to the resume function call. + +If passed an object and a signal, the execution is resumed when the object's signal is emmited. + .. _class_@GDScript_assert: - :ref:`Nil` **assert** **(** :ref:`bool` condition **)** +Assert that the condition is true. If the condition is false, generates an error. + diff --git a/classes/class_@global scope.rst b/classes/class_@global scope.rst index 20d9f495e..9d307de33 100644 --- a/classes/class_@global scope.rst +++ b/classes/class_@global scope.rst @@ -60,63 +60,63 @@ Numeric Constants - **SPKEY** = **16777216** --- Scancodes with this bit applied are non printable. - **KEY_ESCAPE** = **16777217** --- Escape Key - **KEY_TAB** = **16777218** --- Tab Key -- **KEY_BACKTAB** = **16777219** --- Shift-Tab key -- **KEY_BACKSPACE** = **16777220** -- **KEY_RETURN** = **16777221** -- **KEY_ENTER** = **16777222** -- **KEY_INSERT** = **16777223** -- **KEY_DELETE** = **16777224** -- **KEY_PAUSE** = **16777225** -- **KEY_PRINT** = **16777226** +- **KEY_BACKTAB** = **16777219** --- Shift-Tab Key +- **KEY_BACKSPACE** = **16777220** --- Backspace Key +- **KEY_RETURN** = **16777221** --- Return Key +- **KEY_ENTER** = **16777222** --- Enter Key +- **KEY_INSERT** = **16777223** --- Insert Key +- **KEY_DELETE** = **16777224** --- Delete Key +- **KEY_PAUSE** = **16777225** --- Pause Key +- **KEY_PRINT** = **16777226** --- Printscreen Key - **KEY_SYSREQ** = **16777227** - **KEY_CLEAR** = **16777228** -- **KEY_HOME** = **16777229** -- **KEY_END** = **16777230** -- **KEY_LEFT** = **16777231** -- **KEY_UP** = **16777232** -- **KEY_RIGHT** = **16777233** -- **KEY_DOWN** = **16777234** -- **KEY_PAGEUP** = **16777235** -- **KEY_PAGEDOWN** = **16777236** -- **KEY_SHIFT** = **16777237** -- **KEY_CONTROL** = **16777238** +- **KEY_HOME** = **16777229** --- Home Key +- **KEY_END** = **16777230** --- End Key +- **KEY_LEFT** = **16777231** --- Left Arrow Key +- **KEY_UP** = **16777232** --- Up Arrow Key +- **KEY_RIGHT** = **16777233** --- Right Arrow Key +- **KEY_DOWN** = **16777234** --- Down Arrow Key +- **KEY_PAGEUP** = **16777235** --- Pageup Key +- **KEY_PAGEDOWN** = **16777236** --- Pagedown Key +- **KEY_SHIFT** = **16777237** --- Shift Key +- **KEY_CONTROL** = **16777238** --- Control Key - **KEY_META** = **16777239** -- **KEY_ALT** = **16777240** -- **KEY_CAPSLOCK** = **16777241** -- **KEY_NUMLOCK** = **16777242** -- **KEY_SCROLLLOCK** = **16777243** -- **KEY_F1** = **16777244** -- **KEY_F2** = **16777245** -- **KEY_F3** = **16777246** -- **KEY_F4** = **16777247** -- **KEY_F5** = **16777248** -- **KEY_F6** = **16777249** -- **KEY_F7** = **16777250** -- **KEY_F8** = **16777251** -- **KEY_F9** = **16777252** -- **KEY_F10** = **16777253** -- **KEY_F11** = **16777254** -- **KEY_F12** = **16777255** -- **KEY_F13** = **16777256** -- **KEY_F14** = **16777257** -- **KEY_F15** = **16777258** -- **KEY_F16** = **16777259** -- **KEY_KP_ENTER** = **16777344** -- **KEY_KP_MULTIPLY** = **16777345** -- **KEY_KP_DIVIDE** = **16777346** -- **KEY_KP_SUBTRACT** = **16777347** -- **KEY_KP_PERIOD** = **16777348** -- **KEY_KP_ADD** = **16777349** -- **KEY_KP_0** = **16777350** -- **KEY_KP_1** = **16777351** -- **KEY_KP_2** = **16777352** -- **KEY_KP_3** = **16777353** -- **KEY_KP_4** = **16777354** -- **KEY_KP_5** = **16777355** -- **KEY_KP_6** = **16777356** -- **KEY_KP_7** = **16777357** -- **KEY_KP_8** = **16777358** -- **KEY_KP_9** = **16777359** +- **KEY_ALT** = **16777240** --- Alt Key +- **KEY_CAPSLOCK** = **16777241** --- Capslock Key +- **KEY_NUMLOCK** = **16777242** --- Numlock Key +- **KEY_SCROLLLOCK** = **16777243** --- Scrolllock Key +- **KEY_F1** = **16777244** --- F1 Key +- **KEY_F2** = **16777245** --- F2 Key +- **KEY_F3** = **16777246** --- F3 Key +- **KEY_F4** = **16777247** --- F4 Key +- **KEY_F5** = **16777248** --- F5 Key +- **KEY_F6** = **16777249** --- F6 Key +- **KEY_F7** = **16777250** --- F7 Key +- **KEY_F8** = **16777251** --- F8 Key +- **KEY_F9** = **16777252** --- F9 Key +- **KEY_F10** = **16777253** --- F10 Key +- **KEY_F11** = **16777254** --- F11 Key +- **KEY_F12** = **16777255** --- F12 Key +- **KEY_F13** = **16777256** --- F13 Key +- **KEY_F14** = **16777257** --- F14 Key +- **KEY_F15** = **16777258** --- F15 Key +- **KEY_F16** = **16777259** --- F16 Key +- **KEY_KP_ENTER** = **16777344** --- Enter Key on Numpad +- **KEY_KP_MULTIPLY** = **16777345** --- Multiply Key on Numpad +- **KEY_KP_DIVIDE** = **16777346** --- Divide Key on Numpad +- **KEY_KP_SUBTRACT** = **16777347** --- Subtract Key on Numpad +- **KEY_KP_PERIOD** = **16777348** --- Period Key on Numpad +- **KEY_KP_ADD** = **16777349** --- Add Key on Numpad +- **KEY_KP_0** = **16777350** --- Number 0 on Numpad +- **KEY_KP_1** = **16777351** --- Number 1 on Numpad +- **KEY_KP_2** = **16777352** --- Number 2 on Numpad +- **KEY_KP_3** = **16777353** --- Number 3 on Numpad +- **KEY_KP_4** = **16777354** --- Number 4 on Numpad +- **KEY_KP_5** = **16777355** --- Number 5 on Numpad +- **KEY_KP_6** = **16777356** --- Number 6 on Numpad +- **KEY_KP_7** = **16777357** --- Number 7 on Numpad +- **KEY_KP_8** = **16777358** --- Number 8 on Numpad +- **KEY_KP_9** = **16777359** --- Number 9 on Numpad - **KEY_SUPER_L** = **16777260** - **KEY_SUPER_R** = **16777261** - **KEY_MENU** = **16777262** @@ -166,7 +166,7 @@ Numeric Constants - **KEY_LAUNCHE** = **16777318** - **KEY_LAUNCHF** = **16777319** - **KEY_UNKNOWN** = **33554431** -- **KEY_SPACE** = **32** +- **KEY_SPACE** = **32** --- Space Key - **KEY_EXCLAM** = **33** - **KEY_QUOTEDBL** = **34** - **KEY_NUMBERSIGN** = **35** @@ -182,16 +182,16 @@ Numeric Constants - **KEY_MINUS** = **45** - **KEY_PERIOD** = **46** - **KEY_SLASH** = **47** -- **KEY_0** = **48** -- **KEY_1** = **49** -- **KEY_2** = **50** -- **KEY_3** = **51** -- **KEY_4** = **52** -- **KEY_5** = **53** -- **KEY_6** = **54** -- **KEY_7** = **55** -- **KEY_8** = **56** -- **KEY_9** = **57** +- **KEY_0** = **48** --- Number 0 +- **KEY_1** = **49** --- Number 1 +- **KEY_2** = **50** --- Number 2 +- **KEY_3** = **51** --- Number 3 +- **KEY_4** = **52** --- Number 4 +- **KEY_5** = **53** --- Number 5 +- **KEY_6** = **54** --- Number 6 +- **KEY_7** = **55** --- Number 7 +- **KEY_8** = **56** --- Number 8 +- **KEY_9** = **57** --- Number 9 - **KEY_COLON** = **58** - **KEY_SEMICOLON** = **59** - **KEY_LESS** = **60** @@ -199,32 +199,32 @@ Numeric Constants - **KEY_GREATER** = **62** - **KEY_QUESTION** = **63** - **KEY_AT** = **64** -- **KEY_A** = **65** -- **KEY_B** = **66** -- **KEY_C** = **67** -- **KEY_D** = **68** -- **KEY_E** = **69** -- **KEY_F** = **70** -- **KEY_G** = **71** -- **KEY_H** = **72** -- **KEY_I** = **73** -- **KEY_J** = **74** -- **KEY_K** = **75** -- **KEY_L** = **76** -- **KEY_M** = **77** -- **KEY_N** = **78** -- **KEY_O** = **79** -- **KEY_P** = **80** -- **KEY_Q** = **81** -- **KEY_R** = **82** -- **KEY_S** = **83** -- **KEY_T** = **84** -- **KEY_U** = **85** -- **KEY_V** = **86** -- **KEY_W** = **87** -- **KEY_X** = **88** -- **KEY_Y** = **89** -- **KEY_Z** = **90** +- **KEY_A** = **65** --- A Key +- **KEY_B** = **66** --- B Key +- **KEY_C** = **67** --- C Key +- **KEY_D** = **68** --- D Key +- **KEY_E** = **69** --- E Key +- **KEY_F** = **70** --- F Key +- **KEY_G** = **71** --- G Key +- **KEY_H** = **72** --- H Key +- **KEY_I** = **73** --- I Key +- **KEY_J** = **74** --- J Key +- **KEY_K** = **75** --- K Key +- **KEY_L** = **76** --- L Key +- **KEY_M** = **77** --- M Key +- **KEY_N** = **78** --- N Key +- **KEY_O** = **79** --- O Key +- **KEY_P** = **80** --- P Key +- **KEY_Q** = **81** --- Q Key +- **KEY_R** = **82** --- R Key +- **KEY_S** = **83** --- S Key +- **KEY_T** = **84** --- T Key +- **KEY_U** = **85** --- U Key +- **KEY_V** = **86** --- V Key +- **KEY_W** = **87** --- W Key +- **KEY_X** = **88** --- X Key +- **KEY_Y** = **89** --- Y Key +- **KEY_Z** = **90** --- Z Key - **KEY_BRACKETLEFT** = **91** - **KEY_BACKSLASH** = **92** - **KEY_BRACKETRIGHT** = **93** @@ -310,9 +310,9 @@ Numeric Constants - **KEY_MASK_CMD** = **268435456** - **KEY_MASK_KPAD** = **536870912** - **KEY_MASK_GROUP_SWITCH** = **1073741824** -- **BUTTON_LEFT** = **1** -- **BUTTON_RIGHT** = **2** -- **BUTTON_MIDDLE** = **3** +- **BUTTON_LEFT** = **1** --- Left Mouse Button +- **BUTTON_RIGHT** = **2** --- Right Mouse Button +- **BUTTON_MIDDLE** = **3** --- Middle Mouse Button - **BUTTON_WHEEL_UP** = **4** - **BUTTON_WHEEL_DOWN** = **5** - **BUTTON_WHEEL_LEFT** = **6** @@ -357,31 +357,31 @@ Numeric Constants - **JOY_DS_B** = **0** - **JOY_DS_X** = **3** - **JOY_DS_Y** = **2** -- **JOY_SELECT** = **10** -- **JOY_START** = **11** -- **JOY_DPAD_UP** = **12** -- **JOY_DPAD_DOWN** = **13** -- **JOY_DPAD_LEFT** = **14** -- **JOY_DPAD_RIGHT** = **15** -- **JOY_L** = **4** -- **JOY_L2** = **6** -- **JOY_L3** = **8** -- **JOY_R** = **5** -- **JOY_R2** = **7** -- **JOY_R3** = **9** -- **JOY_AXIS_0** = **0** -- **JOY_AXIS_1** = **1** -- **JOY_AXIS_2** = **2** -- **JOY_AXIS_3** = **3** +- **JOY_SELECT** = **10** --- Joystick Button Select +- **JOY_START** = **11** --- Joystick Button Start +- **JOY_DPAD_UP** = **12** --- Joystick DPad Up +- **JOY_DPAD_DOWN** = **13** --- Joystick DPad Down +- **JOY_DPAD_LEFT** = **14** --- Joystick DPad Left +- **JOY_DPAD_RIGHT** = **15** --- Joystick DPad Right +- **JOY_L** = **4** --- Joystick Left Shoulder Button +- **JOY_L2** = **6** --- Joystick Left Trigger +- **JOY_L3** = **8** --- Joystick Left Stick Click +- **JOY_R** = **5** --- Joystick Right Shoulder Button +- **JOY_R2** = **7** --- Joystick Right Trigger +- **JOY_R3** = **9** --- Joystick Right Stick Click +- **JOY_AXIS_0** = **0** --- Joystick Left Stick Horizontal Axis +- **JOY_AXIS_1** = **1** --- Joystick Left Stick Vertical Axis +- **JOY_AXIS_2** = **2** --- Joystick Right Stick Horizontal Axis +- **JOY_AXIS_3** = **3** --- Joystick Right Stick Vertical Axis - **JOY_AXIS_4** = **4** - **JOY_AXIS_5** = **5** -- **JOY_AXIS_6** = **6** -- **JOY_AXIS_7** = **7** +- **JOY_AXIS_6** = **6** --- Joystick Left Trigger Analog Axis +- **JOY_AXIS_7** = **7** --- Joystick Right Trigger Analog Axis - **JOY_AXIS_MAX** = **8** -- **JOY_ANALOG_0_X** = **0** -- **JOY_ANALOG_0_Y** = **1** -- **JOY_ANALOG_1_X** = **2** -- **JOY_ANALOG_1_Y** = **3** +- **JOY_ANALOG_0_X** = **0** --- Joystick Left Stick Horizontal Axis +- **JOY_ANALOG_0_Y** = **1** --- Joystick Left Stick Vertical Axis +- **JOY_ANALOG_1_X** = **2** --- Joystick Right Stick Horizontal Axis +- **JOY_ANALOG_1_Y** = **3** --- Joystick Right Stick Vertical Axis - **JOY_ANALOG_2_X** = **4** - **JOY_ANALOG_2_Y** = **5** - **JOY_ANALOG_L2** = **6** @@ -446,7 +446,6 @@ Numeric Constants - **PROPERTY_HINT_IMAGE_COMPRESS_LOSSY** = **17** - **PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS** = **18** - **PROPERTY_USAGE_STORAGE** = **1** --- Property will be used as storage (default). -- **PROPERTY_USAGE_STORAGE** = **1** --- Property will be used as storage (default). - **PROPERTY_USAGE_EDITOR** = **2** --- Property will be visible in editor (default). - **PROPERTY_USAGE_NETWORK** = **4** - **PROPERTY_USAGE_DEFAULT** = **7** --- Default usage (storage and editor). @@ -470,16 +469,16 @@ Numeric Constants - **TYPE_PLANE** = **9** --- Variable is of type :ref:`Plane`. - **TYPE_QUAT** = **10** --- Variable is of type :ref:`Quat`. - **TYPE_AABB** = **11** --- Variable is of type :ref:`AABB`. -- **TYPE_MATRIX3** = **12** --- Variable is fo type :ref:`Matrix3`. -- **TYPE_TRANSFORM** = **13** --- Variable is fo type :ref:`Transform`. -- **TYPE_COLOR** = **14** --- Variable is fo type :ref:`Color`. -- **TYPE_IMAGE** = **15** --- Variable is fo type :ref:`Image`. -- **TYPE_NODE_PATH** = **16** --- Variable is fo type :ref:`NodePath`. -- **TYPE_RID** = **17** --- Variable is fo type :ref:`RID`. -- **TYPE_OBJECT** = **18** --- Variable is fo type :ref:`Object`. -- **TYPE_INPUT_EVENT** = **19** --- Variable is fo type :ref:`InputEvent`. -- **TYPE_DICTIONARY** = **20** --- Variable is fo type :ref:`Dictionary`. -- **TYPE_ARRAY** = **21** --- Variable is fo type :ref:`Array`. +- **TYPE_MATRIX3** = **12** --- Variable is of type :ref:`Matrix3`. +- **TYPE_TRANSFORM** = **13** --- Variable is of type :ref:`Transform`. +- **TYPE_COLOR** = **14** --- Variable is of type :ref:`Color`. +- **TYPE_IMAGE** = **15** --- Variable is of type :ref:`Image`. +- **TYPE_NODE_PATH** = **16** --- Variable is of type :ref:`NodePath`. +- **TYPE_RID** = **17** --- Variable is of type :ref:`RID`. +- **TYPE_OBJECT** = **18** --- Variable is of type :ref:`Object`. +- **TYPE_INPUT_EVENT** = **19** --- Variable is of type :ref:`InputEvent`. +- **TYPE_DICTIONARY** = **20** --- Variable is of type :ref:`Dictionary`. +- **TYPE_ARRAY** = **21** --- Variable is of type :ref:`Array`. - **TYPE_RAW_ARRAY** = **22** - **TYPE_INT_ARRAY** = **23** - **TYPE_REAL_ARRAY** = **24** diff --git a/classes/class_boxcontainer.rst b/classes/class_boxcontainer.rst index a3f2d3545..703fb03e2 100644 --- a/classes/class_boxcontainer.rst +++ b/classes/class_boxcontainer.rst @@ -20,6 +20,8 @@ Base class for Box containers. Member Functions ---------------- ++------------------------+------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_spacer` **(** :ref:`bool` begin **)** | +------------------------+------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_alignment` **(** **)** const | +------------------------+------------------------------------------------------------------------------------------------------+ @@ -41,6 +43,10 @@ Base class for Box containers. It arranges children controls vertically or horiz Member Function Description --------------------------- +.. _class_BoxContainer_add_spacer: + +- void **add_spacer** **(** :ref:`bool` begin **)** + .. _class_BoxContainer_get_alignment: - :ref:`int` **get_alignment** **(** **)** const diff --git a/classes/class_node.rst b/classes/class_node.rst index cc4d20c2a..cbdeb4dbe 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -337,6 +337,8 @@ Return the parent :ref:`Node` of the current :ref:`Node` - :ref:`Node` **find_node** **(** :ref:`String` mask, :ref:`bool` recursive=true, :ref:`bool` owned=true **)** const +Find a descendant of this node whose name matches ``mask`` as in :ref:`String.match` (i.e. case sensitive, but '\*' matches zero or more characters and '?' matches any single character except '.'). Note that it does not match against the full path, just against individual node names. + .. _class_Node_has_node_and_resource: - :ref:`bool` **has_node_and_resource** **(** :ref:`NodePath` path **)** const diff --git a/classes/class_os.rst b/classes/class_os.rst index b76465cf2..fd2170c5a 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -420,6 +420,8 @@ Return the amount of fixed iterations per second (for fixed process and physics) - void **set_time_scale** **(** :ref:`float` time_scale **)** +Speeds up or slows down the physics by changing the delta variable. (delta \* time_scale) + .. _class_OS_get_time_scale: - :ref:`float` **get_time_scale** **(** **)** diff --git a/classes/class_rigidbody.rst b/classes/class_rigidbody.rst index 78a5be2bd..7bc61fb20 100644 --- a/classes/class_rigidbody.rst +++ b/classes/class_rigidbody.rst @@ -103,6 +103,7 @@ Signals - **body_enter_shape** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** - **body_exit** **(** :ref:`Object` body **)** - **body_exit_shape** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +- **sleeping_state_changed** **(** **)** Numeric Constants ----------------- diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index 9792e2bfd..009002232 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -105,6 +105,7 @@ Signals - **body_enter_shape** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** - **body_exit** **(** :ref:`Object` body **)** - **body_exit_shape** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +- **sleeping_state_changed** **(** **)** Numeric Constants ----------------- diff --git a/classes/class_string.rst b/classes/class_string.rst index 7306a4cc9..a60545515 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -286,13 +286,13 @@ Return the length of the string in characters. - :ref:`bool` **match** **(** :ref:`String` expr **)** -Do a simple expression matching, using ? and \* wildcards. +Do a simple expression match, where '\*' matches zero or more arbitrary characters and '?' matches any single character except '.'. .. _class_String_matchn: - :ref:`bool` **matchn** **(** :ref:`String` expr **)** -Do a simple, case insensitive, expression matching, using ? and \* wildcards. +Do a simple case insensitive expression match, using ? and \* wildcards (see :ref:`match`). .. _class_String_md5_buffer: