Drag[en]gine Script Module DragonScript Script API  1.0
FindSpawnPointProcessor Class Reference
Inheritance diagram for FindSpawnPointProcessor:
ElementProcessor

Public Member Functions

String getClassname ()
 
int getReferenceNumber ()
 
SpawnPoint getSpawnPoint ()
 
bool hasSpawnPoint ()
 
FindSpawnPointProcessor new (String className, int refNum)
 
bool processElement (Element element)
 

Detailed Description

Finds the spawn point matching the given classname and reference number.

Author
Roland Pl├╝ss
Version
1.0

Member Function Documentation

§ getClassname()

String getClassname ( )

Retrieves the classname to look for.

Returns
classname to look for

§ getReferenceNumber()

int getReferenceNumber ( )

Retrieves the reference number to look for.

Returns
reference number to look for

§ getSpawnPoint()

SpawnPoint getSpawnPoint ( )

Retrieves the found spawn point or null if not found.

Returns
spawn point or null

§ hasSpawnPoint()

bool hasSpawnPoint ( )

Determines if a spawn point has been found.

Returns
true if a spawn point has been found

§ new()

FindSpawnPointProcessor new ( String  className,
int  refNum 
)

Creates a new FindSpawnPointProcessor object.

Parameters
classNameClassname to look for
refNumReference number to look for

§ processElement()

bool processElement ( Element  element)

Processes an element. Return true if you want to process more elements of false to stop.

Parameters
elementElement to process
Returns
true to continue processing elements or false to stop

Implements ElementProcessor.


The documentation for this class was generated from the following file: