Types

Every type of the API. In TypeScript they are in the namespace OpenRoadMP, e.g. OpenRoadMP.Player.

WeatherCopy Anchor Link

type Weather = "clear" | "rain"

The weather of mp.players.setWeather / mp.world.setWeather: clear (dry, sunny or cloudy) or rain.

MarkerIconCopy Anchor Link

type MarkerIcon = "flag" | "none" | "question" | "rest" | "fuel" | "service" | "garage" | "weigh" | "dealer" | "recruitment" | "buy" | "ferry" | "train" | "toll" | "border" | "viewpoint" | "ring"

The symbol of a world marker's hologram (the game's own): flag (default), none (only the brackets and the ring), question, rest (bed), fuel, service (wrench), garage, weigh (scales), dealer, recruitment, buy (euro), ferry (anchor), train, toll, border, viewpoint, ring (only the ring on the ground, no brackets or symbol).

UiElementCopy Anchor Link

type UiElement = { readonly type: string }

A building block made with ui.* (e.g. ui.button(...)).

UiChildCopy Anchor Link

type UiChild = UiElement | string | number | false | null | undefined

What a container takes: elements, text (shown as ui.text), or nothing (false/null/undefined are skipped, for conditions).

UiValuesCopy Anchor Link

type UiValues = Readonly<Record<string, string | number | boolean>>

The current values of all inputs of the view, by their id.

UiHandlerCopy Anchor Link

type UiHandler = (player: Player, values: UiValues) => void

Called in the gamemode when the player clicks or changes something.

CompanyActionCopy Anchor Link

type CompanyAction = (player: PlayerRef) => void

company.add / company.remove: takes a player or a player id.

StorageValueCopy Anchor Link

type StorageValue = null | boolean | number | string | StorageValue[] | { [key: string]: StorageValue }

What mp.storage keeps: anything JSON can hold.

StoreCopy Anchor Link

type Store = {
      /** The value, or undefined. A copy - change it and set() it again. */
      get(key: string): StorageValue | undefined
      /** Saves a value (undefined deletes it). Written to disk within a second. */
      set(key: string, value: StorageValue | undefined): void
      delete(key: string): void
      has(key: string): boolean
      keys(): string[]
    }

A key-value store of mp.storage (keys: 1-100 characters).

ZoneCopy Anchor Link

type Zone = {
      readonly id: number
      readonly name: string
      /** Middle; change it to move the zone. */
      center: Vector3
      /** Radius in metres (on the ground, x/z) */
      radius: number
      /** Height of the zone in metres around center.y; 0 = any height */
      height: number
      /** Players in the zone right now */
      readonly players: readonly Player[]
      contains(position: Vector3): boolean
      /** Deletes the zone (players in it get playerLeaveZone). */
      remove(): void
    }

An area made with mp.zones.create. Players in it get playerEnterZone / playerLeaveZone (checked about once a second).

ChatHandlerCopy Anchor Link

type ChatHandler = (player: Player, text: string) => string | false | void

mp.chat.onMessage: return false to drop the message, a string to send that instead, nothing to send it as it is.

PlaceTypeCopy Anchor Link

type PlaceType = "fuel" | "service" | "dealer" | "garage" | "recruitment" | "weighStation" | "parking" | "viewpoint" | "ferry"

Kinds of places on the map (mp.world.places).

MapMarkerCopy Anchor Link

type MapMarker = {
      readonly id: number
      /** Where it is; change it to move the marker. */
      position: MapPoint
      label: string
      /** "#rrggbb" */
      color: string
      remove(): void
    }

A marker on the server's live map (mp.map.addMarker).

WorldMarkerCopy Anchor Link

type WorldMarker = {
      readonly id: number
      /** Where it is; change it to move the marker for everyone who sees it. */
      position: MapPoint | Vector3
      label: string
      /** "#rrggbb" */
      color: string
      /** Metres from the player's truck within which it is shown (10-100000). */
      range: number
      /** The label is seen through everything (else buildings and terrain hide it). */
      throughObjects: boolean
      /** false: no label, only the hologram. */
      showLabel: boolean
      /** The symbol in the hologram. */
      icon: MarkerIcon
      remove(): void
    }

A marker in the players' 3D world (mp.markers.add).

Vector3Copy Anchor Link

World coordinates in metres: x = east, y = up, z = south.

DamageCopy Anchor Link

Truck wear from 0 (new) to 1 (broken), as shown by the game's truck diagnostics.

JobPlaceCopy Anchor Link

One end of a job: city and company, display names as the player's game shows them plus the game's ids.

JobCopy Anchor Link

The player's active job, as the game describes it.

RadioCopy Anchor Link

What the player listens to.

CommandInfoCopy Anchor Link

A chat command of a gamemode on this server.

PlayerCopy Anchor Link

A connected player. Position and speed are updated every second.

FineCopy Anchor Link

ServerInfoCopy Anchor Link

JobDeliveredCopy Anchor Link

A completed freight job of the game.

JobCancelledCopy Anchor Link

TollPaidCopy Anchor Link

TransportCopy Anchor Link

Ferry or train.

SpecialJobDoneCopy Anchor Link

Car transport or bus job (newer game content).

TruckInfoCopy Anchor Link

A truck a player can get with players.setVehicle (see mp.vehicles.trucks()).

JobPlaceRefCopy Anchor Link

One end of a job to assign, as the game's ids (the same as Job.source.companyId / cityId).

JobSpecCopy Anchor Link

A freight market job to assign (see JobBuilder).

MailCopy Anchor Link

A mail for the game's mail screen (desktop menu Mail). Plain text: a line break starts a new line, < and > are shown as ( and ).

UiViewOptionsCopy Anchor Link

Options of a UiView.

UiStackPropsCopy Anchor Link

Children one below the other.

UiRowPropsCopy Anchor Link

Children side by side.

UiGridPropsCopy Anchor Link

Children in a grid.

UiCardPropsCopy Anchor Link

A framed card.

UiTextPropsCopy Anchor Link

UiHeadingPropsCopy Anchor Link

UiBadgePropsCopy Anchor Link

UiAlertPropsCopy Anchor Link

UiProgressPropsCopy Anchor Link

UiTablePropsCopy Anchor Link

UiSectionCopy Anchor Link

A tab or an accordion item.

UiTabsPropsCopy Anchor Link

UiAccordionPropsCopy Anchor Link

UiButtonPropsCopy Anchor Link

UiInputPropsCopy Anchor Link

UiTextareaPropsCopy Anchor Link

UiOptionCopy Anchor Link

An entry of a select or radio group.

UiSelectPropsCopy Anchor Link

UiCheckPropsCopy Anchor Link

A checkbox or switch.

UiRadioPropsCopy Anchor Link

UiSliderPropsCopy Anchor Link

UiLogoPickerPropsCopy Anchor Link

CompanyInitCopy Anchor Link

What mp.companies.create takes.

CompanyCopy Anchor Link

A company of your gamemode (mp.companies.create). Its members see its name and logo in the game as their own company. Changing name or logo applies to every member right away. Companies live as long as the gamemode runs.

ZoneInitCopy Anchor Link

What mp.zones.create takes.

BanCopy Anchor Link

A ban by Open Road MP account (mp.bans).

BanOptionsCopy Anchor Link

What mp.bans.add takes besides the player.

CommandOptionsCopy Anchor Link

Optional fourth argument of mp.commands.add.

MapPointCopy Anchor Link

A point on the map: x to the east, z to the south, in metres (like position, without the height).

CityCopy Anchor Link

A city on the map (mp.world).

CompanySiteCopy Anchor Link

A company depot on the map (mp.world.companies) - the places of the game's jobs.

PlaceCopy Anchor Link

A fuel station, service, dealer ... (mp.world.places).

CargoInfoCopy Anchor Link

A cargo of the game (mp.world.cargo).

MarkerInitCopy Anchor Link

What mp.map.addMarker takes.

WorldMarkerInitCopy Anchor Link

What mp.markers.add takes.

NoticeCopy Anchor Link

A notice at the top of a player's HUD (mp.ui.notify).

VehicleStateCopy Anchor Link

The gauges and switches of a player's truck, updated every second. Gear, rpm, fuel, odometer, cruise control, speed limit, parking brake, cargo damage and route are missing for players with an older client.

VehicleLightsCopy Anchor Link

Light switches of a truck.

RouteCopy Anchor Link

What the navigation shows for its route.

CompanySpawnCopy Anchor Link

A place at a company depot for a truck: on the ground, facing into the yard.