Skip to content

⬅️ Back to Table of Contents

📄 SetScriptValueCommand.js

📊 Analysis Summary

Metric Count
🔧 Functions 5
🧱 Classes 1
📦 Imports 1

📚 Table of Contents

🛠️ File Location:

📂 editor/js/commands/SetScriptValueCommand.js

📦 Imports

Name Source
Command ../Command.js

Functions

SetScriptValueCommand.execute(): void

Returns: void

Calls:

  • this.editor.signals.scriptChanged.dispatch
Code
execute() {

        this.script[ this.attributeName ] = this.newValue;

        this.editor.signals.scriptChanged.dispatch( this.script );

    }

SetScriptValueCommand.undo(): void

Returns: void

Calls:

  • this.editor.signals.scriptChanged.dispatch
Code
undo() {

        this.script[ this.attributeName ] = this.oldValue;

        this.editor.signals.scriptChanged.dispatch( this.script );

    }

SetScriptValueCommand.update(cmd: any): void

Parameters:

  • cmd any

Returns: void

Code
update( cmd ) {

        this.newValue = cmd.newValue;

    }

SetScriptValueCommand.toJSON(): { type: string; id: number; name: string; }

Returns: { type: string; id: number; name: string; }

Calls:

  • super.toJSON
  • this.editor.scripts[ this.object.uuid ].indexOf
Code
toJSON() {

        const output = super.toJSON( this );

        output.objectUuid = this.object.uuid;
        output.index = this.editor.scripts[ this.object.uuid ].indexOf( this.script );
        output.attributeName = this.attributeName;
        output.oldValue = this.oldValue;
        output.newValue = this.newValue;

        return output;

    }

SetScriptValueCommand.fromJSON(json: any): void

Parameters:

  • json any

Returns: void

Calls:

  • super.fromJSON
  • this.editor.objectByUuid
Code
fromJSON( json ) {

        super.fromJSON( json );

        this.oldValue = json.oldValue;
        this.newValue = json.newValue;
        this.attributeName = json.attributeName;
        this.object = this.editor.objectByUuid( json.objectUuid );
        this.script = this.editor.scripts[ json.objectUuid ][ json.index ];

    }

Classes

SetScriptValueCommand

Class Code
class SetScriptValueCommand extends Command {

    /**
     * @param {Editor} editor
     * @param {THREE.Object3D|null} object
     * @param {string} script
     * @param {string} attributeName
     * @param {string} newValue
     * @constructor
     */
    constructor( editor, object = null, script = '', attributeName = '', newValue = null ) {

        super( editor );

        this.type = 'SetScriptValueCommand';
        this.name = editor.strings.getKey( 'command/SetScriptValue' ) + ': ' + attributeName;
        this.updatable = true;

        this.object = object;
        this.script = script;

        this.attributeName = attributeName;
        this.oldValue = ( script !== '' ) ? script[ this.attributeName ] : null;
        this.newValue = newValue;

    }

    execute() {

        this.script[ this.attributeName ] = this.newValue;

        this.editor.signals.scriptChanged.dispatch( this.script );

    }

    undo() {

        this.script[ this.attributeName ] = this.oldValue;

        this.editor.signals.scriptChanged.dispatch( this.script );

    }

    update( cmd ) {

        this.newValue = cmd.newValue;

    }

    toJSON() {

        const output = super.toJSON( this );

        output.objectUuid = this.object.uuid;
        output.index = this.editor.scripts[ this.object.uuid ].indexOf( this.script );
        output.attributeName = this.attributeName;
        output.oldValue = this.oldValue;
        output.newValue = this.newValue;

        return output;

    }

    fromJSON( json ) {

        super.fromJSON( json );

        this.oldValue = json.oldValue;
        this.newValue = json.newValue;
        this.attributeName = json.attributeName;
        this.object = this.editor.objectByUuid( json.objectUuid );
        this.script = this.editor.scripts[ json.objectUuid ][ json.index ];

    }

}

Methods

execute(): void
Code
execute() {

        this.script[ this.attributeName ] = this.newValue;

        this.editor.signals.scriptChanged.dispatch( this.script );

    }
undo(): void
Code
undo() {

        this.script[ this.attributeName ] = this.oldValue;

        this.editor.signals.scriptChanged.dispatch( this.script );

    }
update(cmd: any): void
Code
update( cmd ) {

        this.newValue = cmd.newValue;

    }
toJSON(): { type: string; id: number; name: string; }
Code
toJSON() {

        const output = super.toJSON( this );

        output.objectUuid = this.object.uuid;
        output.index = this.editor.scripts[ this.object.uuid ].indexOf( this.script );
        output.attributeName = this.attributeName;
        output.oldValue = this.oldValue;
        output.newValue = this.newValue;

        return output;

    }
fromJSON(json: any): void
Code
fromJSON( json ) {

        super.fromJSON( json );

        this.oldValue = json.oldValue;
        this.newValue = json.newValue;
        this.attributeName = json.attributeName;
        this.object = this.editor.objectByUuid( json.objectUuid );
        this.script = this.editor.scripts[ json.objectUuid ][ json.index ];

    }