Discrete user input
- Last UpdatedJul 26, 2024
- 1 minute read
The following elements can be specified for a discrete user input animation link:
|
Elements |
Description |
|---|---|
|
Title |
Object name. Optional. |
|
Message |
Message text to user. Default is no message text. Required if the optional schema is used. |
|
InputOnly |
If input only: {true, false}. Default is false. |
|
OnMessage |
On message text for user. Default is On. Cannot be empty text. |
|
OffMessage |
Off message text for user. Default is Off. Cannot be empty text. |
|
SetPrompt |
Set prompt message text for user. Default is On. Cannot be empty text. |
|
ResetPrompt |
Reset prompt message text for user. Default is Off. Cannot be empty text. |
|
KeyAssignment |
Virtual key element. Default is no assignment. An empty string means no assignment occurs. |
|
Expression |
Discrete tag. Required. Object is not created if invalid or missing. |
Example:
<UserInputDiscrete>
<Title>UserInputDiscrete1</Title>
<InputOnly>false</InputOnly>
<KeyAssignment>
<KeyCode>F1</KeyCode>
<KeyFlags>Ctrl</KeyFlags>
</KeyAssignment>
<Message>Pump Valve State</Message>
<Expression><![CDATA[dTag001]]></Expression>
<OnMessage>On Message Text</OnMessage>
<OffMessage>Off Message Text</OffMessage>
<ResetPrompt>
<![CDATA[Reset Prompt Text]]>
</ResetPrompt>
<SetPrompt>Set Prompt Text</SetPrompt>
</UserInputDiscrete>
Minimal example:
<UserInputDiscrete>
<Message>Pump Valve State</Message>
<Expression>dTag001</Expression>
</UserInputDiscrete>