GetEngineCameraFarClipPlane

Definition

double GetEngineCameraFarClipPlane(string engineCameraName)

Description

This function returns the far clip plane of the engineCameraName engine camera.

Parameters

engineCameraName
Specifies the name of the engine camera. You can also use the name “this” for this parameter. In this case, “this” refers to the camera object that this script is attached to.

Return Value

Far clip plane of the engineCameraName engine camera.

Example 1

fcp = 0.0

function Init()
    fcp = GetEngineCameraFarClipPlane("camera1")

    message = string.format("\nFar Clip Plane is > %.2f" , fcp)
    PrintConsole(message)
end

function Update()

end
Returns the far clip plane of the “camera1” engine camera.

Example 2

--Name of script is GetEngineCameraFarClipPlane2.lua

fcp = 0.0

function Init()
    fcp = GetEngineCameraFarClipPlane("this")

    message = string.format("\nFar Clip Plane is > %.2f" , fcp)
    PrintConsole(message)
end

function Update()

end
In this case, “this” string in the GetEngineCameraFarClipPlane points to the camera that GetEngineCameraFarClipPlane2.lua script is attached to. For example, if GetEngineCameraFarClipPlane2.lua script is attached to a engine camera named “camera1”, “this” will be equivalent to the name “camera1”. In this example, GetEngineCameraFarClipPlane function returns the far clip plane of current engine camera.
adminGetEngineCameraFarClipPlane