com.shakelang.shake.compiler.processor/com.shakelang.shake.processor.program.types/ShakeParameter

ShakeParameter

interface ShakeParameter : ShakeAssignable(source)

Represents a parameter in the Shake language. Parameters are used in functions or constructors and can be assigned values.

Since

0.1.0

Inheritors

CreationShakeParameter

Properties

actualType

abstract val actualType: ShakeType

The actual type of the assignable entity.

actualValue

abstract val actualValue: ShakeValue?

The actual value of the assignable entity.

name

abstract val name: String

The name of the parameter.

type

abstract override val type: ShakeType

The type of the parameter.

uniqueName

open val uniqueName: String

The unique name of the parameter, typically used internally. By default, it is prefixed with "param_" followed by the parameter's name.

Functions

additionAssignType

open fun additionAssignType(other: ShakeType, scope: ShakeScope): ShakeType?

Performs addition assignment on this entity's type.

assignType

open fun assignType(other: ShakeType, scope: ShakeScope): ShakeType?

Assigns a type to this entity.

decrementAfterType

open fun decrementAfterType(scope: ShakeScope): ShakeType?

Handles the type after decrement operation.

decrementBeforeType

open fun decrementBeforeType(scope: ShakeScope): ShakeType?

Handles the type before decrement operation.

divisionAssignType

open fun divisionAssignType(other: ShakeType, scope: ShakeScope): ShakeType?

Performs division assignment on this entity's type.

incrementAfterType

open fun incrementAfterType(scope: ShakeScope): ShakeType?

Handles the type after increment operation.

incrementBeforeType

open fun incrementBeforeType(scope: ShakeScope): ShakeType?

Handles the type before increment operation.

modulusAssignType

open fun modulusAssignType(other: ShakeType, scope: ShakeScope): ShakeType?

Performs modulus assignment on this entity's type.

multiplicationAssignType

open fun multiplicationAssignType(other: ShakeType, scope: ShakeScope): ShakeType?

Performs multiplication assignment on this entity's type.

powerAssignType

open fun powerAssignType(other: ShakeType, scope: ShakeScope): ShakeType?

Performs power assignment on this entity's type.

subtractionAssignType

open fun subtractionAssignType(other: ShakeType, scope: ShakeScope): ShakeType?

Performs subtraction assignment on this entity's type.

toJson

open fun toJson(): Map<String, Any?>

Converts the parameter to a JSON representation. Useful for serialization or debugging purposes.