Class ActivityHostConceptMetadata

Defines properties and message types for ActivityHostConcept.

Property Types

See also PropertyType

Message Types

See also MessageType
ActivityHostConceptMetadata.ActivateActivityMessageMessage

Send this message to an Activity Host to activate its child Activity that you set in the message. On successful activation, Exclusive Activity Hosts automatically deactivates the previously active Activity.

Arguments: ActivityHostConceptMetadata.ActivationMessageArguments

ActivityHostConceptMetadata.DeactivateActivityMessageMessage

Send this message to an Activity Host to deactivate its child Activity that you set in the message. You can use this message only to deactivate an Activity in a Parallel Activity Host.

Arguments: ActivityHostConceptMetadata.ActivationMessageArguments

ActivityHostConceptMetadata.ActivityPrefabAttachedMessageMessage

An Activity Host sends this message when it attaches the prefab of the Activity that is activated.

Arguments: ActivityConceptMetadata.ActivityPrefabMessageArguments

ActivityHostConceptMetadata.ActivityPrefabDetachedMessageMessage

An Activity Host sends this message when it detaches the prefab of the Activity that is deactivated.

Arguments: ActivityConceptMetadata.ActivityPrefabMessageArguments

Message Arguments

Message arguments classes define message arguments used for different message types. Each class defines a number of property types - arguments - together with getter and setter functions for them.

ActivityHostConceptMetadata.ActivationMessageArguments

ActivationPathProperty

The relative path from the target Activity Host to the Activity that you want to activate.

Example
local value = arguments:getActivationPathProperty()
arguments:setActivationPathProperty(value)
ResetHistoryProperty

Determines whether Kanzi resets the Activity property values when an Activity becomes active:

  • When enabled, Kanzi discards the serialized values of Activity properties for this Activity and its child Activities.
  • When disabled, Kanzi reinstates the serialized values of Activity properties of this Activity and its child Activities. The default value.
Example
local value = arguments:getResetHistoryProperty()
arguments:setResetHistoryProperty(value)

ActivityHostConceptMetadata.RegisterActivityElementInternalMessageArguments

ActivityHostConceptMetadata.UnregisterActivityElementInternalMessageArguments