TorqueDoc

Public Functions

int ExampleMode::assignBotObjectives (
ExampleMode this
AiController bot
)

Gives objectives to a bot.

Returns:: -1 if default objectives should not be assigned
See Also:: Slayer_AiController::addObjective

6function ExampleMode::assignBotObjectives ( %this, %bot )

bool ExampleMode::miniGameCanDamage (
ExampleMode this
SimObject objA
SimObject objB
)

Determines whether an object can be damaged.

Returns:: Whether the object can be damaged.

12function ExampleMode::miniGameCanDamage ( %this, %objA, %objB )

bool ExampleMode::miniGameCanUse (
ExampleMode this
SimObject objA
SimObject objB
)

Determines whether an object can be used.

Returns:: Whether the object can be used.

24function ExampleMode::miniGameCanUse ( %this, %objA, %objB )

bool ExampleMode::miniGameClientCanDamage (
ExampleMode this
GameConnection clientA
GameConnection clientB
)

Determines whether an object belonging to a client can be damaged by that of another client.

Returns:: Whether the object can be damaged.

18function ExampleMode::miniGameClientCanDamage ( %this, %clientA, %clientB )

void ExampleMode::onClientChat (
ExampleMode this
GameConnection client
string msg
)

Called when the client talks.

37function ExampleMode::onClientChat ( %this, %client, %msg )

void ExampleMode::onClientDisplayRules (
ExampleMode this
GameConnection client
)

Called when minigame rules are displayed to the client.

Can be used to display additional game mode rules or information.

42function ExampleMode::onClientDisplayRules ( %this, %client )

void ExampleMode::onClientJoinGame (
ExampleMode this
GameConnection client
)

Called when a client joins the minigame.

28function ExampleMode::onClientJoinGame ( %this, %client )

void ExampleMode::onClientJoinTeam (
ExampleMode this
Slayer_TeamSO team
GameConnection client
)

Called when a client joins the team.

173function ExampleMode::onClientJoinTeam ( %this, %team, %client )

void ExampleMode::onClientLeaveGame (
ExampleMode this
GameConnection client
)

Called when a client leaves the minigame.

32function ExampleMode::onClientLeaveGame ( %this, %client )

void ExampleMode::onClientLeaveTeam (
ExampleMode this
Slayer_TeamSO team
GameConnection client
)

Called when a client leaves the team.

178function ExampleMode::onClientLeaveTeam ( %this, %team, %client )

void ExampleMode::onClientSetScore (
ExampleMode this
GameConnection client
int score
)

Called when the client's score changes.

47function ExampleMode::onClientSetScore ( %this, %client, %score )

void ExampleMode::onClientSpectateFree (
ExampleMode this
GameConnection client
)

Called when the client enters free-spectate mode.

51function ExampleMode::onClientSpectateFree ( %this, %client )

void ExampleMode::onClientSpectateTarget (
ExampleMode this
GameConnection client
GameConnection target
)

Called when the client spectates another client.

56function ExampleMode::onClientSpectateTarget ( %this, %client, %target )

void ExampleMode::onCPCapture (
ExampleMode this
FxDtsBrick capturePoint
int color
int oldColor
GameConnection client
)

Called when a capture point is captured.

70function ExampleMode::onCPCapture ( %this, %capturePoint, %color, %oldColor, %client )

void ExampleMode::onCPReset (
ExampleMode this
FxDtsBrick capturePoint
int color
int oldColor
GameConnection client
)

Called when a capture point is reset.

63function ExampleMode::onCPReset ( %this, %capturePoint, %color, %oldColor, %client )

string ExampleMode::onCreateDeathMessage (
ExampleMode this
GameConnection client
GameConnection killer
string value — The current death message.
)

Called when a player's death message is being created.

Returns:: A modified death message in Support_SpecialKills notation.

77function ExampleMode::onCreateDeathMessage ( %this, %client, %killer, %value )

void ExampleMode::onGameModeEnd (
ExampleMode this
)

Called when the game mode ends.

83function ExampleMode::onGameModeEnd ( %this )

void ExampleMode::onGameModeStart (
ExampleMode this
)

Called when the game mode begins.

80function ExampleMode::onGameModeStart ( %this )

string ExampleMode::onMiniGameBrickAdded (
ExampleMode this
FxDtsBrick brick
string type — The Slayer brick type designation.
)

Called when a Slayer brick, such as a team spawn, is added.

Returns:: Message to display when the brick is planted.

99function ExampleMode::onMiniGameBrickAdded ( %this, %brick, %type )

void ExampleMode::onMiniGameBrickRemoved (
ExampleMode this
FxDtsBrick brick
string type — The Slayer brick type designation.
)

Called when a Slayer brick, such as a team spawn, is removed.

104function ExampleMode::onMiniGameBrickRemoved ( %this, %brick, %type )

void ExampleMode::onMinigameReset (
ExampleMode this
GameConnection client — The client that reset the minigame.
)

Called after the minigame has been reset.

See Also:: ExampleMode::preMinigameReset

88function ExampleMode::onMinigameReset ( %this, %client )

void ExampleMode::onObserverTrigger (
ExampleMode this
Observer observer
Camera camera
int button
bool state
GameConnection client
)

Called when a client presses a button in spectator mode.

112function ExampleMode::onObserverTrigger ( %this, %observer, %camera, %button, %state, %client )

int ExampleMode::onPlayerDeath (
ExampleMode this
GameConnection client
var obj
GameConnection killer
var type
var area
)

Called after the death message has displayed.

Returns:: -1 will prevent minigame resetting when out of lives - deprecated

121function ExampleMode::onPlayerDeath ( %this, %client, %obj, %killer, %type, %area )

void ExampleMode::onPlayerSpawn (
ExampleMode this
GameConnection client
)

115function ExampleMode::onPlayerSpawn ( %this, %client )

void ExampleMode::onPreRoundCountdownTick (
ExampleMode this
int totalTicks
int remainingTicks
)

130function ExampleMode::onPreRoundCountdownTick ( %this, %totalTicks, %remainingTicks )

void ExampleMode::onRoundEnd (
ExampleMode this
)

Called after the end-of-round announcement.

143function ExampleMode::onRoundEnd ( %this )

void ExampleMode::onRoundStart (
ExampleMode this
)

Called when a new round begins.

133function ExampleMode::onRoundStart ( %this )

void ExampleMode::onTeamAdd (
ExampleMode this
Slayer_TeamSO team
)

Called when a team is created.

147function ExampleMode::onTeamAdd ( %this, %team )

void ExampleMode::onTeamChat (
ExampleMode this
GameConnection client
string msg
)

Called when the client uses team chat.

168function ExampleMode::onTeamChat ( %this, %client, %msg )

void ExampleMode::onTeamRemove (
ExampleMode this
Slayer_TeamSO team
)

Called when a team is removed.

151function ExampleMode::onTeamRemove ( %this, %team )

void ExampleMode::onTeamShuffle (
ExampleMode this
Slayer_TeamHandlerSG teamHandler — The team group.
int shuffleMode
bool doNotRespawn
)

Called when teams are shuffled.

157function ExampleMode::onTeamShuffle ( %this, %teamHandler, %shuffleMode, %doNotRespawn )

void ExampleMode::onTeamSwap (
ExampleMode this
Slayer_TeamHandlerSG teamHandler — The team group.
GameConnection clientA
GameConnection clientB
)

Called when clients swap teams.

163function ExampleMode::onTeamSwap ( %this, %teamHandler, %clientA, %clientB )

vector3F ExampleMode::pickPlayerSpawnPoint (
ExampleMode this
GameConnection client
)

Chooses a spawn point for the player.

Returns:: The position for the player to spawn at.

183function ExampleMode::pickPlayerSpawnPoint ( %this, %client )

void ExampleMode::preMinigameReset (
ExampleMode this
GameConnection client — The client that reset the minigame.
)

Called before the minigame has been reset.

See Also:: ExampleMode::onMinigameReset

93function ExampleMode::preMinigameReset ( %this, %client )

void ExampleMode::prePlayerDeath (
ExampleMode this
GameConnection client
var obj
GameConnection killer
var type
var area
)

Called before the death message has displayed.

126function ExampleMode::prePlayerDeath ( %this, %client, %obj, %killer, %type, %area )

void ExampleMode::preRoundEnd (
ExampleMode this
)

Called before the end-of-round announcement.

138function ExampleMode::preRoundEnd ( %this )

string ExampleMode::scoreListAdd (
ExampleMode this
Slayer_TeamSO object — The player/team to add.
string line — The default tagged string. Default: '<color:%1><b>%2</b></color>\t%3\t%4\t%5\t%6<br>'
string var1 — Value that corresponds to tag in line.
string var2 — Value that corresponds to tag in line.
string var3 — Value that corresponds to tag in line.
string var4 — Value that corresponds to tag in line.
string var5 — Value that corresponds to tag in line.
string var6 — Value that corresponds to tag in line.
string var7 — Value that corresponds to tag in line.
string var8 — Value that corresponds to tag in line.
string var9 — Value that corresponds to tag in line.
)

Adds an item to the score list.

Returns:: To change line, return: true TAB 'line' TAB "lineVal1" TAB "lineVal2"...

224function ExampleMode::scoreListAdd ( %this, %object, %line, %var1, %var2, %var3, %var4, %var5, %var6, %var7, %var8, %var9 )

bool ExampleMode::scoreListCheckSendPlayers (
ExampleMode this
)

Determines whether to include players in the score list.

Returns:: Whether to display player scores in the list.

208function ExampleMode::scoreListCheckSendPlayers ( %this )

bool ExampleMode::scoreListCheckSendTeams (
ExampleMode this
)

Determines whether to include teams in the score list.

Returns:: Whether to display team scores in the list.

204function ExampleMode::scoreListCheckSendTeams ( %this )

string ExampleMode::scoreListInit (
ExampleMode this
string header — The default tagged header string. Default: '<color:ffffff><tab:150, 250, 350, 450><font:arial:16>%1<h2>%2\t%3\t%4\t%5\t%6</h2><br>'
string var1 — Value that corresponds to tag in header.
string var2 — Value that corresponds to tag in header.
string var3 — Value that corresponds to tag in header.
string var4 — Value that corresponds to tag in header.
string var5 — Value that corresponds to tag in header.
string var6 — Value that corresponds to tag in header.
string var7 — Value that corresponds to tag in header.
string var8 — Value that corresponds to tag in header.
string var9 — Value that corresponds to tag in header.
)

Creates headers for the end of round score list.

Returns:: To change headers, return: true TAB 'headerstring' TAB "headerVal1" TAB "headerVal2"...
See Also:: ExampleMode::scoreListAdd; ExampleMode::scoreListCheckSendPlayers; ExampleMode::scoreListCheckSendTeams

200function ExampleMode::scoreListInit ( %this, %header, %var1, %var2, %var3, %var4, %var5, %var6, %var7, %var8, %var9 )

SimObject ExampleMode::victoryCheck_lives (
ExampleMode this
)

Checks whether there is a last man/team standing.

Returns:: The winner, a GameConnection or Slayer_TeamSO.

229function ExampleMode::victoryCheck_lives ( %this )

SimObject ExampleMode::victoryCheck_points (
ExampleMode this
)

Finds the man/team with the most points.

Returns:: The winner, a GameConnection or Slayer_TeamSO.

233function ExampleMode::victoryCheck_points ( %this )

SimObject ExampleMode::victoryCheck_time (
ExampleMode this
)

Checks whether time is up and determines a winner.

Returns:: The winner, a GameConnection or Slayer_TeamSO.

237function ExampleMode::victoryCheck_time ( %this )