Returns the current state of this switch: true (on) or false (off). Use this overload of GetCurrentState when this device has Store State Per Player set to Yes.
Verse using statement |
using { /Fortnite.com/Devices } |
GetCurrentState<public>(Agent:agent)<decides><diverges><reads><writes><allocates><dictates>:void
Parameters
GetCurrentState takes the following parameters:
| Name | Type | Description |
|---|---|---|
Agent |
agent |
Attributes and Effects
The following attributes and effects determine how GetCurrentState behaves and how you can use it in your programs. For the complete list of attribute and effect specifiers, see the Specifiers Page.
| Attribute | Meaning |
|---|---|
public |
The identifier is universally accessible. You can use this on modules, classes, interfaces, structs, enums, methods, and data. |
| Effect | Meaning |
|---|---|
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. |
diverges |
Indicates that calls to the function may not complete. |
reads |
This effect indicates that the same inputs to the function may not always produce the same output. The behavior depends on factors external to the specified inputs, such as memory or the containing package version. |
writes |
This effect indicates that the function may change values in memory. |
allocates |
This effect indicates that the function may instantiate an object in memory. Allocating <unique> classes requires the <allocates> specifier. |
dictates |