aom.scripting.xs.kb

Class TargetSelector

Object

TargetSelector

public class TargetSelector
extends Object

This class provides a collection of KB commands concerning Target Selectors.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Method Summary

Modifier and Type	Method and Description
bool	kbTargetSelectorAddQueryResults(int queryID) Sets the list of potential targets to the results in the given query.
bool	kbTargetSelectorAddUnitType(int baseUnitTypeID) Add the UAIT for the given base unit type as a filter.
int	kbTargetSelectorCreate(string name) Creates a target selector and returns the ID.
bool	kbTargetSelectorDestroy(int id) Destroys the given target selector.
int	kbTargetSelectorGetNumberResults() Returns the number of results in the given target selector.
int	kbTargetSelectorGetResultValue(int index) Returns the result value for given index of the current target selector.
bool	kbTargetSelectorResetResults() Resets the current target selector.
bool	kbTargetSelectorSelect(int id) Selects the given target selector.
bool	kbTargetSelectorStart() Starts the current target selector.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

kbTargetSelectorCreate

public int kbTargetSelectorCreate(string name)

Creates a target selector and returns the ID.

kbTargetSelectorDestroy

public bool kbTargetSelectorDestroy(int id)

Destroys the given target selector.

kbTargetSelectorResetResults

public bool kbTargetSelectorResetResults()

Resets the current target selector.

kbTargetSelectorSelect

public bool kbTargetSelectorSelect(int id)

Selects the given target selector.

kbTargetSelectorAddUnitType

public bool kbTargetSelectorAddUnitType(int baseUnitTypeID)

Add the UAIT for the given base unit type as a filter.

kbTargetSelectorAddQueryResults

public bool kbTargetSelectorAddQueryResults(int queryID)

Sets the list of potential targets to the results in the given query.

kbTargetSelectorGetNumberResults

public int kbTargetSelectorGetNumberResults()

Returns the number of results in the given target selector.

kbTargetSelectorGetResultValue

public int kbTargetSelectorGetResultValue(int index)

Returns the result value for given index of the current target selector.

kbTargetSelectorStart

public bool kbTargetSelectorStart()

Starts the current target selector.