Lua Functions
This is a list of functions exposed by Burnout Paradise's Lua implementation. A small subset is used in the Party Pack challenges; others are only in the unused scripted challenges.
Most of these notes are quite old; documentation is missing and could be wrong in some cases.
General Notes
Lua 5.1 is the version used, as per the _VERSION global variable.
The following standard libraries are included: coroutine, debug, io, math, package, string, table.
Actions
The game will automatically call these functions if they are defined in the script. Initialise and Update are enabled by default, others require a call to EnableAction.
Initialise
Initialise()
Should do everything needed to set up the script and game environment.
Update
boolean Update()
Should implement a main logic loop. Returning true stops the script.
PostUpdate
PostUpdate()
OnHitProp
OnHitProp(number id, number type)
Player hit a prop.
"type" is 0 for decorative props, 1 for Smash Gates, 2 for Burnout Billboards.
OnLocalPlayerPlacedOnTrack
OnLocalPlayerPlacedOnTrack()
Player regained control after crashing or being reset.
OnLocalPlayerTriggersLandmark
OnLocalPlayerTriggersLandmark()
OnNetworkPlayerHitsFatalCollision
OnNetworkPlayerHitsFatalCollision()
OnTakeDown
OnTakeDown()
OnVerticalTakeDown
OnVerticalTakeDown()
OnEndMessageReceived
OnEndMessageReceived(boolean cancelled, boolean quit)
Doesn't seem to work as expected; only called on the next script.
OnHitBillboard
OnHitBillboard(number id)
Player hit a Burnout Billboard.
OnHitSmash
OnHitSmash(number id)
Player hit a Smash Gate.
OnSuperJump
OnSuperJump(number id)
Player successfully landed a Super Jump.
OnDriveThruOrCarPark
OnDriveThruOrCarPark(string type, string unk)
Player entered a Drive Thru or Car Park. The Car Park on Big Surf Island does not activate this.
Types are "Junkyard", "BikeShop", "GasStation", "AutoRepair", "PaintShop" or "CarPark".
OnRoadRuleStart
OnRoadRuleStart()
Can't be used due to challenges disabling Road Rules.
OnRoadRuleEnd
OnRoadRuleEnd()
Can't be used due to challenges disabling Road Rules.
OnCarsLeapt
OnCarsLeapt()
OnBankedOncoming
OnBankedOncoming(number distance)
Player finished driving in oncoming.
OnBankedReverseOncoming
OnBankedReverseOncoming(number distance)
Player finished driving in reverse oncoming.
OnBankedHandbrakeTurn
OnBankedHandbrakeTurn(number degrees)
Player finished a handbrake turn.
OnBankedJumpDistance
OnBankedJumpDistance(number distance)
Player successfully landed a jump.
OnBankedAirTime
OnBankedAirTime(number seconds)
Player stopped being in the air.
OnBankedReverseDriving
OnBankedReverseDriving(number distance)
Player finished driving in reverse.
OnNearMiss
OnNearMiss()
Player had a near miss.
OnNearMissChain
OnNearMissChain(number misses)
Player finished a near miss chain, including by crashing or hitting a car.
OnAerialNearMiss
OnAerialNearMiss()
OnCrash
OnCrash()
Player crashed or was reset.
OnCrashIntoPlayer
OnCrashIntoPlayer()
OnCrashIntoWorld
OnCrashIntoWorld()
Player crashed into world or was reset.
OnCrashIntoTraffic
OnCrashIntoTraffic()
Player crashed into traffic.
OnBankedBarrelRoll
OnBankedBarrelRoll(number rolls)
Player successfully landed barrel roll(s).
OnBankedFlatSpin
OnBankedFlatSpin(number degrees)
Player successfully landed a flat spin.
OnBankedDriftTime
OnBankedDriftTime(number seconds)
Player successfully finished a drift.
OnBankedDriftDistance
OnBankedDriftDistance(number distance)
Player successfully finished a drift.
OnPowerPark
OnPowerPark(number percent)
Player successfully performed a Power Park.
OnPowerParkPlayer
OnPowerParkPlayer(number rating)
OnPowerParkTraffic
OnPowerParkTraffic(number rating)
OnBoostTimeBanked
OnBoostTimeBanked(number seconds)
Player stopped boosting, including by crashing.
OnBoostChain
OnBoostChain()
OnStageChanged
OnStageChanged(number new, number old)
The challenge stage changed.
Functions
AmITheHost
boolean AmITheHost()
Camera_LockToBumper
Camera_LockToBumper()
Locks the camera to bumper view.
Camera_Unlock
Camera_Unlock()
Unlocks the camera from bumper view and forces it to normal view.
CanPlayerCarBePainted
boolean CanPlayerCarBePainted()
Doesn't seem to work as expected; but it does differ based on vehicle?
ChooseRandomTeams
boolean ChooseRandomTeams(number amount)
DebugDrawText
DebugDrawText(string text, number x, number y)
Has no visible effect.
DisableAction
DisableAction(string action)
Disables an action.
DisableAllActions
DisableAllActions()
Disables all actions except Update.
DisableGameModeSetting
DisableGameModeSetting(string setting)
Disables the given gamemode setting.
DisableResetOnTrack
DisableResetOnTrack()
Disables respawning the player.
DistanceToPlayer
number DistanceToPlayer(number player)
Distance to the given player.
DistanceToTrigger
number DistanceToTrigger(number id)
Distance to center of the trigger.
EnableAction
EnableAction(string action)
Enables an action.
EnableGameModeSetting
EnableGameModeSetting(string setting)
Enables the given gamemode setting.
EnableResetOnTrack
EnableResetOnTrack()
Enables respawning the player.
GetClosestPlayer
number GetClosestPlayer()
GetCurrentChallengeStage
number GetCurrentChallengeStage()
The current challenge stage.
GetCurrentPlayerRoad
number GetCurrentPlayerRoad()
ID of the road the player is on. See Road Indices.
GetDistanceToClosestPlayer
number GetDistanceToClosestPlayer()
GetDistanceToFurthestPlayer
number GetDistanceToFurthestPlayer()
Returns distance to the furthest player, or 0 if there are no other players.
GetFurthestPlayer
number GetFurthestPlayer()
Returns the furthest player, or 0 if there are no other players.
GetGroupIDOfTrigger
number GetGroupIDOfTrigger(number id)
Group ID of the given trigger, or its own ID if it has no group.
GetMaxPlayers
number GetMaxPlayers()
Always 8.
GetMyCarNumber
number GetMyCarNumber()
Always 0 during single player testing, probably related to player number?
GetNetworkPlayerTeam
number GetNetworkPlayerTeam(number player)
GetNumberOfPlayers
number GetNumberOfPlayers()
Number of players participating in the challenge.
GetPlayerBoostType
string GetPlayerBoostType()
Player's vehicle boost type. Returns "Danger", "Aggression", "Stunt", "None" or "Infinite".
GetPlayerCurrentAirTime
number GetPlayerCurrentAirTime()
Player's current air time, in seconds.
GetPlayerCurrentBarrelRolls
number GetPlayerCurrentBarrelRolls()
Player's current barrel rolls.
GetPlayerCurrentBoostTime
number GetPlayerCurrentBoostTime()
Player's continuous boosting time, in seconds.
GetPlayerCurrentCarsLeapt
GetPlayerCurrentCarsLeapt()
GetPlayerCurrentDriftDistance
number GetPlayerCurrentDriftDistance()
Player's current drift distance.
GetPlayerCurrentDriftTime
number GetPlayerCurrentDriftTime()
Player's current drift time, in seconds.
GetPlayerCurrentFlatSpinAngle
number GetPlayerCurrentFlatSpinAngle()
Player's current flat spin angle, in radians.
GetPlayerCurrentHandbrakeTurnAngle
number GetPlayerCurrentHandbrakeTurnAngle()
Player's current handbrake turn angle, in degrees.
GetPlayerCurrentJumpDistance
number GetPlayerCurrentJumpDistance()
Player's current jump distance.
GetPlayerCurrentReverseDistance
number GetPlayerCurrentReverseDistance()
Player's current reverse driving distance.
GetPlayerCurrentReverseOncomingDistance
number GetPlayerCurrentReverseOncomingDistance()
Alias of GetPlayerReverseOncoming.
GetPlayerDrivingDistance
number GetPlayerDrivingDistance()
Player's driven distance since the start of this challenge. Can be reset with ResetPlayerDrivingDistance.
Bug: Driving in reverse will subtract distance and cause negative numbers.
GetPlayerLiveryType
string GetPlayerLiveryType()
Player's vehicle finish type.
GetPlayerNearMissChain
number GetPlayerNearMissChain()
Player's current near miss chain.
GetPlayerOncoming
number GetPlayerOncoming()
Player's current oncoming distance.
GetPlayerPalette
string? GetPlayerPalette()
Player's vehicle paint type. Returns "Gloss", "Metallic", "Pearlescent", "Special". Type 5 (Party paint) returns nil.
GetPlayerPaletteAndColourIndices
number, number GetPlayerPaletteAndColourIndices()
Player's vehicle paint color and type, respectively.
GetPlayerReverseDrivingDistance
number GetPlayerReverseDrivingDistance()
Always 0?
GetPlayerReverseOncoming
number GetPlayerReverseOncoming()
Player's current reverse oncoming distance.
GetPlayerSpeed
number GetPlayerSpeed()
Player's current speed, in MPH.
GetPlayerTeam
number GetPlayerTeam()
Player's current team. See Team Indices.
GetPlayerVehicleColour
string? GetPlayerVehicleColour()
Player's vehicle paint color. Returns "Black", "Blue", "Green", "Grey", "Orange", "Pink", "Purple", "Red", "White", "Yellow", "Special", or nil if unknown.
GetPlayerVehicleID
string GetPlayerVehicleID()
Player's vehicle ID. Returns a string like "XUSSCB1".
GetPlayerVehicleManufacturer
string GetPlayerVehicleManufacturer()
Player's vehicle manufacturer. Returns a string like "Jansen".
GetPlayerVehicleParentID
string GetPlayerVehicleParentID()
Player's vehicle parent ID, or its own ID if it has no parent.
GetPlayerVehicleType
string GetPlayerVehicleType()
Player's vehicle type. Returns "Car", "Motorbike" or "Plane".
GetTime
number GetTime()
Time since the challenge started, in seconds.
GetTimeOfDay
number, number, number GetTimeOfDay()
Hours, minutes and seconds of the in-game time, respectively.
GoToChallengeStage
boolean GoToChallengeStage(number stage)
Change to the specified stage. Always returns true?
HUD_ClearLandmarks
HUD_ClearLandmarks()
Removes all minimap dots.
HUD_ClearTickerMessage
HUD_ClearTickerMessage()
Hides the ticker.
HUD_DisableHUDOption
HUD_DisableHUDOption(string option)
Disables the given HUD option.
HUD_DisableLandmark
HUD_DisableLandmark(number id)
Removes the specified minimap dot. The parameter is a number previously returned by HUD_EnableLandmark.
HUD_EnableHUDOption
HUD_EnableHUDOption(string option)
Enables the given HUD option.
HUD_EnableLandmark
number HUD_EnableLandmark(number id)
Adds a minimap dot. Returns a number to be used with HUD_DisableLandmark.
HUD_HideEliminatedPlayersOnMap
HUD_HideEliminatedPlayersOnMap()
Removes eliminated players (gray, not in challenge) from the minimap?
HUD_HideOtherTeamsOnMap
HUD_HideOtherTeamsOnMap()
Disables showing teams different from the player's from the minimap.
HUD_MarkIconsVisible
HUD_MarkIconsVisible(string? icon...)
Sets which icon(s) are visible on the minimap and map. Parameters correspond to which icons should be enabled. See the list here.
HUD_SetEventInfoHeadings
HUD_SetEventInfoHeadings(string label...)
Sets the label(s) for the EVENTINFO HUD option.
HUD_SetEventInfoTitle
HUD_SetEventInfoTitle(string title)
Sets the title for the EVENTINFO HUD option.
HUD_SetEventInfoValue
HUD_SetEventInfoValue(number index, string format, any value, boolean flash)
Sets a value for the EVENTINFO HUD option. Index starts at 0.
HUD_SetPlayerListNumberOfTargets
HUD_SetPlayerListNumberOfTargets(number unk)
Unknown, the parameter is always 1 in the unused scripted challenges?
HUD_SetPlayerListScore
HUD_SetPlayerListScore(number player, string format, number value, boolean tickbox)
Sets the given player's score shown in the POSITIONTABLE HUD option. See POSITIONTABLE Formats.
HUD_SetPlayerListSortMode
HUD_SetPlayerListSortMode(string mode)
Sets the POSITIONTABLE HUD option sorting mode. See POSITIONTABLE Sorting.
HUD_SetPlayerListTitle
HUD_SetPlayerListTitle(string title)
Sets the POSITIONTABLE HUD option list title.
HUD_SetPlayerListType
HUD_SetPlayerListType(string type)
Sets the POSITIONTABLE HUD option list display type. See POSITIONTABLE Type.
HUD_SetTeamBased
HUD_SetTeamBased(boolean yes)
Sets whether the POSITIONTABLE HUD option shows team colors.
HUD_ShowEliminatedPlayersOnMap
HUD_ShowEliminatedPlayersOnMap()
HUD_ShowGamerTagNegativeHUDMessage
HUD_ShowGamerTagNegativeHUDMessage(string title, string subtitle, number time, string? audio, ...)
No apparent difference from HUD_ShowNegativeHUDMessage.
HUD_ShowGamerTagPositiveHUDMessage
HUD_ShowGamerTagPositiveHUDMessage(string title, string subtitle, number time, string? audio, ...)
No apparent difference from HUD_ShowPositiveHUDMessage.
HUD_ShowNegativeHUDMessage
HUD_ShowNegativeHUDMessage(string title, string subtitle, number time, string? audio, ...)
Show a negative HUD message (similar to the "You are X takedowns behind" messages).
Remaining parameters are triplets of format, index (starting at 1) and value.
HUD_ShowOtherTeamsOnMap
HUD_ShowOtherTeamsOnMap()
Enables showing different teams from the player's from the minimap.
HUD_ShowPositiveHUDMessage
HUD_ShowPositiveHUDMessage(string title, string subtitle, number time, string? audio, ...)
Show a positive HUD message (similar to the "You are X takedowns ahead" messages).
Remaining parameters are triplets of format, index (starting at 1) and value.
HUD_ShowStartHUDMessage
HUD_ShowStartHUDMessage(string title, string subtitle, number time, string? audio, ...)
No apparent difference from HUD_ShowPositiveHUDMessage.
HUD_ShowTickerMessage
HUD_ShowTickerMessage(string text, boolean? loop, number? unk)
Shows a message on the ticker, either once or continuously. Looping defaults to false.
HasPlayerCrashed
boolean HasPlayerCrashed(number unk)
Always returns false?
IsPlayerBoostBarFull
boolean IsPlayerBoostBarFull()
Whether the Player's boost bar is filled.
IsPlayerCarDeformed
boolean IsPlayerCarDeformed()
Whether the Player's vehicle has deformation. Damage value is irrelevant.
IsPlayerCrashing
boolean IsPlayerCrashing()
Whether the Player is currently crashing.
IsPlayerDoingWheelie
boolean IsPlayerDoingWheelie()
Whether the Player is doing a Wheelie.
IsPlayerInAir
boolean IsPlayerInAir()
Whether the Player is in the air.
IsPlayerInChallenge
boolean IsPlayerInChallenge(number player)
Whether the given player is participating in the challenge.
IsPlayerInCounty
function IsPlayerInCounty(string county)
Returns itself, likely due to an error in its implementation, which means it is unusable.
Counties are "PalmBay", "SilverLake", "HarborTown", "WhiteMountain", "Downtown", "ParadiseKeys".
IsPlayerInRoad
boolean IsPlayerInRoad(number id)
Whether the Player is in the given road. See Road Indices.
IsPlayerInTrigger
boolean IsPlayerInTrigger(number id...)
Whether the Player is any triggers with the given ID.
IsPlayerInTriggerGroup
IsPlayerInTriggerGroup(number id...)
Crashes the game?
IsPlayerTouchingWall
boolean IsPlayerTouchingWall()
Whether the Player is touching a wall.
LockPlayerVehicle
LockPlayerVehicle()
Forces the handbrake on and disables input. Boosting state is maintained.
PlayAudioGUISound
PlayAudioGUISound(string audio)
Plays the given sound. See Sound List.
Print(string text)
Has no visible effect.
ResetPlayerDrivingDistance
ResetPlayerDrivingDistance()
Resets the result of GetPlayerDrivingDistance.
ResetTeams
ResetTeams()
Scoring_AddScoreEntry
number Scoring_AddScoreEntry(number limit)
Scoring_AddSlot
number Scoring_AddSlot(number limit)
Alias of Scoring_AddScoreEntry.
Scoring_GetMyScore
number Scoring_GetMyScore(number slot)
Scoring_GetScore
number Scoring_GetScore(number player, number slot)
Scoring_GetTotalScore
number Scoring_GetTotalScore(number slot)
Scoring_SetMyScore
Scoring_SetMyScore(number slot, number score, number? unk)
SetPlayerBoostAmount
SetPlayerBoostAmount(number amount)
Set the player's boost amount as a number from 0 to 100.
SetPlayerTeam
SetPlayerTeam(number team)
Sets the player's team. See Team Indices.
SetTimeOfDay
SetTimeOfDay(number hour, number minute)
Sets the in-game time.
SetWeather
SetWeather(string name, number? delta)
Sets the weather, specifying a transition time. Names are "Sunny", "Overcast" and "Foggy".
TimeSince
number TimeSince(number timestamp)
Time since the given timestamp, in seconds. Timestamps in the future return a negative number.
Traffic_SetDensity
Traffic_SetDensity(number density)
Sets the traffic density.
Triggers_DistanceToTrigger
number Triggers_DistanceToTrigger(number id)
Alias of DistanceToTrigger.
Triggers_GetGroupIDOfTrigger
number Triggers_GetGroupIDOfTrigger(number id)
Alias of GetGroupIDOfTrigger.
Triggers_GetScoringSlotForTrigger
Triggers_GetScoringSlotForTrigger(number unk)
Triggers_HasLocalPlayerActivatedTrigger
Triggers_HasLocalPlayerActivatedTrigger(number unk)
Triggers_HasPlayerActivatedTrigger
Triggers_HasPlayerActivatedTrigger(number unk1, number unk2)
Triggers_HaveAllPlayersActivatedTrigger
Triggers_HaveAllPlayersActivatedTrigger(number unk)
Triggers_HaveAnyPlayersActivatedTrigger
Triggers_HaveAnyPlayersActivatedTrigger(number unk)
Triggers_HowManyPlayersHaveActivatedTrigger
Triggers_HowManyPlayersHaveActivatedTrigger(number unk)
Triggers_IsPlayerInTrigger
boolean Triggers_IsPlayerInTrigger(number id...)
Alias of IsPlayerInTrigger.
Triggers_IsPlayerInTriggerGroup
boolean Triggers_IsPlayerInTriggerGroup(number id...)
Alias of IsPlayerInTriggerGroup.
Triggers_ResetLocalPlayerTriggerStatus
Triggers_ResetLocalPlayerTriggerStatus(number unk)
Triggers_StopTrackingAllTriggers
Triggers_StopTrackingAllTriggers()
Triggers_StopTrackingTrigger
Triggers_StopTrackingTrigger(number unk)
Triggers_TrackMeetUpTrigger
Triggers_TrackMeetUpTrigger(number unk1, number? unk2)
UnlockPlayerVehicle
UnlockPlayerVehicle()
Stop forcing the handbrake on and reallow player input.
Party Pack Functions
These functions are only available in the context of Party Pack challenges.
Controller_DisableBrakes
Controller_DisableBrakes()
Disables braking.
Controller_EnableBrakes
Controller_EnableBrakes()
Enables braking.
Controller_InvertSteering
Controller_InvertSteering()
Inverts steering.
Controller_LockAccelerator
Controller_LockAccelerator()
Locks the accelerator on.
Controller_LockBoost
Controller_LockBoost()
Locks boosting and makes boost infinite.
Controller_NormalSteering
Controller_NormalSteering()
Returns normal steering.
Controller_UnlockAccelerator
Controller_UnlockAccelerator()
Unlocks the accelerator.
Controller_UnlockBoost
Controller_UnlockBoost()
Unlocks boosting.
PassThePadHUD_SetScore
PassThePadHUD_SetScore(number score)
PassThePadHUD_SetupDigitalScoreDisplay
PassThePadHUD_SetupDigitalScoreDisplay(string title)
PassThePadHUD_SetupScoreDisplay
PassThePadHUD_SetupScoreDisplay(string title, string? heading, string? format)
PassThePadHUD_SetupTimeDisplay
PassThePadHUD_SetupTimeDisplay(string type, number? time)
PassThePad_CalculateScore
PassThePad_CalculateScore(number score, number min, number max, number bias, string type)
PassThePad_GetTimeSinceStart
number PassThePad_GetTimeSinceStart()
PassThePad_HoldGUITimer
PassThePad_HoldGUITimer()
PassThePad_SetCurrentGameScore
PassThePad_SetCurrentGameScore(number score)
PassThePad_SetStartingTrigger
PassThePad_SetStartingTrigger(number id)
PassThePad_SetVehicle
PassThePad_SetVehicle(string id)
PassThePad_UseAnalogueScoring
PassThePad_UseAnalogueScoring(string type, string format, string heading)
PassThePad_UseDigitalScoring
PassThePad_UseDigitalScoring()
Enumerations
HUD Options
| Value | Comments |
|---|---|
| POSITIONTABLE | Player table on the top right |
| EVENTINFO | Enables a HUD element on the top left, similar to when an online event is configured |
| MAPICONS | Toggles Drive Thru, map events, and landmarks set with HUD_EnableLandmark |
| STUNTDISPLAY | Enables the Stunt Run points HUD on the top left |
| COMPASS | Enables the compass HUD at the top |
| DISCOVERABLESONBOOST | Related to showing discoverable progress on the bottom left? |
| DONTFORCEPLAYERICONONTOP | Related to Party player photo? |
| CUSTOMTICKERINRACEMAINHUD | |
| TURNOFFROADRULES | Toggling this has no effect on challenges disabling Road Rules |
| TURNOFFROADSIGNS | Turns off the road display at the top |
| TURNOFFREVENGEMESSAGES | |
| TURNOFFBOOSTBAR | Hides the Boost bar; requires pausing |
| TURNOFFMAP | Hides the minimap; requires pausing |
| TURNOFFCRASHHUD | Hides the crash HUD. Used in Party Pack challenges |
| TURNOFFBOOSTMESSAGES | |
| TURNOFFODOMETER | Hides time and driven distance under minimap; requires pausing |
| TURNOFFONLINENOTIFICATIONS | Related to friend and invite notifications? |
| ENABLEPLAYERIMAGEONHUD | Related to Party player photo? |
| PARTYSTYLEBOOSTMESSAGES | Enables Party style stunt messages |
| PARTYSTYLEDISTRICTICON | Enables Party minimap background; requires pausing |
| TURNOFF_EASY_DRIVE | Turns off Easy Drive; requires pausing |
Icon Options
| Value | Comments |
|---|---|
| JUNK_YARD | |
| CAR_PARK | No visible effect |
| BODY_SHOP | Auto Repair |
| PAINT_SHOP | |
| GAS_STATION | |
| EVENT_ICONS |
POSITIONTABLE Formats
| Value |
|---|
| NONE |
| CRASHES |
| NEAR_MISS |
| ONCOMING |
| DRIFT |
| AIR |
| AIR_DISTANCE |
| BARREL_ROLLS |
| FLAT_SPINS |
| CARS_LEAPT |
| SPEED_ROAD_RULE |
| CRASH_ROAD_RULE |
| SUCCESSFUL_LANDINGS |
| BURNOUTS |
| POWER_PARKS |
| PERCENTAGE |
| MEET_UP |
| BILLBOARDS |
| BOOST_TIME |
| CONVOY_POSITION |
| DISTANCE |
| CHAIN |
| MULTIPLIER |
| STUNT_SCORE |
| CORKSCREW |
| SUPER_JUMP |
| INTERSTATE_LAP |
| TAKEDOWNS |
| RANKING |
| RANKING_POINTS |
| VALUE_INT |
| VERT_TAKEDOWN |
| AERIAL_NEAR_MISS |
| REV_DRIVING |
| REV_ONCOMING |
| COUNT_UP |
| HOURS_MINUTES_SECONDS |
| MINUTES_SECONDS |
| MINUTES_SECONDS_HUNDRETHS |
| SECONDS_HUNDRETHS |
| WINS |
| AUTODISTANCE |
| BIKES_LEAPT |
| WHEELIE |
| WHEELIE_NEAR_MISS |
| WHEELIE_ONCOMING |
| ONCOMING_NEAR_MISS |
| DISTANCE_TRAVELED |
POSITIONTABLE Sorting
| Value |
|---|
| NONE |
| ALPHABETICAL |
| HIGHTOLOW |
| LOWTOHIGH |
| TEAM_HIGHTOLOW |
| TEAM_LOWTOHIGH |
| TEAM_BLUELOWTOHIGH_REDHIGHTOLOW |
| TEAM_REDLOWTOHIGH_BLUEHIGHTOLOW |
POSITIONTABLE Type
| Value | Comments |
|---|---|
| DEFAULT | Number column |
| TOTAL | Number column and total |
| TICKBOX | Number column and tickbox |
| TICKBOX_TOTAL | Number column, tickbox and total |
Sound List
This is a list of sounds referenced in existing game scripts. The full list is unknown.
| Name |
|---|
| PassThePad_Audio_ChallengeComplete |
| PassThePad_Audio_CriticalAction |
| PassThePad_Audio_HUDNegative |
| PassThePad_Audio_HUDPositivex1 |
| PassThePad_Audio_HUDPositivex2 |
| PassThePad_Audio_HUDPositivex3 |
| PassThePad_Audio_HUDPositivex4 |
| PassThePad_Audio_HUDPositivex5 |
| PassThePad_Audio_HUDScore |
| PassThePad_Audio_HurryUp |
| PassThePad_Audio_NonCriticalCrash |
| PassThePad_Audio_ScoreAccumulating |
| PassThePad_Audio_TicksUrgent |
| PassThePad_Audio_TimerTicks |
Team Indices
| Value | Color |
|---|---|
| 0 | Black |
| 1 | Red |
| 2 | Blue |
| 3 | Yellow |
| 4 | Pink |
| 5 | Green |
| 6 | Orange |
| 7 | Purple |
| 8 | Cyan |
Format Parameters
| Format | Comments |
|---|---|
| STRING | String without formatting |
| INT | Rounds near 0 |
| FLOAT | Same as INT |
| MONEY | Currency ($5,000) |
| TIME | Similar to INT, but doesn't support negative numbers |
| STRINGID | Translation string ("GENERAL_OPTION_OK" becomes "OK") |
| GAMERTAG | Same as STRING |
| HOURS_MINUTES_SECONDS | 01:00:01 |
| MINUTES_SECONDS | 1:01 |
| MINUTES_SECONDS_HUNDRETHS | 1:01.50 |
| SECONDS_HUNDRETHS | 1.50 |
| AUTODISTANCE | Miles for long distances, yards for short distances |
| DISTANCE | Always yards |
Road Indices
| Value | Road |
|---|---|
| -1 | Offroad or junction |
| 0 | Angus |
| 1 | Watt |
| 2 | 4th |
| 3 | 3rd |
| 4 | 2nd |
| 5 | Patterson |
| 6 | Glancey |
| 7 | Riverside |
| 8 | 1st |
| 9 | 5th |
| 10 | Fry |
| 11 | Paradise |
| 12 | Gabriel |
| 13 | Shepherd |
| 14 | Warren |
| 15 | Young |
| 16 | King |
| 17 | Franke |
| 18 | Hamilton |
| 19 | Read |
| 20 | Lewis |
| 21 | N. Rouse |
| 22 | Nelson |
| 23 | Uphill |
| 24 | Chubb |
| 25 | Ross |
| 26 | N. Mountain |
| 27 | Rack |
| 28 | Schembri |
| 29 | S. Mountain |
| 30 | Hans |
| 31 | Lucas |
| 32 | S. Rouse |
| 33 | Newton |
| 34 | Hall |
| 35 | 7th |
| 36 | 9th |
| 37 | Nakamura |
| 38 | Sullivan |
| 39 | Hawley |
| 40 | W. Crawford |
| 41 | Moore |
| 42 | Hudson |
| 43 | Lambert |
| 44 | Parr |
| 45 | Hubbard |
| 46 | Webster |
| 47 | South Bay |
| 48 | I-88 Section 3 |
| 49 | I-88 Section 4 |
| 50 | Harber |
| 51 | Manners |
| 52 | I-88 Section 1 |
| 53 | E. Crawford |
| 54 | I-88 Section 2 |
| 55 | Andersen |
| 56 | Evans |
| 57 | Root |
| 58 | Cannon |
| 59 | Lawrence |
| 60 | Casey |
| 61 | Geldard |
| 62 | W. Lake |
| 63 | E. Lake |
| 64 | Glover |
| 65 | Grange |
| 66 | Huntley |
| 67 | Griffin |
| 68 | Jacobs |
| 69 | Lipscomb |
| 70 | Paradise Keys |
| 71 | Daniell |
| 72 | Pitt |
| 73 | McDonald |
| 74 | Shires |
| 75 | Maguire |