RAGE Multiplayer Wiki - User contributions [en]

Player::setSwimMultiplierForPlayer

2021-11-11T18:23:48Z

Crltoz: bad function name

Swim speed multiplier. Multiplier goes up to 1.49 Just call it one time, it is not required to be called once every tick. - Note copied from below native. Note: At least the IDA method if you change the max float multiplier from 1.5 it will change it for both this and RUN_SPRINT below. I say 1.5 as the function blrs if what you input is greater than or equal to 1.5 hence why it's 1.49 max default.
==Syntax==
<syntaxhighlight lang="javascript">mp.game.player.setSwimMultiplierFor(multiplier);</syntaxhighlight>
=== Required Arguments ===
*'''multiplier:''' float
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Player_s_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Vehicle::wheelType

2021-11-01T17:15:01Z

Crltoz:

__TOC__
 Gets/Sets the vehicle's wheel type.

==Getter==
* '''Number - [[Wheels Type]]'''

==Setter==
* '''Number - [[Wheels Type]]'''

=== Required Arguments ===
*'''WheelType:''' int

==Example==
{{ServersideCode|
<pre>
let wheelType = mp.vehicles.at(0).wheelType; // GETTER

mp.vehicles.at(0).wheelType = 11; // SETTER
</pre>
}}

===Wheel Types ===
*-1: Stock
*0: Sport
*1: Muscle
*2: Lowrider
*3: SUV
*4: Offroad
*5: Tuner
*6: Bike Wheels
*7: High End
*8: Benny's Original
*9: Benny's Bespoke
*10: Open Wheel
*11: Street

===Return value===
*'''unknown'''

Vehicle::wheelType

2021-11-01T17:09:25Z

Crltoz: /* Syntax */

__TOC__
 Sets the vehicle's wheel type.

==Syntax==
<syntaxhighlight lang="javascript">vehicle.wheelType = wheelType;</syntaxhighlight>

=== Required Arguments ===
*'''WheelType:''' int

===Wheel Types ===
*-1: Stock
*0: Sport
*1: Muscle
*2: Lowrider
*3: SUV
*4: Offroad
*5: Tuner
*6: Bike Wheels
*7: High End
*8: Benny's Original
*9: Benny's Bespoke
*10: Open Wheel
*11: Street

===Return value===
*'''unknown'''

==Example==
{{ServerSide}}
<pre>
mp.vehicles.at(0).wheelType = 11; // set street wheels
</pre>

Vehicle::wheelType

2021-11-01T05:50:06Z

Crltoz: Created page with "__TOC__ Sets the vehicle's wheel type. ==Syntax== <syntaxhighlight lang="javascript">vehicle.setWheelType(WheelType);</syntaxhighlight> === Required Arguments === *'''Wh..."

__TOC__
 Sets the vehicle's wheel type.

==Syntax==
<syntaxhighlight lang="javascript">vehicle.setWheelType(WheelType);</syntaxhighlight>

=== Required Arguments ===
*'''WheelType:''' int

===Wheel Types ===
*-1: Stock
*0: Sport
*1: Muscle
*2: Lowrider
*3: SUV
*4: Offroad
*5: Tuner
*6: Bike Wheels
*7: High End
*8: Benny's Original
*9: Benny's Bespoke
*10: Open Wheel
*11: Street

===Return value===
*'''unknown'''

==Example==
{{ServerSide}}
<pre>
mp.vehicles.at(0).wheelType = 11; // set street wheels
</pre>

Vehicle::getClass

2021-10-09T00:53:50Z

Crltoz: add trailers to get class

__TOC__

==='''Description'''===

Gets the Vehicle Class.
 Vehicle Classes: 0: Compacts 1: Sedans 2: SUVs 3: Coupes 4: Muscle 5: Sports Classics 6: Sports 7: Super 8: Motorcycles 9: Off-road 10: Industrial 11: Utility (and Trailers) 12: Vans 13: Cycles 14: Boats 15: Helicopters 16: Planes 17: Service 18: Emergency 19: Military 20: Commercial 21: Trains 22: Open Wheels 

==Syntax==
<syntaxhighlight lang="javascript">vehicle.getClass();</syntaxhighlight>

===Return value===
*'''int'''
==Example==

<syntaxhighlight lang="javascript">
let vehicle = mp.players.local.vehicle;
let vehClass = vehicle.getClass(); // Defining a variable with the return value of vehicle.getClass()
</syntaxhighlight>

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

Controls::getDisabledControlNormal

2021-09-20T04:11:28Z

Crltoz: add input and control page

control - c# works with (int)GTA.Control.CursorY / (int)GTA.Control.CursorX and returns the mouse movement (additive). 0, 1 and 2 used in the scripts. 0 is by far the most common of them.
==Syntax==
<syntaxhighlight lang="javascript">mp.game.controls.getDisabledControlNormal(inputGroup, control);</syntaxhighlight>
=== Required Arguments ===
*'''inputGroup:''' {{RageType|Int}} ([[InputGroup|Input Groups]])
*'''control:''' {{RageType|Int}} ([[Controls|Controls]])

===Return value===
*'''float'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Controls_s_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Player::taskMoveNetwork

2021-07-24T17:59:42Z

Crltoz: add list of tasks names

Example: Player::_2D537BA194896636(PLAYER::PLAYER_Player_ID(), 'arm_wrestling_sweep_paired_a_rev3', 0.0, 1, 'mini@arm_wrestling', 0);

List of tasks names: https://pastebin.com/fS0XQnwG (Thanks to noBrain#0032)
==Syntax==
<syntaxhighlight lang="javascript">player.taskMoveNetwork(task, multiplier, p3, animDict, flags);</syntaxhighlight>
=== Required Arguments ===
*'''task:''' String
*'''multiplier:''' float
*'''p3:''' Boolean
*'''animDict:''' String
*'''flags:''' int
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Player_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Mobile::setMobilePhoneRotation

2021-07-24T02:51:20Z

Crltoz: /* Required Arguments */

Last parameter is unknown and always zero.
==Syntax==
<syntaxhighlight lang="javascript">mp.game.mobile.setMobilePhoneRotation(rotX, rotY, rotZ, p3);</syntaxhighlight>
=== Required Arguments ===
*'''rotX:''' float
*'''rotY:''' float
*'''rotZ:''' float
*'''p3:''' int (unknown)

===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Mobile_s_function_c}}
[[Category:Clientside API]]
[[Category:Mobile API]]
[[Category:TODO: Example]]

Entity::setLoadCollisionFlag

2021-06-07T19:43:40Z

Crltoz: add information

Loads collision grid for an entity spawned outside of a player's loaded area. This allows peds to execute tasks rather than sit dormant because of a lack of a physics grid.

Certainly not the main usage of this native but when set to true for a Vehicle, it will prevent the vehicle to explode if it is spawned far away from the player.

==Syntax==
<syntaxhighlight lang="javascript">entity.setLoadCollisionFlag(toggle);</syntaxhighlight>
=== Required Arguments ===
*'''toggle:''' Boolean
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Entity_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Script::requestScript

2021-06-07T19:12:28Z

Crltoz: change pastebin link

For a full list, see here: pastebin.com/K9adDsu4
==Syntax==
<syntaxhighlight lang="javascript">mp.game.script.requestScript(scriptName);</syntaxhighlight>
=== Required Arguments ===
*'''scriptName:''' String
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Script_s_function_c}}
[[Category:Clientside API]]
[[Category:Script API]]
[[Category:TODO: Example]]

Object::createObject

2021-06-07T19:08:29Z

Crltoz: add returns value

p5 - last parameter does not mean object handle is returned maybe a quick view in disassembly will tell us what is actually does

This returns a script handle (fwScriptGuid index) for the object, or 0 if the object failed to be created. (NOT IS A OBJECT HANDLE)
==Syntax==
<syntaxhighlight lang="javascript">mp.game.object.createObject(modelHash, x, y, z, networkHandle, createHandle, dynamic);</syntaxhighlight>
=== Required Arguments ===
*'''modelHash:''' Model hash or name
*'''x:''' float
*'''y:''' float
*'''z:''' float
*'''networkHandle:''' Boolean
*'''createHandle:''' Boolean
*'''dynamic:''' Boolean
===Return value===
*'''Script handle'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Object_s_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Vehicle::setDamage

2021-04-29T21:53:52Z

Crltoz: /* Syntax */

Apply damage to vehicle at a location. Location is relative to vehicle model (not world). Radius of effect damage applied in a sphere at impact location
It is enough to use x,y,z values from -1 to 1.
When focusOnModel set to true, the damage sphere will travel towards the vehicle from the given point, thus guaranteeing an impact
Good values for radius could be from 25 to 200, for damage 50-200.
You need to apply delay if you want to call setDamage couple times in a row. Typically 10ms is enough.
==Syntax==
<syntaxhighlight lang="javascript">vehicle.setDamage(xOffset, yOffset, zOffset, damage, radius, focusOnModel);</syntaxhighlight>
=== Required Arguments ===
*'''xOffset:''' float
*'''yOffset:''' float
*'''zOffset:''' float
*'''damage:''' float
*'''radius:''' float
*'''focusOnModel:''' Boolean

===Return value===
*'''Undefined'''

==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>

[[Category:Clientside API]]
[[Category:TODO: Example]]

Vehicle::setDamage

2021-04-29T21:53:36Z

Crltoz:

Apply damage to vehicle at a location. Location is relative to vehicle model (not world). Radius of effect damage applied in a sphere at impact location
It is enough to use x,y,z values from -1 to 1.
When focusOnModel set to true, the damage sphere will travel towards the vehicle from the given point, thus guaranteeing an impact
Good values for radius could be from 25 to 200, for damage 50-200.
You need to apply delay if you want to call setDamage couple times in a row. Typically 10ms is enough.
==Syntax==
<syntaxhighlight lang="javascript">vehicle.setDamage(xOffset, yOffset, zOffset, damage, radius, p6);</syntaxhighlight>
=== Required Arguments ===
*'''xOffset:''' float
*'''yOffset:''' float
*'''zOffset:''' float
*'''damage:''' float
*'''radius:''' float
*'''focusOnModel:''' Boolean

===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>

[[Category:Clientside API]]
[[Category:TODO: Example]]

Vehicle::setDamage

2021-04-29T21:52:24Z

Crltoz: /* Required Arguments */

Apply damage to vehicle at a location. Location is relative to vehicle model (not world). Radius of effect damage applied in a sphere at impact location
It is enough to use x,y,z values from -1 to 1.
p6 should be true, with false it does not taking in account offset values and all damage is applied to rear left part of the vehicle.
Good values for radius could be from 25 to 200, for damage 50-200.
You need to apply delay if you want to call setDamage couple times in a row. Typically 10ms is enough.
==Syntax==
<syntaxhighlight lang="javascript">vehicle.setDamage(xOffset, yOffset, zOffset, damage, radius, p6);</syntaxhighlight>
=== Required Arguments ===
*'''xOffset:''' float
*'''yOffset:''' float
*'''zOffset:''' float
*'''damage:''' float
*'''radius:''' float
*'''focusOnModel:''' Boolean

===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>

[[Category:Clientside API]]
[[Category:TODO: Example]]