Class VariableMap

Index

Constructors

Properties

variableMap_ workspace

Methods

clear createVariable deleteVariable deleteVariableById deleteVariableInternal_ getAllVariables getVariable getVariableById getVariablesOfType getVariableTypes getVariableUsesById renameVariable renameVariableAndUses_ renameVariableById renameVariableWithConflict_

Constructors

constructor

new VariableMap(): VariableMap
Returns VariableMap

Properties

variableMap_

variableMap_: Record<string, VariableModel>

workspace

workspace: Workspace

Methods

clear

clear(): void
Returns void
- Defined in types/scratch-blocks.d.ts:45

createVariable

createVariable(
    name: string,
    type?: ScratchBlocks.VariableType,
    id?: string,
    isLocal?: boolean,
    isCloud?: boolean,
): VariableModel
Parameters
- name: string
- Optionaltype: ScratchBlocks.VariableType
- Optionalid: string
- OptionalisLocal: boolean
- OptionalisCloud: boolean
Returns VariableModel
- Defined in types/scratch-blocks.d.ts:50

deleteVariable

deleteVariable(variable: VariableModel): void
Parameters
- variable: VariableModel
Returns void
- Defined in types/scratch-blocks.d.ts:51

deleteVariableById

deleteVariableById(id: string): void
Parameters
- id: string
Returns void
- Defined in types/scratch-blocks.d.ts:52

deleteVariableInternal_

deleteVariableInternal_(
variable: VariableModel,
uses: ScratchBlocks.Block[],
): void
Parameters
- variable: VariableModel
- uses: ScratchBlocks.Block[]
Returns void
- Defined in types/scratch-blocks.d.ts:53

getAllVariables

getAllVariables(): VariableModel[]
Returns VariableModel[]
- Defined in types/scratch-blocks.d.ts:58

getVariable

getVariable(
name: string,
type?: ScratchBlocks.VariableType,
): VariableModel | null
Parameters
- name: string
- Optionaltype: ScratchBlocks.VariableType
Returns VariableModel | null
- Defined in types/scratch-blocks.d.ts:54

getVariableById

getVariableById(id: string): VariableModel | null
Parameters
- id: string
Returns VariableModel | null
- Defined in types/scratch-blocks.d.ts:55

getVariablesOfType

getVariablesOfType(type: ScratchBlocks.VariableType): VariableModel[]
Parameters
- type: ScratchBlocks.VariableType
Returns VariableModel[]
- Defined in types/scratch-blocks.d.ts:56

getVariableTypes

getVariableTypes(): ScratchBlocks.VariableType[]
Returns ScratchBlocks.VariableType[]
- Defined in types/scratch-blocks.d.ts:57

getVariableUsesById

getVariableUsesById(id: string): ScratchBlocks.Block[]
Parameters
- id: string
Returns ScratchBlocks.Block[]
- Defined in types/scratch-blocks.d.ts:59

renameVariable

renameVariable(variable: VariableModel, newName: string): void
Parameters
- variable: VariableModel
- newName: string
Returns void
- Defined in types/scratch-blocks.d.ts:46

renameVariableAndUses_

renameVariableAndUses_(
    variable: VariableModel,
    newName: string,
    uses: ScratchBlocks.Block[],
): void
Parameters
- variable: VariableModel
- newName: string
- uses: ScratchBlocks.Block[]
Returns void
- Defined in types/scratch-blocks.d.ts:48

renameVariableById

renameVariableById(id: string, newName: string): void
Parameters
- id: string
- newName: string
Returns void
- Defined in types/scratch-blocks.d.ts:47

renameVariableWithConflict_

renameVariableWithConflict_(
    variable: VariableModel,
    newName: string,
    conflictingVariable: VariableModel,
    uses: ScratchBlocks.Block[],
): void
Parameters
- variable: VariableModel
- newName: string
- conflictingVariable: VariableModel
- uses: ScratchBlocks.Block[]
Returns void
- Defined in types/scratch-blocks.d.ts:49