aom.scripting.xs.tr

Enum TriggerParamType

Object

Enum<TriggerParamType>

TriggerParamType

All Implemented Interfaces:

Serializable, Comparable<TriggerParamType>

public enum TriggerParamType
extends Enum<TriggerParamType>

This is an enumeration of all parameter types a trigger can use as input.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALLIANCE A drop down list of diplomacy settings.
AREA A "select area" style button.
BOOL A button that can be switched ON or OFF.
CAMERAINFO A set of "Set Cut" style buttons.
CAMTRACK A drop down list of camera tracks.
EVENT A drop down list of triggers.
FLOAT An input box for floats.
GODPOWER A drop down list of god powers.
GROUP Army selection tools.
KBSTAT A drop down list of statistics.
LONG An input box for integers.
OPERATOR A drop down list of operators.
PLAYER A drop down list of player numbers.
PROTOUNIT A drop down list of different unit types.
PUFIELD A drop down list of modifiable unit fields.
RESOURCE A drop down list of resources.
SOUND Select sound style tools.
STRING An input box for strings.
STRINGID Seems to be the same as string, but it may have internal differences.
TECH A drop down list of technologies.
TECHSTATUS A drop down list of possible technology statuses.
UICATEGORY A drop down list of UI categories.
UNIT A "select unit" style button that returns the name of the selected unit.
UNITSTANCE A drop down list of unit stances.

Method Summary

Modifier and Type	Method and Description
static TriggerParamType	valueOf(String name) Returns the enum constant of this type with the specified name.
static TriggerParamType[]	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

LONG

public static final TriggerParamType LONG

An input box for integers.

Example

-1

FLOAT

public static final TriggerParamType FLOAT

An input box for floats.

Example

-1.0

STRING

public static final TriggerParamType STRING

An input box for strings.

Example

default

STRINGID

public static final TriggerParamType STRINGID

Seems to be the same as string, but it may have internal differences.

Example

default

BOOL

public static final TriggerParamType BOOL

A button that can be switched ON or OFF. Returns either true or false.

UNIT

public static final TriggerParamType UNIT

A "select unit" style button that returns the name of the selected unit.

Example

5

GROUP

public static final TriggerParamType GROUP

Army selection tools.

Example

1,11 (player 1, army 11)

AREA

public static final TriggerParamType AREA

A "select area" style button.

Example

0, 0, 0

SOUND

public static final TriggerParamType SOUND

Select sound style tools.

Note

Yes, that's a correct example. The 1 seems to be ununsed, might be something like volume level though.

Example

music_file","1

CAMERAINFO

public static final TriggerParamType CAMERAINFO

A set of "Set Cut" style buttons. Returns 4 vectors (position, direction, up, right) that exactly define the current camera position.

CAMTRACK

public static final TriggerParamType CAMTRACK

A drop down list of camera tracks.

Example

My_Camera_Track

OPERATOR

public static final TriggerParamType OPERATOR

A drop down list of operators. Two sets are available:

• >
• >=
• ==
• <=
• <

or

• +
• -
• *
• /

The choice of set is decided by the default value you enter.

PLAYER

public static final TriggerParamType PLAYER

A drop down list of player numbers. Does not contain player 11 and 12. Therefore, you better use LONG to choose a player.

Example

1

TECH

public static final TriggerParamType TECH

A drop down list of technologies.

See Also:

Technology Constants in AI Reference.

Example

123

PROTOUNIT

public static final TriggerParamType PROTOUNIT

A drop down list of different unit types.

Example

Villager Greek

ALLIANCE

public static final TriggerParamType ALLIANCE

A drop down list of diplomacy settings. Returns either Ally, Neutral or Enemy.

KBSTAT

public static final TriggerParamType KBSTAT

A drop down list of statistics. Complete List:

0. Tribute Received
1. Tribute Sent
2. Enemy Units Killed
3. Enemy Builings Killed
4. Units Killed Cost
5. Buildings Killed Cost
6. Units Lost
7. Builings Lost
8. Units Lost Cost
9. Buildings Lost Cost
10. Map Explored
11. Trade Profit
12. MIlitary Count
13. Research Count Complete
14. Research Total Cost
15. Wonder Time
16. Raw Score
17. Relic High
18. Economic Unit High
19. Settlement High

Example

0

GODPOWER

public static final TriggerParamType GODPOWER

A drop down list of god powers.

Example

Reverse Time

RESOURCE

public static final TriggerParamType RESOURCE

A drop down list of resources. Returns either food, wood, gold or favor.

EVENT

public static final TriggerParamType EVENT

A drop down list of triggers.

Example

Trigger0

TECHSTATUS

public static final TriggerParamType TECHSTATUS

A drop down list of possible technology statuses.

See Also:

Technology Status Constants in AI Reference.

Example

1

UNITSTANCE

public static final TriggerParamType UNITSTANCE

A drop down list of unit stances. Returns either Aggressive, Defensive or Passive.

UICATEGORY

public static final TriggerParamType UICATEGORY

A drop down list of UI categories. Complete List:

0. market
1. market2
2. setgather
3. cleargather
4. eject
5. garrison
6. transform
7. stance1
8. stance2
9. stance3
10. townbell
11. returntowork
12. guard
13. patrol
14. AgeUp1
15. AgeUp2
16. AgeUp3
17. Repair
18. Empower
19. CombatOn
20. CombatOff
21. Formation1
22. Formation2
23. Formation3
24. Formation4
25. Delete
26. Stop
27. Unbuild
28. Unbuild2
29. SummonWorkers

Example

1

PUFIELD

public static final TriggerParamType PUFIELD

A drop down list of modifiable unit fields. Complete List:

0. HP
1. Speed
2. LOS
3. Train Points
4. Build Points
5. Max Contained
6. Pop Count
7. Pop Cap Addition
8. Lifespan
9. Recharge Time
10. Build Limit
11. Range
12. Minimum Range
13. Num. Projectiles
14. Healing Rate
15. Healing Range
16. Cost Gold
17. Cost Wood
18. Cost Food
19. Cost Favor
20. Carry Capacity Gold
21. Carry Capacity Wood
22. Carry Capacity Food
23. Carry Capacity Favor
24. Armor Hack
25. Armor Pierce
26. Armor Crush
27. Hand Attack Hack
28. Hand Attack Pierce
29. Hand Attack Crush
30. Ranged Attack Hack
31. Ranged Attack Pierce
32. Ranged Attack Crush
33. Hand Bonus v. Myth
34. Hand Bonus v. Hero
35. Hand Bonus v. Cavalry
36. Hand Bonus v. Infantry
37. Hand Bonus v. Archer
38. Hand Bonus v. Siege
39. Hand Bonus v. Tower
40. Hand Bonus v. Ship
41. Hand Bonus v. Buildings
42. Hand Bonus v. Villagers
43. Hand Bonus v. Huntable Animal
44. Ranged Bonus v. Myth
45. Ranged Bonus v. Hero
46. Ranged Bonus v. Cavalry
47. Ranged Bonus v. Infantry
48. Ranged Bonus v. Archer
49. Ranged Bonus v. Siege
50. Ranged Bonus v. Tower
51. Ranged Bonus v. Ship
52. Ranged Bonus v. Buildings
53. Ranged Bonus v. Villagers
54. Ranged Bonus v. Huntable Animal

Example

2

Method Detail

values

public static TriggerParamType[] 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 (TriggerParamType c : TriggerParamType.values())
    System.out.println(c);

Returns:

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

valueOf

public static TriggerParamType 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