ReactiveStateSchema

Inherits: Class

Methods

AddBooleanField

function ReactiveStateSchema:AddBooleanField(key, default)
  -> self

Defines a boolean field as part of the schema.

Parameters:

Name	Type	Description
key	string	The key of the new field
default	boolean	The default value of the field

Returns:

Type	Description
self

AddDeferredBooleanField

function ReactiveStateSchema:AddDeferredBooleanField(key)
  -> self

Defines a boolean field as part of the schema which can be nil (and is by default) but is defined with a non-nil assertion for the language server.

Parameters:

Name	Type	Description
key	string	The key of the new field

Returns:

Type	Description
self

AddDeferredClassField

function ReactiveStateSchema:AddDeferredClassField(key, class)
  -> self

Defines an optional class field as part of the schema which can be nil (and is by default) but is defined with a non-nil assertion for the language server.

Parameters:

Name	Type	Description
key	string	The key of the new field
class	T | T	The class or name of the class (subclasses are not permitted in the later case)

Returns:

Type	Description
self

AddDeferredEnumField

function ReactiveStateSchema:AddDeferredEnumField(key, enumType)
  -> self

Defines an enum field field as part of the schema which can be nil (and is by default) but is defined with a non-nil assertion for the language server.

Parameters:

Name	Type	Description
key	string	The key of the new field
enumType	EnumObject	The enum type

Returns:

Type	Description
self

AddDeferredNumberField

function ReactiveStateSchema:AddDeferredNumberField(key, validateFunc)
  -> self

Defines a number field as part of the schema which can be nil (and is by default) but is defined with a non-nil assertion for the language server.

Parameters:

Name	Type	Description
key	string	The key of the new field
validateFunc	fun(value: number): boolean	A function used to validate values

Returns:

Type	Description
self

AddDeferredStringField

function ReactiveStateSchema:AddDeferredStringField(key, validateFunc)
  -> self

Defines a string field as part of the schema which can be nil (and is by default) but is defined with a non-nil assertion for the language server.

Parameters:

Name	Type	Description
key	string	The key of the new field
validateFunc	fun(value: string): boolean	A function used to validate values

Returns:

Type	Description
self

AddDeferredTableField

function ReactiveStateSchema:AddDeferredTableField(key, validateFunc)
  -> self

Defines a table field as part of the schema which can be nil (and is by default) but is defined with a non-nil assertion for the language server.

Parameters:

Name	Type	Description
key	string	The key of the new field
validateFunc	fun(value: table): boolean	A function used to validate values

Returns:

Type	Description
self

AddEnumField

function ReactiveStateSchema:AddEnumField(key, enumType, default)
  -> self

Defines an enum field as part of the schema.

Parameters:

Name	Type	Description
key	string	The key of the new field
enumType	EnumObject	The enum type
default	EnumValue	The default value of the field

Returns:

Type	Description
self

AddNumberField

function ReactiveStateSchema:AddNumberField(key, default, validateFunc)
  -> self

Defines a number field as part of the schema.

Parameters:

Name	Type	Description
key	string	The key of the new field
default	number	The default value of the field
validateFunc	fun(value: number): boolean	A function used to validate values

Returns:

Type	Description
self

AddOptionalBooleanField

function ReactiveStateSchema:AddOptionalBooleanField(key)
  -> self

Defines a boolean field as part of the schema which can be nil (and is by default).

Parameters:

Name	Type	Description
key	string	The key of the new field

Returns:

Type	Description
self

AddOptionalClassField

function ReactiveStateSchema:AddOptionalClassField(key, class)
  -> self

Defines an optional class field as part of the schema which can be nil (and is by default).

Parameters:

Name	Type	Description
key	string	The key of the new field
class	T | T	The class or name of the class (subclasses are not permitted in the later case)

Returns:

Type	Description
self

AddOptionalEnumField

function ReactiveStateSchema:AddOptionalEnumField(key, enumType)
  -> self

Defines an enum field as part of the schema which can be nil (and is by default).

Parameters:

Name	Type	Description
key	string	The key of the new field
enumType	EnumObject	The enum type

Returns:

Type	Description
self

AddOptionalNumberField

function ReactiveStateSchema:AddOptionalNumberField(key, validateFunc)
  -> self

Defines a number field as part of the schema which can be nil (and is by default).

Parameters:

Name	Type	Description
key	string	The key of the new field
validateFunc	fun(value: number): boolean	A function used to validate values

Returns:

Type	Description
self

AddOptionalStringField

function ReactiveStateSchema:AddOptionalStringField(key, validateFunc)
  -> self

Defines a string field as part of the schema which can be nil (and is by default).

Parameters:

Name	Type	Description
key	string	The key of the new field
validateFunc	fun(value: string): boolean	A function used to validate values

Returns:

Type	Description
self

AddOptionalTableField

function ReactiveStateSchema:AddOptionalTableField(key, validateFunc)
  -> self

Defines a table field as part of the schema which can be nil (and is by default).

Parameters:

Name	Type	Description
key	string	The key of the new field
validateFunc	fun(value: table): boolean	A function used to validate values

Returns:

Type	Description
self

AddStringField

function ReactiveStateSchema:AddStringField(key, default, validateFunc)
  -> self

Defines a string field as part of the schema.

Parameters:

Name	Type	Description
key	string	The key of the new field
default	string	The default value of the field
validateFunc	fun(value: string): boolean	A function used to validate values

Returns:

Type	Description
self

Commit

function ReactiveStateSchema:Commit()
  -> self

Commits the schema and prevents further changes.

Returns:

Type	Description
self

CreateState

function ReactiveStateSchema:CreateState()

Creates a state object based on the schema.

Extend

function ReactiveStateSchema:Extend(name)
  -> self

Returns a new state schema which extends the existing one

Parameters:

Name	Type	Description
name	string	The name of the extended schema

Returns:

Type	Description
self

UpdateFieldDefault

function ReactiveStateSchema:UpdateFieldDefault(key, default)
  -> self

Updates the default value of an existing field.

Parameters:

Name	Type	Description
key	string	The key of the field
default	any	The default value of the field

Returns:

Type	Description
self

__tostring

function ReactiveStateSchema:__tostring()

Functions

Create

function ReactiveStateSchema.Create(name)
  -> ReactiveStateSchema

Creates a new state schema object.

Parameters:

Name	Type	Description
name	string	The name for debugging purposes

Returns:

Type	Description
ReactiveStateSchema