From d454e64f429affb89de036eed6daa5c6e5278492 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Thu, 7 Apr 2016 21:27:29 +0200 Subject: [PATCH] Sync docs with source --- doc/base/classes.xml | 452 ++++++++++++++++++++++++++++++++++++++----- 1 file changed, 402 insertions(+), 50 deletions(-) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index b6457f0d89b..23b699ecb06 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -1,5 +1,5 @@ - + Built-in GDScript functions. @@ -591,7 +591,7 @@ - + Hash the variable passed and return an integer. @@ -638,7 +638,7 @@ - + @@ -5149,6 +5149,42 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -5506,6 +5542,12 @@ Base class for Box containers. It arranges children controls vertically or horizontally, and rearranges them automatically when their minimum size changes. + + + + + + @@ -10074,7 +10116,9 @@ Returns an empty String "" at the end of the list. - + + + @@ -11756,7 +11800,9 @@ Returns an empty String "" at the end of the list. The dialog functions as a folder selector, disallowing the selection of any file. - + + + The dialog will warn when a file exists. @@ -12646,6 +12692,18 @@ Returns an empty String "" at the end of the list. + + + + + + + + + + + + @@ -12712,6 +12770,14 @@ Returns an empty String "" at the end of the list. + + + + + + + + @@ -14035,6 +14101,134 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -15846,6 +16040,76 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -15902,6 +16166,22 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) + + + + + + + + + + + + + + + + @@ -17423,6 +17703,56 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Main loop is the abstract main loop base class. @@ -19650,7 +19980,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) - Find a descendant of this node whose name matches [code]mask[/code] as in [method 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. + Find a descendant of this node whose name matches [code]mask[/code] as in [method 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. @@ -20444,6 +20774,18 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) + + + + + + + + + + + + @@ -20624,24 +20966,22 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) Return the main loop object (see [MainLoop]). - - - - - - - Returns current date in a dictionary of keys: year, month, - day, weekday, dst (daylight savings time). - - - Returns current datetime in a dictionary of keys: year, - month, day, weekday, dst (daylight savings time), hour, minute, second + Returns current datetime as a dictionary of keys: year, month, day, weekday, dst (daylight savings time), hour, minute, second. + + + + + + + + + Returns current date as a dictionary of keys: year, month, day, weekday, dst (daylight savings time). @@ -20650,36 +20990,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) - Returns current time in a dictionary of keys: - hour, minute, second - - - - - - - - - Get a dictionary of time values when given epoch time. - Dictionary Time values will be a union of values from [method get_time] - and [method get_date] dictionaries (with the exception of dst = - day light standard time, as it cannot be determined from epoc) - - - - - - - - - Get an epoch time value from a dictionary of time values - datetime must be populated with the following keys: - day, hour, minute, month, second, year. You can pass the output from - [method get_datetime_from_unix_time] directly into this function. Day - light savings time (dst), if present, is ignored. - - To be accurate, datetime dictionary must have keys for: year, month, day, - hour, minute, second + Returns current time as a dictionary of keys: hour, minute, second @@ -20694,6 +21005,27 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) + + + + + + + Get a dictionary of time values when given epoch time. + Dictionary Time values will be a union of values from [method get_time] and [method get_date] dictionaries (with the exception of dst = day light standard time, as it cannot be determined from epoch). + + + + + + + + + Get an epoch time value from a dictionary of time values. + [code]datetime[/code] must be populated with the following keys: year, month, day, hour, minute, second. + You can pass the output from [method get_datetime_from_unix_time] directly into this function. Daylight savings time (dst), if present, is ignored. + + @@ -29430,6 +29762,10 @@ This method controls whether the position between two cached points is interpola + + + + @@ -29779,6 +30115,10 @@ This method controls whether the position between two cached points is interpola This signal not only receives the body that stopped colliding with this one, but also its [RID] (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body stopped colliding with. + + + + @@ -34503,14 +34843,14 @@ This method controls whether the position between two cached points is interpola - + Set the [EventStream] this player will play. - + Return the currently assigned stream. @@ -37721,6 +38061,18 @@ This method controls whether the position between two cached points is interpola Stop (cancel) the timer. + + + + + + + + + + + +