dataDrivenConfiguratorExtension

Members

<static> isInited :boolean

Description

Flag indicating whether the Data Driven Configurator Extension has been fully initialized.
This is set to true after all dependent components have completed their initialization.

Details

Methods

<static> forgetLastValueDefinedByUserForAttributes( attributes )

Description

By default, this method does nothing more than propagating the call to dataDrivenConfigurator.forgetLastValueDefinedByUserForAttributes.

It is meant to be adjusted as needed.

Parameters

Name	Type	Default	Description
`attributes`	Array.<object>		The list of attributes for which data driven should forget previous user defined values. If `null`, the values of all attributes will be forgotten.

Details

<static> getStatus() → {dataDrivenConfigurator.attributesStatus}

Description

By default, this method does nothing more than propagating the call to dataDrivenConfigurator.getStatus.

It is meant to be adjusted as needed.

Returns

Details

<static> setConfiguration( configurationObject [, options ] )

Description

By default, this method does nothing more than propagating the call to dataDrivenConfigurator.setConfiguration.

It is meant to be adjusted as needed.

Parameters

Name Type Attributes Default Description

configurationObject

object

A configuration object containing the attributes to set and their values

options

object

Since 0.3.3 Options as how the configuration should be set.

Name	Type	Attributes	Default	Description
`repercussionConfigPropagationMode`	dataDrivenConfigurator.repercussionConfigPropagationMode	<optional>	async	The way the repercussion configuration object should be propagated.
`repercussionConfigDelayedPropagationModeDelay`	dataDrivenConfigurator.repercussionConfigDelayedPropagationModeDelay	<optional>	1	Delay in milliseconds to apply when repercussionConfigPropagationMode is set to `delayed`.

Details

<static> simulateSetConfiguration()

Description

By default, this method does nothing more than propagating the call to dataDrivenConfigurator.simulateSetConfiguration.

It is meant to be adjusted as needed.

Details

<static> unload()

Description

Unloads everything related to the data driven extension and the data driven.

If used in addition to the player’s native unload, the data driven code’s one should be called first.

Examples


			window.dataDrivenConfiguratorExtension.unload();
			player.unload();

Details

Events

dataDrivenConfiguratorExtensionIsInited

Description

Fired when the Data Driven Configurator Extension has inited.

Properties

Name Type Description

detail

object

A holder.

Name	Type	Description
`version`	string	The version of the Data Driven Configurator Extension code that has been inited.

dataDrivenConfiguratorExtension