Answer (Panel): Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
(Created page with "{{stub}} A panel can be given "answers". These are buttons that are added to a panel and allow the end-user to close the panel by selecting from the specified options. These...")
 
mNo edit summary
Line 1: Line 1:
{{stub}}
{{stub}}


A panel can be given "answers". These are buttons that are added to a panel and allow the end-user to close the panel by selecting from the specified options. These "answers" can be further supplemented through the attachment of [[event]]s. When the user selects an "answer" that has one or more events attached to it, these events will get fired (triggered) and will affect the session accordingly.
A [[Panel]] can be given Answers. These are buttons that are added to a [[Panel]] and allow the end-user to close the [[Panel]], and at the same time trigger one or more [[Event]]s in the [[Session]].
 
==When to use==
Answers can be used to provide an additional way to interact with the [[Session]]. They are always used as an additional function of [[Panel]]s. A [[Panel]] provides information and if Answers are added to a [[Panel]] the end-user can act on the provided information by selecting one of the Answers.
 
Panels can always be closed by clicking on their "X" on the top right of their window. For this reason, Answers should not be used for restrictive control-flow of a user's actions.
 
===Answers as part of Template Panels===
When an Answer is attached to a [[Template Panel]], it is part of the properties that are carried over to its instances. The name is kept verbatim. The [[Event]]s are copied over intelligently. Specifically, if the [[Event]] has as one of its parameters an [[Item]] of the type which the [[Template Panel]] is applied to, then the [[Event]] of the instance created will have that parameter refer to the item the instance belongs to. For example, if the Answer has a NEIGHBORHOOD_SET_ATTRIBUTE [[Event]], and the [[Template Panel]] is applied to [[Neighborhood]]s, then each instanced [[Panel]] will relate to a specific [[Neighborhood], and the NEIGHBORHOOD_SET_ATTRIBUTE [[Event]] of that [[Panel]] will be configured to change an [[Attribute]] of that specific [[Neighborhood]].
 
==Properties==
Answers have a number of properties, which can be configured in the Editor. They define the Answer's text and its effects.
 
; Name
: When the Answer is displayed, this is the text on the button. Note that Answers can have the same name as other Answers.
 
; Events
: These are the [[Event]]s fired when this Answer is chosen.


===Adding/removing answers===
===Adding/removing answers===
Line 34: Line 51:


{{clear}}
{{clear}}
===Answers as part of template panels===
Template panels can also have ''answers'' attached to them, which will then also apply to all of its instances. In the case that a template panel has a specific target object (e.g., NEIGHBORHOODS) and one of the ''answers'' features an event (e.g., NEIGHBORHOOD_SET_ATTRIBUTE), the event will only affect the specific target object it was created for.

Revision as of 13:02, 31 July 2020

This article is a stub.

A Panel can be given Answers. These are buttons that are added to a Panel and allow the end-user to close the Panel, and at the same time trigger one or more Events in the Session.

When to use

Answers can be used to provide an additional way to interact with the Session. They are always used as an additional function of Panels. A Panel provides information and if Answers are added to a Panel the end-user can act on the provided information by selecting one of the Answers.

Panels can always be closed by clicking on their "X" on the top right of their window. For this reason, Answers should not be used for restrictive control-flow of a user's actions.

Answers as part of Template Panels

When an Answer is attached to a Template Panel, it is part of the properties that are carried over to its instances. The name is kept verbatim. The Events are copied over intelligently. Specifically, if the Event has as one of its parameters an Item of the type which the Template Panel is applied to, then the Event of the instance created will have that parameter refer to the item the instance belongs to. For example, if the Answer has a NEIGHBORHOOD_SET_ATTRIBUTE Event, and the Template Panel is applied to Neighborhoods, then each instanced Panel will relate to a specific [[Neighborhood], and the NEIGHBORHOOD_SET_ATTRIBUTE Event of that Panel will be configured to change an Attribute of that specific Neighborhood.

Properties

Answers have a number of properties, which can be configured in the Editor. They define the Answer's text and its effects.

Name
When the Answer is displayed, this is the text on the button. Note that Answers can have the same name as other Answers.
Events
These are the Events fired when this Answer is chosen.

Adding/removing answers

Editor → Current Situation (Ribbon tab) → Panels (Ribbon bar) → Panel (Left panel)
How to add an answer to a panel:
  1. Select the panel you wish to add an answer to in the left panel.
  2. Select "Add Answer".
How to remove an answer from a panel:
  1. Select the answer you wish to remove.
  2. Select "Remove".

Configuring answers

Editor → Current Situation (Ribbon tab) → Panels (Ribbon bar) → Answer of a panel (Left panel)

When selecting an answer, a number of properties can be configured in the right panel.

The right panel for panel answers in the editor.
Property Description Example
Answer Text This text will be displayed to the end user if the panels is opened and form one of the selectable options in the case of multiple answers.
Input field for the answer text.
Events One or more events can be coupled to this answer, which will then be fired (triggered) upon selecting this answer. The events are divided into 'server events' and 'client events'. Server events will also trigger changes in the state of the session, whereas client events will only affect the visualization for the end user who selected the answer.

For the exact steps for adding, removing, and changing events, please see Editing Events.

The events fired when the answer is selected.