aom.scripting.xs.kb

Class Query

Object

Query

public class Query
extends Object

This class provides a collection of KB commands concerning Queries. Queries are a powerful search engine: they provide you with a way to get the IDs of units matching your criteria fast and effectively.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
int	cUnitQueryInvalidArmy
int	cUnitQueryNoArmy

Method Summary

Modifier and Type	Method and Description
int	kbGetPopulationSlotsByQueryID(int queryID) Returns the number of pop slots currently occupied by the results in the given query.
int	kbUnitQueryCreate(string name) Creates a unit query, returns the query ID.
bool	kbUnitQueryDestroy(long queryID) Destroys the given unit query.
int	kbUnitQueryExecute(long queryID) Executes the current query; returns number of results.
int	kbUnitQueryExecuteOnQuery(long currentQueryID, int previousQueryID) Executes the current query on the previous query's results; returns the new number of results.
int	kbUnitQueryExecuteOnQueryByName(long currentQueryID, string previousQueryName) Executes the current query on the previous query's results; returns the new number of results.
int	kbUnitQueryGetResult(long queryID, int index) Returns the UnitID of the index'th result in the current query.
int	kbUnitQueryNumberResults(long queryID) Returns the number of results in the current query.
bool	kbUnitQueryResetData(long queryID) Resets the given unit query data AND results.
bool	kbUnitQueryResetResults(long queryID) Resets the given unit query results.
bool	kbUnitQuerySetActionType(long queryID, int actionTypeID) Sets query data.
bool	kbUnitQuerySetAreaGroupID(long queryID, int areaGroupID) Sets query data.
bool	kbUnitQuerySetAreaID(long queryID, int areaID) Sets query data.
bool	kbUnitQuerySetArmyID(long queryID, int armyID) Sets query data.
bool	kbUnitQuerySetAscendingSort(long queryID, bool ascending) If ascending is true, results are sorted in ascending distance order from the query position.
bool	kbUnitQuerySetBaseID(long queryID, int baseID) Sets query data.
bool	kbUnitQuerySetMaximumDistance(long queryID, float distance) Sets query data.
bool	kbUnitQuerySetPlayerID(long queryID, int playerID, bool resetQueryData) Sets query data.
bool	kbUnitQuerySetPlayerRelation(long queryID, int playerRelation) Sets query data.
bool	kbUnitQuerySetPosition(long queryID, vector v) Sets query data.
bool	kbUnitQuerySetSeeableOnly(long queryID, bool seeableOnly) Sets query data.
bool	kbUnitQuerySetState(long queryID, int state) Sets query data.
bool	kbUnitQuerySetUnitType(long queryID, int unitTypeID) Sets query data.

Methods inherited from class Object

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

Field Detail

cUnitQueryNoArmy

public final int cUnitQueryNoArmy

See Also:

Constant Field Values

cUnitQueryInvalidArmy

public final int cUnitQueryInvalidArmy

See Also:

Constant Field Values

Method Detail

kbGetPopulationSlotsByQueryID

public int kbGetPopulationSlotsByQueryID(int queryID)

Returns the number of pop slots currently occupied by the results in the given query.

kbUnitQueryCreate

public int kbUnitQueryCreate(string name)

Creates a unit query, returns the query ID.

kbUnitQueryResetData

public bool kbUnitQueryResetData(long queryID)

Resets the given unit query data AND results.

kbUnitQueryResetResults

public bool kbUnitQueryResetResults(long queryID)

Resets the given unit query results.

kbUnitQueryDestroy

public bool kbUnitQueryDestroy(long queryID)

Destroys the given unit query.

kbUnitQueryNumberResults

public int kbUnitQueryNumberResults(long queryID)

Returns the number of results in the current query.

kbUnitQueryGetResult

public int kbUnitQueryGetResult(long queryID,
                                int index)

Returns the UnitID of the index'th result in the current query.

kbUnitQuerySetPlayerID

public bool kbUnitQuerySetPlayerID(long queryID,
                                   int playerID,
                                   bool resetQueryData)

Sets query data.

kbUnitQuerySetPlayerRelation

public bool kbUnitQuerySetPlayerRelation(long queryID,
                                         int playerRelation)

Sets query data.

kbUnitQuerySetUnitType

public bool kbUnitQuerySetUnitType(long queryID,
                                   int unitTypeID)

Sets query data.

kbUnitQuerySetActionType

public bool kbUnitQuerySetActionType(long queryID,
                                     int actionTypeID)

Sets query data.

kbUnitQuerySetState

public bool kbUnitQuerySetState(long queryID,
                                int state)

Sets query data.

kbUnitQuerySetPosition

public bool kbUnitQuerySetPosition(long queryID,
                                   vector v)

Sets query data.

kbUnitQuerySetMaximumDistance

public bool kbUnitQuerySetMaximumDistance(long queryID,
                                          float distance)

Sets query data.

kbUnitQuerySetAscendingSort

public bool kbUnitQuerySetAscendingSort(long queryID,
                                        bool ascending)

If ascending is true, results are sorted in ascending distance order from the query position.

kbUnitQuerySetBaseID

public bool kbUnitQuerySetBaseID(long queryID,
                                 int baseID)

Sets query data.

kbUnitQuerySetAreaID

public bool kbUnitQuerySetAreaID(long queryID,
                                 int areaID)

Sets query data.

kbUnitQuerySetAreaGroupID

public bool kbUnitQuerySetAreaGroupID(long queryID,
                                      int areaGroupID)

Sets query data.

kbUnitQuerySetArmyID

public bool kbUnitQuerySetArmyID(long queryID,
                                 int armyID)

Sets query data.

kbUnitQuerySetSeeableOnly

public bool kbUnitQuerySetSeeableOnly(long queryID,
                                      bool seeableOnly)

Sets query data.

kbUnitQueryExecute

public int kbUnitQueryExecute(long queryID)

Executes the current query; returns number of results.

kbUnitQueryExecuteOnQuery

public int kbUnitQueryExecuteOnQuery(long currentQueryID,
                                     int previousQueryID)

Executes the current query on the previous query's results; returns the new number of results.

kbUnitQueryExecuteOnQueryByName

public int kbUnitQueryExecuteOnQueryByName(long currentQueryID,
                                           string previousQueryName)

Executes the current query on the previous query's results; returns the new number of results.