Class VariablesContainer

constructor

• new VariablesContainer(initialVariablesData?): VariablesContainer

• Parameters

  • Optional initialVariablesData: Readonly<{
        children?: Readonly<{ name?: string | undefined; value?: string | number | boolean | undefined; children?: Readonly<...>[] | undefined; type?: VariableType | undefined; }>[] | undefined;
        name?: string;
        type?: VariableType;
        value?: string | number | boolean;
    }>[]

    Optional array containing representations of the base variables.

  Returns VariablesContainer

Static badVariable

Static badVariablesContainer

add

• add(name, newVariable): void

• Add a new variable. This can be costly, don't use in performance sensitive paths.

  Parameters

  • name: string

    Variable name
  • newVariable: Variable

    The variable to be added

  Returns void

get

• get(name): Variable

• Get a variable.

  Parameters

  • name: string

    The variable's name

  Returns Variable

  The specified variable. If not found, an empty variable is added to the container.

getFromIndex

• getFromIndex(id): Variable

• Get a variable using its index. If you're unsure about how to use this method, prefer to use get. The index of a variable is its index in the data passed to initFrom.

  This method is generally used by events generated code to increase lookup speed for variables.

  Parameters

  • id: number

    The variable index

  Returns Variable

  The specified variable. If not found, an empty variable is added to the container, but it should not happen.

getNetworkSyncData

• getNetworkSyncData(syncOptions): VariableNetworkSyncData[]

• Parameters

  • syncOptions: GetNetworkSyncDataOptions

  Returns VariableNetworkSyncData[]

getStructureNetworkSyncData

• getStructureNetworkSyncData(variable): undefined | VariableNetworkSyncData[]

• Parameters

  • variable: Variable

  Returns undefined | VariableNetworkSyncData[]

getVariableNameInContainerByLoopingThroughAllVariables

• getVariableNameInContainerByLoopingThroughAllVariables(variable): null | string

• Parameters

  • variable: Variable

  Returns null | string

has

• has(name): boolean

• Check if a variable exists in the container.

  Parameters

  • name: string

    The variable's name

  Returns boolean

  true if the variable exists.

hasVariable

• hasVariable(variable): boolean

• Check if a variable exists in the container.

  Parameters

  • variable: Variable

    The variable

  Returns boolean

  true if the variable exists.

initFrom

• initFrom(data, keepOldVariables?): void

• Initialize variables from a container data.
  If keepOldVariables is set to false (by default), all already existing variables will be erased, but the new variables will be accessible thanks to getFromIndex.
  if keepOldVariables is set to true, already existing variables won't be erased and will be still accessible thanks to getFromIndex.

  Parameters

  • data: Readonly<{
        children?: Readonly<({ name?: string | undefined; value?: string | number | boolean | undefined; children?: Readonly<...>[] | undefined; type?: VariableType | undefined; })>[];
        name?: string;
        type?: VariableType;
        value?: string | number | boolean;
    }>[]

    The array containing data used to initialize variables.
  • Optional keepOldVariables: Boolean

    If set to true, already existing variables won't be erased.

  Returns void

rebuildIndexFrom

• rebuildIndexFrom(data): void

• Parameters

  • data: Readonly<{
        children?: Readonly<({ name?: string | undefined; value?: string | number | boolean | undefined; children?: Readonly<...>[] | undefined; type?: VariableType | undefined; })>[];
        name?: string;
        type?: VariableType;
        value?: string | number | boolean;
    }>[]

  Returns void

remove

• remove(name): void

• Remove a variable. (the variable is not really removed from the container to avoid creating garbage, but marked as undefined)

  Parameters

  • name: string

    Variable to be removed

  Returns void

updateFromNetworkSyncData

• updateFromNetworkSyncData(networkSyncData): void

• Parameters

  • networkSyncData: VariableNetworkSyncData[]

  Returns void