Camera::attachTo: Difference between revisions

From RAGE Multiplayer Wiki
(Added example, added description)
m (Replaced HTML with template)
Line 2: Line 2:


*JulioNIB:<br>Last param determines if its relative to the Entity
*JulioNIB:<br>Last param determines if its relative to the Entity
==Syntax==
==Syntax==
<syntaxhighlight lang="javascript">camera.attachTo(entity, xOffset, yOffset, zOffset, isRelative);</syntaxhighlight>
<pre>camera.attachTo(entity, xOffset, yOffset, zOffset, isRelative);</pre>
 
=== Required Arguments ===
=== Required Arguments ===
*'''entity:''' Entity handle or object
*'''entity:''' Entity handle or object
Line 10: Line 12:
*'''zOffset:''' float
*'''zOffset:''' float
*'''isRelative:''' Boolean
*'''isRelative:''' Boolean
===Return value===
===Return value===
*'''Undefined'''
*'''Undefined'''
==Example==
==Example==
Attaches a camera to a vehicle and sets it as your active camera.
Attaches a camera to a vehicle and sets it as your active camera.


<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #AE4040;">
{{ClientsideCode|
<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>
<pre>
<syntaxhighlight lang="javascript">
let mainCar = mp.vehicles.new(mp.game.joaat("turismor"), new mp.Vector3(-421.88, 1136.86, 326));
let mainCar = mp.vehicles.new(mp.game.joaat("turismor"), new mp.Vector3(-421.88, 1136.86, 326));


Line 25: Line 28:
     mp.game.cam.renderScriptCams(true, false, 0, true, false);
     mp.game.cam.renderScriptCams(true, false, 0, true, false);
});
});
</syntaxhighlight>
</pre>
</div>
}}
 
==See also==
==See also==
{{Camera_definition_c}}
{{Camera_definition_c}}
[[Category:Clientside API]]
[[Category:Clientside API]]

Revision as of 13:19, 26 October 2018

Attaches your camera to an object.

  • JulioNIB:
    Last param determines if its relative to the Entity

Syntax

camera.attachTo(entity, xOffset, yOffset, zOffset, isRelative);

Required Arguments

  • entity: Entity handle or object
  • xOffset: float
  • yOffset: float
  • zOffset: float
  • isRelative: Boolean

Return value

  • Undefined

Example

Attaches a camera to a vehicle and sets it as your active camera.

Client-Side
let mainCar = mp.vehicles.new(mp.game.joaat("turismor"), new mp.Vector3(-421.88, 1136.86, 326));

mp.events.add("vehCam", () => {
    vehicleCamera.attachTo(mainCar.handle, 0, 0, 2.0, false);
    vehicleCamera.setActive(true);
    mp.game.cam.renderScriptCams(true, false, 0, true, false);
});

See also