Scene / Effect

Effect Class ​

Effect

It is usually used for the effect performance in the game scene, such as fire, water flow, weapon trailing, etc. When the editor details panel checks Auto enable, the running game will automatically play effect.

To precisely control the play and stop of effect, please use the play and stop methods. Different effect have different life cycles, and some effect can be adjusted through the parameters in the detail panel.

Example usage: Create a script called "Effectiveness Example", place it in the object bar, open the script, enter the following code to save, run the game, and you will see the effect of particle effects exploding in the scene. The code is as follows:

@Component
export default class EffectExample extends Script {

    private readonly effect = {
        assetID: "145884",
        object: null as mw.Effect,
    };

    protected onStart(): void {
        this.createEffect();
    }

    @RemoteFunction(Client)
    public async createEffect(): Promise<void> {
        const success = await mw.AssetUtil.asyncDownloadAsset(this.effect.assetID);
            if (success) {
                // Download completed create effect
                this.effect.object = await mw.GameObject.asyncSpawn(this.effect.assetID) as mw.Effect;

                // Set effect transform
                const transform = new mw.Transform(new mw.Vector(500, 0, 0), new mw.Rotation(0, 0, 0), new mw.Vector(1, 1, 1));
                this.effect.object.localTransform = transform;

                // Play effect
                this.effect.object.play();
                // Set the scalar value of effect parameter Life
                this.effect.object.setFloat("LifeTime", 10);
                // Set the special effect parameter Speed vector value
                this.effect.object.setVector("Speed", new mw.Vector(0,0,150));
                // Set the color value of effect parameter Color
                this.effect.object.setColor("Color", new mw.LinearColor(1,0,0,1));
            }
    }
}

@Component
export default class EffectExample extends Script {

    private readonly effect = {
        assetID: "145884",
        object: null as mw.Effect,
    };

    protected onStart(): void {
        this.createEffect();
    }

    @RemoteFunction(Client)
    public async createEffect(): Promise<void> {
        const success = await mw.AssetUtil.asyncDownloadAsset(this.effect.assetID);
            if (success) {
                // Download completed create effect
                this.effect.object = await mw.GameObject.asyncSpawn(this.effect.assetID) as mw.Effect;

                // Set effect transform
                const transform = new mw.Transform(new mw.Vector(500, 0, 0), new mw.Rotation(0, 0, 0), new mw.Vector(1, 1, 1));
                this.effect.object.localTransform = transform;

                // Play effect
                this.effect.object.play();
                // Set the scalar value of effect parameter Life
                this.effect.object.setFloat("LifeTime", 10);
                // Set the special effect parameter Speed vector value
                this.effect.object.setVector("Speed", new mw.Vector(0,0,150));
                // Set the color value of effect parameter Color
                this.effect.object.setColor("Color", new mw.LinearColor(1,0,0,1));
            }
    }
}

Hierarchy ​

• GameObject

  ↳ Effect

Table of contents ​

Properties ​

Accessors ​

Methods ​

Properties ​

onFinish ​

• onFinish: MulticastDelegate<() => void>

Special effects playback completed event

Accessors ​

duration ​

loopCount ​

timeLength ​

Methods ​

forceStop ​

• forceStop(): void other

Force effect to stop, and destroy all particle

play ​

• play(onSuccess?): void other

Play effect

Parameters ​

setColor ​

• setColor(parameterName, value): void other

Set effect Color Parameter Value

Parameters ​

The special effect color parameter is the "color" field in the "Special Effect Parameter Control" property panel on the right after selecting the special effect.

There is a case where multiple color property can be set for a effect, such as "color01" and "color02".

setColorRandom ​

• setColorRandom(parameterName, maxValue, minValue): void other

Set special effect color parameters randomly

Parameters ​

The special effect color parameter is the "color" field in the "Special Effect Parameter Control" property panel on the right after selecting the special effect.

setCullDistance ​

• setCullDistance(inCullDistance): void other

Objects beyond this distance between players will be cropped, and the final cropping distance will depend on the image quality level; When this property is modified to ≤ 0, the cropping distance will be automatically adjusted according to the object size (CullDistanceVolume function will be automatically enabled)

Parameters ​

setFloat ​

• setFloat(parameterName, value): void other

Set the effect scalar parameter value

Parameters ​

setFloatRandom ​

• setFloatRandom(parameterName, maxValue, minValue): void other

Set special effects scalar parameters randomly

Parameters ​

setVector ​

• setVector(parameterName, value): void other

Set effect Vector Parameter Value

Parameters ​

setVectorRandom ​

• setVectorRandom(parameterName, maxValue, minValue): void other

Set the effect vector parameter range to be random, and take the random value of the vector within a certain range

Parameters ​

stop ​

• stop(): void other

Stop effect without affecting generate particle