Lua Functions

From Burnout Wiki

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[edit | edit source]

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[edit | edit source]

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[edit | edit source]

Initialise()

Should do everything needed to set up the script and game environment.

Update[edit | edit source]

boolean Update()

Should implement a main logic loop. Returning true stops the script.

PostUpdate[edit | edit source]

PostUpdate()

OnHitProp[edit | edit source]

OnHitProp(number id, number type)

Player hit a prop.

"type" is 0 for decorative props, 1 for Smash Gates, 2 for Burnout Billboards.

OnLocalPlayerPlacedOnTrack[edit | edit source]

OnLocalPlayerPlacedOnTrack()

Player regained control after crashing or being reset.

OnLocalPlayerTriggersLandmark[edit | edit source]

OnLocalPlayerTriggersLandmark()

OnNetworkPlayerHitsFatalCollision[edit | edit source]

OnNetworkPlayerHitsFatalCollision()

OnTakeDown[edit | edit source]

OnTakeDown()

OnVerticalTakeDown[edit | edit source]

OnVerticalTakeDown()

OnEndMessageReceived[edit | edit source]

OnEndMessageReceived(boolean cancelled, boolean quit)

Doesn't seem to work as expected; only called on the next script.

OnHitBillboard[edit | edit source]

OnHitBillboard(number id)

Player hit a Burnout Billboard.

OnHitSmash[edit | edit source]

OnHitSmash(number id)

Player hit a Smash Gate.

OnSuperJump[edit | edit source]

OnSuperJump(number id)

Player successfully landed a Super Jump.

OnDriveThruOrCarPark[edit | edit source]

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[edit | edit source]

OnRoadRuleStart()

Can't be used due to challenges disabling Road Rules.

OnRoadRuleEnd[edit | edit source]

OnRoadRuleEnd()

Can't be used due to challenges disabling Road Rules.

OnCarsLeapt[edit | edit source]

OnCarsLeapt()

OnBankedOncoming[edit | edit source]

OnBankedOncoming(number distance)

Player finished driving in oncoming.

OnBankedReverseOncoming[edit | edit source]

OnBankedReverseOncoming(number distance)

Player finished driving in reverse oncoming.

OnBankedHandbrakeTurn[edit | edit source]

OnBankedHandbrakeTurn(number degrees)

Player finished a handbrake turn.

OnBankedJumpDistance[edit | edit source]

OnBankedJumpDistance(number distance)

Player successfully landed a jump.

OnBankedAirTime[edit | edit source]

OnBankedAirTime(number seconds)

Player stopped being in the air.

OnBankedReverseDriving[edit | edit source]

OnBankedReverseDriving(number distance)

Player finished driving in reverse.

OnNearMiss[edit | edit source]

OnNearMiss()

Player had a near miss.

OnNearMissChain[edit | edit source]

OnNearMissChain(number misses)

Player finished a near miss chain, including by crashing or hitting a car.

OnAerialNearMiss[edit | edit source]

OnAerialNearMiss()

OnCrash[edit | edit source]

OnCrash()

Player crashed or was reset.

OnCrashIntoPlayer[edit | edit source]

OnCrashIntoPlayer()

OnCrashIntoWorld[edit | edit source]

OnCrashIntoWorld()

Player crashed into world or was reset.

OnCrashIntoTraffic[edit | edit source]

OnCrashIntoTraffic()

Player crashed into traffic.

OnBankedBarrelRoll[edit | edit source]

OnBankedBarrelRoll(number rolls)

Player successfully landed barrel roll(s).

OnBankedFlatSpin[edit | edit source]

OnBankedFlatSpin(number degrees)

Player successfully landed a flat spin.

OnBankedDriftTime[edit | edit source]

OnBankedDriftTime(number seconds)

Player successfully finished a drift.

OnBankedDriftDistance[edit | edit source]

OnBankedDriftDistance(number distance)

Player successfully finished a drift.

OnPowerPark[edit | edit source]

OnPowerPark(number percent)

Player successfully performed a Power Park.

OnPowerParkPlayer[edit | edit source]

OnPowerParkPlayer(number rating)

OnPowerParkTraffic[edit | edit source]

OnPowerParkTraffic(number rating)

OnBoostTimeBanked[edit | edit source]

OnBoostTimeBanked(number seconds)

Player stopped boosting, including by crashing.

OnBoostChain[edit | edit source]

OnBoostChain()

OnStageChanged[edit | edit source]

OnStageChanged(number new, number old)

The challenge stage changed.

Functions[edit | edit source]

AmITheHost[edit | edit source]

boolean AmITheHost()

Camera_LockToBumper[edit | edit source]

Camera_LockToBumper()

Locks the camera to bumper view.

Camera_Unlock[edit | edit source]

Camera_Unlock()

Unlocks the camera from bumper view and forces it to normal view.

CanPlayerCarBePainted[edit | edit source]

boolean CanPlayerCarBePainted()

Doesn't seem to work as expected; but it does differ based on vehicle?

ChooseRandomTeams[edit | edit source]

boolean ChooseRandomTeams(number amount)

DebugDrawText[edit | edit source]

DebugDrawText(string text, number x, number y)

Has no visible effect.

DisableAction[edit | edit source]

DisableAction(string action)

Disables an action.

DisableAllActions[edit | edit source]

DisableAllActions()

Disables all actions except Update.

DisableGameModeSetting[edit | edit source]

DisableGameModeSetting(string setting)

Disables the given gamemode setting.

DisableResetOnTrack[edit | edit source]

DisableResetOnTrack()

Disables respawning the player.

DistanceToPlayer[edit | edit source]

number DistanceToPlayer(number player)

Distance to the given player.

DistanceToTrigger[edit | edit source]

number DistanceToTrigger(number id)

Distance to center of the trigger.

EnableAction[edit | edit source]

EnableAction(string action)

Enables an action.

EnableGameModeSetting[edit | edit source]

EnableGameModeSetting(string setting)

Enables the given gamemode setting.

EnableResetOnTrack[edit | edit source]

EnableResetOnTrack()

Enables respawning the player.

GetClosestPlayer[edit | edit source]

number GetClosestPlayer()

GetCurrentChallengeStage[edit | edit source]

number GetCurrentChallengeStage()

The current challenge stage.

GetCurrentPlayerRoad[edit | edit source]

number GetCurrentPlayerRoad()

ID of the road the player is on. See Road Indices.

GetDistanceToClosestPlayer[edit | edit source]

number GetDistanceToClosestPlayer()

GetDistanceToFurthestPlayer[edit | edit source]

number GetDistanceToFurthestPlayer()

Returns distance to the furthest player, or 0 if there are no other players.

GetFurthestPlayer[edit | edit source]

number GetFurthestPlayer()

Returns the furthest player, or 0 if there are no other players.

GetGroupIDOfTrigger[edit | edit source]

number GetGroupIDOfTrigger(number id)

Group ID of the given trigger, or its own ID if it has no group.

GetMaxPlayers[edit | edit source]

number GetMaxPlayers()

Always 8.

GetMyCarNumber[edit | edit source]

number GetMyCarNumber()

Always 0 during single player testing, probably related to player number?

GetNetworkPlayerTeam[edit | edit source]

number GetNetworkPlayerTeam(number player)

GetNumberOfPlayers[edit | edit source]

number GetNumberOfPlayers()

Number of players participating in the challenge.

GetPlayerBoostType[edit | edit source]

string GetPlayerBoostType()

Player's vehicle boost type. Returns "Danger", "Aggression", "Stunt", "None" or "Infinite".

GetPlayerCurrentAirTime[edit | edit source]

number GetPlayerCurrentAirTime()

Player's current air time, in seconds.

GetPlayerCurrentBarrelRolls[edit | edit source]

number GetPlayerCurrentBarrelRolls()

Player's current barrel rolls.

GetPlayerCurrentBoostTime[edit | edit source]

number GetPlayerCurrentBoostTime()

Player's continuous boosting time, in seconds.

GetPlayerCurrentCarsLeapt[edit | edit source]

GetPlayerCurrentCarsLeapt()

GetPlayerCurrentDriftDistance[edit | edit source]

number GetPlayerCurrentDriftDistance()

Player's current drift distance.

GetPlayerCurrentDriftTime[edit | edit source]

number GetPlayerCurrentDriftTime()

Player's current drift time, in seconds.

GetPlayerCurrentFlatSpinAngle[edit | edit source]

number GetPlayerCurrentFlatSpinAngle()

Player's current flat spin angle, in radians.

GetPlayerCurrentHandbrakeTurnAngle[edit | edit source]

number GetPlayerCurrentHandbrakeTurnAngle()

Player's current handbrake turn angle, in degrees.

GetPlayerCurrentJumpDistance[edit | edit source]

number GetPlayerCurrentJumpDistance()

Player's current jump distance.

GetPlayerCurrentReverseDistance[edit | edit source]

number GetPlayerCurrentReverseDistance()

Player's current reverse driving distance.

GetPlayerCurrentReverseOncomingDistance[edit | edit source]

number GetPlayerCurrentReverseOncomingDistance()

Alias of GetPlayerReverseOncoming.

GetPlayerDrivingDistance[edit | edit source]

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[edit | edit source]

string GetPlayerLiveryType()

Player's vehicle finish type.

GetPlayerNearMissChain[edit | edit source]

number GetPlayerNearMissChain()

Player's current near miss chain.

GetPlayerOncoming[edit | edit source]

number GetPlayerOncoming()

Player's current oncoming distance.

GetPlayerPalette[edit | edit source]

string? GetPlayerPalette()

Player's vehicle paint type. Returns "Gloss", "Metallic", "Pearlescent", "Special". Type 5 (Party paint) returns nil.

GetPlayerPaletteAndColourIndices[edit | edit source]

number, number GetPlayerPaletteAndColourIndices()

Player's vehicle paint color and type, respectively.

GetPlayerReverseDrivingDistance[edit | edit source]

number GetPlayerReverseDrivingDistance()

Always 0?

GetPlayerReverseOncoming[edit | edit source]

number GetPlayerReverseOncoming()

Player's current reverse oncoming distance.

GetPlayerSpeed[edit | edit source]

number GetPlayerSpeed()

Player's current speed, in MPH.

GetPlayerTeam[edit | edit source]

number GetPlayerTeam()

Player's current team. See Team Indices.

GetPlayerVehicleColour[edit | edit source]

string? GetPlayerVehicleColour()

Player's vehicle paint color. Returns "Black", "Blue", "Green", "Grey", "Orange", "Pink", "Purple", "Red", "White", "Yellow", "Special", or nil if unknown.

GetPlayerVehicleID[edit | edit source]

string GetPlayerVehicleID()

Player's vehicle ID. Returns a string like "XUSSCB1".

GetPlayerVehicleManufacturer[edit | edit source]

string GetPlayerVehicleManufacturer()

Player's vehicle manufacturer. Returns a string like "Jansen".

GetPlayerVehicleParentID[edit | edit source]

string GetPlayerVehicleParentID()

Player's vehicle parent ID, or its own ID if it has no parent.

GetPlayerVehicleType[edit | edit source]

string GetPlayerVehicleType()

Player's vehicle type. Returns "Car", "Motorbike" or "Plane".

GetTime[edit | edit source]

number GetTime()

Time since the challenge started, in seconds.

GetTimeOfDay[edit | edit source]

number, number, number GetTimeOfDay()

Hours, minutes and seconds of the in-game time, respectively.

GoToChallengeStage[edit | edit source]

boolean GoToChallengeStage(number stage)

Change to the specified stage. Always returns true?

HUD_ClearLandmarks[edit | edit source]

HUD_ClearLandmarks()

Removes all minimap dots.

HUD_ClearTickerMessage[edit | edit source]

HUD_ClearTickerMessage()

Hides the ticker.

HUD_DisableHUDOption[edit | edit source]

HUD_DisableHUDOption(string option)

Disables the given HUD option.

HUD_DisableLandmark[edit | edit source]

HUD_DisableLandmark(number id)

Removes the specified minimap dot. The parameter is a number previously returned by HUD_EnableLandmark.

HUD_EnableHUDOption[edit | edit source]

HUD_EnableHUDOption(string option)

Enables the given HUD option.

HUD_EnableLandmark[edit | edit source]

number HUD_EnableLandmark(number id)

Adds a minimap dot. Returns a number to be used with HUD_DisableLandmark.

HUD_HideEliminatedPlayersOnMap[edit | edit source]

HUD_HideEliminatedPlayersOnMap()

Removes eliminated players (gray, not in challenge) from the minimap?

HUD_HideOtherTeamsOnMap[edit | edit source]

HUD_HideOtherTeamsOnMap()

Disables showing teams different from the player's from the minimap.

HUD_MarkIconsVisible[edit | edit source]

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[edit | edit source]

HUD_SetEventInfoHeadings(string label...)

Sets the label(s) for the EVENTINFO HUD option.

HUD_SetEventInfoTitle[edit | edit source]

HUD_SetEventInfoTitle(string title)

Sets the title for the EVENTINFO HUD option.

HUD_SetEventInfoValue[edit | edit source]

HUD_SetEventInfoValue(number index, string format, any value, boolean flash)

Sets a value for the EVENTINFO HUD option. Index starts at 0.

HUD_SetPlayerListNumberOfTargets[edit | edit source]

HUD_SetPlayerListNumberOfTargets(number unk)

Unknown, the parameter is always 1 in the unused scripted challenges?

HUD_SetPlayerListScore[edit | edit source]

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[edit | edit source]

HUD_SetPlayerListSortMode(string mode)

Sets the POSITIONTABLE HUD option sorting mode. See POSITIONTABLE Sorting.

HUD_SetPlayerListTitle[edit | edit source]

HUD_SetPlayerListTitle(string title)

Sets the POSITIONTABLE HUD option list title.

HUD_SetPlayerListType[edit | edit source]

HUD_SetPlayerListType(string type)

Sets the POSITIONTABLE HUD option list display type. See POSITIONTABLE Type.

HUD_SetTeamBased[edit | edit source]

HUD_SetTeamBased(boolean yes)

Sets whether the POSITIONTABLE HUD option shows team colors.

HUD_ShowEliminatedPlayersOnMap[edit | edit source]

HUD_ShowEliminatedPlayersOnMap()

HUD_ShowGamerTagNegativeHUDMessage[edit | edit source]

HUD_ShowGamerTagNegativeHUDMessage(string title, string subtitle, number time, string? audio, ...)

No apparent difference from HUD_ShowNegativeHUDMessage.

HUD_ShowGamerTagPositiveHUDMessage[edit | edit source]

HUD_ShowGamerTagPositiveHUDMessage(string title, string subtitle, number time, string? audio, ...)

No apparent difference from HUD_ShowPositiveHUDMessage.

HUD_ShowNegativeHUDMessage[edit | edit source]

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[edit | edit source]

HUD_ShowOtherTeamsOnMap()

Enables showing different teams from the player's from the minimap.

HUD_ShowPositiveHUDMessage[edit | edit source]

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[edit | edit source]

HUD_ShowStartHUDMessage(string title, string subtitle, number time, string? audio, ...)

No apparent difference from HUD_ShowPositiveHUDMessage.

HUD_ShowTickerMessage[edit | edit source]

HUD_ShowTickerMessage(string text, boolean? loop, number? unk)

Shows a message on the ticker, either once or continuously. Looping defaults to false.

HasPlayerCrashed[edit | edit source]

boolean HasPlayerCrashed(number unk)

Always returns false?

IsPlayerBoostBarFull[edit | edit source]

boolean IsPlayerBoostBarFull()

Whether the Player's boost bar is filled.

IsPlayerCarDeformed[edit | edit source]

boolean IsPlayerCarDeformed()

Whether the Player's vehicle has deformation. Damage value is irrelevant.

IsPlayerCrashing[edit | edit source]

boolean IsPlayerCrashing()

Whether the Player is currently crashing.

IsPlayerDoingWheelie[edit | edit source]

boolean IsPlayerDoingWheelie()

Whether the Player is doing a Wheelie.

IsPlayerInAir[edit | edit source]

boolean IsPlayerInAir()

Whether the Player is in the air.

IsPlayerInChallenge[edit | edit source]

boolean IsPlayerInChallenge(number player)

Whether the given player is participating in the challenge.

IsPlayerInCounty[edit | edit source]

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[edit | edit source]

boolean IsPlayerInRoad(number id)

Whether the Player is in the given road. See Road Indices.

IsPlayerInTrigger[edit | edit source]

boolean IsPlayerInTrigger(number id...)

Whether the Player is any triggers with the given ID.

IsPlayerInTriggerGroup[edit | edit source]

IsPlayerInTriggerGroup(number id...)

Crashes the game?

IsPlayerTouchingWall[edit | edit source]

boolean IsPlayerTouchingWall()

Whether the Player is touching a wall.

LockPlayerVehicle[edit | edit source]

LockPlayerVehicle()

Forces the handbrake on and disables input. Boosting state is maintained.

PlayAudioGUISound[edit | edit source]

PlayAudioGUISound(string audio)

Plays the given sound. See Sound List.

Print[edit | edit source]

Print(string text)

Has no visible effect.

ResetPlayerDrivingDistance[edit | edit source]

ResetPlayerDrivingDistance()

Resets the result of GetPlayerDrivingDistance.

ResetTeams[edit | edit source]

ResetTeams()

Scoring_AddScoreEntry[edit | edit source]

number Scoring_AddScoreEntry(number limit)

Scoring_AddSlot[edit | edit source]

number Scoring_AddSlot(number limit)

Alias of Scoring_AddScoreEntry.

Scoring_GetMyScore[edit | edit source]

number Scoring_GetMyScore(number slot)

Scoring_GetScore[edit | edit source]

number Scoring_GetScore(number player, number slot)

Scoring_GetTotalScore[edit | edit source]

number Scoring_GetTotalScore(number slot)

Scoring_SetMyScore[edit | edit source]

Scoring_SetMyScore(number slot, number score, number? unk)

SetPlayerBoostAmount[edit | edit source]

SetPlayerBoostAmount(number amount)

Set the player's boost amount as a number from 0 to 100.

SetPlayerTeam[edit | edit source]

SetPlayerTeam(number team)

Sets the player's team. See Team Indices.

SetTimeOfDay[edit | edit source]

SetTimeOfDay(number hour, number minute)

Sets the in-game time.

SetWeather[edit | edit source]

SetWeather(string name, number? delta)

Sets the weather, specifying a transition time. Names are "Sunny", "Overcast" and "Foggy".

TimeSince[edit | edit source]

number TimeSince(number timestamp)

Time since the given timestamp, in seconds. Timestamps in the future return a negative number.

Traffic_SetDensity[edit | edit source]

Traffic_SetDensity(number density)

Sets the traffic density.

Triggers_DistanceToTrigger[edit | edit source]

number Triggers_DistanceToTrigger(number id)

Alias of DistanceToTrigger.

Triggers_GetGroupIDOfTrigger[edit | edit source]

number Triggers_GetGroupIDOfTrigger(number id)

Alias of GetGroupIDOfTrigger.

Triggers_GetScoringSlotForTrigger[edit | edit source]

Triggers_GetScoringSlotForTrigger(number unk)

Triggers_HasLocalPlayerActivatedTrigger[edit | edit source]

Triggers_HasLocalPlayerActivatedTrigger(number unk)

Triggers_HasPlayerActivatedTrigger[edit | edit source]

Triggers_HasPlayerActivatedTrigger(number unk1, number unk2)

Triggers_HaveAllPlayersActivatedTrigger[edit | edit source]

Triggers_HaveAllPlayersActivatedTrigger(number unk)

Triggers_HaveAnyPlayersActivatedTrigger[edit | edit source]

Triggers_HaveAnyPlayersActivatedTrigger(number unk)

Triggers_HowManyPlayersHaveActivatedTrigger[edit | edit source]

Triggers_HowManyPlayersHaveActivatedTrigger(number unk)

Triggers_IsPlayerInTrigger[edit | edit source]

boolean Triggers_IsPlayerInTrigger(number id...)

Alias of IsPlayerInTrigger.

Triggers_IsPlayerInTriggerGroup[edit | edit source]

boolean Triggers_IsPlayerInTriggerGroup(number id...)

Alias of IsPlayerInTriggerGroup.

Triggers_ResetLocalPlayerTriggerStatus[edit | edit source]

Triggers_ResetLocalPlayerTriggerStatus(number unk)

Triggers_StopTrackingAllTriggers[edit | edit source]

Triggers_StopTrackingAllTriggers()

Triggers_StopTrackingTrigger[edit | edit source]

Triggers_StopTrackingTrigger(number unk)

Triggers_TrackMeetUpTrigger[edit | edit source]

Triggers_TrackMeetUpTrigger(number unk1, number? unk2)

UnlockPlayerVehicle[edit | edit source]

UnlockPlayerVehicle()

Stop forcing the handbrake on and reallow player input.

Party Pack Functions[edit | edit source]

These functions are only available in the context of Party Pack challenges.

Controller_DisableBrakes[edit | edit source]

Controller_DisableBrakes()

Disables braking.

Controller_EnableBrakes[edit | edit source]

Controller_EnableBrakes()

Enables braking.

Controller_InvertSteering[edit | edit source]

Controller_InvertSteering()

Inverts steering.

Controller_LockAccelerator[edit | edit source]

Controller_LockAccelerator()

Locks the accelerator on.

Controller_LockBoost[edit | edit source]

Controller_LockBoost()

Locks boosting and makes boost infinite.

Controller_NormalSteering[edit | edit source]

Controller_NormalSteering()

Returns normal steering.

Controller_UnlockAccelerator[edit | edit source]

Controller_UnlockAccelerator()

Unlocks the accelerator.

Controller_UnlockBoost[edit | edit source]

Controller_UnlockBoost()

Unlocks boosting.

PassThePadHUD_SetScore[edit | edit source]

PassThePadHUD_SetScore(number score)

PassThePadHUD_SetupDigitalScoreDisplay[edit | edit source]

PassThePadHUD_SetupDigitalScoreDisplay(string title)

PassThePadHUD_SetupScoreDisplay[edit | edit source]

PassThePadHUD_SetupScoreDisplay(string title, string? heading, string? format)

PassThePadHUD_SetupTimeDisplay[edit | edit source]

PassThePadHUD_SetupTimeDisplay(string type, number? time)

PassThePad_CalculateScore[edit | edit source]

PassThePad_CalculateScore(number score, number min, number max, number bias, string type)

PassThePad_GetTimeSinceStart[edit | edit source]

number PassThePad_GetTimeSinceStart()

PassThePad_HoldGUITimer[edit | edit source]

PassThePad_HoldGUITimer()

PassThePad_SetCurrentGameScore[edit | edit source]

PassThePad_SetCurrentGameScore(number score)

PassThePad_SetStartingTrigger[edit | edit source]

PassThePad_SetStartingTrigger(number id)

PassThePad_SetVehicle[edit | edit source]

PassThePad_SetVehicle(string id)

PassThePad_UseAnalogueScoring[edit | edit source]

PassThePad_UseAnalogueScoring(string type, string format, string heading)

PassThePad_UseDigitalScoring[edit | edit source]

PassThePad_UseDigitalScoring()

Enumerations[edit | edit source]

HUD Options[edit | edit source]

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[edit | edit source]

Value Comments
JUNK_YARD
CAR_PARK No visible effect
BODY_SHOP Auto Repair
PAINT_SHOP
GAS_STATION
EVENT_ICONS

POSITIONTABLE Formats[edit | edit source]

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[edit | edit source]

Value
NONE
ALPHABETICAL
HIGHTOLOW
LOWTOHIGH
TEAM_HIGHTOLOW
TEAM_LOWTOHIGH
TEAM_BLUELOWTOHIGH_REDHIGHTOLOW
TEAM_REDLOWTOHIGH_BLUEHIGHTOLOW

POSITIONTABLE Type[edit | edit source]

Value Comments
DEFAULT Number column
TOTAL Number column and total
TICKBOX Number column and tickbox
TICKBOX_TOTAL Number column, tickbox and total

Sound List[edit | edit source]

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[edit | edit source]

Value Color
0 Black
1 Red
2 Blue
3 Yellow
4 Pink
5 Green
6 Orange
7 Purple
8 Cyan

Format Parameters[edit | edit source]

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[edit | edit source]

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