customClass

AI.AIUtil. customClass

new customClass()

A class name to register as an AI class.

Methods

(static) register(classNameopt, imagePathopt) → {Promise.<void>}

Registers a class name as a custom AI class, using an image for the description.

Parameters:

NameTypeAttributesDescription
classNamestring <optional>
The class name to register.
imagePathstring <optional>
The path of the image to use to describe the class.

Returns:

a promise that is fulfilled after the class is registered.
Type
Promise.<void>

(static) unregister(classNameopt) → {Promise.<void>}

Unregisters a custom class.

Parameters:

NameTypeAttributesDescription
classNamestring <optional>
The class name to unregister.

Returns:

a promise that is fulfilled after the class is unregistered.
Type
Promise.<void>

(static) unregisterAll() → {Promise.<void>}

Unregisters all custom classes.

Returns:

a promise that is fulfilled after all classes are unregistered.
Type
Promise.<void>