class Cam

NativeDB Introduced: v3258

Seems to animate the gameplay camera zoom.  
Eg. _ANIMATE_GAMEPLAY_CAM_ZOOM(1f, 1000f);  
will animate the camera zooming in from 1000 meters away.  
Game scripts use it like this:  
// Setting this to 1 prevents V key from changing zoom  
PLAYER::SET_PLAYER_FORCED_ZOOM(PLAYER::PLAYER_ID(), 1);  
// These restrict how far you can move cam up/down left/right  
CAM::_CLAMP_GAMEPLAY_CAM_YAW(-20f, 50f);  
CAM::_CLAMP_GAMEPLAY_CAM_PITCH(-60f, 0f);  
CAM::_ANIMATE_GAMEPLAY_CAM_ZOOM(1f, 1f);  

This native works with vehicles only. Bone indexes are usually given by this native GET_ENTITY_BONE_INDEX_BY_NAME.

minimum: Degrees between -90f and 90f.
maximum: Degrees between -90f and 90f.
Clamps the gameplay camera's current pitch.
Eg. _CLAMP_GAMEPLAY_CAM_PITCH(0.0f, 0.0f) will set the vertical angle directly behind the player.

minimum: Degrees between -180f and 180f.
maximum: Degrees between -180f and 180f.
Clamps the gameplay camera's current yaw.
Eg. _CLAMP_GAMEPLAY_CAM_YAW(0.0f, 0.0f) will set the horizontal angle directly behind the player.

Disables first person camera for the current frame.  
Found in decompiled scripts:  
GRAPHICS::DRAW_DEBUG_TEXT_2D("Disabling First Person Cam", 0.5, 0.8, 0.0, 0, 0, 255, 255);  
CAM::_DE2EF5DA284CC8DF();  

Shows the crosshair even if it wouldn't show normally. Only works for one frame, so make sure to call it repeatedly.  

Enumerated type defined in camControlHelperMetadataViewModes:

enum eContext {
    ON_FOOT = 0, // [G|S]ET_FOLLOW_PED_CAM_*
    IN_VEHICLE = 1, // [G|S]ET_FOLLOW_VEHICLE_CAM_*
    ON_BIKE = 2,
    IN_BOAT = 3,
    IN_AIRCRAFT = 4,
    IN_SUBMARINE = 5,
    IN_HELI = 6,
    IN_TURRET = 7,
}

NativeDB Introduced: v2699

NativeDB Introduced: v2699

NativeDB Introduced: v2372

Interpolates the camera to specified parameters over a set duration using various curve types for position, rotation, and fov.

NativeDB Introduced: v3258

Resets the vehicle idle camera timer. Calling this in a loop will disable the idle camera.

IS_A*

This native has its name defined inside its codE  

Native name labeled within its code

This native has a name defined inside its code  

This native has a name defined inside its code  

This native has a name defined inside its code  

if p0 is 0, effect is cancelled  
if p0 is 1, effect zooms in, gradually tilts cam clockwise apx 30 degrees, wobbles slowly. Motion blur is active until cancelled.  
if p0 is 2, effect immediately tilts cam clockwise apx 30 degrees, begins to wobble slowly, then gradually tilts cam back to normal. The wobbling will continue until the effect is cancelled.  

NativeDB Introduced: v1365

Sets gameplay camera to hash

NativeDB Introduced: v1180

Does nothing  

NativeDB Added Parameter 2: Any p1

From b617 scripts:
CAM::_21E253A7F8DA5DFB("DINGHY");
CAM::_21E253A7F8DA5DFB("ISSI2");
CAM::_21E253A7F8DA5DFB("SPEEDO");

Only used in R* Script fm_mission_controller_2020

NativeDB Introduced: v2699

I filled p1-p6 (the floats) as they are as other natives with 6 floats in a row are similar and I see no other method. So if a test from anyone proves them wrong please correct.  
p7 (length) determines the length of the spline, affects camera path and duration of transition between previous node and this one  
p8 big values ~100 will slow down the camera movement before reaching this node  
p9 != 0 seems to override the rotation/pitch (bool?)  

Takes a camera and uses the information from it as a camera spline node.

Example from michael2 script.  
CAM::ANIMATED_SHAKE_CAM(l_5069, "shake_cam_all@", "light", "", 1f);  

CAM::ANIMATED_SHAKE_SCRIPT_GLOBAL("SHAKE_CAM_medium", "medium", "", 0.5f);

Last param determines if its relative to the Entity  

This native works with peds only.

Creates a camera with the specified cam name, You can use SET_CAM_ natives to manipulate the camera.\ Make sure to call RENDER_SCRIPT_CAMS once the camera is created, or this won't have any visible effect.

Camera names:

• DEFAULT_SCRIPTED_CAMERA
• DEFAULT_ANIMATED_CAMERA
• DEFAULT_SPLINE_CAMERA
• DEFAULT_SCRIPTED_FLY_CAMERA
• TIMED_SPLINE_CAMERA
• CUSTOM_TIMED_SPLINE_CAMERA
• ROUNDED_SPLINE_CAMERA
• SMOOTHED_SPLINE_CAMERA

Create a camera with the specified cam name/type, You can use SET_CAM_ natives to manipulate the camera.

Take a look at CREATE_CAM if you would like to see the available camera names.

Creates a camera with the specified camera hash, You can use SET_CAM_ natives to manipulate the camera. Make sure to call RENDER_SCRIPT_CAMS once the camera is created, or this won't have any visible effect.

Take a look at CREATE_CAM if you would like to see the available camera names.

NativeDB Introduced: v323

Create a camera with the specified camera hash, You can use SET_CAM_ natives to manipulate the camera. Make sure to call RENDER_SCRIPT_CAMS once the camera is created, or this won't have any visible effect.

Take a look at CREATE_CAM if you would like to see the available camera names.

NativeDB Introduced: v323

some camera effect that is used in the drunk-cheat, and turned off (by setting it to 0.0) along with the shaking effects once the drunk cheat is disabled.  

BOOL param indicates whether the cam should be destroyed if it belongs to the calling script.  

BOOL param indicates whether the cam should be destroyed if it belongs to the calling script.  

Fades the screen in.  
duration: The time the fade should take, in milliseconds.  

Fades the screen out.  
duration: The time the fade should take, in milliseconds.  

Looks up a camera handle in the current camera pool and returns true if the handle is found, otherwise it returns false.

Gets a camera's rotation by handle (cam) lookup, outputs a Vector3 in degrees.

I'm pretty sure the parameter is the camera as usual, but I am not certain so I'm going to leave it as is.  

Can use this with SET_CAM_SPLINE_PHASE to set the float it this native returns.  
(returns 1.0f when no nodes has been added, reached end of non existing spline)  

See GET_FOLLOW_PED_CAM_VIEW_MODE for the view mode enum.

// view mode enumeration
enum eCamViewMode 
{
	THIRD_PERSON_NEAR = 0,
	THIRD_PERSON_MEDIUM = 1,
	THIRD_PERSON_FAR = 2,
	CINEMATIC = 3,
	FIRST_PERSON = 4,
};

See GET_FOLLOW_PED_CAM_VIEW_MODE for the follow mode enum.

See GET_FOLLOW_PED_CAM_VIEW_MODE for the follow mode enum.

See GET_FOLLOW_PED_CAM_VIEW_MODE for the follow mode enum.

This function takes a rotation order and outputs a Vector3 in degrees.

It first calls a game function to calculate these values given the rotation order and effectively multiplies those values by 180/PI, hence degrees since the function it calls outputs radians which are then converted to degrees.

Attaches a camera to an entity, including full matrix transformations for both rotation and position offsets.

NativeDB Introduced: v2189

Attaches a camera to a specific bone of a Ped, including full matrix transformations for both rotation and position offsets. This native works with peds only.

NativeDB Introduced: v1180

Resets the idle camera timer. Calling that in a loop once every few seconds is enough to disable the idle cinematic camera.

Returns whether or not the passed camera handle is active.  

Animations list

NativeDB Introduced: v1493

Examples when this function will return 0 are:
- During busted screen.
- When player is coming out from a hospital.
- When player is coming out from a police station.
- When player is buying gun from AmmuNation.

Determines if a global camera shake is currently active. You can stop the currently active global camera shake using STOP_SCRIPT_GLOBAL_SHAKING.

NativeDB Introduced: v323

Max value for p1 is 15.  

Atleast one time in a script for the zRot Rockstar uses GET_ENTITY_HEADING to help fill the parameter.  
p9 is unknown at this time.  
p10 throughout all the X360 Scripts is always 2.  

Animations list

Examples:  
CAM::PLAY_SYNCHRONIZED_CAM_ANIM(l_2734, NETWORK::_02C40BF885C567B6(l_2739), "PLAYER_EXIT_L_CAM", "mp_doorbell");  
CAM::PLAY_SYNCHRONIZED_CAM_ANIM(l_F0D[7/ *1* /], l_F4D[15/ *1* /], "ah3b_attackheli_cam2", "missheistfbi3b_helicrash");  

Animations list

Points the camera at the specified entity.

Offset works like GET_OFFSET_FROM_ENTITY_IN_WORLD_COORDS.

Parameters p0-p5 seems correct. The bool p6 is unknown, but through every X360 script it's always 1. Please correct p0-p5 if any prove to be wrong.  

Renders the camera previously created with CREATE_CAM or CREATE_CAMERA

NativeDB Added Parameter 6: Any p5

Set camera as active/inactive.  

Previous declaration void SET_CAM_ACTIVE_WITH_INTERP(Cam camTo, Cam camFrom, int duration, BOOL easeLocation, BOOL easeRotation) is completely wrong. The last two params are integers not BOOLs...  

Allows you to aim and shoot at the direction the camera is facing.  

Makes the minimap follow a scripted camera's rotation instead of the gameplay cam.

Sets the position of the cam.  

NOTE: Debugging functions are not present in the retail version of the game.  

Specifies how much the DoF effect should be applied (Set using SET_CAM_NEAR_DOF, SET_CAM_FAR_DOF, etc.)

Specifies when the camera should stop being in focus. Can be used together with SET_USE_HI_DOF, SET_CAM_NEAR_DOF, SET_CAM_USE_SHALLOW_DOF_MODE, SET_CAM_DOF_STRENGTH and other DoF related natives.

Usage Example

A usage example for this native can be found in the following native documentation: SET_CAM_DOF_STRENGTH.

Adjusts the field of view (FOV) for a specified camera, allowing for a wider or narrower perspective of the game world. The field of view is measured in degrees and affects how much of the game world is visible at any given moment through the camera.

NativeDB Introduced: v323

The native seems to only be called once.  
The native is used as so,  
CAM::SET_CAM_INHERIT_ROLL_VEHICLE(l_544, getElem(2, &l_525, 4));  
In the exile1 script.  

Specifies when the camera should start being in focus. Can be used together with SET_USE_HI_DOF, SET_CAM_FAR_DOF, SET_CAM_USE_SHALLOW_DOF_MODE, SET_CAM_DOF_STRENGTH and other DoF related natives.

Usage Example

A usage example for this native can be found in the following native documentation: SET_CAM_DOF_STRENGTH.

Sets the rotation of the camera.

I named p1 as timeDuration as it is obvious. I'm assuming tho it is ran in ms(Milliseconds) as usual.  

Sets the smoothing style for a DEFAULT_SPLINE_CAMERA Ranges from 0 to 3 in rockstar scripts although there are actually 26

0: No lead-in or lead-out smoothing
1: Smooth lead-in
2: Smooth lead-out
3: Both lead-in and lead-out are smoothed
4-6: Longer speed up, lead-in, lead-out, and both in order as above. 
6: see above, but missed a node in testing(?)
7: Smoothed lead-in, longer smoothed lead-out
8: Longer lead-in and lead-out than 6, didn't drop node
9: Constant acceleration
10: Constant deceleration. Dropped 2 nodes in testing.
11: Same as 0
12: 10 but slower lead-in, reaches end node less early
13: Extremely close to 3, slightly longer lead-in/lead-out
14: Constant acceleration, dropped last 2 nodes in testing and halted (?)
15: Very similar to 10, did not drop any nodes.
16: Long lead-in, dropped 2 nodes in testing, very long leadout.
17: Constant acceleration, slower speed-up than 9
18: Same as 17 is to 9, slightly longer lead-out, lingers at end node
19: Very long lead in and out
20: Very long, gradual lead-in acceleration at start, gets extremely fast
21: Same as 20 but for constant deceleration
22: 20 and 21 combined, long linger at end node. Dropped 2 nodes in testing
23: Constant acceleration, doesn't complete path before it stops
24: Same as 23 but with constant deceleration, but completes path
25: 23 and 24 combined, insanely fast at middle.
26: No noticable lead-in, misses last 2 nodes in testing
27+: Alternates between 0 and 26

The above is documented and graphed at Spline Cam Interp Graphs

Using 1-3 will result in misalignment from the passed durations for the spline nodes, the overall duration will remain but other nodes will be shortened if smoothing anything.

Graph below demonstrates interpolation between 0-1000 and back 10 times.

![](https://i.imgur.com/cixWh7m.png)

## Parameters
* **cam**: The DEFAULT_SPLINE_CAMERA to apply the smoothing to
* **smoothingStyle**: 0 to 3, 0 no additional smoothing, 1 smooth lead-in, 2 smooth lead-out, 3 smooth lead-in & lead-out

Enables or disables the usage of a shallow DOF. Needs to be set to true to use SET_CAM_NEAR_DOF, SET_CAM_FAR_DOF, etc. Doesn't need to be called every tick.

Usage Example

A usage example for this native can be found in the following native documentation: SET_CAM_DOF_STRENGTH.

Toggles the vehicle cinematic cam; requires the player ped to be in a vehicle to work.

Overrides the ped follow camera (not first person camera) with the specified camera. The game loads all camera metadata from update/update.rpf/x64/data/metadata/cameras.ymt and x64a.rpf/data/metadata/cameras.ymt with the ped follow cameras being of type camFollowPedCameraMetadata.

| Follow Camera Names | |----------------------------------------------| | DEFAULT_FOLLOW_PED_CAMERA | | FOLLOW_PED_ATTACHED_TO_ROPE_CAMERA | | FOLLOW_PED_ON_EXILE1_LADDER_CAMERA | | FOLLOW_PED_SKY_DIVING_CAMERA | | FOLLOW_PED_SKY_DIVING_FAMILY5_CAMERA | | NIGHTCLUB_FOLLOW_PED_CAMERA | | FOLLOW_PED_INTIMIDATION_CAMERA | | FOLLOW_PED_IN_WATER_CAMERA | | FOLLOW_PED_PRONE_CAMERA | | FOLLOW_PED_ON_SEAT_CAMERA | | FOLLOW_PED_HANGING_UPSIDE_DOWN_CAMERA | | FOLLOW_PED_ATTACHED_TO_ROPE_CAMERA | | CUSTOM_TRANSITION_AFTER_WARP_SKY_DIVE_CAMERA | | FOLLOW_PED_ON_HORSE_CAMERA | | FOLLOW_PED_ON_LOUNGER_CAMERA |

Other camera hashes (names not found yet)

// 0x5DBBFB6E
// 0xA38DB056
// 0x16B702A3
// 0x41D72A2E

See GET_FOLLOW_PED_CAM_VIEW_MODE for the follow mode enum.

See GET_FOLLOW_PED_CAM_VIEW_MODE for the follow mode enum.

See GET_FOLLOW_PED_CAM_VIEW_MODE for the follow mode enum.

Sets the camera position relative to heading in float from -360 to +360.  
Heading is alwyas 0 in aiming camera.  

This native sets the camera's pitch (rotation on the x-axis).

Sets the amplitude for the gameplay (i.e. 3rd or 1st) camera to shake. Used in script "drunk_controller.ysc.c4" to simulate making the player drunk.  

p6 & p7 - possibly length or time  

Focuses the camera on the specified vehicle.

Override the camera work of the third-person camera to table game for current frame only.

Needs to be called every tick to make the active camera use a high depth of field.\ The DoF can be customized using SET_CAM_NEAR_DOF, SET_CAM_FAR_DOF, SET_CAM_USE_SHALLOW_DOF_MODE, SET_CAM_DOF_STRENGTH and other DoF related natives.

Usage Example

A usage example for this native can be found in the following native documentation: SET_CAM_DOF_STRENGTH.

Possible shake types (updated b617d):  
DEATH_FAIL_IN_EFFECT_SHAKE  
DRUNK_SHAKE  
FAMILY5_DRUG_TRIP_SHAKE  
HAND_SHAKE  
JOLT_SHAKE  
LARGE_EXPLOSION_SHAKE  
MEDIUM_EXPLOSION_SHAKE  
SMALL_EXPLOSION_SHAKE  
ROAD_VIBRATION_SHAKE  
SKY_DIVING_SHAKE  
VIBRATE_SHAKE  

p0 argument found in the b617d scripts: "DRUNK_SHAKE"  

Possible shake types (updated b617d):  
DEATH_FAIL_IN_EFFECT_SHAKE  
DRUNK_SHAKE  
FAMILY5_DRUG_TRIP_SHAKE  
HAND_SHAKE  
JOLT_SHAKE  
LARGE_EXPLOSION_SHAKE  
MEDIUM_EXPLOSION_SHAKE  
SMALL_EXPLOSION_SHAKE  
ROAD_VIBRATION_SHAKE  
SKY_DIVING_SHAKE  
VIBRATE_SHAKE  

CAM::SHAKE_SCRIPT_GLOBAL("HAND_SHAKE", 0.2);

Terminates the current gameplay hint camera, with an option for immediate cessation or a gradual fade out.

NativeDB Introduced: v323

Instructs the game engine to stop rendering scripted cameras and transition back to the gameplay camera, optionally applying custom blending and rendering options.

enum eRenderingOptionFlags {
    RO_NO_OPTIONS = 0,
    RO_STOP_RENDERING_OPTION_WHEN_PLAYER_EXITS_INTO_COVER = 1
};

enum eCamSplineSmoothingFlags {
	// No smoothing just moves at a constant rate
	CAM_SPLINE_NO_SMOOTH = 0,
	// Decelerates when approaching a node
	CAM_SPLINE_SLOW_IN_SMOOTH = 1, 
	// Accelerates slowly when leaving a node
	CAM_SPLINE_SLOW_OUT_SMOOTH = 2,    
	// Decelerates when approaching a node and accelerates slowly when leaving a node
	CAM_SPLINE_SLOW_IN_OUT_SMOOTH = 3,
	CAM_SPLINE_VERY_SLOW_IN = 4,
	CAM_SPLINE_VERY_SLOW_OUT = 5,
	CAM_SPLINE_VERY_SLOW_IN_SLOW_OUT = 6,
	CAM_SPLINE_SLOW_IN_VERY_SLOW_OUT = 7,
	CAM_SPLINE_VERY_SLOW_IN_VERY_SLOW_OUT = 8,
	CAM_SPLINE_EASE_IN = 9,
	CAM_SPLINE_EASE_OUT = 10,
	CAM_SPLINE_QUADRATIC_EASE_IN = 11,
	CAM_SPLINE_QUADRATIC_EASE_OUT = 12,
	CAM_SPLINE_QUADRATIC_EASE_IN_OUT = 13,
	CAM_SPLINE_CUBIC_EASE_IN = 14,
	CAM_SPLINE_CUBIC_EASE_OUT = 15,
	CAM_SPLINE_CUBIC_EASE_IN_OUT = 16,
	CAM_SPLINE_QUARTIC_EASE_IN = 17,
	CAM_SPLINE_QUARTIC_EASE_OUT = 18,
	CAM_SPLINE_QUARTIC_EASE_IN_OUT = 19,
	CAM_SPLINE_QUINTIC_EASE_IN = 20,
	CAM_SPLINE_QUINTIC_EASE_OUT = 21,
	CAM_SPLINE_QUINTIC_EASE_IN_OUT = 22,
	CAM_SPLINE_CIRCULAR_EASE_IN = 23,
	CAM_SPLINE_CIRCULAR_EASE_OUT = 24,
	CAM_SPLINE_CIRCULAR_EASE_IN_OUT = 25 
};

NativeDB Added Parameter 4: int renderingOptions : An integer bitmask of eRenderingOptionFlags to apply specific rendering behaviors during the transition. RO_NO_OPTIONS signifies no special options are applied.

NativeDB Introduced: v323

Stops the currently active global camera shake that was initiated by a script. You can check if a global camera shake is active using IS_SCRIPT_GLOBAL_SHAKING.

NativeDB Introduced: v323

Sets the ambient ped & vehicle population spawning origin to be based around the active scripted camera for this frame This will prevent vehicles from being created close to the camera and/or on-screen

Applies a predefined set of vehicle camera settings optimized for capturing stunts, effective for the current game update/frame.

NativeDB Introduced: v791