SHVDN  v3
An ASI plugin for Grand Theft Auto V, which allows running scripts written in any .NET language in-game. Developed by crosire https://github.com/crosire/scripthookvdotnet/
GTA.Camera Class Reference
Inheritance diagram for GTA.Camera:
GTA.PoolObject GTA.ISpatial GTA.Native.INativeValue GTA.IDeletable GTA.IExistable

Public Member Functions

 Camera (int handle)
 
Vector3 GetOffsetPosition (Vector3 offset)
 Gets the position in world coordinates of an offset relative to this Camera More...
 
Vector3 GetPositionOffset (Vector3 worldCoords)
 Gets the relative offset of this Camera from a world coordinates position More...
 
void Shake (CameraShake shakeType, float amplitude)
 Shakes this Camera. More...
 
void StopShaking ()
 Stops shaking this Camera. More...
 
void PointAt (Entity target, Vector3 offset=default)
 Points this Camera at a specified Entity. More...
 
void PointAt (PedBone target, Vector3 offset=default)
 Points this Camera at a specified PedBone. More...
 
void PointAt (Vector3 target)
 Points this Camera at a specified position. More...
 
void StopPointing ()
 Stops this Camera pointing at a specific target. More...
 
void InterpTo (Camera to, int duration, int easePosition, int easeRotation)
 Moves this Camera to the to position. More...
 
void AttachTo (Entity entity, Vector3 offset)
 Attaches this Camera to a specific Entity. More...
 
void AttachTo (PedBone pedBone, Vector3 offset)
 Attaches this Camera to a specific PedBone. More...
 
void Detach ()
 Detaches this Camera from any Entity or PedBone it may be attached to. More...
 
override void Delete ()
 Destroys this Camera. More...
 
override bool Exists ()
 Determines if this Camera exists. More...
 
override bool Equals (object obj)
 Determines if an object refers to the same camera as this Camera. More...
 
override int GetHashCode ()
 

Static Public Member Functions

static bool operator== (Camera left, Camera right)
 Determines if two Cameras refer to the same camera. More...
 
static bool operator!= (Camera left, Camera right)
 Determines if two Checkpoints don't refer to the same camera. More...
 
static implicit operator InputArgument (Camera value)
 Converts a Camera to a native input argument. More...
 

Properties

IntPtr MemoryAddress [get]
 Gets the memory address of this Camera. More...
 
bool IsActive [get, set]
 Gets or sets a value indicating whether this Camera is currently being rendered. More...
 
MatrixMatrix [get]
 Gets the matrix of this Camera. More...
 
Vector3 Position [get, set]
 Gets or sets the position of this Camera. More...
 
Vector3 Rotation [get, set]
 Gets or sets the rotation of this Camera. More...
 
Vector3 Direction [get, set]
 Gets or sets the direction this Camera is pointing in. More...
 
Vector3UpVector [get]
 Gets the up vector of this Camera. More...
 
Vector3RightVector [get]
 Gets the right vector of this Camera. More...
 
Vector3ForwardVector [get]
 Gets the forward vector of this Camera, see also

See also
Direction

. More...

 
float FarClip [get, set]
 Gets or sets the far clip of this Camera. More...
 
float NearClip [get, set]
 Gets or sets the near clip of this Camera. More...
 
float FieldOfView [get, set]
 Gets or sets the field of view of this Camera. More...
 
float FarDepthOfField [get, set]
 Gets or sets the far depth of field of this Camera. More...
 
float NearDepthOfField [set]
 Sets the near depth of field for this Camera. More...
 
float MotionBlurStrength [set]
 Sets the strength of the motion blur for this Camera More...
 
float DepthOfFieldStrength [set]
 Sets the depth of field strength for this Camera. More...
 
bool IsShaking [get]
 Gets a value indicating whether this Camera is shaking. More...
 
float ShakeAmplitude [set]
 Sets the shake amplitude for this Camera. More...
 
bool IsInterpolating [get]
 Gets a value indicating whether this Camera is interpolating. More...
 
- Properties inherited from GTA.PoolObject
int Handle [get, protected set]
 The handle of the object. More...
 
ulong NativeValue [get, set]
 The handle of the object translated to a native value. More...
 
- Properties inherited from GTA.Native.INativeValue
ulong NativeValue [get, set]
 
- Properties inherited from GTA.ISpatial
Vector3 Position [get, set]
 
Vector3 Rotation [get, set]
 

Additional Inherited Members

- Protected Member Functions inherited from GTA.PoolObject
 PoolObject (int handle)
 

Constructor & Destructor Documentation

◆ Camera()

GTA.Camera.Camera ( int  handle)

Member Function Documentation

◆ AttachTo() [1/2]

void GTA.Camera.AttachTo ( Entity  entity,
Vector3  offset 
)

Attaches this Camera to a specific Entity.

Parameters
entityThe Entity to attach to.
offsetThe offset from the entity to attach to.

◆ AttachTo() [2/2]

void GTA.Camera.AttachTo ( PedBone  pedBone,
Vector3  offset 
)

Attaches this Camera to a specific PedBone.

Parameters
pedBoneThe PedBone to attach to.
offsetThe offset from the pedBone to attach to.

◆ Delete()

override void GTA.Camera.Delete ( )
virtual

Destroys this Camera.

Implements GTA.PoolObject.

◆ Detach()

void GTA.Camera.Detach ( )

Detaches this Camera from any Entity or PedBone it may be attached to.

◆ Equals()

override bool GTA.Camera.Equals ( object  obj)

Determines if an object refers to the same camera as this Camera.

Parameters
objThe object to check.
Returns
true if the obj is the same camera as this Camera; otherwise, false.

◆ Exists()

override bool GTA.Camera.Exists ( )
virtual

Determines if this Camera exists.

Returns
true if this Camera exists; otherwise, false.

Implements GTA.PoolObject.

◆ GetHashCode()

override int GTA.Camera.GetHashCode ( )

◆ GetOffsetPosition()

Vector3 GTA.Camera.GetOffsetPosition ( Vector3  offset)

Gets the position in world coordinates of an offset relative to this Camera

Parameters
offsetThe offset from this Camera.

◆ GetPositionOffset()

Vector3 GTA.Camera.GetPositionOffset ( Vector3  worldCoords)

Gets the relative offset of this Camera from a world coordinates position

Parameters
worldCoordsThe world coordinates.

◆ InterpTo()

void GTA.Camera.InterpTo ( Camera  to,
int  duration,
int  easePosition,
int  easeRotation 
)

Moves this Camera to the to position.

◆ operator InputArgument()

static implicit GTA.Camera.operator InputArgument ( Camera  value)
static

Converts a Camera to a native input argument.

◆ operator!=()

static bool GTA.Camera.operator!= ( Camera  left,
Camera  right 
)
static

Determines if two Checkpoints don't refer to the same camera.

Parameters
leftThe left Camera.
rightThe right Camera.
Returns
true if left is not the same camera as right ; otherwise, false.

◆ operator==()

static bool GTA.Camera.operator== ( Camera  left,
Camera  right 
)
static

Determines if two Cameras refer to the same camera.

Parameters
leftThe left Camera.
rightThe right Camera.
Returns
true if left is the same camera as right ; otherwise, false.

◆ PointAt() [1/3]

void GTA.Camera.PointAt ( Entity  target,
Vector3  offset = default 
)

Points this Camera at a specified Entity.

Parameters
targetThe Entity to point at.
offsetThe offset from the target to point at.

◆ PointAt() [2/3]

void GTA.Camera.PointAt ( PedBone  target,
Vector3  offset = default 
)

Points this Camera at a specified PedBone.

Parameters
targetThe PedBone to point at.
offsetThe offset from the target to point at

◆ PointAt() [3/3]

void GTA.Camera.PointAt ( Vector3  target)

Points this Camera at a specified position.

Parameters
targetThe position to point at.

◆ Shake()

void GTA.Camera.Shake ( CameraShake  shakeType,
float  amplitude 
)

Shakes this Camera.

Parameters
shakeTypeType of the shake to apply.
amplitudeThe amplitude of the shaking.

◆ StopPointing()

void GTA.Camera.StopPointing ( )

Stops this Camera pointing at a specific target.

◆ StopShaking()

void GTA.Camera.StopShaking ( )

Stops shaking this Camera.

Property Documentation

◆ DepthOfFieldStrength

float GTA.Camera.DepthOfFieldStrength
set

Sets the depth of field strength for this Camera.

◆ Direction

Vector3 GTA.Camera.Direction
getset

Gets or sets the direction this Camera is pointing in.

◆ FarClip

float GTA.Camera.FarClip
getset

Gets or sets the far clip of this Camera.

◆ FarDepthOfField

float GTA.Camera.FarDepthOfField
getset

Gets or sets the far depth of field of this Camera.

◆ FieldOfView

float GTA.Camera.FieldOfView
getset

Gets or sets the field of view of this Camera.

◆ ForwardVector

Vector3? GTA.Camera.ForwardVector
get

Gets the forward vector of this Camera, see also

See also
Direction

.

◆ IsActive

bool GTA.Camera.IsActive
getset

Gets or sets a value indicating whether this Camera is currently being rendered.

true if this Camera is active; otherwise, false.

◆ IsInterpolating

bool GTA.Camera.IsInterpolating
get

Gets a value indicating whether this Camera is interpolating.

true if this Camera is interpolating; otherwise, false.

◆ IsShaking

bool GTA.Camera.IsShaking
get

Gets a value indicating whether this Camera is shaking.

true if this Camera is shaking; otherwise, false.

◆ Matrix

Matrix? GTA.Camera.Matrix
get

Gets the matrix of this Camera.

◆ MemoryAddress

IntPtr GTA.Camera.MemoryAddress
get

Gets the memory address of this Camera.

◆ MotionBlurStrength

float GTA.Camera.MotionBlurStrength
set

Sets the strength of the motion blur for this Camera

◆ NearClip

float GTA.Camera.NearClip
getset

Gets or sets the near clip of this Camera.

◆ NearDepthOfField

float GTA.Camera.NearDepthOfField
set

Sets the near depth of field for this Camera.

◆ Position

Vector3 GTA.Camera.Position
getset

Gets or sets the position of this Camera.

◆ RightVector

Vector3? GTA.Camera.RightVector
get

Gets the right vector of this Camera.

◆ Rotation

Vector3 GTA.Camera.Rotation
getset

Gets or sets the rotation of this Camera.

The yaw, pitch and roll rotations measured in degrees.

◆ ShakeAmplitude

float GTA.Camera.ShakeAmplitude
set

Sets the shake amplitude for this Camera.

◆ UpVector

Vector3? GTA.Camera.UpVector
get

Gets the up vector of this Camera.


The documentation for this class was generated from the following file: