RAGE Multiplayer Wiki - User contributions [en]

Template:Vehicle functions c

2021-12-19T09:09:07Z

MrPancakers2: Added vehicle.setExperimentalAttachmentSyncEnabled

*[[Vehicle::addModelOverride|mp.game.vehicle.addModelOverride]]
*[[Vehicle::addVehicleStuckCheckWithWarp|mp.game.vehicle.addVehicleStuckCheckWithWarp]]
*[[Vehicle::clearModelOverrides|mp.game.vehicle.clearModelOverrides]]
*[[Vehicle::createMissionTrain|mp.game.vehicle.createMissionTrain]]
*[[Vehicle::createScriptVehicleGenerator|mp.game.vehicle.createScriptVehicleGenerator]]
*[[Vehicle::createVehicle|mp.game.vehicle.createVehicle]]
*[[Vehicle::defaultEngineBehaviour|mp.game.vehicle.defaultEngineBehaviour]]
*[[Vehicle::deleteMissionTrain|mp.game.vehicle.deleteMissionTrain]]
*[[Vehicle::deleteScriptVehicleGenerator|mp.game.vehicle.deleteScriptVehicleGenerator]]
*[[Vehicle::disableVehicleWeapon|mp.game.vehicle.disableVehicleWeapon]]
*[[Vehicle::displayDistantVehicles|mp.game.vehicle.displayDistantVehicles]]
*[[Vehicle::doesScriptVehicleGeneratorExist|mp.game.vehicle.doesScriptVehicleGeneratorExist]]
*[[Vehicle::doesVehicleExistWithDecorator|mp.game.vehicle.doesVehicleExistWithDecorator]]
*[[Vehicle::getClosestVehicle|mp.game.vehicle.getClosestVehicle]]
*[[Vehicle::getCurrentPlaybackForVehicle|mp.game.vehicle.getCurrentPlaybackForVehicle]]
*[[Vehicle::getDisplayNameFromVehicleModel|mp.game.vehicle.getDisplayNameFromVehicleModel]]
*[[Vehicle::getNumModColors|mp.game.vehicle.getNumModColors]]
*[[Vehicle::getPositionInRecording|mp.game.vehicle.getPositionInRecording]]
*[[Vehicle::getPositionOfVehicleRecordingAtTime|mp.game.vehicle.getPositionOfVehicleRecordingAtTime]]
*[[Vehicle::getRandomVehicleBackBumperInSphere|mp.game.vehicle.getRandomVehicleBackBumperInSphere]]
*[[Vehicle::getRandomVehicleFrontBumperInSphere|mp.game.vehicle.getRandomVehicleFrontBumperInSphere]]
*[[Vehicle::getRandomVehicleInSphere|mp.game.vehicle.getRandomVehicleInSphere]]
*[[Vehicle::getRandomVehicleModelInMemory|mp.game.vehicle.getRandomVehicleModelInMemory]]
*[[Vehicle::getRotationOfVehicleRecordingAtTime|mp.game.vehicle.getRotationOfVehicleRecordingAtTime]]
*[[Vehicle::getTimePositionInRecording|mp.game.vehicle.getTimePositionInRecording]]
*[[Vehicle::getTotalDurationOfVehicleRecordingId|mp.game.vehicle.getTotalDurationOfVehicleRecordingId]]
*[[Vehicle::getTotalDurationOfVehicleRecording|mp.game.vehicle.getTotalDurationOfVehicleRecording]]
*[[Vehicle::getVehicleClassFromName|mp.game.vehicle.getVehicleClassFromName]]
*[[Vehicle::getVehicleClassMaxAcceleration|mp.game.vehicle.getVehicleClassMaxAcceleration]]
*[[Vehicle::getVehicleClassMaxAgility|mp.game.vehicle.getVehicleClassMaxAgility]]
*[[Vehicle::getVehicleClassMaxBraking|mp.game.vehicle.getVehicleClassMaxBraking]]
*[[Vehicle::getVehicleClassMaxTraction|mp.game.vehicle.getVehicleClassMaxTraction]]
*[[Vehicle::getVehicleModelAcceleration|mp.game.vehicle.getVehicleModelAcceleration]]
*[[Vehicle::getVehicleModelMaxBraking|mp.game.vehicle.getVehicleModelMaxBraking]]
*[[Vehicle::getVehicleModelMaxNumberOfPassengers|mp.game.vehicle.getVehicleModelMaxNumberOfPassengers]]
*[[Vehicle::getVehicleModelMaxSpeed|mp.game.vehicle.getVehicleModelMaxSpeed]]
*[[Vehicle::getVehicleModelMaxTraction|mp.game.vehicle.getVehicleModelMaxTraction]]
*[[Vehicle::getVehicleRecordingId|mp.game.vehicle.getVehicleRecordingId]]
*[[Vehicle::hasPreloadModsFinished|mp.game.vehicle.hasPreloadModsFinished]]
*[[Vehicle::hasVehicleAssetLoaded|mp.game.vehicle.hasVehicleAssetLoaded]]
*[[Vehicle::hasVehicleRecordingBeenLoaded|mp.game.vehicle.hasVehicleRecordingBeenLoaded]]
*[[Vehicle::isAnyVehicleNearPoint|mp.game.vehicle.isAnyVehicleNearPoint]]
*[[Vehicle::isCopVehicleInArea3d|mp.game.vehicle.isCopVehicleInArea3d]]
*[[Vehicle::isPlaybackGoingOnForVehicle|mp.game.vehicle.isPlaybackGoingOnForVehicle]]
*[[Vehicle::isPlaybackUsingAiGoingOnForVehicle|mp.game.vehicle.isPlaybackUsingAiGoingOnForVehicle]]
*[[Vehicle::isThisModelABicycle|mp.game.vehicle.isThisModelABicycle]]
*[[Vehicle::isThisModelABike|mp.game.vehicle.isThisModelABike]]
*[[Vehicle::isThisModelABoat|mp.game.vehicle.isThisModelABoat]]
*[[Vehicle::isThisModelACar|mp.game.vehicle.isThisModelACar]]
*[[Vehicle::isThisModelAHeli|mp.game.vehicle.isThisModelAHeli]]
*[[Vehicle::isThisModelAPlane|mp.game.vehicle.isThisModelAPlane]]
*[[Vehicle::isThisModelAQuadbike|mp.game.vehicle.isThisModelAQuadbike]]
*[[Vehicle::isThisModelATrain|mp.game.vehicle.isThisModelATrain]]
*[[Vehicle::isThisModelAnEmergencyBoat|mp.game.vehicle.isThisModelAnEmergencyBoat]]
*[[Vehicle::isVehicleInGarageArea|mp.game.vehicle.isVehicleInGarageArea]]
*[[Vehicle::pausePlaybackRecordedVehicle|mp.game.vehicle.pausePlaybackRecordedVehicle]]
*[[Vehicle::preloadVehicleMod|mp.game.vehicle.preloadVehicleMod]]
*[[Vehicle::removeModelOverride|mp.game.vehicle.removeModelOverride]]
*[[Vehicle::removeVehicleAsset|mp.game.vehicle.removeVehicleAsset]]
*[[Vehicle::removeVehicleRecording|mp.game.vehicle.removeVehicleRecording]]
*[[Vehicle::removeVehicleStuckCheck|mp.game.vehicle.removeVehicleStuckCheck]]
*[[Vehicle::removeVehiclesFromGeneratorsInArea|mp.game.vehicle.removeVehiclesFromGeneratorsInArea]]
*[[Vehicle::repairOnExtraToggle|mp.game.vehicle.repairOnExtraToggle]]
*[[Vehicle::requestVehicleAsset|mp.game.vehicle.requestVehicleAsset]]
*[[Vehicle::requestVehicleRecording|mp.game.vehicle.requestVehicleRecording]]
*[[Vehicle::setAllLowPriorityVehicleGeneratorsActive|mp.game.vehicle.setAllLowPriorityVehicleGeneratorsActive]]
*[[Vehicle::setAllVehicleGeneratorsActiveInArea|mp.game.vehicle.setAllVehicleGeneratorsActiveInArea]]
*[[Vehicle::setCargobobHookPosition|mp.game.vehicle.setCargobobHookPosition]]
*[[Vehicle::setExperimentalAttachmentSyncEnabled|mp.game.vehicle.setExperimentalAttachmentSyncEnabled]]
*[[Vehicle::setFarDrawVehicles|mp.game.vehicle.setFarDrawVehicles]]
*[[Vehicle::setGarbageTrucks|mp.game.vehicle.setGarbageTrucks]]
*[[Vehicle::setMissionTrainAsNoLongerNeeded|mp.game.vehicle.setMissionTrainAsNoLongerNeeded]]
*[[Vehicle::setNumberOfParkedVehicles|mp.game.vehicle.setNumberOfParkedVehicles]]
*[[Vehicle::setParkedVehicleDensityMultiplierThisFrame|mp.game.vehicle.setParkedVehicleDensityMultiplierThisFrame]]
*[[Vehicle::setPlaybackSpeed|mp.game.vehicle.setPlaybackSpeed]]
*[[Vehicle::setPlaybackToUseAiTryToRevertBackLater|mp.game.vehicle.setPlaybackToUseAiTryToRevertBackLater]]
*[[Vehicle::setRandomBoats|mp.game.vehicle.setRandomBoats]]
*[[Vehicle::setRandomTrains|mp.game.vehicle.setRandomTrains]]
*[[Vehicle::setRandomVehicleDensityMultiplierThisFrame|mp.game.vehicle.setRandomVehicleDensityMultiplierThisFrame]]
*[[Vehicle::setScriptVehicleGenerator|mp.game.vehicle.setScriptVehicleGenerator]]
*[[Vehicle::setVehicleDensityMultiplierThisFrame|mp.game.vehicle.setVehicleDensityMultiplierThisFrame]]
*[[Vehicle::setVehicleModelIsSuppressed|mp.game.vehicle.setVehicleModelIsSuppressed]]
*[[Vehicle::setVehicleShootAtTarget|mp.game.vehicle.setVehicleShootAtTarget]]
*[[Vehicle::skipTimeInPlaybackRecordedVehicle|mp.game.vehicle.skipTimeInPlaybackRecordedVehicle]]
*[[Vehicle::skipToEndAndStopPlaybackRecordedVehicle|mp.game.vehicle.skipToEndAndStopPlaybackRecordedVehicle]]
*[[Vehicle::startPlaybackRecordedVehicleUsingAi|mp.game.vehicle.startPlaybackRecordedVehicleUsingAi]]
*[[Vehicle::startPlaybackRecordedVehicleWithFlags|mp.game.vehicle.startPlaybackRecordedVehicleWithFlags]]
*[[Vehicle::startPlaybackRecordedVehicle|mp.game.vehicle.startPlaybackRecordedVehicle]]
*[[Vehicle::stopPlaybackRecordedVehicle|mp.game.vehicle.stopPlaybackRecordedVehicle]]
*[[Vehicle::switchTrainTrack|mp.game.vehicle.switchTrainTrack]]
*[[Vehicle::unpausePlaybackRecordedVehicle|mp.game.vehicle.unpausePlaybackRecordedVehicle]]

Client-side functions

2021-12-19T09:07:45Z

MrPancakers2: Added nametags.orderByDistance

==RAGE Classes==
===Blip===
{{Blip_functions_c}}

===Browser===
{{Browser_definition_c}}

===Camera===
{{Camera_definition_c}}

===Checkpoint===
*[[Checkpoint::Checkpoint]]

===Dummy Entity===
{{Dummies_definition_c}}

===Entity===
{{Entity_functions_c}}

===Entity pool===
{{EntityPool_Client_functions}}

===Label===
{{Label_definition_c}}

===Marker===
{{Marker_definition_c}}

===Object===
{{Object_definition_c}}

===Peds===
*[[Ped::Ped]]

===Pickup===
*[[Pickup::Pickup]]

===Player===
{{Player_definition_c}}

===Vector3===
{{Vector3_definition}}

===Vehicle===
{{Vehicle_definition_c}}

==RAGE Static Objects==
===Globals===
{{Global_properties_c}}

=== Console ===
{{Console_definition_c}}

===Cursor===
{{Cursor_definition_c}}

===Discord===
*[[Discord::update|mp.discord.update]]

===Event===
{{Event_functions_c}}

===Gui===
{{Gui_definition_c}}

===Keys===
{{Keys_functions_c}}

===Nametags===
*Functions:
**[[nametags.update|mp.nametags.update]]
**[[nametags.set|mp.nametags.set]]
*Properties:
**[[nametags.enabled|mp.nametags.enabled]]
**[[nametags.orderByDistance|mp.nametags.orderByDistance]]
**[[nametags.useScreen2dCoords|mp.nametags.useScreen2dCoords]]

===Preferences===
{{Preferences_definition_c}}

===Raycasting===
*[[Raycasting::testPointToPoint|mp.raycasting.testPointToPoint]]
*[[Raycasting::testCapsule|mp.raycasting.testCapsule]]

===Storage===
{{Storage_definition_c}}

===System===
*Functions:
**[[system.notify()|mp.system.notify]]
*Properties:
**[[system.isFullscreen|mp.system.isFullscreen]]
**[[system.isFocused|mp.system.isFocused]]

===Voice chat===
*Functions:
**[[voiceChat.getPreprocessingParam|mp.voiceChat.getPreprocessingParam]]
**[[voiceChat.setPreprocessingParam|mp.voiceChat.setPreprocessingParam]]
*Properties:
**[[voiceChat.lastVad|mp.voiceChat.lastVad]]
**[[voiceChat.minVad|mp.voiceChat.minVad]]
**[[voiceChat.muted|mp.voiceChat.muted]]

==Game Static Objects==

===App===
{{App_functions_c}}

===Audio===
{{Audio_functions_c}}

===Brain===
{{Brain_functions_c}}

===Cam===
{{Cam_functions_c}}

===Controls===
{{Controls_functions_c}}

===Cutscene===
{{Cutscene_functions_c}}

===Datafile===
{{Datafile_functions_c}}

===Decisionevent===
{{Decisionevent_functions_c}}

===Decorator===
*[[Decorator::decorIsRegisteredAsType|mp.game.decorator.decorIsRegisteredAsType]]
*[[Decorator::decorRegister|mp.game.decorator.decorRegister]]

===DLC===
{{Dlc1_functions_c}}

===DLC2===
*[[Dlc2::nullify|mp.game.dlc2.nullify]]
*[[Dlc2::isDlcPresent|mp.game.dlc2.isDlcPresent]]

===Fire===
{{Fire_functions_c}}

===Gameplay===
{{Gameplay_functions_c}}

===Game Globals===
{{GameGlobals}}

*Properties:
**[[Client-side_functions#App|mp.game.app]]
**[[Client-side_functions#Audio|mp.game.audio]]
**[[Client-side_functions#Brain|mp.game.brain]]
**[[Client-side_functions#Cam|mp.game.cam]]
**[[Client-side_functions#Controls|mp.game.controls]]
**[[Client-side_functions#Cutscene|mp.game.cutscene]]
**[[Client-side_functions#Datafile|mp.game.datafile]]
**[[Client-side_functions#Decisionevent|mp.game.decisionevent]]
**[[Client-side_functions#Decorator|mp.game.decorator]]
**[[Client-side_functions#Dlc1|mp.game.dlc1]]
**[[Client-side_functions#Dlc2|mp.game.dlc2]]
**[[Client-side_functions#Entity|mp.game.entity]]
**[[Client-side_functions#Fire|mp.game.fire]]
**[[Client-side_functions#Gameplay|mp.game.gameplay]]
**[[Client-side_functions#Graphics|mp.game.graphics]]
**[[Client-side_functions#GXT|mp.game.gxt]]
**[[Client-side_functions#Interior|mp.game.interior]]
**[[Client-side_functions#Itemset|mp.game.itemset]]
**[[Client-side_functions#Mobile|mp.game.mobile]]
**[[Client-side_functions#Object|mp.game.object]]
**[[Client-side_functions#Pathfind|mp.game.pathfind]]
**[[Client-side_functions#Ped|mp.game.ped]]
**[[Client-side_functions#Player|mp.game.player]]
**[[Client-side_functions#Rope|mp.game.rope]]
**[[Client-side_functions#Script|mp.game.script]]
**[[Client-side_functions#Stats|mp.game.stats]]
**[[Client-side_functions#Streaming|mp.game.streaming]]
**[[Client-side_functions#System (Game)|mp.game.system]]
**[[Client-side_functions#Time|mp.game.time]]
**[[Client-side_functions#Ui|mp.game.ui]]
**[[Client-side_functions#Unk|mp.game.unk]]
**[[Client-side_functions#Recorder|mp.game.recorder]]
**[[Client-side_functions#Vehicle|mp.game.vehicle]]
**[[Client-side_functions#Water|mp.game.water]]
**[[Client-side_functions#Weapon|mp.game.weapon]]
**[[Client-side_functions#Worldprobe|mp.game.worldprobe]]
**[[Client-side_functions#Zone|mp.game.zone]]

===Graphics===
{{Graphics_functions_c}}

===GXT===
{{GXT_functions_c}}

===Interior===
{{Interior_functions_c}}

===Itemset===
{{Itemset_functions_c}}

===Mobile===
{{Mobile_functions_c}}

===Object===
{{Object_functions_c}}

===Pathfind===
{{Path_functions_c}}

===Ped===
{{Ped_functions_c}}

===Player===
{{Player_functions_c}}

===Recorder===
*[[Recorder::start|mp.game.recorder.start]]
*[[Recorder::stop|mp.game.recorder.stop]]
*[[Recorder::isRecording|mp.game.recorder.isRecording]]

===Rope===
{{Rope_functions_c}}

===Script===
{{Script_functions_c}}

===Stats===
{{Stats_functions_c}}

===Streaming===
{{Streaming_functions_c}}

===System (Game)===
{{System_functions_c}}

===Time===
{{Time_functions_c}}

===Ui===
{{Ui_functions_c}}

===Unk===
*[[Unk::getBroadcastFinishedLosSound|mp.game.unk.getBroadcastFinishedLosSound]]

===Vehicle===
{{Vehicle_functions_c}}

===Water===
{{Water_functions_c}}

===Weapon===
{{Weapon_functions_c}}

===Worldprobe===
{{Worldprobe_functions_c}}

===Zone===
{{Zone_functions_c}}

Client-side functions

2021-12-19T09:06:32Z

MrPancakers2: Updated nametags links, added useScreen2dCoords

==RAGE Classes==
===Blip===
{{Blip_functions_c}}

===Browser===
{{Browser_definition_c}}

===Camera===
{{Camera_definition_c}}

===Checkpoint===
*[[Checkpoint::Checkpoint]]

===Dummy Entity===
{{Dummies_definition_c}}

===Entity===
{{Entity_functions_c}}

===Entity pool===
{{EntityPool_Client_functions}}

===Label===
{{Label_definition_c}}

===Marker===
{{Marker_definition_c}}

===Object===
{{Object_definition_c}}

===Peds===
*[[Ped::Ped]]

===Pickup===
*[[Pickup::Pickup]]

===Player===
{{Player_definition_c}}

===Vector3===
{{Vector3_definition}}

===Vehicle===
{{Vehicle_definition_c}}

==RAGE Static Objects==
===Globals===
{{Global_properties_c}}

=== Console ===
{{Console_definition_c}}

===Cursor===
{{Cursor_definition_c}}

===Discord===
*[[Discord::update|mp.discord.update]]

===Event===
{{Event_functions_c}}

===Gui===
{{Gui_definition_c}}

===Keys===
{{Keys_functions_c}}

===Nametags===
*Functions:
**[[nametags.update|mp.nametags.update]]
**[[nametags.set|mp.nametags.set]]
*Properties:
**[[nametags.enabled|mp.nametags.enabled]]
**[[nametags.useScreen2dCoords|mp.nametags.useScreen2dCoords]]

===Preferences===
{{Preferences_definition_c}}

===Raycasting===
*[[Raycasting::testPointToPoint|mp.raycasting.testPointToPoint]]
*[[Raycasting::testCapsule|mp.raycasting.testCapsule]]

===Storage===
{{Storage_definition_c}}

===System===
*Functions:
**[[system.notify()|mp.system.notify]]
*Properties:
**[[system.isFullscreen|mp.system.isFullscreen]]
**[[system.isFocused|mp.system.isFocused]]

===Voice chat===
*Functions:
**[[voiceChat.getPreprocessingParam|mp.voiceChat.getPreprocessingParam]]
**[[voiceChat.setPreprocessingParam|mp.voiceChat.setPreprocessingParam]]
*Properties:
**[[voiceChat.lastVad|mp.voiceChat.lastVad]]
**[[voiceChat.minVad|mp.voiceChat.minVad]]
**[[voiceChat.muted|mp.voiceChat.muted]]

==Game Static Objects==

===App===
{{App_functions_c}}

===Audio===
{{Audio_functions_c}}

===Brain===
{{Brain_functions_c}}

===Cam===
{{Cam_functions_c}}

===Controls===
{{Controls_functions_c}}

===Cutscene===
{{Cutscene_functions_c}}

===Datafile===
{{Datafile_functions_c}}

===Decisionevent===
{{Decisionevent_functions_c}}

===Decorator===
*[[Decorator::decorIsRegisteredAsType|mp.game.decorator.decorIsRegisteredAsType]]
*[[Decorator::decorRegister|mp.game.decorator.decorRegister]]

===DLC===
{{Dlc1_functions_c}}

===DLC2===
*[[Dlc2::nullify|mp.game.dlc2.nullify]]
*[[Dlc2::isDlcPresent|mp.game.dlc2.isDlcPresent]]

===Fire===
{{Fire_functions_c}}

===Gameplay===
{{Gameplay_functions_c}}

===Game Globals===
{{GameGlobals}}

*Properties:
**[[Client-side_functions#App|mp.game.app]]
**[[Client-side_functions#Audio|mp.game.audio]]
**[[Client-side_functions#Brain|mp.game.brain]]
**[[Client-side_functions#Cam|mp.game.cam]]
**[[Client-side_functions#Controls|mp.game.controls]]
**[[Client-side_functions#Cutscene|mp.game.cutscene]]
**[[Client-side_functions#Datafile|mp.game.datafile]]
**[[Client-side_functions#Decisionevent|mp.game.decisionevent]]
**[[Client-side_functions#Decorator|mp.game.decorator]]
**[[Client-side_functions#Dlc1|mp.game.dlc1]]
**[[Client-side_functions#Dlc2|mp.game.dlc2]]
**[[Client-side_functions#Entity|mp.game.entity]]
**[[Client-side_functions#Fire|mp.game.fire]]
**[[Client-side_functions#Gameplay|mp.game.gameplay]]
**[[Client-side_functions#Graphics|mp.game.graphics]]
**[[Client-side_functions#GXT|mp.game.gxt]]
**[[Client-side_functions#Interior|mp.game.interior]]
**[[Client-side_functions#Itemset|mp.game.itemset]]
**[[Client-side_functions#Mobile|mp.game.mobile]]
**[[Client-side_functions#Object|mp.game.object]]
**[[Client-side_functions#Pathfind|mp.game.pathfind]]
**[[Client-side_functions#Ped|mp.game.ped]]
**[[Client-side_functions#Player|mp.game.player]]
**[[Client-side_functions#Rope|mp.game.rope]]
**[[Client-side_functions#Script|mp.game.script]]
**[[Client-side_functions#Stats|mp.game.stats]]
**[[Client-side_functions#Streaming|mp.game.streaming]]
**[[Client-side_functions#System (Game)|mp.game.system]]
**[[Client-side_functions#Time|mp.game.time]]
**[[Client-side_functions#Ui|mp.game.ui]]
**[[Client-side_functions#Unk|mp.game.unk]]
**[[Client-side_functions#Recorder|mp.game.recorder]]
**[[Client-side_functions#Vehicle|mp.game.vehicle]]
**[[Client-side_functions#Water|mp.game.water]]
**[[Client-side_functions#Weapon|mp.game.weapon]]
**[[Client-side_functions#Worldprobe|mp.game.worldprobe]]
**[[Client-side_functions#Zone|mp.game.zone]]

===Graphics===
{{Graphics_functions_c}}

===GXT===
{{GXT_functions_c}}

===Interior===
{{Interior_functions_c}}

===Itemset===
{{Itemset_functions_c}}

===Mobile===
{{Mobile_functions_c}}

===Object===
{{Object_functions_c}}

===Pathfind===
{{Path_functions_c}}

===Ped===
{{Ped_functions_c}}

===Player===
{{Player_functions_c}}

===Recorder===
*[[Recorder::start|mp.game.recorder.start]]
*[[Recorder::stop|mp.game.recorder.stop]]
*[[Recorder::isRecording|mp.game.recorder.isRecording]]

===Rope===
{{Rope_functions_c}}

===Script===
{{Script_functions_c}}

===Stats===
{{Stats_functions_c}}

===Streaming===
{{Streaming_functions_c}}

===System (Game)===
{{System_functions_c}}

===Time===
{{Time_functions_c}}

===Ui===
{{Ui_functions_c}}

===Unk===
*[[Unk::getBroadcastFinishedLosSound|mp.game.unk.getBroadcastFinishedLosSound]]

===Vehicle===
{{Vehicle_functions_c}}

===Water===
{{Water_functions_c}}

===Weapon===
{{Weapon_functions_c}}

===Worldprobe===
{{Worldprobe_functions_c}}

===Zone===
{{Zone_functions_c}}

Template:Weapon functions c

2021-12-19T09:03:19Z

MrPancakers2: Added setCurrentDamageEventAmount

*[[Weapon::cancelCurrentDamageEvent|mp.game.weapon.cancelCurrentDamageEvent]]
*[[Weapon::canUseWeaponOnParachute|mp.game.weapon.canUseWeaponOnParachute]]
*[[Weapon::createWeaponObject|mp.game.weapon.createWeaponObject]]
*[[Weapon::doesWeaponTakeWeaponComponent|mp.game.weapon.doesWeaponTakeWeaponComponent]]
*[[Weapon::enableLaserSightRendering|mp.game.weapon.enableLaserSightRendering]]
*[[Weapon::getWeaponClipSize|mp.game.weapon.getWeaponClipSize]]
*[[Weapon::getWeaponComponentHudStats|mp.game.weapon.getWeaponComponentHudStats]]
*[[Weapon::getWeaponComponentTypeModel|mp.game.weapon.getWeaponComponentTypeModel]]
*[[Weapon::getWeaponDamageType|mp.game.weapon.getWeaponDamageType]]
*[[Weapon::getWeaponHudStats|mp.game.weapon.getWeaponHudStats]]
*[[Weapon::getWeaponObjectTintIndex|mp.game.weapon.getWeaponObjectTintIndex]]
*[[Weapon::getWeaponTintCount|mp.game.weapon.getWeaponTintCount]]
*[[Weapon::getWeapontypeGroup|mp.game.weapon.getWeapontypeGroup]]
*[[Weapon::getWeapontypeModel|mp.game.weapon.getWeapontypeModel]]
*[[Weapon::getWeapontypeSlot|mp.game.weapon.getWeapontypeSlot]]
*[[Weapon::giveWeaponComponentToWeaponObject|mp.game.weapon.giveWeaponComponentToWeaponObject]]
*[[Weapon::giveWeaponObjectToPed|mp.game.weapon.giveWeaponObjectToPed]]
*[[Weapon::hasVehicleGotProjectileAttached|mp.game.weapon.hasVehicleGotProjectileAttached]]
*[[Weapon::hasWeaponAssetLoaded|mp.game.weapon.hasWeaponAssetLoaded]]
*[[Weapon::hasWeaponGotWeaponComponent|mp.game.weapon.hasWeaponGotWeaponComponent]]
*[[Weapon::isWeaponValid|mp.game.weapon.isWeaponValid]]
*[[Weapon::removeAllProjectilesOfType|mp.game.weapon.removeAllProjectilesOfType]]
*[[Weapon::removeWeaponAsset|mp.game.weapon.removeWeaponAsset]]
*[[Weapon::removeWeaponComponentFromWeaponObject|mp.game.weapon.removeWeaponComponentFromWeaponObject]]
*[[Weapon::requestWeaponAsset|mp.game.weapon.requestWeaponAsset]]
*[[Weapon::requestWeaponHighDetailModel|mp.game.weapon.requestWeaponHighDetailModel]]
*[[Weapon::setCurrentDamageEventAmount|mp.game.weapon.setCurrentDamageEventAmount]]
*[[Weapon::setFlashLightFadeDistance|mp.game.weapon.setFlashLightFadeDistance]]
*[[Weapon::setPedAmmoToDrop|mp.game.weapon.setPedAmmoToDrop]]
*[[Weapon::setWeaponObjectTintIndex|mp.game.weapon.setWeaponObjectTintIndex]]
*[[Weapon::unequipEmptyWeapons|mp.game.weapon.unequipEmptyWeapons]]

Template:Weapon functions c

2021-12-19T09:02:26Z

MrPancakers2: Added cancelCurrentDamageEvent

*[[Weapon::cancelCurrentDamageEvent|mp.game.weapon.cancelCurrentDamageEvent]]
*[[Weapon::canUseWeaponOnParachute|mp.game.weapon.canUseWeaponOnParachute]]
*[[Weapon::createWeaponObject|mp.game.weapon.createWeaponObject]]
*[[Weapon::doesWeaponTakeWeaponComponent|mp.game.weapon.doesWeaponTakeWeaponComponent]]
*[[Weapon::enableLaserSightRendering|mp.game.weapon.enableLaserSightRendering]]
*[[Weapon::getWeaponClipSize|mp.game.weapon.getWeaponClipSize]]
*[[Weapon::getWeaponComponentHudStats|mp.game.weapon.getWeaponComponentHudStats]]
*[[Weapon::getWeaponComponentTypeModel|mp.game.weapon.getWeaponComponentTypeModel]]
*[[Weapon::getWeaponDamageType|mp.game.weapon.getWeaponDamageType]]
*[[Weapon::getWeaponHudStats|mp.game.weapon.getWeaponHudStats]]
*[[Weapon::getWeaponObjectTintIndex|mp.game.weapon.getWeaponObjectTintIndex]]
*[[Weapon::getWeaponTintCount|mp.game.weapon.getWeaponTintCount]]
*[[Weapon::getWeapontypeGroup|mp.game.weapon.getWeapontypeGroup]]
*[[Weapon::getWeapontypeModel|mp.game.weapon.getWeapontypeModel]]
*[[Weapon::getWeapontypeSlot|mp.game.weapon.getWeapontypeSlot]]
*[[Weapon::giveWeaponComponentToWeaponObject|mp.game.weapon.giveWeaponComponentToWeaponObject]]
*[[Weapon::giveWeaponObjectToPed|mp.game.weapon.giveWeaponObjectToPed]]
*[[Weapon::hasVehicleGotProjectileAttached|mp.game.weapon.hasVehicleGotProjectileAttached]]
*[[Weapon::hasWeaponAssetLoaded|mp.game.weapon.hasWeaponAssetLoaded]]
*[[Weapon::hasWeaponGotWeaponComponent|mp.game.weapon.hasWeaponGotWeaponComponent]]
*[[Weapon::isWeaponValid|mp.game.weapon.isWeaponValid]]
*[[Weapon::removeAllProjectilesOfType|mp.game.weapon.removeAllProjectilesOfType]]
*[[Weapon::removeWeaponAsset|mp.game.weapon.removeWeaponAsset]]
*[[Weapon::removeWeaponComponentFromWeaponObject|mp.game.weapon.removeWeaponComponentFromWeaponObject]]
*[[Weapon::requestWeaponAsset|mp.game.weapon.requestWeaponAsset]]
*[[Weapon::requestWeaponHighDetailModel|mp.game.weapon.requestWeaponHighDetailModel]]
*[[Weapon::setFlashLightFadeDistance|mp.game.weapon.setFlashLightFadeDistance]]
*[[Weapon::setPedAmmoToDrop|mp.game.weapon.setPedAmmoToDrop]]
*[[Weapon::setWeaponObjectTintIndex|mp.game.weapon.setWeaponObjectTintIndex]]
*[[Weapon::unequipEmptyWeapons|mp.game.weapon.unequipEmptyWeapons]]

Pickup::Pickup

2021-08-19T11:38:20Z

MrPancakers2:

__TOC__
{{ServersideJsFunction}}
Creates a new Pickup.
*'''[https://wiki.rage.mp/index.php?title=Pickups Pickups list]'''

{{JSContainer|
<pre>There is a shell "mp.pickups", but for some reason such a function does not exist in the list of functions of this shell:
mp.pickups.new();</pre>
<pre>There is also such a function in the "mp.pickups" shell, but unfortunately it also does not accept any parameters for implementation:
mp.pickups._new();</pre>
}}

Client-side functions

2021-08-19T11:37:27Z

MrPancakers2: Undo revision 21045 by Leinader (talk)

==Classes==
===Blip===
{{Blip_functions_c}}

===Browser===
{{Browser_definition_c}}

===Camera===
{{Camera_definition_c}}

===Checkpoint===
*[[Checkpoint::Checkpoint]]

===Dummy Entity===
{{Dummies_definition_c}}

===Entity===
{{Entity_functions_c}}

===Entity pool===
{{EntityPool_Client_functions}}

===Label===
{{Label_definition_c}}

===Marker===
{{Marker_definition_c}}

===Object===
{{Object_definition_c}}

===Peds===
*[[Peds::new|mp.peds.new]]

===Pickup===
*[[Pickup::Pickup]]

===Player===
{{Player_definition_c}}

===Vector3===
{{Vector3_definition}}

===Vehicle===
{{Vehicle_definition_c}}

==Static Objects==

===Globals===
{{Global_properties_c}}

===Event===
{{Event_functions_c}}

===Gui===
{{Gui_definition_c}}

=== Console ===
{{Console_definition_c}}

===Cursor===
{{Cursor_definition_c}}

===Voice chat===
*Functions:
**[[voiceChat.getPreprocessingParam|mp.voiceChat.getPreprocessingParam]]
**[[voiceChat.setPreprocessingParam|mp.voiceChat.setPreprocessingParam]]
*Properties:
**[[voiceChat.lastVad|mp.voiceChat.lastVad]]
**[[voiceChat.minVad|mp.voiceChat.minVad]]
**[[voiceChat.muted|mp.voiceChat.muted]]

===Nametags===
*Functions:
**mp.nametags.update
**[[nametags.set|mp.nametags.set]]
*Properties:
**mp.nametags.enabled

===Keys===
{{Keys_functions_c}}

===Preferences===
{{Preferences_definition_c}}

===Storage===
{{Storage_definition_c}}

===System===
*Functions:
**[[system.notify()|mp.system.notify]]
*Properties:
**[[system.isFullscreen|mp.system.isFullscreen]]
**[[system.isFocused|mp.system.isFocused]]

==Static Objects (Game)==

===App===
{{App_functions_c}}

===Audio===
{{Audio_functions_c}}

===Brain===
{{Brain_functions_c}}

===Cam===
{{Cam_functions_c}}

===Controls===
{{Controls_functions_c}}

===Cutscene===
{{Cutscene_functions_c}}

===Datafile===
{{Datafile_functions_c}}

===Decisionevent===
{{Decisionevent_functions_c}}

===Decorator===
*[[Decorator::decorIsRegisteredAsType|mp.game.decorator.decorIsRegisteredAsType]]
*[[Decorator::decorRegister|mp.game.decorator.decorRegister]]

===Discord===
*[[Discord::update|mp.discord.update]]

===DLC===
{{Dlc1_functions_c}}

===DLC2===
*[[Dlc2::nullify|mp.game.dlc2.nullify]]
*[[Dlc2::isDlcPresent|mp.game.dlc2.isDlcPresent]]

===Fire===
{{Fire_functions_c}}

===Gameplay===
{{Gameplay_functions_c}}

===Game Globals===
{{GameGlobals}}

*Properties:
**[[Client-side_functions#App|mp.game.app]]
**[[Client-side_functions#Audio|mp.game.audio]]
**[[Client-side_functions#Brain|mp.game.brain]]
**[[Client-side_functions#Cam|mp.game.cam]]
**[[Client-side_functions#Controls|mp.game.controls]]
**[[Client-side_functions#Cutscene|mp.game.cutscene]]
**[[Client-side_functions#Datafile|mp.game.datafile]]
**[[Client-side_functions#Decisionevent|mp.game.decisionevent]]
**[[Client-side_functions#Decorator|mp.game.decorator]]
**[[Client-side_functions#Dlc1|mp.game.dlc1]]
**[[Client-side_functions#Dlc2|mp.game.dlc2]]
**[[Client-side_functions#Entity|mp.game.entity]]
**[[Client-side_functions#Fire|mp.game.fire]]
**[[Client-side_functions#Gameplay|mp.game.gameplay]]
**[[Client-side_functions#Graphics|mp.game.graphics]]
**[[Client-side_functions#GXT|mp.game.gxt]]
**[[Client-side_functions#Interior|mp.game.interior]]
**[[Client-side_functions#Itemset|mp.game.itemset]]
**[[Client-side_functions#Mobile|mp.game.mobile]]
**[[Client-side_functions#Object|mp.game.object]]
**[[Client-side_functions#Pathfind|mp.game.pathfind]]
**[[Client-side_functions#Ped|mp.game.ped]]
**[[Client-side_functions#Player|mp.game.player]]
**[[Client-side_functions#Rope|mp.game.rope]]
**[[Client-side_functions#Script|mp.game.script]]
**[[Client-side_functions#Stats|mp.game.stats]]
**[[Client-side_functions#Streaming|mp.game.streaming]]
**[[Client-side_functions#System (Game)|mp.game.system]]
**[[Client-side_functions#Time|mp.game.time]]
**[[Client-side_functions#Ui|mp.game.ui]]
**[[Client-side_functions#Unk|mp.game.unk]]
**[[Client-side_functions#Recorder|mp.game.recorder]]
**[[Client-side_functions#Vehicle|mp.game.vehicle]]
**[[Client-side_functions#Water|mp.game.water]]
**[[Client-side_functions#Weapon|mp.game.weapon]]
**[[Client-side_functions#Worldprobe|mp.game.worldprobe]]
**[[Client-side_functions#Zone|mp.game.zone]]

===Graphics===
{{Graphics_functions_c}}

===GXT===
{{GXT_functions_c}}

===Interior===
{{Interior_functions_c}}

===Itemset===
{{Itemset_functions_c}}

===Mobile===
{{Mobile_functions_c}}

===Object===
{{Object_functions_c}}

===Pathfind===
{{Path_functions_c}}

===Ped===
{{Ped_functions_c}}

===Player===
{{Player_functions_c}}

===Raycasting===
*[[Raycasting::testPointToPoint|mp.raycasting.testPointToPoint]]
*[[Raycasting::testCapsule|mp.raycasting.testCapsule]]

===Recorder===
*[[Recorder::start|mp.game.recorder.start]]
*[[Recorder::stop|mp.game.recorder.stop]]
*[[Recorder::isRecording|mp.game.recorder.isRecording]]

===Rope===
{{Rope_functions_c}}

===Script===
{{Script_functions_c}}

===Stats===
{{Stats_functions_c}}

===Streaming===
{{Streaming_functions_c}}

===System (Game)===
{{System_functions_c}}

===Time===
{{Time_functions_c}}

===Ui===
{{Ui_functions_c}}

===Unk===
*[[Unk::getBroadcastFinishedLosSound|mp.game.unk.getBroadcastFinishedLosSound]]

===Vehicle===
{{Vehicle_functions_c}}

===Water===
{{Water_functions_c}}

===Weapon===
{{Weapon_functions_c}}

===Worldprobe===
{{Worldprobe_functions_c}}

===Zone===
{{Zone_functions_c}}

Template:GameGlobals

2021-07-21T01:13:49Z

MrPancakers2:

Template:Streaming functions c

2021-07-21T01:02:21Z

MrPancakers2: Added newest API

*[[Streaming::doesAnimDictExist|mp.game.streaming.doesAnimDictExist]]
*[[Streaming::getAllModelHashes|mp.game.streaming.getAllModelHashes]]
*[[Streaming::getAllModelNames|mp.game.streaming.getAllModelNames]]
*[[Streaming::getModelNameFromHash|mp.game.streaming.getModelNameFromHash]]
*[[Streaming::getIdealPlayerSwitchType|mp.game.streaming.getIdealPlayerSwitchType]]
*[[Streaming::forceStreamingUpdate|mp.game.streaming.forceStreamingUpdate]]
*[[Streaming::hasAnimDictLoaded|mp.game.streaming.hasAnimDictLoaded]]
*[[Streaming::hasAnimSetLoaded|mp.game.streaming.hasAnimSetLoaded]]
*[[Streaming::hasClipSetLoaded|mp.game.streaming.hasClipSetLoaded]]
*[[Streaming::hasCollisionForModelLoaded|mp.game.streaming.hasCollisionForModelLoaded]]
*[[Streaming::hasModelLoaded|mp.game.streaming.hasModelLoaded]]
*[[Streaming::hasNamedPtfxAssetLoaded|mp.game.streaming.hasNamedPtfxAssetLoaded]]
*[[Streaming::isIplActive|mp.game.streaming.isIplActive]]
*[[Streaming::isModelAVehicle|mp.game.streaming.isModelAVehicle]]
*[[Streaming::isModelInCdimage|mp.game.streaming.isModelInCdimage]]
*[[Streaming::isModelValid|mp.game.streaming.isModelValid]]
*[[Streaming::loadScene|mp.game.streaming.loadScene]]
*[[Streaming::newLoadSceneStartSafe|mp.game.streaming.newLoadSceneStartSafe]]
*[[Streaming::newLoadSceneStart|mp.game.streaming.newLoadSceneStart]]
*[[Streaming::prefetchSrl|mp.game.streaming.prefetchSrl]]
*[[Streaming::removeAnimDict|mp.game.streaming.removeAnimDict]]
*[[Streaming::removeAnimSet|mp.game.streaming.removeAnimSet]]
*[[Streaming::removeClipSet|mp.game.streaming.removeClipSet]]
*[[Streaming::removeIpl|mp.game.streaming.removeIpl]]
*[[Streaming::removeNamedPtfxAsset|mp.game.streaming.removeNamedPtfxAsset]]
*[[Streaming::requestAdditionalCollisionAtCoord|mp.game.streaming.requestAdditionalCollisionAtCoord]]
*[[Streaming::requestAnimDict|mp.game.streaming.requestAnimDict]]
*[[Streaming::requestAnimSet|mp.game.streaming.requestAnimSet]]
*[[Streaming::requestClipSet|mp.game.streaming.requestClipSet]]
*[[Streaming::requestCollisionAtCoord|mp.game.streaming.requestCollisionAtCoord]]
*[[Streaming::requestCollisionForModel|mp.game.streaming.requestCollisionForModel]]
*[[Streaming::requestIpl|mp.game.streaming.requestIpl]]
*[[Streaming::requestModel2|mp.game.streaming.requestModel2]]
*[[Streaming::requestModel|mp.game.streaming.requestModel]]
*[[Streaming::requestNamedPtfxAsset|mp.game.streaming.requestNamedPtfxAsset]]
*[[Streaming::setDitchPoliceModels|mp.game.streaming.setDitchPoliceModels]]
*[[Streaming::setFocusArea|mp.game.streaming.setFocusArea]]
*[[Streaming::setGamePausesForStreaming|mp.game.streaming.setGamePausesForStreaming]]
*[[Streaming::setHdArea|mp.game.streaming.setHdArea]]
*[[Streaming::setInteriorActive|mp.game.streaming.setInteriorActive]]
*[[Streaming::setModelAsNoLongerNeeded|mp.game.streaming.setModelAsNoLongerNeeded]]
*[[Streaming::setPedPopulationBudget|mp.game.streaming.setPedPopulationBudget]]
*[[Streaming::setPlayerSwitchLocation|mp.game.streaming.setPlayerSwitchLocation]]
*[[Streaming::setReducePedModelBudget|mp.game.streaming.setReducePedModelBudget]]
*[[Streaming::setReduceVehicleModelBudget|mp.game.streaming.setReduceVehicleModelBudget]]
*[[Streaming::setSrlTime|mp.game.streaming.setSrlTime]]
*[[Streaming::setStreaming|mp.game.streaming.setStreaming]]
*[[Streaming::setUnkCameraSettings|mp.game.streaming.setUnkCameraSettings]]
*[[Streaming::setVehiclePopulationBudget|mp.game.streaming.setVehiclePopulationBudget]]
*[[Streaming::startPlayerSwitch|mp.game.streaming.startPlayerSwitch]]

Template:EntityPool Client functions

2021-07-21T00:53:09Z

MrPancakers2:

* Functions
**[[Pool::apply]]
**[[Pool::at]]
**[[Pool::atHandle]]
**[[Pool::atRemoteId]]
**[[Pool::exists]]
**[[Pool::forEach]]
**[[Pool::forEachInStreamRange]]
**[[Pool::remoteId]]
**[[Pool::toArray]]
* Properties
**[[Pool::maxStreamed]]

Client-side functions

2021-07-21T00:51:52Z

MrPancakers2: /* Entity pool */

Player::setEnableScuba

2021-07-18T11:31:45Z

MrPancakers2: Updated page

__NOTOC__
{{ClientsideJsFunction}}
When enabled, will change the style of your swimming when underwater.

'''NOTE''': This does not apply any scuba gear. This must be done using the appropriate functions.

{{JSContainer|
==Syntax==
<pre>player.setEnableScuba(toggle);</pre>

=== Required Arguments ===
*'''toggle:''' Boolean

==Example==
{{ClientsideCode|
<pre>
mp.players.local.setEnableScuba(true);
</pre>
}}
}}
==See also==
{{Player_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Player::setEnableHandcuffs

2021-07-18T11:17:16Z

MrPancakers2: Updated page with proper info.

__NOTOC__
{{ClientsideJsFunction}}
When enabled, players can no longer pull out a weapon. The weapon wheel can still be opened, but it won't equip any selected weapon.

'''NOTE''': This does not add the hand cuffs or play the animation on the player, this only stops weapons being equiped.

{{JSContainer|
== Syntax ==

<pre>
player.setEnableHandcuffs(toggle);
</pre>

=== Parameters ===
*'''toggle:''' Boolean

==Example==
Enables the cuff effect when the event is called.
{{ClientsideCode|
<pre>
mp.events.add('cuffPlayer', (item) => {
mp.players.local.setEnableHandcuffs(true);
})
</pre>
}}
}}
==See also==
{{Player_function_c}}
[[Category:Clientside API]]
[[Category:Client-side Function]]

Getting Started with Server

2021-06-29T03:42:35Z

MrPancakers2: /* Setting up the server */

== Introduction ==

*[[Ru:Getting Started with Server]]

This brief tutorial will show you how to run your server on both Windows and Linux distributions.

By default, the server makes use of port 22005 UDP for server access and the port after (here 22006) for the HTTP server hosting the client packages for the clients to download from. 
So make sure to have done the ports forwarding on your router process and have also unblocked the ports on your firewall before running the server.

=Bridge=
The following tutorial is found on [https://wiki.gtanet.work/index.php?title=Setting_up_the_Bridge_on_Linux/Windows Setting up the Bridge on Linux/Windows].

=Windows=
==Prerequisite==
For a hassle-free installation and operation, it is recommended to have the latest VC Redist.

[https://aka.ms/vs/15/release/VC_redist.x64.exe Microsoft Visual C++ Redistributable 2017]

==Setting up the server==
1. Download the RAGE Multiplayer Client ([https://cdn.rage.mp/public/files/RAGEMultiplayer_Setup.exe Download Here])

2. Open your '''server-files''' folder and run '''ragemp-server.exe'''. You should now be able to connect to your server locally (default local host IP: '''127.0.0.1:22005''').
: Read more about [https://wiki.rage.mp/index.php?title=Server_settings Server Settings].

==Next step==
[[Getting Started with Development]]

=Linux=
==Prerequisite==
It's recommended to use Debian or Ubuntu to set up a server if you're new to Linux.
*Debian 10 or above [https://distrowatch.com/table.php?distribution=debian See more]
*Ubuntu 18.10 or above [https://distrowatch.com/table.php?distribution=ubuntu See more]
*An OS that supports glibc v2.28

===Ubuntu===
<syntaxhighlight lang="bash">
sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test
sudo apt update && sudo apt install libstdc++6
</syntaxhighlight>

===Debian===
<syntaxhighlight lang="bash">
echo 'deb http://httpredir.debian.org/debian testing main contrib non-free' > /etc/apt/sources.list
apt update && apt install -y -t testing libstdc++6
</syntaxhighlight>

==Setting up server==
This bash snippet should automate the server installation.
<syntaxhighlight lang="bash">
# Downloading server
wget https://cdn.rage.mp/updater/prerelease/server-files/linux_x64.tar.gz

# Extract the server files
tar -xzf linux_x64.tar.gz

# Accessing the directory
cd ragemp-srv

# Set executable permission
chmod +x ragemp-server

# Run the server
./ragemp-server
</syntaxhighlight>

==Launching the server as a daemon (systemd)==
If you want to launch the server as a daemon on the latest version of Ubuntu/Debian/CentOS, you need to follow these steps:

1. We recommend move your server to /opt
e.g '''mv ./ragemp-srv /opt/'''

2. Create the systemd unit (e.g /etc/systemd/system/rageserv.service) and enter this config:

<syntaxhighlight lang="ini">
[Unit]
Description=RAGE-MP Dedicated server
After=network.target
StartLimitIntervalSec=0

[Service]
Type=simple
Restart=always
RestartSec=1
; not safe, change root to another user
User=root
WorkingDirectory=/opt/ragemp-srv
ExecStart=/opt/ragemp-srv/ragemp-server

[Install]
WantedBy=multi-user.target
</syntaxhighlight>

'''Important: If you have not moved the directory, you need to edit WorkingDirectory and ExecStart with new absolute paths.'''

3. After saving the new unit we recommend you to update your systemd unit's list.

4. Finally! Now you can enable and run the unit via these commands:
# systemctl enable rageserv
# systemctl start rageserv

If you want to watch status of your server you need enter:
<syntaxhighlight lang="bash">
systemctl status rageserv
</syntaxhighlight>

If you want to restart your server you need to enter:
<syntaxhighlight lang="bash">
systemctl restart rageserv
</syntaxhighlight>

More commands and other details can be found [https://www.freedesktop.org/software/systemd/man/systemctl.html#Unit%20File%20Commands here.]

==Installing screen (Optional)==
For running the server in the background, we recommend using screen, mainly for its ease of use.

===Debian based (Ubuntu & derivatives)===
<syntaxhighlight lang="bash">
sudo apt-get install screen
</syntaxhighlight>

===CentOS 6.x/7.x===
<syntaxhighlight lang="bash">
yum install screen
</syntaxhighlight>

===Starting the server===
<syntaxhighlight lang="bash">
screen -dmS GTASERVER -L bash -c 'cd ~/srv && ./server' &
</syntaxhighlight>
Parameter explanation:
* <syntaxhighlight lang="bash" inline>screen -dmS</syntaxhighlight> starts a separate shell without directly opening an interface towards it (detached mode). The <tt>S</tt> param defines a session name for the newly created session (in this case <code>GTASERVER</code>), so that it is easier to manage in the future.
* <syntaxhighlight lang="bash" inline>screen -L</syntaxhighlight> basically logs whatever error that is shown by the server through the separate shell into a file for easier reference in the future.
'''!IMPORTANT!'''
* Log output will be saved as <code>screenlog.''_number_''</code> in the server directory.
* <code>&</code> '''IS IMPORTANT''' IF YOU WANT TO TERMINATE THE PROCESS GRACEFULLY.

===Stopping the server===
There are usually two ways to stop the server; One that we call a '''graceful''' shutdown that sends the server a signal for termination and the other, well, a '''crash''' since it does not allow the code to run through the termination process correctly.

'''RECOMMENDED:'''
<syntaxhighlight lang="bash">
kill $(ps h --ppid $(screen -ls | grep GTASERVER | cut -d. -f1) -o pid)
</syntaxhighlight>

'''NOT RECOMMENDED:''' It does not shut down the server gracefully
<syntaxhighlight lang="bash">
screen -S GTASERVER -X quit
</syntaxhighlight>

=Troubleshooting=
==Linux==
<syntaxhighlight lang="bash">
./server: /usr/lib/x86_64-linux-gnu/libstdc++.so.6: version `GLIBCXX_3.4.22' not found (required by ./server)
</syntaxhighlight>

Make sure GCC/G++ 6 or newer is installed, follow the [[#Prerequisite_2|Prerequisite]].

= See also =
* [[Server settings]]
{{ScriptingTutorials}}

[[Category:Tutorials]]

Getting Started with Development

2021-06-15T10:27:08Z

MrPancakers2: /* Requirements */

__TOC__

== Introduction ==
We are going to show you how to start developing your own server with a simple tutorial. We will show you how you can create your own resource and run it in your server. In here we are going to use NodeJS programming.

If you wish to learn server-side with C# programming, [[Development_with_Visual_Studio_Code|Click here]].

== Requirements ==

* Server Files (from [https://cdn.rage.mp/public/files/RAGEMultiplayer_Setup.exe RAGE:MP Client])
* Basic [[wikipedia:en:JavaScript|JavaScript]]/[[wikipedia:en:Node.js|NodeJS]] programming knowledge
* A scripting/text editor of your choice (e.g. [[wikipedia:en:Visual Studio Code|Visual Studio Code]] or [[wikipedia:en:Notepad++|Notepad++]])

== Starting the server ==
When downloading the [https://cdn.rage.mp/client/updater.exe Rage MP updater] and running it, you will get the server files. The folder name will be called <code>server-files</code>. Open the folder and you will find this:

<gallery widths=800px heights=426px>
File:server-files.png
</gallery>

*'''client_packages''': Folder in which client-side scripts are located and downloaded by the client. (Client-side allows you to draw [[wikipedia:en:Graphical user interface|<abbr title="Graphical User Interface">GUI</abbr>]] or do <abbr title="Chromium Embedded Framework">[https://bitbucket.org/chromiumembedded/cef CEF]</abbr> work)
*'''packages''': Folder in which server-side scripts are located and loaded by the server. (Server-side allows you to manage the player and create your own world)
*'''maps''': Folder in which map files (in [[wikipedia:en:JSON|JSON]] format) are loaded into the game world.
*'''plugins''': Allows you to load custom <code>.dll</code> plugins into the server.
*'''conf.json''': Contains the server configuration in JSON format. Read more about server settings [[Server_settings|here]].
*'''server.exe''': Server executable, which if you run, starts the game server.

Currently you will find your folders empty, so if you want to load a gamemode there is a [https://github.com/n-n1ks/rage.mp-freeroam freeroam gamemode sample] available to study/use on your server.

== Setting up API auto complete (TypeScript) ==
Autocompletion is one of the most important features a developer can use while developing. It is annoying to keep searching in the wiki for the right syntax or find the right function you want. Thanks to '''CocaColaBear''' for his great contribution in creating an autocompletion package for RAGE JS API.

*[https://github.com/CocaColaBear/types-ragemp-s autocomplete for SERVER side script]
*[https://github.com/CocaColaBear/types-ragemp-c autocomplete for CLIENT side script]

=== Installation ===
*Open your terminal (like [[wikipedia:en:cmd.exe|Command Prompt]]) and navigate to your server folder.
*Install the following Node.js packages with NPM:
**<code>npm install --save-dev github:CocaColaBear/types-ragemp-s#master</code> or <code>npm install --save-dev https://github.com/CocaColaBear/types-ragemp-s/tarball/master</code>
**<code>npm install --save-dev github:CocaColaBear/types-ragemp-c#master</code> or <code>npm install --save-dev https://github.com/CocaColaBear/types-ragemp-c/tarball/master</code>
*You should now get autocomplete.
*Follow our next title to find out how the environment works and you'll notice that autocomplete is working.

Learn more [[Using_Typescript|here]].

== Creating your first resource ==
Rage Multiplayer consists of 2 sides of scripting:
* '''Client-side''' allows you to create and develop <abbr title="User Interface">UI</abbr>, manipulate game client features and show people your creativity.
* '''Server-side''' allows you to manipulate the server itself with things like managing all players, vehicles, markers, etc ([[:Category:Assets|see more]]).

We will create our first server-side resource, and will see how it works in game. To learn about creating client-side resource, see [[Getting Started with Client-side|Getting started with Client-side]].

First of all, go to <code>packages</code> and create a folder (name of game mode anything you want).

=== Scripting server commands ===
In your game mode folder, create an <code>index.js</code> file. After that, open the file and write the following:

<syntaxhighlight lang="javascript">
//init Commands file
require('./commands.js')
</syntaxhighlight>

Now save and close the file, then create another file named <code>commands.js</code> and open it.

Add these simple commands to your file:

<syntaxhighlight lang="javascript">
mp.events.addCommand('hp', (player) => {
player.health = 100;
});

mp.events.addCommand('armor', (player) => {
player.armour = 100;
});

mp.events.addCommand('kill', (player) => {
player.health = 0;
});
</syntaxhighlight>

Learn more about these on [[Getting Started with Commands|Getting started with commands]]. Now we have created a simple source with 3 basic commands. One that gives health, one that gives armor, and one that kills you.

Now save the file and close it.

=== Scripting server event ===
Have you noticed anything wrong with the code we just wrote? If not, let me give you a hint. If you trigger the kill command, this means it will kill the player, but will you re-spawn back? I have the solution for you!

Create a '''JSON''' file and name it <code>spawn_points.json</code> and then add the following code:

<syntaxhighlight lang="json">
{
"SpawnPoints": [
{ "x": -425.517, "y": 1123.620, "z": 325.8544 },
{ "x": -415.777, "y": 1168.791, "z": 325.854 },
{ "x": -432.534, "y": 1157.461, "z": 325.854 },
{ "x": -401.850, "y": 1149.482, "z": 325.854 }
]
}
</syntaxhighlight>

Done? Now save it and close.

Create a new file named <code>events.js</code> and add the following code:

<syntaxhighlight lang="javascript">

let spawnPoints = require('./spawn_points.json').SpawnPoints;

mp.events.add('playerDeath', (player) => {
player.spawn(spawnPoints[Math.floor(Math.random() * spawnPoints.length)]);
player.health = 100;
});
</syntaxhighlight>

We have defined our spawn points that we want the player to spawn in, and then we added an event for when the player dies. When this event is triggered, they re-spawn in a random location from the spawn points you defined. Also do not forget to restore the player's health 100 again or they can teleport while dead to the spawn point.

'''IMPORTANT''': Do not forget to require the <code>events.js</code> in the <code>index.js</code>.

=== Putting it all together ===
In the end, your <code>index.js</code> file should look this:

<syntaxhighlight lang="javascript">
//init Commands file
require('./commands.js')

//init Events file
require('./events.js')
</syntaxhighlight>

Now save everything then launch your server and go test what you just wrote!

I hope you enjoyed creating your first script in RAGE:MP and we will be sure to create further tutorials for you to learn more.
Happy Gaming!

= See also =
* [https://wiki.gtanet.work/index.php?title=Getting_Started_with_Development Getting started with Development on C# Bridge Server]
* [[Server-side events]] (or in [https://wiki.gtanet.work/index.php?title=Scripting_Events C#] bridge)
* [[Server-side functions]] (or in [https://wiki.gtanet.work/index.php?title=Server_Scripting_Functions C#] bridge)
* [[Client-side events]] (or in [[Client-side_CSharp_events|C#]])
* [[Client-side functions]] (or in [[Client-side_CSharp_functions|C#]])

[[Category:Tutorials]]

Vehicle::getEngineHealth

2021-05-09T05:26:33Z

MrPancakers2: Undo revision 20673 by Shr0x (talk)

{| class="wikitable"
|-
|Engine Health
|Status
|-
|1000
|Perfect - Undamaged
|-
|< 1000
|Damaged
|-
|< 400
| Engine is smoking and losing functionality
|-
| 0
| Engine stops working and car is not drivable
|-
| < 0
| Engine catches fire, health rapidly declines and blows up seconds later
|}
Maximum: 1000 
Minimum: -4000 
Note*: Returns 1000.0 if the function is unable to get the address of the specified vehicle or if it's not a vehicle. 
==Syntax==
<pre>vehicle.getEngineHealth();</pre>
=== Required Arguments ===
===Return value===
*'''float'''

==Example==

{{ClientsideCode|
<pre>
function getEngineHealth() {
let vehicle = mp.players.local.vehicle;
let engineHealth = vehicle.getEngineHealth();
mp.gui.chat.push(`engine health: ${engineHealth}`);

return engineHealth; // returns the value of the engine health as a float
}
</pre>
}}

==See also==
{{Vehicle_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Pool::toArray

2021-04-25T02:07:10Z

MrPancakers2:

__NOTOC__
{{SharedJsFunction}}
This function converts a pool to an array. If you don't need to create a new array every time, use [[Pool::toArrayFast]].

{{JSContainer|
==Syntax==

<pre>
mp.pool.toArray();
</pre>

==Example==
{{ServersideCode|
<pre>
const onlinePlayers = mp.players.toArray();
if(onlinePlayers.every((player) => { return player.isAiming; } ))
console.log("Everyone is aiming.");
</pre>
}}
}}

== See Also ==
{{EntityPool_definition}}

[[Category:Shared API]]
[[Category:Shared Function]]

Pool::toArrayFast

2021-04-25T02:00:07Z

MrPancakers2: Created page with "__NOTOC__ {{SharedJsFunction}} Same as Pool::toArray except it doesn't create a new array each time and instead updates it and returns the same array. {{JSContainer| == S..."

__NOTOC__
{{SharedJsFunction}}
Same as [[Pool::toArray]] except it doesn't create a new array each time and instead updates it and returns the same array.

{{JSContainer|
== Syntax ==

<pre>
mp.pool.toArrayFast();
</pre>

== Return value ==
*'''Array'''

== Examples ==
<pre>
// To do
</pre>
}}

== See Also ==
{{EntityPool_definition}}

[[Category:TODO: Example]]
[[Category:Shared API]]
[[Category:Shared Function]]

Template:EntityPool functions

2021-04-25T01:54:01Z

MrPancakers2:

**[[Pool::apply]]
**[[Pool::at]]
**[[Pool::exists]]
**[[Pool::forEach]]
**[[Pool::forEachInDimension]]
**[[Pool::forEachInRange]]
**[[Pool::getClosest]]
**[[Pool::getClosestInDimension]]
**[[Pool::toArray]]
**[[Pool::toArrayFast]]

Streaming::requestAnimDict

2021-04-25T01:51:50Z

MrPancakers2:

__NOTOC__
{{ClientsideJsFunction}}
Requests and loads the animation dictionary required to play an animation.

{{JSContainer|
==Syntax==

<pre>
mp.game.streaming.requestAnimDict(animDict);
</pre>

=== Required Arguments ===
*'''animDict:''' {{RageType|String}}

==Example==
A function to load the animation dictionary used for the lucky wheel spin animations.
{{ClientsideCode|
<pre>
async function loadLuckyWheelAnimLib(){
if(mp.players.local.model === mp.game.joaat("mp_m_freemode_01")){
animationLib = "anim_casino_a@amb@casino@games@lucky7wheel@male"
} else if(mp.players.local.model === mp.game.joaat("mp_f_freemode_01")) {
animationLib = "anim_casino_a@amb@casino@games@lucky7wheel@female"
} else {
return mp.gui.chat.push("You must be using a freemode character model");
}

mp.game.streaming.requestAnimDict(animationLib);

for(let i = 0; mp.game.streaming.hasAnimDictLoaded(animationLib) === 0 && i < 15; i++){
if(i === 14) return mp.game.graphics.notify('~r~Error loading Lucky Wheel spin animation.');
mp.gui.chat.push("Loading wheel spin animation...");
await mp.game.waitAsync(100);
}

mp.gui.chat.push("Anim loaded.")
}
</pre>
}}
}}

==See also==
{{Streaming_functions_c}}

[[Category:Clientside API]]
[[Category:Client-side Function]]

Streaming::hasAnimDictLoaded

2021-04-25T01:47:34Z

MrPancakers2:

__NOTOC__
{{ClientsideJsFunction}}
Checks to see if the animation dictionary has loaded.

{{JSContainer|
==Syntax==
<pre>
mp.game.streaming.hasAnimDictLoaded(animDict);
</pre>

=== Required Arguments ===
*'''animDict:''' {{RageType|String}}

===Return value===
*'''Boolean'''

==Example #1==
{{ClientsideCode|
<pre>
async function loadLuckyWheelAnimLib(){
if(mp.players.local.model === mp.game.joaat("mp_m_freemode_01")){
animationLib = "anim_casino_a@amb@casino@games@lucky7wheel@male"
} else if(mp.players.local.model === mp.game.joaat("mp_f_freemode_01")) {
animationLib = "anim_casino_a@amb@casino@games@lucky7wheel@female"
} else {
return mp.gui.chat.push("You must be using a freemode character model");
}

mp.game.streaming.requestAnimDict(animationLib);

// Used so you don't get stuck in an infinite loop if it never loads.
for(let i = 0; mp.game.streaming.hasAnimDictLoaded(animationLib) === 0 && i < 15; i++){
if(i === 14) return mp.game.graphics.notify('~r~Error loading Lucky Wheel spin animation.');
mp.gui.chat.push("Loading wheel spin animation...");
await mp.game.waitAsync(100);
}

mp.gui.chat.push("Anim loaded.");
}
</pre>
}}
}}

==See also==
{{Streaming_functions_c}}
[[Category:Clientside API]]

Storage.flush()

2021-04-25T01:21:55Z

MrPancakers2:

__NOTOC__
{{ClientsideJsFunction}}
Flushes [[storage.data]]. It isn't neccessary to flush it after every change since it will be flushed on disconnect, but recommended.
 Data is saved in <path to RAGEMP>/client_resources/<server ip>/.storage

{{JSContainer|
==Syntax==

<pre>
mp.storage.flush();
</pre>

==Example==
{{ClientsideCode|
<pre>
mp.storage.data.auth = { token: "abcd" };
mp.storage.flush();
</pre>
}}
}}

==See also==
{{Storage_definition_c}}

[[Category:Clientside API]]
[[Category:Client-side Function]]

Storage.data

2021-04-25T01:19:50Z

MrPancakers2:

__NOTOC__
{{ClientsideJsProperty}}
Used to set some client-related data. Saved on the client, see [[storage.flush()]] for more details.
 Data is saved in <path to RAGEMP>/client_resources/<server ip>/.storage
 Thus it is wiped when player deletes client folder.

{{JSContainer|
==Syntax==

<pre>
mp.storage.data.someKey = obj;
</pre>

==Example==
{{ClientsideCode|
<pre>
mp.storage.data.auth = { token: "abcd" };
mp.storage.flush();
</pre>
}}
}}
==See also==
{{Storage_definition_c}}

[[Category:Clientside API]]
[[Category:Client-side Property]]

Storage.sessionData

2021-04-25T01:16:12Z

MrPancakers2: Created page with "__NOTOC__ {{ClientsideJsProperty}} Keeps data saved over resource reloads, but is cleared on reconnect. {{JSContainer| == Syntax == <pre> mp.storage.sessionData </pre> == E..."

__NOTOC__
{{ClientsideJsProperty}}
Keeps data saved over resource reloads, but is cleared on reconnect.

{{JSContainer|
== Syntax ==

<pre>
mp.storage.sessionData
</pre>

== Examples ==
<pre>
// To do
</pre>
}}

== See Also ==
{{Storage_definition_c}}

[[Category:TODO: Example]]
[[Category:Clientside API]]
[[Category:Client-side Property]]

Client-side functions

2021-04-25T01:15:25Z

MrPancakers2:

==Classes==
===Blip===
{{Blip_functions_c}}

===Browser===
{{Browser_definition_c}}

===Camera===
{{Camera_definition_c}}

===Checkpoint===
*[[Checkpoint::Checkpoint]]

===Dummy Entity===
{{Dummies_definition_c}}

===Entity===
{{Entity_functions_c}}

===Entity pool===
*[[Pool::atHandle]]
*[[Pool::atRemoteId]]
{{EntityPool_Client_functions}}
*[[Pool::remoteId]]

===Label===
{{Label_definition_c}}

===Marker===
{{Marker_definition_c}}

===Object===
{{Object_definition_c}}

===Peds===
*[[Peds::new|mp.peds.new]]

===Pickup===
*[[Pickup::Pickup]]

===Player===
{{Player_definition_c}}

===Vector3===
{{Vector3_definition}}

===Vehicle===
{{Vehicle_definition_c}}

==Static Objects==

===Globals===
{{Global_properties_c}}

===Event===
{{Event_functions_c}}

===Gui===
{{Gui_definition_c}}

=== Console ===
{{Console_definition_c}}

===Cursor===
{{Cursor_definition_c}}

===Voice chat===
*Functions:
**[[voiceChat.getPreprocessingParam|mp.voiceChat.getPreprocessingParam]]
**[[voiceChat.setPreprocessingParam|mp.voiceChat.setPreprocessingParam]]
*Properties:
**[[voiceChat.lastVad|mp.voiceChat.lastVad]]
**[[voiceChat.minVad|mp.voiceChat.minVad]]
**[[voiceChat.muted|mp.voiceChat.muted]]

===Nametags===
*Functions:
**mp.nametags.update
**[[nametags.set|mp.nametags.set]]
*Properties:
**mp.nametags.enabled

===Keys===
{{Keys_functions_c}}

===Preferences===
{{Preferences_definition_c}}

===Storage===
{{Storage_definition_c}}

===System===
*Functions:
**[[system.notify()|mp.system.notify]]
*Properties:
**[[system.isFullscreen|mp.system.isFullscreen]]
**[[system.isFocused|mp.system.isFocused]]

==Static Objects (Game)==

===App===
{{App_functions_c}}

===Audio===
{{Audio_functions_c}}

===Brain===
{{Brain_functions_c}}

===Cam===
{{Cam_functions_c}}

===Controls===
{{Controls_functions_c}}

===Cutscene===
{{Cutscene_functions_c}}

===Datafile===
{{Datafile_functions_c}}

===Decisionevent===
{{Decisionevent_functions_c}}

===Decorator===
*[[Decorator::decorIsRegisteredAsType|mp.game.decorator.decorIsRegisteredAsType]]
*[[Decorator::decorRegister|mp.game.decorator.decorRegister]]

===Discord===
*[[Discord::update|mp.discord.update]]

===DLC===
{{Dlc1_functions_c}}

===DLC2===
*[[Dlc2::nullify|mp.game.dlc2.nullify]]
*[[Dlc2::isDlcPresent|mp.game.dlc2.isDlcPresent]]

===Fire===
{{Fire_functions_c}}

===Gameplay===
{{Gameplay_functions_c}}

===Game Globals===
{{GameGlobals}}

*Properties:
**[[Client-side_functions#App|mp.game.app]]
**[[Client-side_functions#Audio|mp.game.audio]]
**[[Client-side_functions#Brain|mp.game.brain]]
**[[Client-side_functions#Cam|mp.game.cam]]
**[[Client-side_functions#Controls|mp.game.controls]]
**[[Client-side_functions#Cutscene|mp.game.cutscene]]
**[[Client-side_functions#Datafile|mp.game.datafile]]
**[[Client-side_functions#Decisionevent|mp.game.decisionevent]]
**[[Client-side_functions#Decorator|mp.game.decorator]]
**[[Client-side_functions#Dlc1|mp.game.dlc1]]
**[[Client-side_functions#Dlc2|mp.game.dlc2]]
**[[Client-side_functions#Entity|mp.game.entity]]
**[[Client-side_functions#Fire|mp.game.fire]]
**[[Client-side_functions#Gameplay|mp.game.gameplay]]
**[[Client-side_functions#Graphics|mp.game.graphics]]
**[[Client-side_functions#GXT|mp.game.gxt]]
**[[Client-side_functions#Interior|mp.game.interior]]
**[[Client-side_functions#Itemset|mp.game.itemset]]
**[[Client-side_functions#Mobile|mp.game.mobile]]
**[[Client-side_functions#Object|mp.game.object]]
**[[Client-side_functions#Pathfind|mp.game.pathfind]]
**[[Client-side_functions#Ped|mp.game.ped]]
**[[Client-side_functions#Player|mp.game.player]]
**[[Client-side_functions#Rope|mp.game.rope]]
**[[Client-side_functions#Script|mp.game.script]]
**[[Client-side_functions#Stats|mp.game.stats]]
**[[Client-side_functions#Streaming|mp.game.streaming]]
**[[Client-side_functions#System (Game)|mp.game.system]]
**[[Client-side_functions#Time|mp.game.time]]
**[[Client-side_functions#Ui|mp.game.ui]]
**[[Client-side_functions#Unk|mp.game.unk]]
**[[Client-side_functions#Recorder|mp.game.recorder]]
**[[Client-side_functions#Vehicle|mp.game.vehicle]]
**[[Client-side_functions#Water|mp.game.water]]
**[[Client-side_functions#Weapon|mp.game.weapon]]
**[[Client-side_functions#Worldprobe|mp.game.worldprobe]]
**[[Client-side_functions#Zone|mp.game.zone]]

===Graphics===
{{Graphics_functions_c}}

===GXT===
{{GXT_functions_c}}

===Interior===
{{Interior_functions_c}}

===Itemset===
{{Itemset_functions_c}}

===Mobile===
{{Mobile_functions_c}}

===Object===
{{Object_functions_c}}

===Pathfind===
{{Path_functions_c}}

===Ped===
{{Ped_functions_c}}

===Player===
{{Player_functions_c}}

===Raycasting===
*[[Raycasting::testPointToPoint|mp.raycasting.testPointToPoint]]
*[[Raycasting::testCapsule|mp.raycasting.testCapsule]]

===Recorder===
*[[Recorder::start|mp.game.recorder.start]]
*[[Recorder::stop|mp.game.recorder.stop]]
*[[Recorder::isRecording|mp.game.recorder.isRecording]]

===Rope===
{{Rope_functions_c}}

===Script===
{{Script_functions_c}}

===Stats===
{{Stats_functions_c}}

===Streaming===
{{Streaming_functions_c}}

===System (Game)===
{{System_functions_c}}

===Time===
{{Time_functions_c}}

===Ui===
{{Ui_functions_c}}

===Unk===
*[[Unk::getBroadcastFinishedLosSound|mp.game.unk.getBroadcastFinishedLosSound]]

===Vehicle===
{{Vehicle_functions_c}}

===Water===
{{Water_functions_c}}

===Weapon===
{{Weapon_functions_c}}

===Worldprobe===
{{Worldprobe_functions_c}}

===Zone===
{{Zone_functions_c}}

Template:Storage definition c

2021-04-25T01:15:01Z

MrPancakers2: Created page with "*Functions: **mp.storage.flush *Properties: **mp.storage.data **mp.storage.sessionData"

*Functions:
**[[storage.flush()|mp.storage.flush]]
*Properties:
**[[storage.data|mp.storage.data]]
**[[storage.sessionData|mp.storage.sessionData]]

Template:PlayerPool functions

2021-04-25T01:09:38Z

MrPancakers2: Added reloadResources

**[[Players::broadcast]]
**[[Players::broadcastInDimension]]
**[[Players::broadcastInRange]]
**[[Players::call]]
**[[Players::callInDimension]]
**[[Players::callInRange]]
**[[Players::callUnreliable]]
**[[Players::callInDimensionUnreliable]]
**[[Players::callInRangeUnreliable]]
**[[Players::reloadResources]]

Events::callRemote

2021-04-24T03:21:00Z

MrPancakers2: Updated page

__NOTOC__
{{ClientsideJsFunction}}
This function is used to call a server-side event from a client-side script.

'''NOTE''': If you're calling a server-side event, the first parameter of that server-side event will be your player object that gets sent automatically.

{{JSContainer|
==Syntax==
<pre>
mp.events.callRemote(String eventName [, ...args])
</pre>

=== Parameters ===
*'''eventName''': {{RageType|String}}
*'''args''': {{RageType|Any}}

==Example==
This example will call the server-side event, from the client-side script, to see if the player screen size is not 1280x1024.

{{ClientsideCode|
<pre>
mp.events.add("playerReady", () => {
let res = mp.game.graphics.getScreenActiveResolution(x, y);

if (!((res.x == 1280) && (res.y == 1024))) {
mp.events.callRemote("kickMeImBad", res.x, res.y);
};
});
</pre>
}}

{{ServersideCode|
<pre>
mp.events.add("kickMeImBad", (player, sx, sy) => {
console.log(`${player.name} bad boy :c, his screen size ${sx}x${sy}`);
player.kick();
});
</pre>
}}
}}
==See Also==
{{Event_functions}}

Template:Weapon functions c

2021-04-17T06:59:54Z

MrPancakers2: Added unequipEmptyWeapons

*[[Weapon::canUseWeaponOnParachute|mp.game.weapon.canUseWeaponOnParachute]]
*[[Weapon::createWeaponObject|mp.game.weapon.createWeaponObject]]
*[[Weapon::doesWeaponTakeWeaponComponent|mp.game.weapon.doesWeaponTakeWeaponComponent]]
*[[Weapon::enableLaserSightRendering|mp.game.weapon.enableLaserSightRendering]]
*[[Weapon::getWeaponClipSize|mp.game.weapon.getWeaponClipSize]]
*[[Weapon::getWeaponComponentHudStats|mp.game.weapon.getWeaponComponentHudStats]]
*[[Weapon::getWeaponComponentTypeModel|mp.game.weapon.getWeaponComponentTypeModel]]
*[[Weapon::getWeaponDamageType|mp.game.weapon.getWeaponDamageType]]
*[[Weapon::getWeaponHudStats|mp.game.weapon.getWeaponHudStats]]
*[[Weapon::getWeaponObjectTintIndex|mp.game.weapon.getWeaponObjectTintIndex]]
*[[Weapon::getWeaponTintCount|mp.game.weapon.getWeaponTintCount]]
*[[Weapon::getWeapontypeGroup|mp.game.weapon.getWeapontypeGroup]]
*[[Weapon::getWeapontypeModel|mp.game.weapon.getWeapontypeModel]]
*[[Weapon::getWeapontypeSlot|mp.game.weapon.getWeapontypeSlot]]
*[[Weapon::giveWeaponComponentToWeaponObject|mp.game.weapon.giveWeaponComponentToWeaponObject]]
*[[Weapon::giveWeaponObjectToPed|mp.game.weapon.giveWeaponObjectToPed]]
*[[Weapon::hasVehicleGotProjectileAttached|mp.game.weapon.hasVehicleGotProjectileAttached]]
*[[Weapon::hasWeaponAssetLoaded|mp.game.weapon.hasWeaponAssetLoaded]]
*[[Weapon::hasWeaponGotWeaponComponent|mp.game.weapon.hasWeaponGotWeaponComponent]]
*[[Weapon::isWeaponValid|mp.game.weapon.isWeaponValid]]
*[[Weapon::removeAllProjectilesOfType|mp.game.weapon.removeAllProjectilesOfType]]
*[[Weapon::removeWeaponAsset|mp.game.weapon.removeWeaponAsset]]
*[[Weapon::removeWeaponComponentFromWeaponObject|mp.game.weapon.removeWeaponComponentFromWeaponObject]]
*[[Weapon::requestWeaponAsset|mp.game.weapon.requestWeaponAsset]]
*[[Weapon::requestWeaponHighDetailModel|mp.game.weapon.requestWeaponHighDetailModel]]
*[[Weapon::setFlashLightFadeDistance|mp.game.weapon.setFlashLightFadeDistance]]
*[[Weapon::setPedAmmoToDrop|mp.game.weapon.setPedAmmoToDrop]]
*[[Weapon::setWeaponObjectTintIndex|mp.game.weapon.setWeaponObjectTintIndex]]
*[[Weapon::unequipEmptyWeapons|mp.game.weapon.unequipEmptyWeapons]]

Preferences::lowQualityAssets

2021-02-06T23:30:19Z

MrPancakers2:

__NOTOC__
{{ClientsideJsProperty}}
Returns the value showing if the user has low-quality server assets enabled.

{{JSContainer|
== Syntax ==

<pre>
mp.user.preferences.lowQualityAssets
</pre>

== Return value ==
*'''enabled''': {{RageType|Boolean}}

== Examples ==
{{ClientsideCode|
<pre>
mp.events.add('playerReady', () => {
mp.gui.chat.push(`Your lowQualityAssets turn: ${mp.user.preferences.lowQualityAssets}`)
});
</pre>
}}
}}

== See Also ==
{{Preferences_definition_c}}

Entity::setOwnVariable

2021-01-04T09:22:33Z

MrPancakers2: Undone translations

__TOC__

{{ServersideJsFunction}}

Sets the data available to the player as opposed to [[Entity::setVariable|entity.setVariable(key, value)]].

{{JSContainer|
==Syntax==
<pre>
entity.setOwnVariable(key, value);
</pre>

=== Required Arguments ===
*{{Required}}'''entity''': {{RageType|Object}}
*{{Required}}'''key''': {{RageType|String}}
*{{Required}}'''value''': {{RageType|Any}}

==Example==
This will set the job id for this player, which will only be available to him.

{{ServersideCode|
<pre>
player.setOwnVariable("jobId", 9);
</pre>
}}

 
{{ClientsideCode|
<pre>
mp.players.local.getVariable("jobId"); // 9
</pre>
}}
}}

== See More ==
{{Entity_functions}}

[[Category:Entity API]]
[[Category:Server-side Function]]

Weapons::clear

2021-01-04T09:22:13Z

MrPancakers2: Undone translations

Removes all weapons from the player. Analog [[Player::removeAllWeapons|player.removeAllWeapons()]]

== Syntax ==

<pre>
player.weapons.clear();
</pre>

== See Also ==
{{Player_block}}

Entity::getOwnVariable

2021-01-04T09:21:26Z

MrPancakers2: Undone translations

__TOC__

{{ServersideJsFunction}}

Allows to get the value set with [[Entity::setOwnVariable|entity.setOwnVariable(key, value)]].

{{JSContainer|
==Syntax==
<pre>
entity.getOwnVariable(key);
</pre>

=== Required Arguments ===
*{{Required}}'''entity''': {{RageType|Object}}
*{{Required}}'''key''': {{RageType|String}}

==Example==
This will set the job id for this player, which will only be available to him.

{{ServersideCode|
<pre>
player.setOwnVariable("jobId", 9);
</pre>
}}

 
So we get the value that we set earlier.

{{ServersideCode|
<pre>
player.getOwnVariable("jobId"); // 9
</pre>
}}
}}

== See More ==
{{Entity_functions}}

[[Category:Entity API]]
[[Category:Server-side Function]]

Vehicle::locked

2020-09-14T01:05:43Z

MrPancakers2:

{{ServersideJsProperty}}
A vehicle property used for locking or unlocking a vehicle.

{{JSContainer|
== Syntax ==
<pre>
vehicle.locked;
</pre>

==Getter==
* {{RageType|Boolean}}

==Setter==
* {{RageType|Boolean}}

==Example==
This example will lock your vehicle.

{{ServersideCode|
<pre>
mp.events.addCommand('lock', (player) => {
let vehicle = player.vehicle;
if (vehicle) {
let newState = !vehicle.locked;
vehicle.locked = newState;
player.outputChatBox(`Your vehicle doors are now ${newState ? `locked` : `unlocked`}.`);
};
}
);
</pre>
}}
}}
==See Also==
{{Vehicle_definition}}

[[Category:Vehicle API]]
[[Category:Serverside API]]
[[Category:Server-side Property]]

Vehicle::getNeonColour

2020-09-14T00:58:47Z

MrPancakers2:

__NOTOC__
{{ServersideJsFunction}}
This function is used to get the vehicle's neon colour in an RGB format.

{{JSContainer|
==Syntax==
<pre>
vehicle.getNeonColour();
</pre>

===Returns===
*'''neonColours''': {{RageType|Array}} Array containing the colours.
** '''r''': Red [0 - 255]
** '''g''': Green [0 - 255]
** '''b''': Blue [0 - 255]

==Example==
{{ServersideCode|
<pre>
mp.events.addCommand(`getneon`,
(player) => {
let vehicle = player.vehicle;
if (!!vehicle) {
let [r, g, b] = vehicle.getNeonColour();
player.outputChatBox(`R ${r}; G ${g}; B ${b}`);
};
}
);
</pre>
}}
}}

== See Also ==
{{Vehicle_function}}

Vehicle::setNeonColour

2020-09-14T00:53:23Z

MrPancakers2:

__NOTOC__
{{ServersideJsFunction}}
This function used for set vehicle RGB neon color.

{{JSContainer|
==Syntax==
<pre>
vehicle.setNeonColour(r, g, b);
</pre>

===Required Arguments===
*'''r:''' {{RageType|Int}} Red [0 - 255]
*'''g:''' {{RageType|Int}} Green [0 - 255]
*'''b:''' {{RageType|Int}} Blue [0 - 255]

==Example==
{{ServersideCode|
<pre>
mp.events.addCommand(`yay!`,
(player) => {
let vehicle = player.vehicle;
if (vehicle) {
vehicle.setNeonColour(255, 255, 0); // Yellow Neon
};
}
);
</pre>
}}
}}

== See Also ==
{{Vehicle_function}}

Globals::waitAsync

2020-08-18T04:30:36Z

MrPancakers2: Created page with "__NOTOC__ {{ClientsideJsFunction}} An asynchronous function that pauses execution of your current script. {{JSContainer| == Syntax == <pre> mp.game.wait(ms); </pre> === Par..."

__NOTOC__
{{ClientsideJsFunction}}
An asynchronous function that pauses execution of your current script.

{{JSContainer|
== Syntax ==

<pre>
mp.game.wait(ms);
</pre>

=== Parameters ===
*'''ms''': {{RageType|Int}}

== Examples ==
Pauses the script for 10ms before checking again if ped.handle is still 0 or not and unfreezes the ped when it's created with a valid handle.
<pre>
let ped = mp.peds.new();
while (ped.handle === 0) await mp.game.waitAsync(0);
ped.freezePosition(false);
</pre>
}}

== See Also ==
{{GameGlobals}}

Template:Vehicle functions c

2020-08-03T09:37:04Z

MrPancakers2: Added mp.game.vehicle.repairOnExtraToggle

*[[Vehicle::addModelOverride|mp.game.vehicle.addModelOverride]]
*[[Vehicle::addVehicleStuckCheckWithWarp|mp.game.vehicle.addVehicleStuckCheckWithWarp]]
*[[Vehicle::clearModelOverrides|mp.game.vehicle.clearModelOverrides]]
*[[Vehicle::createMissionTrain|mp.game.vehicle.createMissionTrain]]
*[[Vehicle::createScriptVehicleGenerator|mp.game.vehicle.createScriptVehicleGenerator]]
*[[Vehicle::createVehicle|mp.game.vehicle.createVehicle]]
*[[Vehicle::defaultEngineBehaviour|mp.game.vehicle.defaultEngineBehaviour]]
*[[Vehicle::deleteMissionTrain|mp.game.vehicle.deleteMissionTrain]]
*[[Vehicle::deleteScriptVehicleGenerator|mp.game.vehicle.deleteScriptVehicleGenerator]]
*[[Vehicle::disableVehicleWeapon|mp.game.vehicle.disableVehicleWeapon]]
*[[Vehicle::displayDistantVehicles|mp.game.vehicle.displayDistantVehicles]]
*[[Vehicle::doesScriptVehicleGeneratorExist|mp.game.vehicle.doesScriptVehicleGeneratorExist]]
*[[Vehicle::doesVehicleExistWithDecorator|mp.game.vehicle.doesVehicleExistWithDecorator]]
*[[Vehicle::getClosestVehicle|mp.game.vehicle.getClosestVehicle]]
*[[Vehicle::getCurrentPlaybackForVehicle|mp.game.vehicle.getCurrentPlaybackForVehicle]]
*[[Vehicle::getDisplayNameFromVehicleModel|mp.game.vehicle.getDisplayNameFromVehicleModel]]
*[[Vehicle::getNumModColors|mp.game.vehicle.getNumModColors]]
*[[Vehicle::getPositionInRecording|mp.game.vehicle.getPositionInRecording]]
*[[Vehicle::getPositionOfVehicleRecordingAtTime|mp.game.vehicle.getPositionOfVehicleRecordingAtTime]]
*[[Vehicle::getRandomVehicleBackBumperInSphere|mp.game.vehicle.getRandomVehicleBackBumperInSphere]]
*[[Vehicle::getRandomVehicleFrontBumperInSphere|mp.game.vehicle.getRandomVehicleFrontBumperInSphere]]
*[[Vehicle::getRandomVehicleInSphere|mp.game.vehicle.getRandomVehicleInSphere]]
*[[Vehicle::getRandomVehicleModelInMemory|mp.game.vehicle.getRandomVehicleModelInMemory]]
*[[Vehicle::getRotationOfVehicleRecordingAtTime|mp.game.vehicle.getRotationOfVehicleRecordingAtTime]]
*[[Vehicle::getTimePositionInRecording|mp.game.vehicle.getTimePositionInRecording]]
*[[Vehicle::getTotalDurationOfVehicleRecordingId|mp.game.vehicle.getTotalDurationOfVehicleRecordingId]]
*[[Vehicle::getTotalDurationOfVehicleRecording|mp.game.vehicle.getTotalDurationOfVehicleRecording]]
*[[Vehicle::getVehicleClassFromName|mp.game.vehicle.getVehicleClassFromName]]
*[[Vehicle::getVehicleClassMaxAcceleration|mp.game.vehicle.getVehicleClassMaxAcceleration]]
*[[Vehicle::getVehicleClassMaxAgility|mp.game.vehicle.getVehicleClassMaxAgility]]
*[[Vehicle::getVehicleClassMaxBraking|mp.game.vehicle.getVehicleClassMaxBraking]]
*[[Vehicle::getVehicleClassMaxTraction|mp.game.vehicle.getVehicleClassMaxTraction]]
*[[Vehicle::getVehicleModelAcceleration|mp.game.vehicle.getVehicleModelAcceleration]]
*[[Vehicle::getVehicleModelMaxBraking|mp.game.vehicle.getVehicleModelMaxBraking]]
*[[Vehicle::getVehicleModelMaxNumberOfPassengers|mp.game.vehicle.getVehicleModelMaxNumberOfPassengers]]
*[[Vehicle::getVehicleModelMaxSpeed|mp.game.vehicle.getVehicleModelMaxSpeed]]
*[[Vehicle::getVehicleModelMaxTraction|mp.game.vehicle.getVehicleModelMaxTraction]]
*[[Vehicle::getVehicleRecordingId|mp.game.vehicle.getVehicleRecordingId]]
*[[Vehicle::hasPreloadModsFinished|mp.game.vehicle.hasPreloadModsFinished]]
*[[Vehicle::hasVehicleAssetLoaded|mp.game.vehicle.hasVehicleAssetLoaded]]
*[[Vehicle::hasVehicleRecordingBeenLoaded|mp.game.vehicle.hasVehicleRecordingBeenLoaded]]
*[[Vehicle::isAnyVehicleNearPoint|mp.game.vehicle.isAnyVehicleNearPoint]]
*[[Vehicle::isCopVehicleInArea3d|mp.game.vehicle.isCopVehicleInArea3d]]
*[[Vehicle::isPlaybackGoingOnForVehicle|mp.game.vehicle.isPlaybackGoingOnForVehicle]]
*[[Vehicle::isPlaybackUsingAiGoingOnForVehicle|mp.game.vehicle.isPlaybackUsingAiGoingOnForVehicle]]
*[[Vehicle::isThisModelABicycle|mp.game.vehicle.isThisModelABicycle]]
*[[Vehicle::isThisModelABike|mp.game.vehicle.isThisModelABike]]
*[[Vehicle::isThisModelABoat|mp.game.vehicle.isThisModelABoat]]
*[[Vehicle::isThisModelACar|mp.game.vehicle.isThisModelACar]]
*[[Vehicle::isThisModelAHeli|mp.game.vehicle.isThisModelAHeli]]
*[[Vehicle::isThisModelAPlane|mp.game.vehicle.isThisModelAPlane]]
*[[Vehicle::isThisModelAQuadbike|mp.game.vehicle.isThisModelAQuadbike]]
*[[Vehicle::isThisModelATrain|mp.game.vehicle.isThisModelATrain]]
*[[Vehicle::isThisModelAnEmergencyBoat|mp.game.vehicle.isThisModelAnEmergencyBoat]]
*[[Vehicle::isVehicleInGarageArea|mp.game.vehicle.isVehicleInGarageArea]]
*[[Vehicle::pausePlaybackRecordedVehicle|mp.game.vehicle.pausePlaybackRecordedVehicle]]
*[[Vehicle::preloadVehicleMod|mp.game.vehicle.preloadVehicleMod]]
*[[Vehicle::removeModelOverride|mp.game.vehicle.removeModelOverride]]
*[[Vehicle::removeVehicleAsset|mp.game.vehicle.removeVehicleAsset]]
*[[Vehicle::removeVehicleRecording|mp.game.vehicle.removeVehicleRecording]]
*[[Vehicle::removeVehicleStuckCheck|mp.game.vehicle.removeVehicleStuckCheck]]
*[[Vehicle::removeVehiclesFromGeneratorsInArea|mp.game.vehicle.removeVehiclesFromGeneratorsInArea]]
*[[Vehicle::repairOnExtraToggle|mp.game.vehicle.repairOnExtraToggle]]
*[[Vehicle::requestVehicleAsset|mp.game.vehicle.requestVehicleAsset]]
*[[Vehicle::requestVehicleRecording|mp.game.vehicle.requestVehicleRecording]]
*[[Vehicle::setAllLowPriorityVehicleGeneratorsActive|mp.game.vehicle.setAllLowPriorityVehicleGeneratorsActive]]
*[[Vehicle::setAllVehicleGeneratorsActiveInArea|mp.game.vehicle.setAllVehicleGeneratorsActiveInArea]]
*[[Vehicle::setCargobobHookPosition|mp.game.vehicle.setCargobobHookPosition]]
*[[Vehicle::setFarDrawVehicles|mp.game.vehicle.setFarDrawVehicles]]
*[[Vehicle::setGarbageTrucks|mp.game.vehicle.setGarbageTrucks]]
*[[Vehicle::setMissionTrainAsNoLongerNeeded|mp.game.vehicle.setMissionTrainAsNoLongerNeeded]]
*[[Vehicle::setNumberOfParkedVehicles|mp.game.vehicle.setNumberOfParkedVehicles]]
*[[Vehicle::setParkedVehicleDensityMultiplierThisFrame|mp.game.vehicle.setParkedVehicleDensityMultiplierThisFrame]]
*[[Vehicle::setPlaybackSpeed|mp.game.vehicle.setPlaybackSpeed]]
*[[Vehicle::setPlaybackToUseAiTryToRevertBackLater|mp.game.vehicle.setPlaybackToUseAiTryToRevertBackLater]]
*[[Vehicle::setRandomBoats|mp.game.vehicle.setRandomBoats]]
*[[Vehicle::setRandomTrains|mp.game.vehicle.setRandomTrains]]
*[[Vehicle::setRandomVehicleDensityMultiplierThisFrame|mp.game.vehicle.setRandomVehicleDensityMultiplierThisFrame]]
*[[Vehicle::setScriptVehicleGenerator|mp.game.vehicle.setScriptVehicleGenerator]]
*[[Vehicle::setVehicleDensityMultiplierThisFrame|mp.game.vehicle.setVehicleDensityMultiplierThisFrame]]
*[[Vehicle::setVehicleModelIsSuppressed|mp.game.vehicle.setVehicleModelIsSuppressed]]
*[[Vehicle::setVehicleShootAtTarget|mp.game.vehicle.setVehicleShootAtTarget]]
*[[Vehicle::skipTimeInPlaybackRecordedVehicle|mp.game.vehicle.skipTimeInPlaybackRecordedVehicle]]
*[[Vehicle::skipToEndAndStopPlaybackRecordedVehicle|mp.game.vehicle.skipToEndAndStopPlaybackRecordedVehicle]]
*[[Vehicle::startPlaybackRecordedVehicleUsingAi|mp.game.vehicle.startPlaybackRecordedVehicleUsingAi]]
*[[Vehicle::startPlaybackRecordedVehicleWithFlags|mp.game.vehicle.startPlaybackRecordedVehicleWithFlags]]
*[[Vehicle::startPlaybackRecordedVehicle|mp.game.vehicle.startPlaybackRecordedVehicle]]
*[[Vehicle::stopPlaybackRecordedVehicle|mp.game.vehicle.stopPlaybackRecordedVehicle]]
*[[Vehicle::switchTrainTrack|mp.game.vehicle.switchTrainTrack]]
*[[Vehicle::unpausePlaybackRecordedVehicle|mp.game.vehicle.unpausePlaybackRecordedVehicle]]

Template:Vehicle functions c

2020-08-03T09:26:23Z

MrPancakers2:

*[[Vehicle::addModelOverride|mp.game.vehicle.addModelOverride]]
*[[Vehicle::addVehicleStuckCheckWithWarp|mp.game.vehicle.addVehicleStuckCheckWithWarp]]
*[[Vehicle::clearModelOverrides|mp.game.vehicle.clearModelOverrides]]
*[[Vehicle::createMissionTrain|mp.game.vehicle.createMissionTrain]]
*[[Vehicle::createScriptVehicleGenerator|mp.game.vehicle.createScriptVehicleGenerator]]
*[[Vehicle::createVehicle|mp.game.vehicle.createVehicle]]
*[[Vehicle::defaultEngineBehaviour|mp.game.vehicle.defaultEngineBehaviour]]
*[[Vehicle::deleteMissionTrain|mp.game.vehicle.deleteMissionTrain]]
*[[Vehicle::deleteScriptVehicleGenerator|mp.game.vehicle.deleteScriptVehicleGenerator]]
*[[Vehicle::disableVehicleWeapon|mp.game.vehicle.disableVehicleWeapon]]
*[[Vehicle::displayDistantVehicles|mp.game.vehicle.displayDistantVehicles]]
*[[Vehicle::doesScriptVehicleGeneratorExist|mp.game.vehicle.doesScriptVehicleGeneratorExist]]
*[[Vehicle::doesVehicleExistWithDecorator|mp.game.vehicle.doesVehicleExistWithDecorator]]
*[[Vehicle::getClosestVehicle|mp.game.vehicle.getClosestVehicle]]
*[[Vehicle::getCurrentPlaybackForVehicle|mp.game.vehicle.getCurrentPlaybackForVehicle]]
*[[Vehicle::getDisplayNameFromVehicleModel|mp.game.vehicle.getDisplayNameFromVehicleModel]]
*[[Vehicle::getNumModColors|mp.game.vehicle.getNumModColors]]
*[[Vehicle::getPositionInRecording|mp.game.vehicle.getPositionInRecording]]
*[[Vehicle::getPositionOfVehicleRecordingAtTime|mp.game.vehicle.getPositionOfVehicleRecordingAtTime]]
*[[Vehicle::getRandomVehicleBackBumperInSphere|mp.game.vehicle.getRandomVehicleBackBumperInSphere]]
*[[Vehicle::getRandomVehicleFrontBumperInSphere|mp.game.vehicle.getRandomVehicleFrontBumperInSphere]]
*[[Vehicle::getRandomVehicleInSphere|mp.game.vehicle.getRandomVehicleInSphere]]
*[[Vehicle::getRandomVehicleModelInMemory|mp.game.vehicle.getRandomVehicleModelInMemory]]
*[[Vehicle::getRotationOfVehicleRecordingAtTime|mp.game.vehicle.getRotationOfVehicleRecordingAtTime]]
*[[Vehicle::getTimePositionInRecording|mp.game.vehicle.getTimePositionInRecording]]
*[[Vehicle::getTotalDurationOfVehicleRecordingId|mp.game.vehicle.getTotalDurationOfVehicleRecordingId]]
*[[Vehicle::getTotalDurationOfVehicleRecording|mp.game.vehicle.getTotalDurationOfVehicleRecording]]
*[[Vehicle::getVehicleClassFromName|mp.game.vehicle.getVehicleClassFromName]]
*[[Vehicle::getVehicleClassMaxAcceleration|mp.game.vehicle.getVehicleClassMaxAcceleration]]
*[[Vehicle::getVehicleClassMaxAgility|mp.game.vehicle.getVehicleClassMaxAgility]]
*[[Vehicle::getVehicleClassMaxBraking|mp.game.vehicle.getVehicleClassMaxBraking]]
*[[Vehicle::getVehicleClassMaxTraction|mp.game.vehicle.getVehicleClassMaxTraction]]
*[[Vehicle::getVehicleModelAcceleration|mp.game.vehicle.getVehicleModelAcceleration]]
*[[Vehicle::getVehicleModelMaxBraking|mp.game.vehicle.getVehicleModelMaxBraking]]
*[[Vehicle::getVehicleModelMaxNumberOfPassengers|mp.game.vehicle.getVehicleModelMaxNumberOfPassengers]]
*[[Vehicle::getVehicleModelMaxSpeed|mp.game.vehicle.getVehicleModelMaxSpeed]]
*[[Vehicle::getVehicleModelMaxTraction|mp.game.vehicle.getVehicleModelMaxTraction]]
*[[Vehicle::getVehicleRecordingId|mp.game.vehicle.getVehicleRecordingId]]
*[[Vehicle::hasPreloadModsFinished|mp.game.vehicle.hasPreloadModsFinished]]
*[[Vehicle::hasVehicleAssetLoaded|mp.game.vehicle.hasVehicleAssetLoaded]]
*[[Vehicle::hasVehicleRecordingBeenLoaded|mp.game.vehicle.hasVehicleRecordingBeenLoaded]]
*[[Vehicle::isAnyVehicleNearPoint|mp.game.vehicle.isAnyVehicleNearPoint]]
*[[Vehicle::isCopVehicleInArea3d|mp.game.vehicle.isCopVehicleInArea3d]]
*[[Vehicle::isPlaybackGoingOnForVehicle|mp.game.vehicle.isPlaybackGoingOnForVehicle]]
*[[Vehicle::isPlaybackUsingAiGoingOnForVehicle|mp.game.vehicle.isPlaybackUsingAiGoingOnForVehicle]]
*[[Vehicle::isThisModelABicycle|mp.game.vehicle.isThisModelABicycle]]
*[[Vehicle::isThisModelABike|mp.game.vehicle.isThisModelABike]]
*[[Vehicle::isThisModelABoat|mp.game.vehicle.isThisModelABoat]]
*[[Vehicle::isThisModelACar|mp.game.vehicle.isThisModelACar]]
*[[Vehicle::isThisModelAHeli|mp.game.vehicle.isThisModelAHeli]]
*[[Vehicle::isThisModelAPlane|mp.game.vehicle.isThisModelAPlane]]
*[[Vehicle::isThisModelAQuadbike|mp.game.vehicle.isThisModelAQuadbike]]
*[[Vehicle::isThisModelATrain|mp.game.vehicle.isThisModelATrain]]
*[[Vehicle::isThisModelAnEmergencyBoat|mp.game.vehicle.isThisModelAnEmergencyBoat]]
*[[Vehicle::isVehicleInGarageArea|mp.game.vehicle.isVehicleInGarageArea]]
*[[Vehicle::pausePlaybackRecordedVehicle|mp.game.vehicle.pausePlaybackRecordedVehicle]]
*[[Vehicle::preloadVehicleMod|mp.game.vehicle.preloadVehicleMod]]
*[[Vehicle::removeModelOverride|mp.game.vehicle.removeModelOverride]]
*[[Vehicle::removeVehicleAsset|mp.game.vehicle.removeVehicleAsset]]
*[[Vehicle::removeVehicleRecording|mp.game.vehicle.removeVehicleRecording]]
*[[Vehicle::removeVehicleStuckCheck|mp.game.vehicle.removeVehicleStuckCheck]]
*[[Vehicle::removeVehiclesFromGeneratorsInArea|mp.game.vehicle.removeVehiclesFromGeneratorsInArea]]
*[[Vehicle::requestVehicleAsset|mp.game.vehicle.requestVehicleAsset]]
*[[Vehicle::requestVehicleRecording|mp.game.vehicle.requestVehicleRecording]]
*[[Vehicle::setAllLowPriorityVehicleGeneratorsActive|mp.game.vehicle.setAllLowPriorityVehicleGeneratorsActive]]
*[[Vehicle::setAllVehicleGeneratorsActiveInArea|mp.game.vehicle.setAllVehicleGeneratorsActiveInArea]]
*[[Vehicle::setCargobobHookPosition|mp.game.vehicle.setCargobobHookPosition]]
*[[Vehicle::setFarDrawVehicles|mp.game.vehicle.setFarDrawVehicles]]
*[[Vehicle::setGarbageTrucks|mp.game.vehicle.setGarbageTrucks]]
*[[Vehicle::setMissionTrainAsNoLongerNeeded|mp.game.vehicle.setMissionTrainAsNoLongerNeeded]]
*[[Vehicle::setNumberOfParkedVehicles|mp.game.vehicle.setNumberOfParkedVehicles]]
*[[Vehicle::setParkedVehicleDensityMultiplierThisFrame|mp.game.vehicle.setParkedVehicleDensityMultiplierThisFrame]]
*[[Vehicle::setPlaybackSpeed|mp.game.vehicle.setPlaybackSpeed]]
*[[Vehicle::setPlaybackToUseAiTryToRevertBackLater|mp.game.vehicle.setPlaybackToUseAiTryToRevertBackLater]]
*[[Vehicle::setRandomBoats|mp.game.vehicle.setRandomBoats]]
*[[Vehicle::setRandomTrains|mp.game.vehicle.setRandomTrains]]
*[[Vehicle::setRandomVehicleDensityMultiplierThisFrame|mp.game.vehicle.setRandomVehicleDensityMultiplierThisFrame]]
*[[Vehicle::setScriptVehicleGenerator|mp.game.vehicle.setScriptVehicleGenerator]]
*[[Vehicle::setVehicleDensityMultiplierThisFrame|mp.game.vehicle.setVehicleDensityMultiplierThisFrame]]
*[[Vehicle::setVehicleModelIsSuppressed|mp.game.vehicle.setVehicleModelIsSuppressed]]
*[[Vehicle::setVehicleShootAtTarget|mp.game.vehicle.setVehicleShootAtTarget]]
*[[Vehicle::skipTimeInPlaybackRecordedVehicle|mp.game.vehicle.skipTimeInPlaybackRecordedVehicle]]
*[[Vehicle::skipToEndAndStopPlaybackRecordedVehicle|mp.game.vehicle.skipToEndAndStopPlaybackRecordedVehicle]]
*[[Vehicle::startPlaybackRecordedVehicleUsingAi|mp.game.vehicle.startPlaybackRecordedVehicleUsingAi]]
*[[Vehicle::startPlaybackRecordedVehicleWithFlags|mp.game.vehicle.startPlaybackRecordedVehicleWithFlags]]
*[[Vehicle::startPlaybackRecordedVehicle|mp.game.vehicle.startPlaybackRecordedVehicle]]
*[[Vehicle::stopPlaybackRecordedVehicle|mp.game.vehicle.stopPlaybackRecordedVehicle]]
*[[Vehicle::switchTrainTrack|mp.game.vehicle.switchTrainTrack]]
*[[Vehicle::unpausePlaybackRecordedVehicle|mp.game.vehicle.unpausePlaybackRecordedVehicle]]

Server settings

2020-08-03T09:21:11Z

MrPancakers2: Added trigger compression configurations

* '''conf.json -''' is a configuration file which allows you manage your server easily.

== Settings ==
The following table will explain the use of the following settings:

{| class="wikitable"
|-
! Setting !! Default value !! Description
|-
| announce || false || Announce to the master server so people can see you in their server browser.
|-
| bind|| 127.0.0.1 || The IP to listen to.
|-
| gamemode|| Freeroam || The server's gamemode. [[gamemodes|List of valid gamemodes]]
|-
| encryption|| false|| Whether the connection to the server will be encrypted or not.
|-
| maxplayers || 100 || Maximum number of players your server will hold.
|-
| name || RAGE:MP Unofficial server || Server name that will be displayed to the master server. Use [] for tags. Eg. "Beast [Serious Roleplay]"
|-
| stream-distance || 500.0 || The distance on the X,Y plane which server entities will stream in for connected players.
|-
| port || 22005 || The port that the server will use. The server uses both UDP and TCP protocols. The port after that one (''port + 1'', so 22006 by default) will be used for the HTTP server that hosts the client packages for the clients to download from.
|-
| disallow-multiple-connections-per-ip|| false|| Allows (false) or disallows (true) multiple players to connect from the same IP address
|-
| limit-time-of-connections-per-ip|| 0|| Maximum time a player can try to reconnect before getting timeout
|-
| url|| || Website URL. Must be a valid URL. Truncated to 20 characters in [https://rage.mp/masterlist RAGE:MP Master List Web] (shows fine in RAGE:MP client).
|-
| language|| en || Server's language (needs to be a string, example: "language": "en")
|-
| sync-rate|| 40|| This number indicates how many times per second the server has to synchronize its entities
|-
| resource-scan-thread-limit|| || Indicates the maximum number of threads used for resource scanning
|-
| max-ping|| || Maximum Ping accepted for the server
|-
| min-fps|| || Minimum FPS required for the server
|-
| max-packet-loss|| || Maximum Packet loss accepted in the server
|-
| allow-cef-debugging || || Whether the client can (true) or not (false) debug the server's CEF pages
|-
| enable-nodejs || true || Enables NodeJS serverside
|-
| csharp || disabled|| If your server will be using the C# bridge plugin set it to true, else don't add this line
|-
| enable-http-security|| false|| When set to true, enables an extra security layer to avoid the server being flooded by fake HTTP requests
|
|-
| voice-chat || || boolean true / false
|
|-
| allow-voice-chat-input || || (only available via registry at the moment); default value: 1
|
|-
| voice-chat-sample-rate || || allowed values are 8000, 16000, 24000, 48000
|-
| fastdl-host || || String URL, this parameter specifies the external URL from which clients will be able to download needed clientside packages. Otherwise they will download them directly from the server.
|-
| server-side-weapons-only-mode || false || boolean true / false, if it's set to true, clientside created wont be synced only if they got created serverside (available with RAGE 1.1+)
|-
| api-threading-debugging || false || If set to true, it'll report every single usage of the API out of proper thread. Use it only for debugging since it adds some CPU overhead. (available with RAGE 1.1+)
|-
| fqdn || || string, e.g. "fqdn": "game-srv.rage.mp". Thanks to this option your players won't notice any server IP change, including the re-utilisation of downloaded packages.
|-
| resources-compression-level || 1 || Use 0 for local server, or a higher value for bandwidth optimisation. -9 for fast compression (available with RAGE 1.1+)
|-
| node-commandline-flags || || e.g. "node-commandline-flags": "--inspect" (available with RAGE 1.1+)
|-
| synchronization-extrapolation-multiplier || 0.0 || enables vehicle synchronization prediction disabling possible latency offset (available with RAGE 1.1+, enabled by default with 1.0 value in 0.3.7)
|-
| http-threads || 50 || Specifies how many concurrent connections will be handled at the same time, the rest will be queued (Increasing this number will increase bandwidth usage)
|-
| trigger-compression-logging || false || Log compression rates of all outgoing client event triggers with the dictionary the server has been initialized with (available with RAGE 1.1+)
|-
| trigger-compression-training || false || Dictionary training, takes data from all of your triggers and flushes it to the file specified at "trigger-compression-dictionary" at every 20th trigger. TIP: You can train it without joining using "mp.players.call" (available with RAGE 1.1+)
|-
| trigger-compression-dictionary || || File to load/save compression dictionary (available with RAGE 1.1+)
|}

== Sample file ==

This is an example of '''conf.json''':

<syntaxhighlight lang="javascript">
{
{
"announce": false,
"bind": "127.0.0.1",
"gamemode": "freeroam",
"name": "RAGE:MP Unofficial server [Tag]",
"maxplayers": 100,
"port": 22005,
"stream-distance": 500.0
}
}
</syntaxhighlight>
[[Category:Reference]]

Template:GameGlobals

2020-08-03T09:14:16Z

MrPancakers2: Added mp.game.waitAsync

World::requestIpl

2020-07-20T09:18:53Z

MrPancakers2: Created page with "__TOC__ {{ServersideJsFunction}} This function will request an IPL and sync it to every client. {{JSContainer| == Syntax == <pre>mp.world.requestIpl(ipl);</pre> == Require..."

__TOC__

{{ServersideJsFunction}}

This function will request an IPL and sync it to every client.

{{JSContainer|
== Syntax ==
<pre>mp.world.requestIpl(ipl);</pre>

== Required Arguments ==
* {{Required}}'''ipl''': {{RageType|String}} ([[Interiors_and_Locations|IPLs]])

==Example==
{{ServersideCode|
<pre>
mp.world.requestIpl("gr_case10_bunkerclosed"); // THIS ADDS THE BUNKER ENTRANCE NEAR ZANCUDO. POSITION: (-3058.714, 3329.19, 12.5844)
</pre>
}}
}}

==See Also==
{{World_definition}}

Template:World functions

2020-07-20T09:17:32Z

MrPancakers2: requireIpl to requestIpl

**[[World::setWeatherTransition]]
**[[World::removeIpl]]
**[[World::requestIpl]]
**[[World::time.set]]

Client-side functions

2020-07-15T01:11:39Z

MrPancakers2: /* Voice chat */

==Classes==
===Blip===
{{Blip_functions_c}}

===Browser===
{{Browser_definition_c}}

===Camera===
{{Camera_definition_c}}

===Checkpoint===
*[[Checkpoint::Checkpoint]]

===Dummy Entity===
{{Dummies_definition_c}}

===Entity===
{{Entity_functions_c}}

===Entity pool===
*[[Pool::atHandle]]
*[[Pool::atRemoteId]]
{{EntityPool_Client_functions}}
*[[Pool::remoteId]]

===Label===
{{Label_definition_c}}

===Marker===
{{Marker_definition_c}}

===Object===
{{Object_definition_c}}

===Peds===
*[[Peds::new|mp.peds.new]]

===Pickup===
*[[Pickup::Pickup]]

===Player===
{{Player_definition_c}}

===Vector3===
{{Vector3_definition}}

===Vehicle===
{{Vehicle_definition_c}}

==Static Objects==

===Globals===
{{Global_properties_c}}

===Event===
{{Event_functions_c}}

===Gui===
{{Gui_definition_c}}

=== Console ===
{{Console_definition_c}}

===Cursor===
{{Cursor_definition_c}}

===Voice chat===
*Functions:
**[[voiceChat.getPreprocessingParam|mp.voiceChat.getPreprocessingParam]]
**[[voiceChat.setPreprocessingParam|mp.voiceChat.setPreprocessingParam]]
*Properties:
**[[voiceChat.lastVad|mp.voiceChat.lastVad]]
**[[voiceChat.minVad|mp.voiceChat.minVad]]
**[[voiceChat.muted|mp.voiceChat.muted]]

===Nametags===
*Functions:
**mp.nametags.update
**[[nametags.set|mp.nametags.set]]
*Properties:
**mp.nametags.enabled

===Keys===
{{Keys_functions_c}}

===Preferences===
{{Preferences_definition_c}}

===Storage===
*Functions:
**[[storage.flush()|mp.storage.flush]]
*Properties:
**[[storage.data|mp.storage.data]]

===System===
*Functions:
**[[system.notify()|mp.system.notify]]
*Properties:
**[[system.isFullscreen|mp.system.isFullscreen]]
**[[system.isFocused|mp.system.isFocused]]

==Static Objects (Game)==

===App===
{{App_functions_c}}

===Audio===
{{Audio_functions_c}}

===Brain===
{{Brain_functions_c}}

===Cam===
{{Cam_functions_c}}

===Controls===
{{Controls_functions_c}}

===Cutscene===
{{Cutscene_functions_c}}

===Datafile===
{{Datafile_functions_c}}

===Decisionevent===
{{Decisionevent_functions_c}}

===Decorator===
*[[Decorator::decorIsRegisteredAsType|mp.game.decorator.decorIsRegisteredAsType]]
*[[Decorator::decorRegister|mp.game.decorator.decorRegister]]

===Discord===
*[[Discord::update|mp.discord.update]]

===DLC===
{{Dlc1_functions_c}}

===DLC2===
*[[Dlc2::nullify|mp.game.dlc2.nullify]]
*[[Dlc2::isDlcPresent|mp.game.dlc2.isDlcPresent]]

===Fire===
{{Fire_functions_c}}

===Gameplay===
{{Gameplay_functions_c}}

===Game Globals===
{{GameGlobals}}

*Properties:
**[[Client-side_functions#App|mp.game.app]]
**[[Client-side_functions#Audio|mp.game.audio]]
**[[Client-side_functions#Brain|mp.game.brain]]
**[[Client-side_functions#Cam|mp.game.cam]]
**[[Client-side_functions#Controls|mp.game.controls]]
**[[Client-side_functions#Cutscene|mp.game.cutscene]]
**[[Client-side_functions#Datafile|mp.game.datafile]]
**[[Client-side_functions#Decisionevent|mp.game.decisionevent]]
**[[Client-side_functions#Decorator|mp.game.decorator]]
**[[Client-side_functions#Dlc1|mp.game.dlc1]]
**[[Client-side_functions#Dlc2|mp.game.dlc2]]
**[[Client-side_functions#Entity|mp.game.entity]]
**[[Client-side_functions#Fire|mp.game.fire]]
**[[Client-side_functions#Gameplay|mp.game.gameplay]]
**[[Client-side_functions#Graphics|mp.game.graphics]]
**[[Client-side_functions#GXT|mp.game.gxt]]
**[[Client-side_functions#Interior|mp.game.interior]]
**[[Client-side_functions#Itemset|mp.game.itemset]]
**[[Client-side_functions#Mobile|mp.game.mobile]]
**[[Client-side_functions#Object|mp.game.object]]
**[[Client-side_functions#Pathfind|mp.game.pathfind]]
**[[Client-side_functions#Ped|mp.game.ped]]
**[[Client-side_functions#Player|mp.game.player]]
**[[Client-side_functions#Rope|mp.game.rope]]
**[[Client-side_functions#Script|mp.game.script]]
**[[Client-side_functions#Stats|mp.game.stats]]
**[[Client-side_functions#Streaming|mp.game.streaming]]
**[[Client-side_functions#System (Game)|mp.game.system]]
**[[Client-side_functions#Time|mp.game.time]]
**[[Client-side_functions#Ui|mp.game.ui]]
**[[Client-side_functions#Unk|mp.game.unk]]
**[[Client-side_functions#Recorder|mp.game.recorder]]
**[[Client-side_functions#Vehicle|mp.game.vehicle]]
**[[Client-side_functions#Water|mp.game.water]]
**[[Client-side_functions#Weapon|mp.game.weapon]]
**[[Client-side_functions#Worldprobe|mp.game.worldprobe]]
**[[Client-side_functions#Zone|mp.game.zone]]

===Graphics===
{{Graphics_functions_c}}

===GXT===
{{GXT_functions_c}}

===Interior===
{{Interior_functions_c}}

===Itemset===
{{Itemset_functions_c}}

===Mobile===
{{Mobile_functions_c}}

===Object===
{{Object_functions_c}}

===Pathfind===
{{Path_functions_c}}

===Ped===
{{Ped_functions_c}}

===Player===
{{Player_functions_c}}

===Raycasting===
*[[Raycasting::testPointToPoint|mp.raycasting.testPointToPoint]]
*[[Raycasting::testCapsule|mp.raycasting.testCapsule]]

===Recorder===
*[[Recorder::start|mp.game.recorder.start]]
*[[Recorder::stop|mp.game.recorder.stop]]
*[[Recorder::isRecording|mp.game.recorder.isRecording]]

===Rope===
{{Rope_functions_c}}

===Script===
{{Script_functions_c}}

===Stats===
{{Stats_functions_c}}

===Streaming===
{{Streaming_functions_c}}

===System (Game)===
{{System_functions_c}}

===Time===
{{Time_functions_c}}

===Ui===
{{Ui_functions_c}}

===Unk===
*[[Unk::getBroadcastFinishedLosSound|mp.game.unk.getBroadcastFinishedLosSound]]

===Vehicle===
{{Vehicle_functions_c}}

===Water===
{{Water_functions_c}}

===Weapon===
{{Weapon_functions_c}}

===Worldprobe===
{{Worldprobe_functions_c}}

===Zone===
{{Zone_functions_c}}

Template:Time functions c

2020-07-15T01:06:29Z

MrPancakers2: Added serverTickCount

*[[Time::addToClockTime|mp.game.time.addToClockTime]]
*[[Time::advanceClockTimeTo|mp.game.time.advanceClockTimeTo]]
*[[Time::getLocalTimeGmt|mp.game.time.getLocalTimeGmt]]
*[[Time::getLocalTime|mp.game.time.getLocalTime]]
*[[Time::getPosixTime|mp.game.time.getPosixTime]]
*[[Time::pauseClock|mp.game.time.pauseClock]]
*[[Time::serverTickCount|mp.game.time.serverTickCount]]
*[[Time::setClockDate|mp.game.time.setClockDate]]
*[[Time::setClockTime|mp.game.time.setClockTime]]

Template:Network functions

2020-07-15T01:01:48Z

MrPancakers2: Created page with "**Network::startBatch **Network::endBatch"

**[[Network::startBatch]]
**[[Network::endBatch]]

Template:Network definition

2020-07-15T01:01:01Z

MrPancakers2: Created page with "*Functions {{Network_functions}}"

*Functions
{{Network_functions}}

Server-side functions

2020-07-15T00:59:23Z

MrPancakers2: Added network definition

==Global==
{{Global_definition}}

==Blip==
{{Blip_definition}}

==Checkpoint==
{{Checkpoint_definition}}

==Colshape==
{{Colshape_definition}}

==Colshape pool==
{{ColshapePool_definition}}

==Entity pool==
{{EntityPool_definition}}

==Event==
{{Event_functions}}

==Label==
{{Label_definition}}

==Marker==
{{Marker_definition}}

==Network==
{{Network_definition}}

==Object==
{{Object_block}}

==Pickup==
{{Pickup_definition}}

==Player==
{{Player_definition}}

==Player pool==
{{PlayerPool_definition}}

==Vector3==
{{Vector3_definition}}

==Vehicle==
{{Vehicle_definition}}

==World==
{{World_definition}}

Template:Browser definition c

2020-06-23T04:47:02Z

MrPancakers2:

Template:Event functions c

2020-06-23T04:45:27Z

MrPancakers2:

*Functions
**[[Events::add]]
**[[Events::addDataHandler]]
**[[Events::call]]
**[[Events::callRemote]]
**[[Events::callRemoteProc]]
**[[Events::callRemoteUnreliable]]
**[[Events::cancelPendingRpc]]
**[[Events::hasPendingRpc]]
*Properties
**[[Events::delayShutdown]]