Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

An event that's triggered when a droid first enters a labelled Area object...

 

Syntax

Code Block
themeEclipse
languagejavascript
linenumberstrue
// see important notes about event name and usage below!
function eventArea<LABEL>eventArea<Label>(droid) {
  // do stuff
}

Parameters & References

Parameter/
Reference
TypeMandatoryDescriptionGame version
<LABEL><Label>

String

(tick)

The name of the label , which is always in uppercase, is appended to associated with the Area object is part of the event name.

For clarification, there is no "eventArea()" event, only variations of that event name that include a label. For example, if there is an Area object with label "FOOFoo", the event when a droid first enters that area will be called "eventAreaFOOeventAreaFoo()".

(question)3.2
droid

Droid object

(tick)

The droid that entered the area.

3.2

Return value

Warzone does not process the event handler's return value.

Notes

Note:

The event only triggers once when a droid first enters it. If you want the event to trigger again in the future, you'll need to reset the area trigger using the resetArea() function

.(question)

Return value

Warzone does not process the event handler's return value.

Notes

You can define areas inside maps via the labels.ini file(see example below).

You can define labelled Area objects at runtime and use them to trigger this event. For more information and example code, see: addLabel().

Example

Code Block
themeRDark
languagejavascript
titleWork out who our main aggressors are
linenumberstrue
// assuming we've labelled an area FOOFoo
function eventAreaFOOeventAreaFoo(droid) {
	// let's reset the area so it triggers again in future
	resetArea("FOOFoo"); //
event will get fired next time a droid enters
}
Div
classbox
Availability
Status
colourYellow
title3.2+

Requires:

  • Warzone 3.2

See forum topic for more information.

See also

Related articles:

  • resetArea() – reset an area so it's associated event will be triggered the next time a droid enters it
  • Area object – objects associated with areas
  • addLabel() – add labels to objects
  • enumLabels() – get a list of labelled objects
  • label() – get an object associated with a specific label
    Div
    classbox
    Contents

    Jump to:

    Table of Contents
    maxLevel5

    Div
    classbox

    Include Page
    .jslinks-labels
    .jslinks-labels