Triggers

Object
- Triggers

```
public abstract class Triggers
extends Object
```
This class provides a collection of Trigger commands that don't fit in any of the subcategories.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Field Summary

Fields
Modifier and Type	Field and Description
`vector`	`cInvalidVector` The invalid vector (-1,-1,-1).
`int`	`cNumberPlayers` Total number of players, mother nature included.
`vector`	`cOriginVector` The vector indicating the bottom of the map, i.e.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`trAddToPlayerCustomScore(int player, int deltaScore)` Adds to the player's custom score bonus.
`void`	`trAIFunc(int playerID, string functionName, float param)` Fires a function in the current AI file.
`bool`	`trArmyDispatch(string SrcArmy, string ProtoName, int Count, float x, float y, float z, int Heading, bool Clear)` Creates the units in the army specified.
`bool`	`trCheckGPActive(string godPower, int playerID)` Returns whether that GP type, for that player, is currently in effect.
`void`	`trClearCounterDisplay()` Clears a counter display.
`void`	`trCounterAbort(string name)` Abort a counter
`void`	`trCounterAddTime(string name, int start, int stop, string message, int eventID)` Start a counter that may or may not fire an event.
`void`	`trCounterAddUnit(string name, int playerID, int count, string protoUnit, string message, int eventID)` Start a counter that may or may not fire an event.
`int`	`trCountUnitsInArea(int centerUnitID, int matchPlayer, int matchType, float range)` Returns the number of units in an area that match the params.
`void`	`trDelayedRuleActivation(string rulename)` Adds a rule to the runtime to be activated on the next update.
`void`	`trEcho(string echoString)` Prints the given string to the RTS3banglog.txt file in the AoM folder.
`void`	`trEchoStatValue(int playerID, int statID)` Fetch a stat value from the KB and echo to chat.
`void`	`trEndGame()` Signal that the game has ended
`void`	`trEventFire(int eventID)` Cause an event to occur.
`void`	`trEventSetHandler(int eventID, string handlerFunction)` Sets a handler function f(int status) for an eventID.
`void`	`trForbidProtounit(int playerID, string protoname)` Adds protounit to the forbidden list.
`void`	`trGameLoadScenario(string scenarioName)` Start a game using scenario.
`void`	`trGamePause(bool pause)` Pause or unpause the game.
`void`	`trGenerateLush()` Force generation of lush from a pre-placed building.
`int`	`trGetGPUsedTime(string godPower, int playerID)` Returns the time when that GP was first used, or -1 for unused.
`int`	`trGetStatValue(int playerID, int statID)` Fetch a stat value from the KB
`int`	`trGetWorldDifficulty()` Returns the world difficulty.
`void`	`trHidePersistentScoreMessage()` Hide the peristent score message.
`void`	`trMessageSetText(string message, int timeout)` Displays a message box at the top of the screen with the given message.
`void`	`trMinimapFlare(int playerID, float duration, vector position, bool flash)` Sends a Minimap flare to a certain player.
`void`	`trModeEnter(string modeName)` Enters the mode specified.
`void`	`trModifyProtounit(string protoUnit, int playerID, int field, float delta)` Modifies protounit data for this scenario only.
`void`	`trObjectiveSetID(int missionNum, int objectiveID)` Sets the objective text.
`void`	`trRateConstruction(float rate)` Modify construction rate.
`void`	`trRateResearch(float rate)` Modify research rate.
`void`	`trRatesNormal()` Restore all rates to normal.
`void`	`trRateTrain(float rate)` Modify training rate
`void`	`trRevealEntireMap()` Shows whole map, similar to how revealed mode works.
`void`	`trSetCivilizationNameOverride(int playerID, string civName)` Override display name of a civilization dynamically.
`void`	`trSetCounterDisplay(string text)` Sets the current fake-counter text.
`void`	`trSetDisableGPBlocking(bool b)` Enable or Disable GP blocking (e.g.
`void`	`trSetFogAndBlackmap(bool fog, bool blackmap)` Turn fog and black map on/off.
`void`	`trSetLighting(string setName, float fadeTime)` Fades to the specified lighting set over a given fadeTime.
`void`	`trSetPauseInObjectiveWindow()` Automatically pauses the game if the Objectives windows opens.
`void`	`trSetPauseOnAgeUpgrade()` Automatically pauses the game if the Age Advancement windows opens.
`void`	`trSetPlayerCustomScore(int player, int newScoreValue)` Sets the player's custom score bonus.
`void`	`trSetRelicType(int techID)` Changes the effect of the selected relic to this custom techID.
`void`	`trSetTimeOfDay(float alpha)` Sets the time of day: 0.0 - 1.0.
`void`	`trSetTimeOfDayPeriod(float period)` Sets the day-night cycle period in seconds.
`void`	`trShowChoiceDialog(string maintext, string choice1, int event1ID, string choice2, int event2ID)` Displays dialog with 2 choices, and activates a trigger in response.
`void`	`trShowPersistentScoreMessage(int player)` Shows the player's kill/loss ratio as the score persistently.
`void`	`trShowScoreMessage(int player, string soundfile)` Shows the player's kill/loss ratio as the score.
`void`	`trShowWinLose(string text, string soundfile, float volume)` Shows a win/lose message and plays a sound.
`void`	`trStartGameRecord()` Starts recording the game.
`void`	`trStopGameRecord()` Stops recording the game.
`void`	`trTechGodPower(int playerID, string techName, int numUses)` Adds X uses to the specified god power.
`void`	`trTechGodPowerAtPosition(int playerID, string techName, int numUses, int slot)` Adds X uses to the specified god power in a specific GP slot (1-4).
`void`	`trTechInvokeGodPower(int playerID, string techName, vector pos1, vector pos2)` Invokes the specified god power.
`void`	`trTechSetStatus(int playerID, int techID, int statusID)` Sets the technology status for the player.
`bool`	`trTechStatusActive(int playerID, int techID)` Returns true if technology is active for player.
`bool`	`trTechStatusResearching(int playerID, int techID)` Returns true if technology is being researched for player.
`int`	`trTime()` Returns the current game time in Seconds.
`int`	`trTimeMS()` Returns the current game time in Milliseconds.
`void`	`trUnforbidProtounit(int playerID, string protoName)` Removes proto unit from the forbidden list.
`void`	`trWriteToLog(string message)` Writes text to the rts3banglog

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- cNumberPlayers
```
public final int cNumberPlayers
```
  Total number of players, mother nature included.
- cOriginVector
```
public final vector cOriginVector
```
  The vector indicating the bottom of the map, i.e. (0, 0, 0).
- cInvalidVector
```
public final vector cInvalidVector
```
  The invalid vector (-1,-1,-1).

Method Detail

trAIFunc

public void trAIFunc(int playerID,
                     string functionName,
                     float param)

Fires a function in the current AI file.

trArmyDispatch

public bool trArmyDispatch(string SrcArmy,
                           string ProtoName,
                           int Count,
                           float x,
                           float y,
                           float z,
                           int Heading,
                           bool Clear)

Creates the units in the army specified. Only works for human players online. Returns true if successful.

trCheckGPActive

public bool trCheckGPActive(string godPower,
                            int playerID)

Returns whether that GP type, for that player, is currently in effect.

trClearCounterDisplay
```
public void trClearCounterDisplay()
```
Clears a counter display.

trCounterAbort

public void trCounterAbort(string name)

Abort a counter

trCounterAddTime

public void trCounterAddTime(string name,
                             int start,
                             int stop,
                             string message,
                             int eventID)

Start a counter that may or may not fire an event.

trCounterAddUnit

public void trCounterAddUnit(string name,
                             int playerID,
                             int count,
                             string protoUnit,
                             string message,
                             int eventID)

Start a counter that may or may not fire an event.

trCountUnitsInArea

public int trCountUnitsInArea(int centerUnitID,
                              int matchPlayer,
                              int matchType,
                              float range)

Returns the number of units in an area that match the params.

trDelayedRuleActivation
```
public void trDelayedRuleActivation(string rulename)
```
Adds a rule to the runtime to be activated on the next update. This causes the rule to be delayed by a small fraction of time, but often enough to properly complete commands that might take a little while.

See Also:

xsEnableRule(string)

trEcho
```
public void trEcho(string echoString)
```
Prints the given string to the RTS3banglog.txt file in the AoM folder.

trEchoStatValue

public void trEchoStatValue(int playerID,
                            int statID)

Fetch a stat value from the KB and echo to chat.

trEndGame
```
public void trEndGame()
```
Signal that the game has ended

trEventFire
```
public void trEventFire(int eventID)
```
Cause an event to occur. Under the hood, an eventID is generated for this event. This event is registered in the default event handler using trEventSetHandler(myEventID, "eventHandler");. Next, this piece of code is appended at the end of the eventHandler function:
```
case myEventID:
{
   xsEnableRule("_My Trigger");
   trEcho("Trigger enabling rule My Trigger");
   break;
}
```

trEventSetHandler
```
public void trEventSetHandler(int eventID,
                              string handlerFunction)
```
Sets a handler function f(int status) for an eventID. Every time this event is fired, the given hander function will automatically be called with the eventID as its status.

trForbidProtounit

public void trForbidProtounit(int playerID,
                              string protoname)

Adds protounit to the forbidden list.

trGameLoadScenario

public void trGameLoadScenario(string scenarioName)

Start a game using scenario.

trGamePause
```
public void trGamePause(bool pause)
```
Pause or unpause the game.

trGenerateLush
```
public void trGenerateLush()
```
Force generation of lush from a pre-placed building.

Since:

AoT

trGetGPUsedTime

public int trGetGPUsedTime(string godPower,
                           int playerID)

Returns the time when that GP was first used, or -1 for unused.

trGetStatValue

public int trGetStatValue(int playerID,
                          int statID)

Fetch a stat value from the KB

trGetWorldDifficulty
```
public int trGetWorldDifficulty()
```
Returns the world difficulty.

trMessageSetText

public void trMessageSetText(string message,
                             int timeout)

Displays a message box at the top of the screen with the given message.

trMinimapFlare

public void trMinimapFlare(int playerID,
                           float duration,
                           vector position,
                           bool flash)

Sends a Minimap flare to a certain player.

trModeEnter
```
public void trModeEnter(string modeName)
```
Enters the mode specified.

Local Call

See Also:

modeEnter(string)

trModifyProtounit
```
public void trModifyProtounit(string protoUnit,
                              int playerID,
                              int field,
                              float delta)
```
Modifies protounit data for this scenario only.

Parameters:

protoUnit - The name of the protounit to modify.

playerID - The player for which the modifications should occur.

field - TriggerParamType.PUFIELD

delta - The (relative) amount to change.

Since:

AoT

trObjectiveSetID

public void trObjectiveSetID(int missionNum,
                             int objectiveID)

Sets the objective text.

trRateConstruction

public void trRateConstruction(float rate)

Modify construction rate.

trRateResearch

public void trRateResearch(float rate)

Modify research rate.

trRatesNormal
```
public void trRatesNormal()
```
Restore all rates to normal.

trRateTrain
```
public void trRateTrain(float rate)
```
Modify training rate

trRevealEntireMap
```
public void trRevealEntireMap()
```
Shows whole map, similar to how revealed mode works.

See Also:

trSetFogAndBlackmap(bool, bool)

trSetCivilizationNameOverride

public void trSetCivilizationNameOverride(int playerID,
                                          string civName)

Override display name of a civilization dynamically.

Since:: AoT

trSetCounterDisplay
```
public void trSetCounterDisplay(string text)
```
Sets the current fake-counter text.

trSetDisableGPBlocking
```
public void trSetDisableGPBlocking(bool b)
```
Enable or Disable GP blocking (e.g. by isis monuments).

Since:

AoT

trSetFogAndBlackmap
```
public void trSetFogAndBlackmap(bool fog,
                                bool blackmap)
```
Turn fog and black map on/off. Similar to the console commands, this just disables the rendering of fog and blackmap. Any area that was previously unscouted will still act as if it was unscouted. To have this scouted effect, use trRevealEntireMap() instead.

See Also:

fog(), blackmap()

trSetLighting

public void trSetLighting(string setName,
                          float fadeTime)

Fades to the specified lighting set over a given fadeTime.

trSetPauseInObjectiveWindow
```
public void trSetPauseInObjectiveWindow()
```
Automatically pauses the game if the Objectives windows opens.

Single Player Only

trSetPauseOnAgeUpgrade
```
public void trSetPauseOnAgeUpgrade()
```
Automatically pauses the game if the Age Advancement windows opens.

Single Player Only

trSetRelicType
```
public void trSetRelicType(int techID)
```
Changes the effect of the selected relic to this custom techID.

trShowChoiceDialog

public void trShowChoiceDialog(string maintext,
                               string choice1,
                               int event1ID,
                               string choice2,
                               int event2ID)

Displays dialog with 2 choices, and activates a trigger in response.

Local Call: Be careful when used online. The trigger events are only fired locally, so an OoS is likely to occur if 2 players choose different options.

trShowWinLose

public void trShowWinLose(string text,
                          string soundfile,
                          float volume)

Shows a win/lose message and plays a sound.

trStartGameRecord
```
public void trStartGameRecord()
```
Starts recording the game. This functionality seems kind of broken for scenarios. Only the first couple of minutes are recorded.

trStopGameRecord
```
public void trStopGameRecord()
```
Stops recording the game.

trTechGodPower

public void trTechGodPower(int playerID,
                           string techName,
                           int numUses)

Adds X uses to the specified god power.

trTechGodPowerAtPosition

public void trTechGodPowerAtPosition(int playerID,
                                     string techName,
                                     int numUses,
                                     int slot)

Adds X uses to the specified god power in a specific GP slot (1-4).

trTechInvokeGodPower

public void trTechInvokeGodPower(int playerID,
                                 string techName,
                                 vector pos1,
                                 vector pos2)

Invokes the specified god power. Ensure that the player actually possesses the given power first. Since AoT this precondition is not required anymore for Mother Nature.

trTechSetStatus

public void trTechSetStatus(int playerID,
                            int techID,
                            int statusID)

Sets the technology status for the player.

trTechStatusActive

public bool trTechStatusActive(int playerID,
                               int techID)

Returns true if technology is active for player.

trTechStatusResearching

public bool trTechStatusResearching(int playerID,
                                    int techID)

Returns true if technology is being researched for player.

trTime
```
public int trTime()
```
Returns the current game time in Seconds.

trTimeMS
```
public int trTimeMS()
```
Returns the current game time in Milliseconds.

trUnforbidProtounit

public void trUnforbidProtounit(int playerID,
                                string protoName)

Removes proto unit from the forbidden list.

trWriteToLog

public void trWriteToLog(string message)

Writes text to the rts3banglog

trShowScoreMessage

public void trShowScoreMessage(int player,
                               string soundfile)

Shows the player's kill/loss ratio as the score.

Since:: AoM:EE

trShowPersistentScoreMessage
```
public void trShowPersistentScoreMessage(int player)
```
Shows the player's kill/loss ratio as the score persistently.

Since:

AoM:EE

trHidePersistentScoreMessage
```
public void trHidePersistentScoreMessage()
```
Hide the peristent score message.

Since:

AoM:EE

trSetTimeOfDay
```
public void trSetTimeOfDay(float alpha)
```
Sets the time of day: 0.0 - 1.0.

Since:

AoM:EE

trSetTimeOfDayPeriod
```
public void trSetTimeOfDayPeriod(float period)
```
Sets the day-night cycle period in seconds. A value of period that is less than 1.0 switches off day-night cycle.

Since:

AoM:EE

trSetPlayerCustomScore

public void trSetPlayerCustomScore(int player,
                                   int newScoreValue)

Sets the player's custom score bonus.

Since:: AoM:EE

trAddToPlayerCustomScore

public void trAddToPlayerCustomScore(int player,
                                     int deltaScore)

Adds to the player's custom score bonus.

Since:: AoM:EE

Class Triggers

Field Summary

Method Summary

Methods inherited from class Object

Field Detail

cNumberPlayers

cOriginVector

cInvalidVector

Method Detail

trAIFunc

trArmyDispatch

trCheckGPActive

trClearCounterDisplay

trCounterAbort

trCounterAddTime

trCounterAddUnit

trCountUnitsInArea

trDelayedRuleActivation

trEcho

trEchoStatValue

trEndGame

trEventFire

trEventSetHandler

trForbidProtounit

trGameLoadScenario

trGamePause

trGenerateLush

trGetGPUsedTime

trGetStatValue

trGetWorldDifficulty

trMessageSetText

trMinimapFlare

trModeEnter

trModifyProtounit

trObjectiveSetID

trRateConstruction

trRateResearch

trRatesNormal

trRateTrain

trRevealEntireMap

trSetCivilizationNameOverride

trSetCounterDisplay

trSetDisableGPBlocking

trSetFogAndBlackmap

trSetLighting

trSetPauseInObjectiveWindow

trSetPauseOnAgeUpgrade

trSetRelicType

trShowChoiceDialog

trShowWinLose

trStartGameRecord

trStopGameRecord

trTechGodPower

trTechGodPowerAtPosition

trTechInvokeGodPower

trTechSetStatus

trTechStatusActive

trTechStatusResearching

trTime

trTimeMS

trUnforbidProtounit

trWriteToLog

trShowScoreMessage

trShowPersistentScoreMessage

trHidePersistentScoreMessage

trSetTimeOfDay

trSetTimeOfDayPeriod

trSetPlayerCustomScore

trAddToPlayerCustomScore