|
Object with the following properties. Used during hotspot
initialization as map is being loaded and parsed.
(activation, activationLimit,
align, assignTo, clickRadius,
mesh, priority, rotation,
sink, solid, tag,
useSMP, visible)
|
| |
long activation
|
| |
|
The condition(s) that will cause this entity to activate.
Multiple conditions can be specified with the OR operator. The
following activation types are defined.
|
| |
|
|
O3D_NONE
|
(Default) – cannot be activated |
|
|
|
O3D_ENTER
|
Activated upon entering the entity. For 3D entities, this will be
from crossing some of the entity's parts. For 2D entities, this
will be moving inside the area. |
|
|
|
O3D_KEYWORD
|
Activated by user keyword while inside the entity. For 3D entities,
the user must be inside the entity 3D box. For 2D entities, this
will be moving inside the area. |
|
|
|
O3D_CLICK
|
Activated by a single, left-click of the user's mouse. |
|
|
|
O3D_DCLICK
|
Activated by a double, left-click of the user's mouse. |
| |
long activationLimit
|
| |
|
Defines the number of times this entity can be activated. Each
activation subtracts one from this value. For O3D_ENTER
activation, setting this to –1 will call the activation
function every 6 seconds. Use a high value for this activation type
if entering this entity will always activate the object. For all
other activation types, setting the value to –1 will result
in unlimited activation.
|
| |
String align
|
| |
|
How the entity aligns with the surface of the basement object at
the contact point. Legal values are the strings: "Vertical",
"X+", "X-", "Y+", "Y-",
"Z+", "Z-". Identical to the Align value in
an SMP format string.
|
| |
long assignTo
|
| |
|
Transfers all scripted hotspot properties to another entity. The
hotspot object is left where it was, but is now inert. As a result,
the entity is now considered a hotspot that can now be activated and
deactivated. 3D entities can have hotspot properties of any kind. 2D
entities, such as polygons and multi-polygons, can be only of O3D_ENTER
or O3D_KEYWORD activation types. Thus, non-rectangular 2D
activation areas can be created, such as circle-shaped trap or
polygonal search area for a secret door.
|
| |
double clickRadius
|
| |
|
Establishes a radius around thisEntity where O3D_CLICK
or O3D_DCLICK activation can occur. The value is given in
units of thisEntity horizontal radius and counts from the
object border.
|
| |
String mesh
|
| |
|
3D mesh name for the hotspot. Mesh names from %Overseer.appPath%\Data\System
directory can be used, such as "CO3D-Sphere", or
"CO3D-Pyramid". This mesh will then be used to represent
the hotspot on the 3D view of the map. This property is ignored if thisEntity.assignTo
is used.
|
| |
long priority
|
| |
|
Entity priority for height ordering. Identical to the Priority
value in an SMP format string.
|
| |
String rotation
|
| |
|
A comma separated string list of entity initial rotation the X,
Y, and Z axes measured in degrees. Thus "10, -5, 45",
would rotate the hotspot 10 degrees around the X axes, -5 degrees
around the Y axes, and 45 degrees around the Z axes.
|
| |
String sink
|
| |
|
A string that governs how the hotspot is sinking into the
basement. It functions identically to the sink value in an SMP
format string. Legal values are: "Center(val)", "CornersDown(val)",
"CornersUp(val)", "AllUp(val)", or "AllDown(val)",
where val is a relative adjustment in percentages. For
example "AllDown(-20)" would settle the hotspot
until all four corners and the center were in contact with the
basement, then sink it an additional 20%.
|
| |
bool solid
|
| |
|
A Boolean that establishes if the entity is solid. During height
ordering, only solid objects will be considered as basements, i.e. a
tree will not stand on a non-solid hill even if the hill is visible.
|
| |
long tag
|
| |
|
The tag number of the hotspot currently being initialized.
Read-only value.
|
| |
String useSMP
|
| |
|
A string that overrides the default SMP entry for this entity.
This is normally used with the thisEntity.assignTo
property.
|
| |
bool visible
|
| |
|
A boolean that determines if the entity is visible/hidden. |
