Verse API reference page for the (Input:[]t).RemoveFirstElement extension
Makes an array by removing the element at the lowest index that equals ElementToRemove from Input.
Fails if Input did not contain any instances of ElementToRemove.
Verse using statement |
using { /Verse.org/Verse } |
(Input:[]t).RemoveFirstElement<public>(ElementToRemove:t where t:comparable)<computes><decides>:[]t
Parameters
RemoveFirstElement takes the following parameters:
| Name | Type | Description |
|---|---|---|
Input |
[]t |
|
ElementToRemove |
t |
|
t |
comparable |
Attributes, Specifiers, and Effects
The following attributes, specifiers, and effects determine how you can interact with RemoveFirstElement in your programs, as well as how it behaves in your programs and UEFN. For the complete list of attributes, specifiers, and effects; see the Specifiers Page.
Specifiers
| Specifier | Meaning |
|---|---|
public |
The identifier is universally accessible. You can use this on modules, classes, interfaces, structs, enums, methods, and data. |
Effects
| Effect | Meaning |
|---|---|
computes |
This effect requires that the function has no side effects, and is not guaranteed to complete. There's an unchecked requirement that the function, when provided with the same arguments, produces the same result. Any function that doesn't have the native specifier that would otherwise have the converges effect is a good example of using the computes effect. |
decides |
Indicates that the function can fail, and that calling this function is a failable expression. Function definitions with the decides effect must also have the transacts effect, which means the actions performed by this function can be rolled back (as if the actions were never performed), if there's a failure anywhere in the function. |