Class PoolRealArray

PoolRealArray metatype, wrapper for godot_pool_real_array

Methods

PoolRealArray:append (...) Alias for push_back.
PoolRealArray:empty () Returns true if the array is empty.
PoolRealArray:extend (iterable) Append all numbers of iterable at the end of Array.
PoolRealArray:get (index) Get the number at index.
PoolRealArray:get_buffer () Returns array's buffer as a PoolByteArray.
PoolRealArray:has (value) Returns true if the array contains the given value.
PoolRealArray:insert (index, value) Inserts a new element at a given position in the array.
PoolRealArray:invert () Reverses the order of the elements in the array.
PoolRealArray:join ([delimiter=""]) Returns a String with each element of the array joined with the given delimiter.
PoolRealArray:push_back (...) Append elements at the end of the array.
PoolRealArray:read () Returns the Read access for the array.
PoolRealArray:remove (index) Removes an element from the array by index.
PoolRealArray:resize (size) Sets the size of the array.
PoolRealArray:safe_get (index) Get the number at index.
PoolRealArray:safe_set (index, value) Set a new number for index.
PoolRealArray:set (index, value) Set a new number for index.
PoolRealArray:size () Returns the size of the array.
PoolRealArray:sort () Sorts the elements of the array in ascending order.
PoolRealArray:write () Returns the Write access for the array.

Static Functions

PoolRealArray:from (iterable) Create a new array with the elements from iterable.

Metamethods

PoolRealArray:__concat (a, b) Concatenates values.
PoolRealArray:__eq (a, b) Equality operation
PoolRealArray:__index (index) Returns method named index or the result of safe_get(index - 1).
PoolRealArray:__ipairs () Returns an iterator for array's elements, called by the idiom ipairs(array).
PoolRealArray:__len () Alias for size.
PoolRealArray:__new (...) PoolRealArray constructor, called by the idiom PoolRealArray(...).
PoolRealArray:__newindex (index, value) Alias for safe_set(index - 1, value).
PoolRealArray:__pairs () Alias for __ipairs, called by the idiom pairs(array).
PoolRealArray:__tostring () Returns a Lua string representation of this array.

Class PoolRealArray.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 porealer.

Class PoolRealArray.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

PoolRealArray:append (...)
Alias for push_back.

Parameters:

  • ...

See also:

PoolRealArray:empty ()
Returns true if the array is empty.

Returns:

    bool
PoolRealArray:extend (iterable)
Append all numbers of iterable at the end of Array.

Parameters:

  • iterable Any object iterable by ipairs, including Lua tables, Arrays and Pool*Arrays.
PoolRealArray:get (index)
Get the number at index. Unlike Lua tables, indices start at 0 instead of 1. For 1-based indexing, use the idiom array[index] instead.

If index is invalid (index < 0 or index >= size()), the application will crash. For a safe version that returns nil if index is invalid, use safe_get or the idiom array[index] instead.

Parameters:

  • index int

Returns:

    number

See also:

PoolRealArray:get_buffer ()
Returns array's buffer as a PoolByteArray.

Returns:

    PoolByteArray
PoolRealArray:has (value)
Returns true if the array contains the given value.

Parameters:

  • value real

Returns:

    bool
PoolRealArray: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 number
PoolRealArray:invert ()
Reverses the order of the elements in the array.
PoolRealArray:join ([delimiter=""])
Returns a String with each element of the array joined with the given delimiter.

Parameters:

  • delimiter (default "")

Returns:

    String
PoolRealArray:push_back (...)
Append elements at the end of the array.

Parameters:

  • ... Numbers to be appended
PoolRealArray:read ()
Returns the Read access for the array.

Returns:

    Read
PoolRealArray:remove (index)
Removes an element from the array by index.

Parameters:

  • index int
PoolRealArray: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
PoolRealArray:safe_get (index)
Get the number at index. Unlike Lua tables, indices start at 0 instead of 1. For 1-based indexing, use the idiom array[index] instead.

The idiom array[index] also calls this method.

Parameters:

  • index int

Returns:

    number

Or

    nil If index is invalid (index < 0 or index >= size())

See also:

PoolRealArray:safe_set (index, value)
Set a new number for index. Unlike Lua tables, indices start at 0 instead of 1. For 1-based indexing, use the idiom array[index] = value instead.

If index >= size(), the array is resized first. The idiom array[index] = value also calls this method.

Parameters:

  • index int
  • value number

Raises:

If index < 0

See also:

PoolRealArray:set (index, value)
Set a new number for index. Unlike Lua tables, indices start at 0 instead of 1. For 1-based indexing, use the idiom array[index] = value instead.

If index is invalid (index < 0 or index >= size()), the application will crash. For a safe approach that resizes if index >= size(), use safe_set or the idiom array[index] = value instead.

Parameters:

  • index int
  • value number

See also:

PoolRealArray:size ()
Returns the size of the array.

Returns:

    int
PoolRealArray:sort ()
Sorts the elements of the array in ascending order.
PoolRealArray:write ()
Returns the Write access for the array.

Returns:

    Write

Static Functions

These don't receive self and should be called directly as Array.static_function(...)
PoolRealArray:from (iterable)
Create a new array with the elements from iterable.

Parameters:

  • iterable If another PoolRealArray is passed, return a copy of it. Otherwise, the new array is extended with iterable.

Returns:

    PoolRealArray

See also:

Usage:

    local array = PoolRealArray.from(some_table_or_other_iterable)

Metamethods

PoolRealArray:__concat (a, b)
Concatenates values.

Parameters:

  • a First value, stringified with GD.str
  • b First value, stringified with GD.str

Returns:

    String
PoolRealArray:__eq (a, b)
Equality operation

Parameters:

Returns:

    bool
PoolRealArray:__index (index)
Returns method named index or the result of safe_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 nil

See also:

PoolRealArray:__ipairs ()
Returns an iterator for array's elements, called by the idiom ipairs(array).

Returns:

  1. function
  2. PoolRealArray self
  3. int 0

Usage:

    for i, number in ipairs(array) do
    -- do something
end
PoolRealArray:__len ()
Alias for size.

Returns:

    int

See also:

PoolRealArray:__new (...)
PoolRealArray constructor, called by the idiom PoolRealArray(...).

Parameters:

Returns:

    PoolRealArray
PoolRealArray:__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:

PoolRealArray:__pairs ()
Alias for __ipairs, called by the idiom pairs(array).

Returns:

  1. function
  2. PoolRealArray self
  3. int 0

See also:

PoolRealArray:__tostring ()
Returns a Lua string representation of this array.

Returns:

    string

Class PoolRealArray.Read

PoolRealArray.Read access metatype, wrapper for godot_pool_real_array_read_access.
Read:assign (other)
Assign a new Read access.

Parameters:

Read:copy ()
Create a copy of Read access.

Returns:

    Read
Read:destroy ()
Destroy a Read access. Holding a valid access object may lock a PoolRealArray, so this method should be called manually when access is no longer needed.
Read:ptr ()
Get Read access porealer.

Returns:

    const godot_real *

Class PoolRealArray.Write

PoolRealArray.Write access metatype, wrapper for godot_pool_real_array_write_access.
Write:assign (other)
Assign a new Write access.

Parameters:

Write:copy ()
Create a copy of Write access.

Returns:

    Write
Write:destroy ()
Destroy a Write access. Holding a valid access object may lock a PoolRealArray, so this method should be called manually when access is no longer needed.
Write:ptr ()
Get Write access pointer.

Returns:

    godot_real *
generated by LDoc 1.4.6 Last updated 2023-01-04 08:52:34