mirror of
https://github.com/google/blockly.git
synced 2026-01-08 01:20:12 +01:00
88ff901a72
* chore: add and configure prettier * chore: remove clang-format * chore: remove clang-format config * chore: lint additional ts files * chore: fix lint errors in blocks * chore: add prettier-ignore where needed * chore: ignore js blocks when formatting * chore: fix playground html syntax * chore: fix yaml spacing from merge * chore: convert text blocks to use arrow functions * chore: format everything with prettier * chore: fix lint unused imports in blocks
105 lines
2.4 KiB
TypeScript
105 lines
2.4 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2018 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* Abstract class for a variable event.
|
|
*
|
|
* @class
|
|
*/
|
|
import * as goog from '../../closure/goog/goog.js';
|
|
goog.declareModuleId('Blockly.Events.VarBase');
|
|
|
|
import * as deprecation from '../utils/deprecation.js';
|
|
import type {VariableModel} from '../variable_model.js';
|
|
|
|
import {
|
|
Abstract as AbstractEvent,
|
|
AbstractEventJson,
|
|
} from './events_abstract.js';
|
|
import type {Workspace} from '../workspace.js';
|
|
|
|
/**
|
|
* Abstract class for a variable event.
|
|
*/
|
|
export class VarBase extends AbstractEvent {
|
|
override isBlank = true;
|
|
/** The ID of the variable this event references. */
|
|
varId?: string;
|
|
|
|
/**
|
|
* @param opt_variable The variable this event corresponds to. Undefined for
|
|
* a blank event.
|
|
*/
|
|
constructor(opt_variable?: VariableModel) {
|
|
super();
|
|
this.isBlank = typeof opt_variable === 'undefined';
|
|
if (!opt_variable) return;
|
|
|
|
this.varId = opt_variable.getId();
|
|
this.workspaceId = opt_variable.workspace.id;
|
|
}
|
|
|
|
/**
|
|
* Encode the event as JSON.
|
|
*
|
|
* @returns JSON representation.
|
|
*/
|
|
override toJson(): VarBaseJson {
|
|
const json = super.toJson() as VarBaseJson;
|
|
if (!this.varId) {
|
|
throw new Error(
|
|
'The var ID is undefined. Either pass a variable to ' +
|
|
'the constructor, or call fromJson'
|
|
);
|
|
}
|
|
json['varId'] = this.varId;
|
|
return json;
|
|
}
|
|
|
|
/**
|
|
* Decode the JSON event.
|
|
*
|
|
* @param json JSON representation.
|
|
*/
|
|
override fromJson(json: VarBaseJson) {
|
|
deprecation.warn(
|
|
'Blockly.Events.VarBase.prototype.fromJson',
|
|
'version 9',
|
|
'version 10',
|
|
'Blockly.Events.fromJson'
|
|
);
|
|
super.fromJson(json);
|
|
this.varId = json['varId'];
|
|
}
|
|
|
|
/**
|
|
* Deserializes the JSON event.
|
|
*
|
|
* @param event The event to append new properties to. Should be a subclass
|
|
* of VarBase, but we can't specify that due to the fact that parameters
|
|
* to static methods in subclasses must be supertypes of parameters to
|
|
* static methods in superclasses.
|
|
* @internal
|
|
*/
|
|
static fromJson(
|
|
json: VarBaseJson,
|
|
workspace: Workspace,
|
|
event?: any
|
|
): VarBase {
|
|
const newEvent = super.fromJson(
|
|
json,
|
|
workspace,
|
|
event ?? new VarBase()
|
|
) as VarBase;
|
|
newEvent.varId = json['varId'];
|
|
return newEvent;
|
|
}
|
|
}
|
|
|
|
export interface VarBaseJson extends AbstractEventJson {
|
|
varId: string;
|
|
}
|