Software Customisation Reference Manual

.description	Description of the event packet which is used when adding or removing the packet into/from the edg system.
	All packets relating to the same utility should have the same description. This makes the removing and maintenance of the system a lot simpler.
.priority	Defines the priority within in the edg system of the packet, with respects to other packets of the same description.
	The priority is a real number, zero being the highest priority. Where a primary packet (priority = 0) is added to the system and there is already another primary packet in the system. You will be prompted to whether you want to replace the one currently in the system with the one being added.
	Only major utilities should be flagged as being primary packets, e.g. creating a section, element, etc. Subsequent packets relating to the same utility (having the same description) should have a lower priority.
	Note: Only packets of the same priority are removed from the system, lower priorities DO NOT get removed when a higher one is added.
.remove	Defines whether the event packet is automatically removed from the system when all the picks within the pick sequences and actions of the packet have been executed.
	The member is a Boolean, true if the packet is to be removed false if the packet is to be reinstated into the system.
	Note: Where a packet fails, it will be removed from the system if true, the system DOES NOT return to the beginning of the event pick sequence.
.form	Contains a pointer to the form that is to be shown when the event is added into the system.
	As the member is of "form" data type, the form MUST exist before it is assigned.
	When the event packet is added to the system, the form will automatically be shown and any initialisation for the form will be run as normal. The form will be shown at the right hand side of the screen, slightly offset from the top. This allows any low level controlling forms (especially the positioning control form) to be positioned above the form.
	When the event packet is removed from the system, the form will automatically be removed from the system and any low level control forms that the packet may require.
	When another event is placed on the stack, the form will still be active, however, the event picks will relate to the event packet at the top of the stack. Any low-level forms that are not required by the new event packet, will be left on the screen, but made inactive. This shows that they are still required be a currently stacked event, but does not allow the modification of the event packet until the event has been reinstated at the top of the stack.

.initialisation	The action that is carried out when the event packet is initially added to the edg system.
	When an event packet is reinstated into the system (this is where the .remove members is false). The action will NOT be executed.
.action	An action which is carried out when all the picks within the pick sequence object (edgPickPacket) have been successfully completed.
	All data derived from picking in the sequence object are returned through the system via the local variable !this.return (refer to Output Data).
.close	An action which is carried out just prior to the event packet being removed from the edg system, whether after a successful completion of the .action, forcibly by another action of the same priority/type or using the escape key, when in the graphics canvas.
	The action is carried out within the event packet object, therefore, arguments that refer to !this relate to the members of the event packet object itself.
	Where a packet has a form associated with the packet (using the .form member) then the close action should not attempt to hide the form, as the system will automatically remove the form.
.continue	An action which is carried out after the event packet has been removed from the edg system, whether after a successful completion of the .action or forcibly by another action of the same priority.
	As the action is carried out external to the event packet object, it is not possible to access any data from the event packet, unless this has been stored via other means, i.e. a global variable or form.
	Note: This action member is NOT run if the event packet is removed using the <esc> key on the Design graphics canvas is used.
.escape	An action which works the same as the .continue member, however it is only carried out if the event has been removed from the using the <esc> key, from the Design graphic canvas.

-- Define input data for packet !packet[1]    = 'String' !packet[2]    = 20 !packet[3]    = !!ce.position !packet.append(10) !packet.insert(1, !!ce) . .

-- Initialisation Action (using first element of input) !packet.initialisation = '!!form.eventInit(!this.input[1]) -- Action routine (using all input array and return pick data) !packet.action = '!!form.eventAction(!this.input, !this.return) -- Close action (using first element of input) !packet.close = '!!form.eventClose(!this.input[1])

-- Action routine _!packet.action = '!!form.eventAction(!this.return)

-- Action routine _!packet.action = '!!form.eventAction(!this.return[1])