Class: VarBase

Defined in: packages/blockly/core/events/events_var_base.ts:25

Abstract class for a variable event.

Extends

• Abstract

Extended by

• VarCreate
• VarDelete
• VarRename
• VarTypeChange

Properties index

Property	Description
workspaceId	The workspace identifier for this event.
group	An ID for the group of events this block is associated with.
recordUndo	Whether this event is undoable or not.
isUiEvent	Whether or not the event is a UI event.
type	Type of this event.
isBlank	Whether or not the event was constructed without necessary parameters (to be populated by fromJson).
varId	The ID of the variable this event references.

Methods index

Method	Description
isNull	Does this event record any change of state?
run	Run an event.
getEventWorkspace_	Get workspace the event belongs to.
toJson	Encode the event as JSON.

Constructors

Constructor

new VarBase(opt_variable?): VarBase;

Defined in: packages/blockly/core/events/events_var_base.ts:34

Parameters

Parameter	Type	Description
opt_variable?	IVariableModel<IVariableState>	The variable this event corresponds to. Undefined for a blank event.

Returns

VarBase

Overrides

Abstract.constructor

Properties

workspaceId?

optional workspaceId?: string = undefined;

Defined in: packages/blockly/core/events/events_abstract.ts:30

The workspace identifier for this event.

Inherited from

Abstract.workspaceId

---

group

group: string;

Defined in: packages/blockly/core/events/events_abstract.ts:38

An ID for the group of events this block is associated with.

Groups define events that should be treated as an single action from the user's perspective, and should be undone together.

Inherited from

Abstract.group

---

recordUndo

recordUndo: boolean;

Defined in: packages/blockly/core/events/events_abstract.ts:41

Whether this event is undoable or not.

Inherited from

Abstract.recordUndo

---

isUiEvent

isUiEvent: boolean = false;

Defined in: packages/blockly/core/events/events_abstract.ts:44

Whether or not the event is a UI event.

Inherited from

Abstract.isUiEvent

---

type

type: string = '';

Defined in: packages/blockly/core/events/events_abstract.ts:47

Type of this event.

Inherited from

Abstract.type

---

isBlank

isBlank: boolean = true;

Defined in: packages/blockly/core/events/events_var_base.ts:26

Whether or not the event was constructed without necessary parameters (to be populated by fromJson).

Overrides

Abstract.isBlank

---

varId?

optional varId?: string;

Defined in: packages/blockly/core/events/events_var_base.ts:28

The ID of the variable this event references.

Methods

isNull()

isNull(): boolean;

Defined in: packages/blockly/core/events/events_abstract.ts:91

Does this event record any change of state?

Returns

boolean

True if null, false if something changed.

Inherited from

Abstract.isNull

---

run()

run(_forward): void;

Defined in: packages/blockly/core/events/events_abstract.ts:100

Run an event.

Parameters

Parameter	Type	Description
_forward	boolean	True if run forward, false if run backward (undo).

Returns

void

Inherited from

Abstract.run

---

getEventWorkspace_()

getEventWorkspace_(): Workspace;

Defined in: packages/blockly/core/events/events_abstract.ts:111

Get workspace the event belongs to.

Returns

Workspace

The workspace the event belongs to.

Throws

if workspace is null.

Inherited from

Abstract.getEventWorkspace_

---

toJson()

toJson(): VarBaseJson;

Defined in: packages/blockly/core/events/events_var_base.ts:48

Encode the event as JSON.

Returns

VarBaseJson

JSON representation.

Overrides

Abstract.toJson