API Reference › frontend-devtools› Effects › ExplosionEffect

ExplosionEffect Class

This tool applies an explosion particle effect used for testing ParticleCollectionBuilder.

Extends

Methods

Name Description
constructor(..._args: any[]): ExplosionEffect    
run(): Promise<boolean> This method runs the tool, applying an explosion particle effect.  

Inherited methods

Name Inherited from Description
parseAndRun(..._args: string[]): Promise<boolean> Inherited Tool Run this instance of a tool using a series of string arguments.
register(namespace?: string): void Static Inherited Tool Register this Tool class with the ToolRegistry.

Properties

Name Type Description
toolId Static string The unique string that identifies this tool.  

Inherited properties

Name Type Inherited from Description
description Accessor Inherited ReadOnly string Tool Get the localized description string from this Tool's class
description Accessor Static Inherited ReadOnly string Tool Get the localized description for this Tool class. This returns the value of "tools." + this.toolId + ".description" from
its registered Namespace (e.g. "en/MyApp.json"). If that key is not in the localization namespace,
Tool.flyover is returned.
englishKeyin Accessor Static Inherited ReadOnly string Tool Get the English keyin string for this Tool class. This returns the value of "tools." + this.toolId + ".keyin" from
its registered Namespace (e.g. "en/MyApp.json").
flyover Accessor Inherited ReadOnly string Tool Get the localized flyover string from this Tool's class
flyover Accessor Static Inherited ReadOnly string Tool Get the localized flyover for this Tool class. This returns the value of "tools." + this.toolId + ".flyover" from
its registered Namespace (e.g. "en/MyApp.json"). If that key is not in the localization namespace,
Tool.keyin is returned.
hidden Static Inherited boolean Tool If true, this Tool will not appear in the list from ToolRegistry.getToolList.
iconSpec Accessor Inherited ReadOnly string Tool Get the iconSpec from this Tool's class.
iconSpec Static Inherited string Tool The icon for this Tool.
keyin Accessor Inherited ReadOnly string Tool Get the localized keyin string from this Tool's class
keyin Accessor Static Inherited ReadOnly string Tool Get the localized keyin string for this Tool class. This returns the value of "tools." + this.toolId + ".keyin" from
its registered Namespace (e.g. "en/MyApp.json").
maxArgs Accessor Static Inherited ReadOnly undefined | number Tool The maximum number of arguments allowed by Tool.parseAndRun, or undefined if there is no maximum.
If subclasses override Tool.parseAndRun, they should also override this method to indicate the maximum
number of arguments their implementation expects.
minArgs Accessor Static Inherited ReadOnly number Tool The minimum number of arguments allowed by Tool.parseAndRun. If subclasses override Tool.parseAndRun, they should also
override this method to indicate the minimum number of arguments their implementation expects. UI controls can use
this information to ensure the tool has enough information to execute.
namespace Static Inherited string Tool The namespace that provides localized strings for this Tool.
toolId Accessor Inherited ReadOnly string Tool Get the toolId string for this Tool class. This string is used to identify the Tool in the ToolRegistry and is used to localize
the keyin, description, etc. from the current locale.

Defined in

Last Updated: 14 November, 2024