I88gerbils: initial content/formatting

2005-05-31T15:23:39Z

initial content/formatting

New page

These are settings for Smong's [[Race Module]].

== MinPlaying ==
integer
* min: 0

The minimum Players required to start a game.

== MinTeams ==
integer
* min: 1

The minimum Teams required to start a game.

== Laps ==
integer
* min: 0

The number of Laps required to complete a [[Race Module|Race]].

== ContinuousMap ==
boolean
* values: 0,1

Toggle whether the Start line is also the Finish line.

== Chkpt0 ==
integer, integer, integer, integer
* min: 0
* max: 1024

This is the first Checkpoint and starting line. Checkpoints are rectangular areas defined by the top-left coordinates and the bottom-right coordinates. For example, 497,287,514,374 would indicate a Checkpoint starting at 497,287 and going to the bottom-left at 514,374.

== ChkptX ==
integer, integer, integer, integer
* min: 0
* max: 1024

Define other Checkpoints by replacing X with 2, 3, ... 10. The minimum number of Checkpoints that need to be defined is 2, but 3 is reccomended.

== AutoRace ==
boolean
* values: 0,1

Enable races to be run automatically whan an arena is not empty.

== StartDelay ==
integer
* min: 0

Defines the delay between the announcement of the Race and the start of the Race.

== RaceDelay ==
integer
* min: 0

Defines the maximum amount of time before a race will end. All unfinished players are "disqualified" and recieve no points.

== RaceReward ==
integer
* min: 0

The multiplier for the Reward given to players that finish the Race. The formula is currenly: (Players^2 * RaceReward) / Rank.

== InSafeToPlay ==
integer
* min: 0
* max: 2

Spectates any player that is not in a safe zone when warping players to the first checkpoint, but BEFORE the start of the race. If this option is set to 2, then any player not in a safezone will simply be ignored and not specced.

== STAGES ==
enum
* values: Ready, Start, CheckPoint, Lap, Finish, Death

The stages of the race allow you to define appropriate actions (see below) to give to a player when that player reaches that particular stage. Each stage precedes an action with a '-'. Stages are not required. Ready represents the 3 second countdown til the start of the race, Start happens at the end of the 3 second countdown, ?CheckPoint occurs when passing a checkpoint, Lap occurs when completing 1 lap, Death occurs on player death, and Finish occurs when a player finishes.

== ACTIONS ==
enum
* values: Spec, ShipReset, Prize, WarpXY, ArenaMessage, Message

Spec and ?ShipReset are boolean actions which toggle whether to take that action during that particular stage. Prize will give the # prize, WarpXY will warp the player, ?ArenaMessage will send an Arena-wide message, and Message will send a message to the player only.

'''Example'''
<pre width=80%>
#define PRIZE_WARP 7

#define PRIZE_MULTI 25

Ready-WarpXY=500,305 ;warp all players to coordinates 500,305 at the Ready stage.

Ready-?ArenaMessage=Start your engines! ;send ?a message to arena.

Finish-Prize=$PRIZE_WARP , $PRIZE_MULTI ;randomly warp and multiprize the player upon finishing.
</pre>

== MACROS ==

There following macros are available to create dynamic/generic messages:

* %name - player's name
* %lap - laps completes so far
* %chkpt - last checkpoint crossed
* %rank - position in the race (0 if still racing)
* %time - playing bong#.wa2
* #

Example
<pre width=80%> Checkpoint-Message=Checkpoint %chkpt - OK!#2 </pre>

[[Category: Settings]]

Race Settings - Revision history

I88gerbils: initial content/formatting