Camera PropertiesRAGE Plugin Hook Documentation

[This is preliminary documentation and is subject to change.]

The Camera type exposes the following members.

Properties

  NameDescription
Public propertyAbovePosition
Gets a position directly above this Entity.
(Inherited from Entity.)
Public propertyActive
Gets or sets a value indicating whether this instance is currently active.
Public propertyAngularVelocity
Gets or sets the rotational velocity of this entity.
(Inherited from Entity.)
Public propertyBelowPosition
Gets a position directly below this Entity.
(Inherited from Entity.)
Public propertyCanBeDamaged
Gets or sets a value indicating whether this entity can be damaged.
(Inherited from Entity.)
Public propertyCollisionIgnoredEntity
Gets or sets the Entity this entity currently ignores collisions from.
(Inherited from Entity.)
Public propertyCreatedByTheCallingPlugin
Gets a value indicating whether this instance was created by the calling plugin.
(Inherited from Entity.)
Public propertyDirection
Gets or sets the direction of this instance.
(Inherited from Entity.)
Public propertyForwardVector
Gets the forward vector of this instance.
(Inherited from Entity.)
Public propertyFOV
Public propertyFrontPosition
Gets a position directly in front of this Entity.
(Inherited from Entity.)
Public propertyHandle
Gets the handle of this instance. Used to identify the instance within its pool.
(Inherited from Entity.)
Public propertyHasBeenDamagedByAnyObject
Gets or sets a value indicating whether this entity has been damaged by any Object.
(Inherited from Entity.)
Public propertyHasBeenDamagedByAnyPed
Gets or sets a value indicating whether this entity has been damaged by any Ped.
(Inherited from Entity.)
Public propertyHasBeenDamagedByAnyVehicle
Gets or sets a value indicating whether this entity has been damaged by any Vehicle.
(Inherited from Entity.)
Public propertyHeading
Gets or sets the heading of this instance in degrees.
(Inherited from Entity.)
Public propertyHealth
Gets or sets the health of this instance.
(Inherited from Entity.)
Public propertyHeight
Gets the height of this Entity.
(Inherited from Entity.)
Public propertyHeightAboveGround

Gets this entity's distance from the ground in 1D on the Z-axis.

The distance is measured from the entity's origin to the surface below the entity (Surfaces include roofs of buildings).

(Inherited from Entity.)
Public propertyInvincible Obsolete.
Sets a value indicating whether this instance is invincible.
(Inherited from Entity.)
Public propertyIsAlive
Gets a value indicating whether this instance is alive.
(Inherited from Entity.)
Public propertyIsBulletProof
Gets or sets a value indicating whether this entity can take damage from bullets.
(Inherited from Entity.)
Public propertyIsCollisionEnabled
Gets or sets a value indicating whether collision is enabled for this entity.
(Inherited from Entity.)
Public propertyIsCollisionProof
Gets or sets a value indicating whether this entity can take damage from collisions.
(Inherited from Entity.)
Public propertyIsDead
Gets a value indicating whether this instance is dead.
(Inherited from Entity.)
Public propertyIsExplosionProof
Gets or sets a value indicating whether this entity can take damage from explosions.
(Inherited from Entity.)
Public propertyIsFireProof
Gets or sets a value indicating whether this entity can take damage from fire.
(Inherited from Entity.)
Public propertyIsGravityDisabled
Gets or sets a value indicating whether gravity is disabled for this entity.
(Inherited from Entity.)
Public propertyIsInAir (Inherited from Entity.)
Public propertyIsInvincible
Sets a value indicating whether this instance is invincible.
(Inherited from Entity.)
Public propertyIsInWater

Gets a value indicating whether this entity is currently in water.

Returns true the moment any part of the entity is touching water.

(Inherited from Entity.)
Public propertyIsMeleeProof
Gets or sets a value indicating whether this entity can take damage from melee attacks.
(Inherited from Entity.)
Public propertyIsOnFire
Gets or sets a value indicating whether this Entity is on fire.
(Inherited from Entity.)
Public propertyIsOnScreen
Gets a value indicating whether this instance is on the screen.
(Inherited from Entity.)
Public propertyIsPersistent
Gets or sets a value indicating whether this instance is persistent within the game world. Persistent instances will not be removed automatically during clean ups.
(Overrides EntityIsPersistent.)
Public propertyIsPositionFrozen
Sets a value indicating whether the position of this entity is frozen.
(Inherited from Entity.)
Public propertyIsRecordingCollisions
Gets or sets a value indicating whether this entity is recording collisions.
(Inherited from Entity.)
Public propertyIsRendered
Gets a value indicating whether this instance is currently being rendered.
(Inherited from Entity.)
Public propertyIsRendering
Gets a value indicating whether this instance is the gameplay camera.
Public propertyIsUpsideDown
Gets or sets a value indicating whether this entity is upside down.
(Inherited from Entity.)
Public propertyIsVisible

Gets or sets a value indicating whether this instance is currently visible within the game world.

Invisible instances will still be processed but will not be rendered.

(Inherited from Entity.)
Public propertyLeftPosition
Gets a position directly to the left of this Entity.
(Inherited from Entity.)
Public propertyLength
Gets the length of this Entity.
(Inherited from Entity.)
Public propertyMaxHealth
Gets or sets the maximum health of this instance.
(Inherited from Entity.)
Public propertyMemoryAddress
Gets the memory address of this instance.
(Overrides EntityMemoryAddress.)
Public propertyCode exampleMetadata

Gets the metadata associated with this instance.

The value of this property can be used to store data about this instance.
Getting or setting metadata is done using the same syntax as getting or setting a property.
Internally the value is added to a dictionary with the specified property name as key.

(Inherited from Entity.)
Public propertyModel
Gets or sets the Model of this instance.
(Inherited from Entity.)
Public propertyNeedsCollision

Gets a value indicating whether this instance needs collision.

Entities not marked explicitly to need collision will still get collision, however, if other entities need collision, entities not marked as needing collision may lose it in favor of those.

(Inherited from Entity.)
Public propertyOpacity
Gets or sets the opacity of this instance.
(Inherited from Entity.)
Public propertyOrientation
Gets or sets the orientation of this instance.
(Inherited from Entity.)
Public propertyPosition
Gets or sets the position of this instance.
(Overrides EntityPosition.)
Public propertyQuaternion
Gets or sets the quaternion of this instance.
(Overrides EntityQuaternion.)
Public propertyRearPosition
Gets a position directly behind this Entity.
(Inherited from Entity.)
Public propertyStatic memberRenderingCamera
Gets the camera currently being rendered.
Public propertyRightPosition
Gets a position directly to the right of this Entity.
(Inherited from Entity.)
Public propertyRightVector
Gets the right vector of this instance.
(Inherited from Entity.)
Public propertyRotation
Gets or sets the rotation of this instance.
(Overrides EntityRotation.)
Public propertySpeed

Gets the speed of this Entity in meters per second.

This is equivalent of Velocity.Length().

(Inherited from Entity.)
Public propertySubmersionLevel
Gets a value indicating how submersed this entity is.
(Inherited from Entity.)
Public propertyUpVector
Gets the up vector of this instance.
(Inherited from Entity.)
Public propertyVelocity
Gets or sets the velocity of this entity.
(Inherited from Entity.)
Public propertyWidth
Gets the width of this Entity.
(Inherited from Entity.)
Top
See Also

Reference