Node Effect 2D¶
Node Effect 2D available properties¶
Name |
Description |
Inherited |
Exported to Kanzi Engine |
---|---|---|---|
Description |
Add a description of the purpose of this item. To export descriptions to a plain text file, select File > Export > Export Descriptions. When you export the kzb file, this description is not included in the exported file. |
No |
No |
Effect Factory Name |
The factory name for the effect. Use this name to instantiate an effect from a plugin. |
No |
No |
Node Effect 2D messages¶
Name |
Description |
Inherited |
Exported to Kanzi Engine |
---|---|---|---|
About To Gain Focus |
Kanzi sends this message before a focusable node receives focus. |
No |
Yes |
About To Lose Focus |
Kanzi sends this message before the focused node loses focus. |
No |
Yes |
Activate Activity |
Send this message to an activity host node to activate the child Activity node that you set in the message. Exclusive Activity Host nodes deactivate the previously active Activity node at the same time. |
No |
Yes |
Activity Prefab Attached |
Activity prefab has been attached. |
No |
Yes |
Activity Prefab Detached |
Activity prefab has been detached. |
No |
Yes |
Animation Playback Completed |
Occurs when animation player completes animation playback. |
No |
Yes |
Animation Playback Started |
Occurs when animation player starts animation playback. |
No |
Yes |
Animation Playback Stopped |
Occurs when animation player stops animation playback. |
No |
Yes |
Asynchronous Load Completed |
Occurs when asynchronous loading of resources from a prefab has been finished. |
No |
Yes |
Button: Cancel |
Occurs when a user lifts their finger outside of a Button that they previously pressed. |
No |
Yes |
Button: Click |
Occurs when a user lifts their finger on top of a Button that they previously pressed and when the time set by the Auto Press Interval property in the pressed Button expires. |
No |
Yes |
Button: Down |
Occurs when the user presses down the Button. |
No |
Yes |
Button: Enter |
Button: Enter trigger is set off: - When the user presses down the button. - When the user presses down the button, moves the pointer outside of the button area, and then moves the pointer back to the button area while still holding down the pointer. |
No |
Yes |
Button: Leave |
Button: Leave trigger is set off: - When the user presses down the button and then lifts the pointer. - When the user presses down the button and then moves the pointer outside of the button area. - When the user sets off a Button : Long Press trigger. |
No |
Yes |
Button: Long Press |
Occurs when the user presses down a Button and holds the Button pressed for the amount of milliseconds defined in the Hold Interval property of that Button. |
No |
Yes |
Click |
Occurs when the pointer is pressed and is released on top of the component and no other gesture has been recognized. |
No |
Yes |
Click Begin |
Occurs when the pointer is pressed down on top of the component. |
No |
Yes |
Click Cancel |
Occurs when a started click cancels. This occurs, for example, when user pressed button down and slides finger away and releases press. |
No |
Yes |
Click Enter |
Occurs when the pointer or touch enters the click manipulator. |
No |
Yes |
Click Leave |
Occurs when the pointer or touch leaves the click manipulator. |
No |
Yes |
Command |
Command message arguments |
No |
Yes |
Composition Text Changed |
Occurs when the text produced in an Input Method Editor is updated in a Text Box node. |
No |
Yes |
Composition Text Committed |
Occurs: - When the text produced in an Input Method Editor is committed to the cached text in a Text Box node. - When a trigger executes the Commit Composition Text action. |
No |
Yes |
Cursor Moved |
Occurs when the user moves the cursor in a Text Box node. |
No |
Yes |
Data Trigger |
Monitors changes in properties and data source values. Use a Data Trigger to apply an action to either set a property value of a target node or activate an Activity node. |
No |
Yes |
Deactivate Activity |
Send this message to an activity host node to deactivate the child Activity node that you set in the message. Exclusive Activity Host nodes ignore this message. |
No |
Yes |
Drag and Drop Canceled |
Occurs when focus moves away from the node during the drag-and-drop gesture. |
No |
Yes |
Drag and Drop Finished |
Occurs when the user lifts their finger after starting the drag-and-drop gesture. |
No |
Yes |
Drag and Drop Moved |
Occurs when the user moves their finger after starting the drag-and-drop gesture. |
No |
Yes |
Drag and Drop Started |
Occurs when the user holds their finger for 500ms on the node. |
No |
Yes |
Easing Interpolation Completed |
Occurs when Property Target Easing Interpolator completes its interpolation. |
No |
Yes |
Editing Finished |
Occurs when a Text Box node leaves the editing state after the user modified the text content. |
No |
Yes |
Editing Started |
Occurs when the user makes the first modification to the text in a Text Box node that is in the editing state. |
No |
Yes |
Entered Editing State |
Occurs when a Text Box node enters the editing state. |
No |
Yes |
Entered State |
Occurs when a state manager has entered a state. |
No |
Yes |
Focus Entered Focus Scope |
When focus enters a focus scope, Kanzi sends this message to the focus scope node that contains the node that gains focus. |
No |
Yes |
Focus Gained |
Kanzi sends this message to the node that received focus. |
No |
Yes |
Focus Left Focus Scope |
When focus leaves a focus scope, Kanzi sends this message to the focus scope node that contains the node that loses focus. |
No |
Yes |
Focus Lost |
Kanzi sends this message to the node that lost focus. |
No |
Yes |
Input Method Action |
Occurs when the user taps the action button on their on-screen keyboard while editing the text in a Text Box node. |
No |
Yes |
Input Method Available |
Occurs when an input method becomes available to a Text Box node. For example, an on-screen keyboard becomes available when it appears on the screen. |
No |
Yes |
Input Method Unavailable |
Occurs when the input method that is composing text in a Text Box node becomes unavailable. For example, an on-screen keyboard becomes unavailable when the user hides it. |
No |
Yes |
Intermediate Click |
If the multi-click manipulator is set to send messages for intermediate clicks, this trigger is set off every time the pointer is pressed and released on top of the node. To set the multi-click manipulator to send messages for intermediate clicks, in the Multi-Click Gesture enable the Send Intermediate Clicked Messages property. |
No |
Yes |
Interpolation Completed |
Occurs when property target interpolator completes interpolation. |
No |
Yes |
Key Canceled |
Occurs when Kanzi recognizes a key-canceled gesture. A key-canceled gesture occurs when Kanzi recognizes that the user canceled a gesture. |
No |
Yes |
Key Navigation Canceled |
Occurs when the key-pressed gesture is canceled for the navigation direction. |
No |
Yes |
Key Navigation Finished |
Occurs when Kanzi recognizes the key-released gesture for the navigation direction. To capture key navigation gestures for a node, create a Navigation Manipulator component in that node. |
No |
Yes |
Key Navigation Started |
Occurs when Kanzi recognizes the key-pressed and key repeat gestures for the navigation direction. To capture key navigation gestures for a node, create a Navigation Manipulator component in that node. |
No |
Yes |
Key Pressed |
Occurs when Kanzi recognizes a key-pressed gesture. A key-pressed gesture occurs when Kanzi recognizes a key event that contains all the elements that compose that gesture. |
No |
Yes |
Key Released |
Occurs when Kanzi recognizes a key-released gesture. A key-released gesture occurs when Kanzi recognizes the release of one of the elements that compose that gesture. |
No |
Yes |
Left Editing State |
Occurs when a Text Box node leaves the editing state |
No |
Yes |
Left State |
Occurs when a state manager has left a state. |
No |
Yes |
List Box: Item Hidden |
Occurs when an item is unloaded from the working memory. To set how many items you want to keep loaded in the working memory at a time, use the Keep Alive Item Count property. |
No |
Yes |
List Box: Item Selected |
Occurs when an item is selected. |
No |
Yes |
List Box: Item Visible |
Occurs when an item is loaded to the working memory. To set how many items you want to keep loaded in the working memory at a time, use the Keep Alive Item Count property. |
No |
Yes |
List Box: Scroll Finished |
Occurs when the List Box stops scrolling. |
No |
Yes |
List Box: Scroll Started |
Occurs when the List Box starts to scroll. |
No |
Yes |
List Box: Scrolled |
Occurs when the List Box scrolls. |
No |
Yes |
List Box: Target Changed |
Occurs when List Box gets a new target item. |
No |
Yes |
List Box: User Scroll Finished |
Occurs when the application user stops scrolling the List Box. |
No |
Yes |
List Box: User Scroll Started |
Occurs when the application user starts to scroll the List Box. |
No |
Yes |
Long Press |
Occurs when the user presses down their finger on the node and holds it down for the time you set in this trigger. |
No |
Yes |
Long Press Cancel |
Occurs when focus moves away from the node during the long-press gesture. |
No |
Yes |
Message Trigger |
No |
Yes |
|
Multi-Click |
Occurs when the pointer is pressed and released on top of the node a specified number of times (default 2) within a specified amount of time (default 250 ms) between them. |
No |
Yes |
Multi-Click Canceled |
Occurs when focus moves away from the node during the multi-click gesture. |
No |
Yes |
Navigate To Next Activity |
Navigates to the next Activity node in the Activity Host. |
No |
Yes |
Navigate To Previous Activity |
Navigates to the previous Activity node in the Activity Host. |
No |
Yes |
On Attached |
This trigger is set off when the item is initialized. For example, when you add a node to the node tree, or enter a state that contains this trigger. |
No |
Yes |
On Property Change |
Occurs when a property is changed |
No |
Yes |
On Timer |
Occurs when timer interval is elapsed |
No |
Yes |
Page Activated |
Page has been activated. |
No |
Yes |
Page Deactivated |
Page has been deactivated. |
No |
Yes |
Page Navigation Finished |
Page host has finished navigation process. |
No |
Yes |
Page Navigation Started |
Page host has started navigation process. |
No |
Yes |
Pan Canceled |
Occurs when focus moves away from the node during the pan gesture. |
No |
Yes |
Pan Entered |
Occurs when the pan gesture enters the node the manipulator is attached to. |
No |
Yes |
Pan Finished |
Occurs when the user lifts their finger after Kanzi recognizes a pan gesture. |
No |
Yes |
Pan Left |
Occurs when the pan gesture leaves the node the manipulator is attached to. |
No |
Yes |
Pan Moved |
Occurs when the user changes the position of their finger and that change exceeds the recognition thresholds. |
No |
Yes |
Pan Started |
Occurs when the user presses down their finger on the node. If the user lifts their finger before exceeding the position change threshold, Kanzi cancels the pan gesture. |
No |
Yes |
Pinch Canceled |
Occurs when focus moves away from the node during the pinch gesture. |
No |
Yes |
Pinch Finished |
Occurs when the user lifts their finger after Kanzi recognizes a pinch gesture. |
No |
Yes |
Pinch Moved |
Occurs when the user changes the position of their finger and that change exceed the scale or rotation threshold. |
No |
Yes |
Pinch Started |
Occurs when the user presses down their finger. If the user lifts their finger before it exceeds the scale or rotate threshold, Kanzi cancels the pinch. |
No |
Yes |
Range Concept: Value Change Finished |
Occurs when the range value stops changing. |
No |
Yes |
Range Concept: Value Change Started |
Occurs when the range value starts changing. |
No |
Yes |
Range Concept: Value Changed |
Occurs when the range value has changed. |
No |
Yes |
Scope Brought To Front |
Occurs when a popup or a modal focus scope is brought to front. |
No |
Yes |
Scope Sent To Back |
Occurs when a foremost popup or modal focus scope is sent to back. |
No |
Yes |
Scroll Ended |
Occurs when the scroll position of a Scroll View node stops changing. |
No |
Yes |
Scroll Started |
Occurs when the scroll position of a Scroll View node starts changing. |
No |
Yes |
Scroll Zoomed |
Occurs when the zoom level of a Scroll View node changes. |
No |
Yes |
Scrolled |
Occurs when the scroll position of a Scroll View node changes. |
No |
Yes |
Selection Changed |
Occurs when the user changes the text selection in a Text Box node. |
No |
Yes |
Selection Cleared |
Occurs when the user clears or resets the text selection in a Text Box node. |
No |
Yes |
Selection Started |
Occurs when the user starts selecting text in a Text Box node. |
No |
Yes |
Snap Request |
Occurs when a Scroll View node requests snapping target from the hosting component. |
No |
Yes |
Status Changed Message |
To receive notifications when the Activity Status of this activity changes, subscribe to this message. |
No |
Yes |
Text Changed |
Occurs when the user changes the text in a Text Box node. |
No |
Yes |
Text Composition Canceled |
Occurs: - When the text composition in a Text Box node is canceled by Input Method that is in text composition state. - When a trigger executes the Cancel Text Composition action. |
No |
Yes |
Toggle Button Group: Toggled |
Occurs when the toggle state of a Toggle Button node in a Toggle Button Group node changes. |
No |
Yes |
Toggle Button: State Toggled |
Occurs when the toggle state of the Button changes. |
No |
Yes |
Toggle Button: Toggled Off |
Occurs when the Button is toggled off. |
No |
Yes |
Toggle Button: Toggled On |
Occurs when the Button is toggled on. |
No |
Yes |
Transition Finished |
Occurs when a state manager finishes a transition to a state. |
No |
Yes |
Transition Started |
Occurs when a state manager begins a transition to a state. |
No |
Yes |
User Scroll Ended Message |
Occurs when the user stops scrolling a Scroll View node. |
No |
Yes |
User Scroll Started |
Occurs when the user starts scrolling a Scroll View node. |
No |
Yes |