Class PoolColorArray
PoolColorArray metatype, wrapper for godot_pool_color_array
Methods
| PoolColorArray:append (...) | Alias for push_back. |
| PoolColorArray:empty () | Returns true if the array is empty. |
| PoolColorArray:extend (iterable) | Append all colors of iterable at the end of Array. |
| PoolColorArray:get (index) | Get the color at index. |
| PoolColorArray:get_buffer () | Returns array's buffer as a PoolByteArray. |
| PoolColorArray:has (value) | Returns true if the array contains the given value. |
| PoolColorArray:insert (index, value) | Inserts a new element at a given position in the array. |
| PoolColorArray:invert () | Reverses the order of the elements in the array. |
| PoolColorArray:join ([delimiter=""]) | Returns a String with each element of the array joined with the given delimiter. |
| PoolColorArray:push_back (...) | Append elements at the end of the array. |
| PoolColorArray:read () | Returns the Read access for the array. |
| PoolColorArray:remove (index) | Removes an element from the array by index. |
| PoolColorArray:resize (size) | Sets the size of the array. |
| PoolColorArray:safe_get (index) | Get the color at index. |
| PoolColorArray:safe_set (index, value) | Set a new color for index. |
| PoolColorArray:set (index, value) | Set a new color for index. |
| PoolColorArray:size () | Returns the size of the array. |
| PoolColorArray:sort () | Sorts the elements of the array in ascending order. |
| PoolColorArray:write () | Returns the Write access for the array. |
Static Functions
| PoolColorArray:from (iterable) | Create a new array with the elements from iterable. |
Metamethods
| PoolColorArray:__concat (a, b) | Concatenates values. |
| PoolColorArray:__eq (a, b) | Equality operation |
| PoolColorArray:__index (index) | Returns method named index or the result of safe_get(index - 1). |
| PoolColorArray:__ipairs () | Returns an iterator for array's elements, called by the idiom ipairs(array). |
| PoolColorArray:__len () | Alias for size. |
| PoolColorArray:__new (...) | PoolColorArray constructor, called by the idiom PoolColorArray(...). |
| PoolColorArray:__newindex (index, value) | Alias for safe_set(index - 1, value). |
| PoolColorArray:__pairs () | Alias for __ipairs, called by the idiom pairs(array). |
| PoolColorArray:__tostring () | Returns a Lua string representation of this array. |
Class PoolColorArray.Read
| Read:assign (other) | Assign a new Read access. |
| Read:copy () | Create a copy of Read access. |
| Read:destroy () | Destroy a Read access. |
| Read:ptr () | Get Read access pocolorer. |
Class PoolColorArray.Write
| Write:assign (other) | Assign a new Write access. |
| Write:copy () | Create a copy of Write access. |
| Write:destroy () | Destroy a Write access. |
| Write:ptr () | Get Write access pointer. |
Methods
- PoolColorArray:append (...)
-
Alias for push_back.
Parameters:
- ...
See also:
- PoolColorArray:empty ()
-
Returns
trueif the array is empty.Returns:
-
bool
- PoolColorArray:extend (iterable)
-
Append all colors of
iterableat the end of Array.Parameters:
- PoolColorArray:get (index)
-
Get the color at
index. Unlike Lua tables, indices start at 0 instead of 1. For 1-based indexing, use the idiomarray[index]instead.If
indexis invalid (index < 0orindex >= size()), the application will crash. For a safe version that returnsnilifindexis invalid, use safe_get or the idiomarray[index]instead.Parameters:
- index int
Returns:
See also:
- PoolColorArray:get_buffer ()
-
Returns array's buffer as a PoolByteArray.
Returns:
- PoolColorArray:has (value)
-
Returns true if the array contains the given
value.Parameters:
- value Color
Returns:
-
bool
- PoolColorArray:insert (index, value)
-
Inserts a new element at a given position in the array.
The position must be valid, or at the end of the array (
index == size()).Parameters:
- index int
- value Color
- PoolColorArray:invert ()
- Reverses the order of the elements in the array.
- PoolColorArray:join ([delimiter=""])
-
Returns a String with each element of the array joined with the given
delimiter.Parameters:
- delimiter (default "")
Returns:
- PoolColorArray:push_back (...)
-
Append elements at the end of the array.
Parameters:
- ... colors to be appended
- PoolColorArray:read ()
-
Returns the Read access for the array.
Returns:
- PoolColorArray:remove (index)
-
Removes an element from the array by index.
Parameters:
- index int
- PoolColorArray:resize (size)
-
Sets the size of the array.
If the array is grown, reserves elements at the end of the array.
If the array is shrunk, truncates the array to the new size.
Parameters:
- size int
- PoolColorArray:safe_get (index)
-
Get the color at
index. Unlike Lua tables, indices start at 0 instead of 1. For 1-based indexing, use the idiomarray[index]instead.The idiom
array[index]also calls this method.Parameters:
- index int
Returns:
Or
-
nil
If index is invalid (
index < 0orindex >= size())See also:
- PoolColorArray:safe_set (index, value)
-
Set a new color for
index. Unlike Lua tables, indices start at 0 instead of 1. For 1-based indexing, use the idiomarray[index] = valueinstead.If
index >= size(), the array is resized first. The idiomarray[index] = valuealso calls this method.Parameters:
- index int
- value Color
Raises:
Ifindex < 0See also:
- PoolColorArray:set (index, value)
-
Set a new color for
index. Unlike Lua tables, indices start at 0 instead of 1. For 1-based indexing, use the idiomarray[index] = valueinstead.If
indexis invalid (index < 0orindex >= size()), the application will crash. For a safe approach that resizes ifindex >= size(), use safe_set or the idiomarray[index] = valueinstead.Parameters:
- index int
- value Color
See also:
- PoolColorArray:size ()
-
Returns the size of the array.
Returns:
-
int
- PoolColorArray:sort ()
- Sorts the elements of the array in ascending order.
- PoolColorArray:write ()
-
Returns the Write access for the array.
Returns:
Static Functions
These don't receive
self and should be called directly as Array.static_function(...)
- PoolColorArray:from (iterable)
-
Create a new array with the elements from
iterable.Parameters:
- iterable
If another PoolColorArray is passed, return a copy of it.
Otherwise, the new array is extended with
iterable.
Returns:
See also:
Usage:
local array = PoolColorArray.from(some_table_or_other_iterable) - iterable
If another PoolColorArray is passed, return a copy of it.
Otherwise, the new array is extended with
Metamethods
- PoolColorArray:__concat (a, b)
-
Concatenates values.
Parameters:
Returns:
- PoolColorArray:__eq (a, b)
-
Equality operation
Parameters:
- a Array, PoolByteArray, PoolIntArray, PoolRealArray, PoolStringArray, PoolVector2Array, PoolVector3Array, PoolColorArray or table
- b Array, PoolByteArray, PoolIntArray, PoolRealArray, PoolStringArray, PoolVector2Array, PoolVector3Array, PoolColorArray or table
Returns:
-
bool
- PoolColorArray:__index (index)
-
Returns method named
indexor the result ofsafe_get(index - 1).Like Lua tables, indices start at 1. For 0-based indexing, call get or safe_get directly.
Parameters:
- index
Returns:
-
Method or element or
nilSee also:
- PoolColorArray:__ipairs ()
-
Returns an iterator for array's elements, called by the idiom
ipairs(array).Returns:
- function
- PoolColorArray self
- int 0
Usage:
for i, color in ipairs(array) do -- do something end
- PoolColorArray:__len ()
-
Alias for size.
Returns:
-
int
See also:
- PoolColorArray:__new (...)
-
PoolColorArray constructor, called by the idiom
PoolColorArray(...).Parameters:
- ... Initial elements, added with push_back
Returns:
- PoolColorArray:__newindex (index, value)
-
Alias for
safe_set(index - 1, value).Like Lua tables, indices start at 1. For 0-based indexing, call set or safe_set directly.
Parameters:
- index int
- value
See also:
- PoolColorArray:__pairs ()
-
Alias for __ipairs, called by the idiom
pairs(array).Returns:
- function
- PoolColorArray self
- int 0
See also:
- PoolColorArray:__tostring ()
-
Returns a Lua string representation of this array.
Returns:
Class PoolColorArray.Read
PoolColorArray.Read access metatype, wrapper for
godot_pool_color_array_read_access.
- Read:assign (other)
-
Assign a new Read access.
Parameters:
- other Read
- Read:copy ()
-
Create a copy of Read access.
Returns:
- Read:destroy ()
- Destroy a Read access. Holding a valid access object may lock a PoolColorArray, so this method should be called manually when access is no longer needed.
- Read:ptr ()
-
Get Read access pocolorer.
Returns:
-
const Color *
Class PoolColorArray.Write
PoolColorArray.Write access metatype, wrapper for
godot_pool_color_array_write_access.
- Write:assign (other)
-
Assign a new Write access.
Parameters:
- other Write
- Write:copy ()
-
Create a copy of Write access.
Returns:
- Write:destroy ()
- Destroy a Write access. Holding a valid access object may lock a PoolColorArray, so this method should be called manually when access is no longer needed.
- Write:ptr ()
-
Get Write access pointer.
Returns: