Class Objects.Camera

Basic cameras that can point at Lara or at a CAMERA_TARGET.

Functions

Camera:GetPosition() Get the camera's position.
Camera:SetPosition(position) Set the camera's position.
Camera:GetName() Get the camera's unique string identifier
Camera:SetName(name) Set the camera's name (its unique string identifier).
Camera:GetRoom() Get the current room of the camera.
Camera:GetRoomNumber() Get the current room number of the camera.
Camera:SetRoomNumber(ID) Set room of camera.
Camera:PlayCamera([target]) Activate the camera for the current game frame.


Functions

Camera:GetPosition()
Get the camera's position.

Returns:

    Vec3 Camera's position.
Camera:SetPosition(position)
Set the camera's position.

Parameters:

  • position Vec3 The new position of the camera.
Camera:GetName()
Get the camera's unique string identifier

Returns:

    string the camera's name.
Camera:SetName(name)
Set the camera's name (its unique string identifier).

Parameters:

  • name string The camera's new name.
Camera:GetRoom()
Get the current room of the camera.

Returns:

    Room Current room of the camera.
Camera:GetRoomNumber()
Get the current room number of the camera.

Returns:

    int Number representing the current room of the camera.
Camera:SetRoomNumber(ID)
Set room of camera. This is used in conjunction with SetPosition to teleport the camera to a new room.

Parameters:

  • ID int The ID of the new room.
Camera:PlayCamera([target])
Activate the camera for the current game frame.

Parameters:

  • target Moveable If you put a moveable, the camera will look at it. Otherwise, it will look at Lara. Optional.
generated by TEN-LDoc (a fork of LDoc 1.4.6)