Kanzi Engine Lua API
Previous
Next
Contents
Manual
Classes
Modules

Class ExclusiveActivityHostConceptMetadata

Defines properties and message types for ExclusiveActivityHostConcept.

Property Types

See also PropertyType
ExclusiveActivityHostConceptMetadata.ExclusiveActivityHostContentProperty

Describes the content of an Exclusive Activity Host node. An Exclusive Activity Host uses the value of this property to instantiate Activity prefabs and control the status and lifetime of its child Activities. Kanzi Studio user cannot directly edit this property. The ActivityBrowserController sets the value of this property according to the changes done to the state of the Activity Tree in the ActivityBrowser. The expected format for the property value is the name of the Activity that the Exclusive Activity Host initially activates, followed by a list of Activity descriptions. Each of this Activity description contains: The name of the Activity

  • The ControllerProperty reference value of the Activity
  • The path to the prefab of that Activity. The values in this property must be separated by a comma. For example, {name0,{name1,666,path1},{name2,123,path2}}.
ExclusiveActivityHostConceptMetadata.FocusOnActivatingActivityProperty

Sets the policy that this Exclusive Activity Host uses to decide whether it tries to set the key focus to its activating Activity:

  • When Host Has Focus: If the Activity Host has the focus, it tries to set the focus to the Activity. This is the default.
  • Always: The Activity Host always tries to set the focus to the Activity.
  • Never: The Activity Host never tries to set the focus to the Activity.

Message Types

See also MessageType
ExclusiveActivityHostConceptMetadata.NavigateNextMessageMessage

Navigates to the next Activity in an Exclusive Activity Host.

Arguments: ExclusiveActivityHostConceptMetadata.ImplicitActivityChangeRequestMessageArguments
ExclusiveActivityHostConceptMetadata.NavigatePreviousMessageMessage

Navigates to the previous Activity in an Exclusive Activity Host.

Arguments: ExclusiveActivityHostConceptMetadata.ImplicitActivityChangeRequestMessageArguments

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.

See also MessageArguments

ExclusiveActivityHostConceptMetadata.ImplicitActivityChangeRequestMessageArguments

LoopActivityProperty

Sets how an Exclusive Activity Host reacts to the 'Navigate To Next Activity' and 'Navigate To Previous Activity' messages when it reaches its last and first Activities. When set to true and an Exclusive Activity Host reaches:

  • The last Activity, the Exclusive Activity Host reacts to the 'Navigate To Next Activity' message by activating the first Activity in that Exclusive Activity Host.
  • The first Activity, the Exclusive Activity Host reacts to the 'Navigate To Previous Activity' message by activating the last Activity in that Exclusive Activity Host.
Example
local value = arguments:getLoopActivityProperty()
arguments:setLoopActivityProperty(value)