1.21.9/llc.redstone.systemsapi.api/Function

Function

Represents a function within Housing.

Provides accessors and mutators for all function settings, and its associated action container.

Implementations perform sequential behavior and therefore expose suspend functions for better interaction with Housing.

Properties

abstract var name: String

The name of this function. This technically does not need to be unique but having multiple functions with the same name will mess with the API's ability to act on a specific function, as the name is our only identifier.

Functions

delete

abstract suspend fun delete()

Deletes this function.

getActionContainer

abstract suspend fun getActionContainer(): ActionContainer

Returns the action container associated with this function.

getAutomaticExecution

abstract suspend fun getAutomaticExecution(): Int

Returns the automatic execution setting, in ticks.

getDescription

abstract suspend fun getDescription(): String

Returns the current description of the function.

getIcon

abstract suspend fun getIcon(): Item

Returns the icon item representing this function.

getName

open suspend fun getName(): String

Returns the current name of the function.

setAutomaticExecution

abstract suspend fun setAutomaticExecution(newAutomaticExecution: Int): Function

Sets the automatic execution frequency, or disables it with 0.

setDescription

abstract suspend fun setDescription(newDescription: String): Function

Sets the description for the function.

setIcon

abstract suspend fun setIcon(newIcon: Item): Function

Sets the icon item for this function.

setName

abstract suspend fun setName(newName: String): Function

Updates the function name.