aom.scripting.xs.ai

Enum UnitAITypes

Object

Enum<UnitAITypes>

UnitAITypes

All Implemented Interfaces:

Serializable, Comparable<UnitAITypes>

public enum UnitAITypes
extends Enum<UnitAITypes>

Unit AI Types are a collection of flags that define how the low level AI handles unit interactions. It's quite a primitive yet powerful system. However, certain proto flags tend to override this behavior.

The format is as follows:

  Type "Name of type" (this will be the name you use in proto)
  [A collection of flags from the list below, 1 per line.]
 

Author:

Mythic_Freak - mythic.freak[a]gmail.com

See Also:

unitaitypes.txt file.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Attack If followed by a unit type: turns "can attack" ON for "Unit Type". Else: turns "can attack" ON for every type.
AutoAttack If followed by a unit type: turns "auto attack" ON for "Unit Type". Else: turns "auto attack" ON for every type.
NoAttack If followed by a unit type: turns "can attack" OFF for "Unit Type". Else: turns "can attack" OFF for every type.
NoAutoAttack If followed by a unit type: turns "auto attack" OFF for "Unit Type". Else: turns "auto attack" OFF for every type.
NoRespondToAttack If followed by a unit type: turns "attack response" OFF for "Unit Type". Else: turns "attack response" OFF for every type.
NoRunAway Restricts these units from running away when they cannot return an attack.
RespondToAttack If followed by a unit type: turns "attack response" ON for "Unit Type". Else: turns "attack response" ON for every type.

Method Summary

Modifier and Type	Method and Description
static UnitAITypes	valueOf(String name) Returns the enum constant of this type with the specified name.
static UnitAITypes[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Attack

public static final UnitAITypes Attack

If followed by a unit type: turns "can attack" ON for "Unit Type".
Else: turns "can attack" ON for every type.

NoAttack

public static final UnitAITypes NoAttack

If followed by a unit type: turns "can attack" OFF for "Unit Type".
Else: turns "can attack" OFF for every type.

AutoAttack

public static final UnitAITypes AutoAttack

If followed by a unit type: turns "auto attack" ON for "Unit Type".
Else: turns "auto attack" ON for every type.

NoAutoAttack

public static final UnitAITypes NoAutoAttack

If followed by a unit type: turns "auto attack" OFF for "Unit Type".
Else: turns "auto attack" OFF for every type.

RespondToAttack

public static final UnitAITypes RespondToAttack

If followed by a unit type: turns "attack response" ON for "Unit Type".
Else: turns "attack response" ON for every type.

NoRespondToAttack

public static final UnitAITypes NoRespondToAttack

If followed by a unit type: turns "attack response" OFF for "Unit Type".
Else: turns "attack response" OFF for every type.

NoRunAway

public static final UnitAITypes NoRunAway

Restricts these units from running away when they cannot return an attack.

Method Detail

values

public static UnitAITypes[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (UnitAITypes c : UnitAITypes.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static UnitAITypes valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null