Broadcast Tuple Reference

From Planimate Knowledge Base
Revision as of 20:01, 11 January 2008 by Rick (talk | contribs) (New page: ''This note is created automatically. Please do not edit it.'' This is a summary of the item attributes that will be set by Planimate when broadcasts are sent to broadcast entries by the ...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This note is created automatically. Please do not edit it.

This is a summary of the item attributes that will be set by Planimate when broadcasts are sent to broadcast entries by the engine. These broadcasts usually occur because the modeller has selected an option on an object, for example selecting the "Send Table Click" option in a table view. Other broadcasts are automatically sent by the Planimate engine and just require a receiving broadcast entry, configured to "listen" to the correct broadcast name. These are indicated below.

It is up to the modeller to ensure that the item class involved has the correctly named attribute, otherwise the attribute will be skipped.

Each collection of attributes is referred to as a Tuple. Some broadcasts The attribute names all start with underscore to set them apart from attributes that the modeller uses for general modelling, hence names starting with underscore should be avoided unless specifically being used for receiving the tuples defined here.

The format of an attribute should usually be a value. Times are best formatted as time/calendar values. _pipeid and _paintid are _Model Objects labels and _Paint Objects labels respectively. _panel is a _Model Panels label.

Table Cell Click (TableClick

This is sent by a broadcast chosen by the modeller and sets these attributes:

  1. _view_row
  2. _view_col
  3. _to_row
  4. _to_col