From b587a13293840975b53bad3392374ad30a578064 Mon Sep 17 00:00:00 2001 From: J08nY Date: Sat, 18 Jun 2016 21:21:29 +0200 Subject: [PATCH] Classref: Mutex, Semaphore, Thread, *Array (#5278) --- doc/base/classes.xml | 58 ++++++++++++++++++++++++++++++++------------ 1 file changed, 43 insertions(+), 15 deletions(-) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 4270e72b34c..070046d100f 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -8459,7 +8459,7 @@ - Resize the array. + Set the size of the [ColorArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. @@ -8468,7 +8468,7 @@ - Set an index in the array. + Change the [Color] at the given index. @@ -16981,7 +16981,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) - Resize the array. + Set the size of the [IntArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. @@ -16990,7 +16990,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) - Set an index in the array. + Change the int at the given index. @@ -20500,22 +20500,27 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) + A synchronization Mutex. + A synchronization Mutex. Element used in multi-threadding. Basically a binary [Semaphore]. Guarantees that only one thread has this lock, can be used to protect a critical section. + Lock this [Mutex], blocks until it is unlocked by the current owner. + Try locking this [Mutex], does not block. Returns [OK] on success else [ERR_BUSY]. + Unlock this [Mutex], leaving it to others threads. @@ -29997,12 +30002,14 @@ This method controls whether the position between two cached points is interpola + Append an element at the end of the array. + Set the size of the [RawArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. @@ -30011,12 +30018,14 @@ This method controls whether the position between two cached points is interpola + Change the byte at the given index. + Return the size of the array. @@ -30025,6 +30034,7 @@ This method controls whether the position between two cached points is interpola + Create from a generic array. @@ -30338,12 +30348,14 @@ This method controls whether the position between two cached points is interpola + Append an element at the end of the array. + Set the size of the [RealArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. @@ -30352,12 +30364,14 @@ This method controls whether the position between two cached points is interpola + Change the float at the given index. + Return the size of the array. @@ -30366,6 +30380,7 @@ This method controls whether the position between two cached points is interpola + Create from a generic array. @@ -33670,20 +33685,24 @@ This method controls whether the position between two cached points is interpola + A synchronization Semaphore. + A synchronization Semaphore. Element used in multi-threadding. Initialized to zero on creation. + Tries to wait for the [Semaphore], if it's value is zero, blocks until non-zero. + Lowers the [Semaphore], allowing one more thread in. @@ -37731,7 +37750,7 @@ This method controls whether the position between two cached points is interpola - Reset the size of the array. + Set the size of the [StringArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. @@ -37740,6 +37759,7 @@ This method controls whether the position between two cached points is interpola + Change the [String] at the given index. @@ -37755,6 +37775,7 @@ This method controls whether the position between two cached points is interpola + Create from a generic array. @@ -39655,8 +39676,10 @@ This method controls whether the position between two cached points is interpola + A unit of execution in a process. + A unit of execution in a process. Can run methods on [Object]s simultaneously. The use of synchronization via [Mutex], [Semaphore] is advised if working with shared objects. @@ -39671,24 +39694,29 @@ This method controls whether the position between two cached points is interpola + Start a new [Thread], it will run "method" on object "instance" using "userdata" as an argument and running with "priority", one of PRIORITY_* enum. + Returns OK on success, or ERR_CANT_CREATE on failure. + Return the id of the thread, uniquely identifying it among all threads. + Whether this thread is currently active, an active Thread cannot start work on a new method but can be joined with [method wait_to_finish]. + Joins the [Thread] and waits for it to finish. Returns what the method called returned. @@ -42610,14 +42638,14 @@ This method controls whether the position between two cached points is interpola - Inserts a Vector2 at the end. + Insert a [Vector2] at the end. - Sets 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. + 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. @@ -42626,14 +42654,14 @@ This method controls whether the position between two cached points is interpola - Changes the Vector2 at the given index. + Change the [Vector2] at the given index. - Returns the size of the array. + Return the size of the array. @@ -42642,7 +42670,7 @@ This method controls whether the position between two cached points is interpola - Constructs a new Vector2Array. Optionally, you can pass in an Array that will be converted. + Construct a new [Vector2Array]. Optionally, you can pass in an Array that will be converted. @@ -42869,14 +42897,14 @@ This method controls whether the position between two cached points is interpola - Inserts a Vector3 at the end. + Insert a Vector3 at the end. - Sets the size of the Vector3Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. + Set the size of the Vector3Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. @@ -42885,14 +42913,14 @@ This method controls whether the position between two cached points is interpola - Changes the Vector3 at the given index. + Change the [Vector3] at the given index. - Returns the size of the array. + Return the size of the array. @@ -42901,7 +42929,7 @@ This method controls whether the position between two cached points is interpola - Constructs a new Vector3Array. Optionally, you can pass in an Array that will be converted. + Construct a new Vector3Array. Optionally, you can pass in an Array that will be converted.