Object::Object: Difference between revisions

From RAGE Multiplayer Wiki
No edit summary
(alpha updated)
 
(11 intermediate revisions by 7 users not shown)
Line 4: Line 4:
   
   
*'''[https://cdn.rage.mp/public/odb/index.html Objects gallery]'''
*'''[https://cdn.rage.mp/public/odb/index.html Objects gallery]'''
==Parameters==
*'''model''': {{RageType|Hash}} (use [[Globals::joaat|mp.joaat]])
*'''position''': {{RageType|Vector3}}
*'''rotation''': {{RageType|Vector3}}
*'''alpha''': {{RageType|Number}}
*'''dimension''': {{RageType|Number}}


{{JSContainer|
==Syntax==
==Syntax==
 
{{SharedCode|
<syntaxhighlight lang="javascript">
<pre>
mp.objects.new(model, position,
mp.objects.new(model, position,
{
{
Line 20: Line 16:
     dimension: dimension
     dimension: dimension
});
});
</syntaxhighlight>
</pre>
}}


=Example=
==Required Arguments==
*'''model''': {{RageType|Hash}}
*'''position''': {{RageType|Vector3}}
*'''rotation''': {{RageType|Vector3}}
*'''alpha''': {{RageType|Number}}: The object's transparency.
*'''dimension''': {{RageType|Number}}


<syntaxhighlight lang="javascript">
==Example==
// OUTDATED EXAMPLE
 
let pos = player.position; // Returns Vector3 object
<pre>
pos.y += 1;
mp.events.addCommand('flag', (player) => {
pos.z -= 1;
    mp.objects.new('apa_prop_flag_portugal', player.position,
        {
            rotation: player.rotation,
            alpha: 255,
            dimension: player.dimension
        });
});


let object = mp.objects.new(mp.joaat('p_stinger_03'), pos, [0, 0, 0]); // Creates a stinger beside the player
//Following this code, you'll create a portuguese flag (apa_prop_flag_portugal) at the players position, facing the same way the player is facing, with no transparency (255 on alpha) and at the same dimension the player is.
let object = mp.objects.new(795100068, pos, [0, 0, 0]); // Alternative, mp.joaat(...) resolves the model name into this object id
</pre>
</syntaxhighlight>
}}
[[Category:Object API]]
[[Category:Shared Function]]
[[Category:TODO: Example]]

Latest revision as of 12:52, 1 February 2023

Shared
Function

 JavaScript


Creates a new Object.


JavaScript Syntax

Syntax

Shared
mp.objects.new(model, position,
{
    rotation: rotation,
    alpha: alpha,
    dimension: dimension
});

Required Arguments

  • model: Hash
  • position: Vector3
  • rotation: Vector3
  • alpha: Number: The object's transparency.
  • dimension: Number

Example

mp.events.addCommand('flag', (player) => {
    mp.objects.new('apa_prop_flag_portugal', player.position,
        {
            rotation: player.rotation,
            alpha: 255,
            dimension: player.dimension
        });
});

//Following this code, you'll create a portuguese flag (apa_prop_flag_portugal) at the players position, facing the same way the player is facing, with no transparency (255 on alpha) and at the same dimension the player is.