Class PoolStringArray

PoolStringArray metatype, wrapper for godot_pool_string_array

Methods

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

Static Functions

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

Metamethods

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

Class PoolStringArray.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 postringer.

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

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

Parameters:

  • ...

See also:

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

Returns:

    bool
PoolStringArray:extend (iterable)
Append all strings of iterable at the end of Array.

Parameters:

  • iterable Any object iterable by ipairs, including Lua tables, Arrays and Pool*Arrays.
PoolStringArray:get (index)
Get the string 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:

    String

See also:

PoolStringArray:has (Value)
Returns true if the array contains the given value.

Parameters:

  • Value , stringified with GD.str

Returns:

    bool
PoolStringArray: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 New value, stringified with GD.str
PoolStringArray:invert ()
Reverses the order of the elements in the array.
PoolStringArray:join ([delimiter=""])
Returns a String with each element of the array joined with the given delimiter.

Parameters:

  • delimiter (default "")

Returns:

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

Parameters:

  • ... Values to be appended, each stringified with GD.str
PoolStringArray:read ()
Returns the Read access for the array.

Returns:

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

Parameters:

  • index int
PoolStringArray: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
PoolStringArray:safe_get (index)
Get the string 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:

    String

Or

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

See also:

PoolStringArray:safe_set (index, value)
Set a new string 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 New value, stringified with GD.str

Raises:

If index < 0

See also:

PoolStringArray:set (index, value)
Set a new string 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 New value, stringified with GD.str

See also:

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

Returns:

    int
PoolStringArray:sort ()
Sorts the elements of the array in ascending order.
PoolStringArray: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(...)
PoolStringArray:from (iterable)
Create a new array with the elements from iterable.

Parameters:

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

Returns:

    PoolStringArray

See also:

Usage:

    local array = PoolStringArray.from(some_table_or_other_iterable)

Metamethods

PoolStringArray:__concat (a, b)
Concatenates values.

Parameters:

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

Returns:

    String
PoolStringArray:__eq (a, b)
Equality operation

Parameters:

Returns:

    bool
PoolStringArray:__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:

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

Returns:

  1. function
  2. PoolStringArray self
  3. int 0

Usage:

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

Returns:

    int

See also:

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

Parameters:

Returns:

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

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

Returns:

  1. function
  2. PoolStringArray self
  3. int 0

See also:

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

Returns:

    string

Class PoolStringArray.Read

PoolStringArray.Read access metatype, wrapper for godot_pool_string_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 PoolStringArray, so this method should be called manually when access is no longer needed.
Read:ptr ()
Get Read access postringer.

Returns:

    const String *

Class PoolStringArray.Write

PoolStringArray.Write access metatype, wrapper for godot_pool_string_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 PoolStringArray, so this method should be called manually when access is no longer needed.
Write:ptr ()
Get Write access pointer.

Returns:

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