Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2025-01-11 13:21:10 +01:00
Code Issues Packages Projects Releases Wiki Activity

Ported: Remove Array link in description of PoolArrays - timothyqiu

Browse Source 
4fda4f31c2
This commit is contained in:
Relintai 2022-07-26 15:16:21 +02:00
parent fc041bf980
commit b4dcb3996b
7 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/classes/PoolByteArray.xml
View File

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PoolByteArray" version="3.5">
<brief_description>
A pooled [Array] of bytes.
A pooled Array of bytes.
</brief_description>
<description>
An [Array] specifically designed to hold bytes. Optimized for memory usage, does not fragment the memory.
An Array specifically designed to hold bytes. Optimized for memory usage, does not fragment the memory.
[b]Note:[/b] This type is passed by value and not by reference.
</description>
<tutorials>
@ -14,7 +14,7 @@
<return type="PoolByteArray" />
<argument index="0" name="from" type="Array" />
<description>
Constructs a new [PoolByteArray]. Optionally, you can pass in a generic [Array] that will be converted.
Constructs a new [PoolByteArray]. Optionally, you can pass in a generic Array that will be converted.
</description>
</method>
<method name="append">

6
doc/classes/PoolColorArray.xml
View File

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PoolColorArray" version="3.5">
<brief_description>
A pooled [Array] of [Color].
A pooled Array of [Color].
</brief_description>
<description>
An [Array] specifically designed to hold [Color]. Optimized for memory usage, does not fragment the memory.
An Array specifically designed to hold [Color]. Optimized for memory usage, does not fragment the memory.
[b]Note:[/b] This type is passed by value and not by reference.
</description>
<tutorials>
@ -14,7 +14,7 @@
<return type="PoolColorArray" />
<argument index="0" name="from" type="Array" />
<description>
Constructs a new [PoolColorArray]. Optionally, you can pass in a generic [Array] that will be converted.
Constructs a new [PoolColorArray]. Optionally, you can pass in a generic Array that will be converted.
</description>
</method>
<method name="append">

6
doc/classes/PoolIntArray.xml
View File

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PoolIntArray" version="3.5">
<brief_description>
A pooled [Array] of integers ([int]).
A pooled Array of integers ([int]).
</brief_description>
<description>
An [Array] specifically designed to hold integer values ([int]). Optimized for memory usage, does not fragment the memory.
An Array specifically designed to hold integer values ([int]). Optimized for memory usage, does not fragment the memory.
[b]Note:[/b] This type is passed by value and not by reference.
[b]Note:[/b] This type is limited to signed 32-bit integers, which means it can only take values in the interval [code][-2^31, 2^31 - 1][/code], i.e. [code][-2147483648, 2147483647][/code]. Exceeding those bounds will wrap around. In comparison, [int] uses signed 64-bit integers which can hold much larger values.
</description>
@ -15,7 +15,7 @@
<return type="PoolIntArray" />
<argument index="0" name="from" type="Array" />
<description>
Constructs a new [PoolIntArray]. Optionally, you can pass in a generic [Array] that will be converted.
Constructs a new [PoolIntArray]. Optionally, you can pass in a generic Array that will be converted.
</description>
</method>
<method name="append">

8
doc/classes/PoolRealArray.xml
View File

@ -1,12 +1,12 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PoolRealArray" version="3.5">
<brief_description>
A pooled [Array] of reals ([float]).
A pooled Array of reals ([float]).
</brief_description>
<description>
An [Array] specifically designed to hold floating-point values. Optimized for memory usage, does not fragment the memory.
An Array specifically designed to hold floating-point values. Optimized for memory usage, does not fragment the memory.
[b]Note:[/b] This type is passed by value and not by reference.
[b]Note:[/b] Unlike primitive [float]s which are 64-bit, numbers stored in [PoolRealArray] are 32-bit floats. This means values stored in [PoolRealArray] have lower precision compared to primitive [float]s. If you need to store 64-bit floats in an array, use a generic [Array] with [float] elements as these will still be 64-bit. However, using a generic [Array] to store [float]s will use roughly 6 times more memory compared to a [PoolRealArray].
[b]Note:[/b] Unlike primitive [float]s which are 64-bit, numbers stored in [PoolRealArray] are 32-bit floats. This means values stored in [PoolRealArray] have lower precision compared to primitive [float]s. If you need to store 64-bit floats in an array, use a generic Array with [float] elements as these will still be 64-bit. However, using a generic Array to store [float]s will use roughly 6 times more memory compared to a [PoolRealArray].
</description>
<tutorials>
</tutorials>
@ -15,7 +15,7 @@
<return type="PoolRealArray" />
<argument index="0" name="from" type="Array" />
<description>
Constructs a new [PoolRealArray]. Optionally, you can pass in a generic [Array] that will be converted.
Constructs a new [PoolRealArray]. Optionally, you can pass in a generic Array that will be converted.
</description>
</method>
<method name="append">

6
doc/classes/PoolStringArray.xml
View File

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PoolStringArray" version="3.5">
<brief_description>
A pooled [Array] of [String].
A pooled Array of [String].
</brief_description>
<description>
An [Array] specifically designed to hold [String]s. Optimized for memory usage, does not fragment the memory.
An Array specifically designed to hold [String]s. Optimized for memory usage, does not fragment the memory.
[b]Note:[/b] This type is passed by value and not by reference.
</description>
<tutorials>
@ -15,7 +15,7 @@
<return type="PoolStringArray" />
<argument index="0" name="from" type="Array" />
<description>
Constructs a new [PoolStringArray]. Optionally, you can pass in a generic [Array] that will be converted.
Constructs a new [PoolStringArray]. Optionally, you can pass in a generic Array that will be converted.
</description>
</method>
<method name="append">

6
doc/classes/PoolVector2Array.xml
View File

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PoolVector2Array" version="3.5">
<brief_description>
A pooled [Array] of [Vector2].
A pooled Array of [Vector2].
</brief_description>
<description>
An [Array] specifically designed to hold [Vector2]. Optimized for memory usage, does not fragment the memory.
An Array specifically designed to hold [Vector2]. Optimized for memory usage, does not fragment the memory.
[b]Note:[/b] This type is passed by value and not by reference.
</description>
<tutorials>
@ -15,7 +15,7 @@
<return type="PoolVector2Array" />
<argument index="0" name="from" type="Array" />
<description>
Constructs a new [PoolVector2Array]. Optionally, you can pass in a generic [Array] that will be converted.
Constructs a new [PoolVector2Array]. Optionally, you can pass in a generic Array that will be converted.
</description>
</method>
<method name="append">

6
doc/classes/PoolVector3Array.xml
View File

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PoolVector3Array" version="3.5">
<brief_description>
A pooled [Array] of [Vector3].
A pooled Array of [Vector3].
</brief_description>
<description>
An [Array] specifically designed to hold [Vector3]. Optimized for memory usage, does not fragment the memory.
An Array specifically designed to hold [Vector3]. Optimized for memory usage, does not fragment the memory.
[b]Note:[/b] This type is passed by value and not by reference.
</description>
<tutorials>
@ -14,7 +14,7 @@
<return type="PoolVector3Array" />
<argument index="0" name="from" type="Array" />
<description>
Constructs a new [PoolVector3Array]. Optionally, you can pass in a generic [Array] that will be converted.
Constructs a new [PoolVector3Array]. Optionally, you can pass in a generic Array that will be converted.
</description>
</method>
<method name="append">