EventTriggeredPlotSymbol

SUMMARY

The defined plot symbol is set.

SYNTAX

For plot symbols:

- placed directly in the ship plan without a connection line:
EventTriggeredPlotSymbol2D (<display, roompolyname, class, symbol_figure, context_figure>);


- placed above or below the ship plan with a connection line:
EventTriggeredPlotSymbol3D (<display, roompolyname, class, symbol_figure, context_figure>);

ARGUMENTS

display (type:string)
The name of the picture in which the room defined by ‘roompolyname’ is located.
roompolyname (type:string)
The name of the ‘roompolygons’ in which the plot symbol should be set.
class, symbol_figure, context_figure (type:string)
See InsertPlotSymbol.

DESCRIPTION

Effect
The function sets automatically the plot symbol defined by class, symbol_figure and context_figure into the room defined by display and roompolyname.
Alike to the 'InsertPlotSymbol-Job' the "Created"-time, if applicable the damage borders (BdcBorderGrfx), are set. If the room name could be ascertained it is returned via the stack.

If the room already contains a plot symbol with the same context_figure no new symbol is plotted.

EXAMPLES

EventTriggeredPlotSymbol3D("PIC", "Room", "F-Dam", "F-DamSym", "F-DamContext");

Syntax Notation
[aaa]
aaa is optional (zero or one occurences)
(aaa|bbb)
aaa exclusive or bbb
(aaa)*
aaa may occur indefinitely often or may be omitted
(aaa)+
aaa may occur indefinitely often but at least once
(aaa)m..n
aaa may occur from m to n times