Camera category

Related help topics

	Release Notes > Stingray 1.1 Release Notes
	Creating Gameplay > Visual programming using Flow > Flow Node Colors and Types (Level Flow)

Nodes

Get Active Camera Returns the current active camera from the engine.

Outputs
		Camera		camera	The currently active camera.
		Unit		unit	The unit holding the camera.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Script node definition in file: core/appkit/appkit.script_flow_nodes

Get Camera Far Range Gets the camera’s Far range distance

Outputs
		Distance		float	The far range of the camera.
Inputs
unit		Unit			The unit owning the camera.
camera		Camera			The camera whose far range you want to retrieve.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Get Camera Local Position Returns the camera’s local position.

Outputs
		Position		vector3	The position of the camera.
Inputs
unit		Unit			The unit owning the camera.
camera		Camera			The camera whose position you want to retrieve.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Get Camera Local Rotation Returns the camera’s local rotation.

Outputs
		Rotation		quaternion	The rotation of the camera.
Inputs
unit		Unit			The unit owning the camera.
camera		Camera			The camera whose rotation you want to retrieve.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Get Camera Near Range Gets the camera’s near range distance

Outputs
		Distance		float	The near range of the camera.
Inputs
unit		Unit			The unit owning the camera.
camera		Camera			The camera whose near range you want to retrieve.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Get Camera Vertical FOV Gets the camera’s vertical field of view.

Outputs
		Angle		float	The vertical FOV angle in radians.
Inputs
unit		Unit			The unit owning the camera.
camera		Camera			The camera whose vertical FOV you want to retrieve.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Get Camera World Position Returns the camera’s world position.

Outputs
		Position		vector3	The world position of the camera.
Inputs
unit		Unit			The unit owning the camera.
camera		Camera			The camera whose position you want to retrieve.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Get Camera World Rotation Returns the camera’s world rotation.

Outputs
		Rotation		quaternion	The world rotation of the camera.
Inputs
unit		Unit			The unit owning the camera.
camera		Camera			The camera whose rotation you want to retrieve.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Inside Camera Frustum Indicates whether the specified point is inside the camera's frustum.

Outputs
		Inside		boolean	Returns true if the point is inside the frustum and false otherwise.
		Distance		float	The distance of the point to the frustum.
Inputs
unit		Unit			The unit owning the camera.
camera		Camera			The camera whose frustum you want to test.
vector3		Position			A point that is tested.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Move Camera Moves the specified camera every frame using a delta position in a direction based on the velocity.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
unit		Unit			The unit owning the camera.
camera		Camera			The camera to move.
vector3		Delta Position			The new delta position of the camera.
vector3		Velocity			The velocity of the camera.
event		In			This event triggers the evaluation of this node.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Screen Position To Ray Casts a ray from the camera position through the screen position converted to world space.

Outputs
		Ray		vector3	The ray cast to the position in world space.
Inputs
unit		Unit			The unit owning the camera.
camera		Camera			The camera whose position and rotation defines the mapping between screen space and world space.
vector3		Screen Position			A point in screen coordinates.
float		Depth			The depth of the point.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Screen To World Converts a screen position with depth into a world position.

Outputs
		World Position		vector3	The converted point in world coordinates.
Inputs
unit		Unit			The unit owning the camera.
camera		Camera			The camera whose position and rotation defines the mapping between screen space and world space.
vector3		Screen Position			A point in screen coordinates (x, y, 0).
float		Depth			The depth of the point.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Set Active Camera Sets the active camera for the engine.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
camera		Camera			The camera to set as active for the engine.
unit		Unit			The unit holding the camera.
event		In			This event triggers the evaluation of this node.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Script node definition in file: core/appkit/appkit.script_flow_nodes

Set Camera Far Range Sets the camera’s far range distance.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
unit		Unit			The unit owning the camera.
camera		Camera			The camera whose far range you want to set.
float		Distance			The far range distance.
event		In			This event triggers the evaluation of this node.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Set Camera Local Position Sets the camera’s local position.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
unit		Unit			The unit owning the camera.
camera		Camera			The camera whose position you want to set.
vector3		Position			The position of the camera.
event		In			This event triggers the evaluation of this node.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Set Camera Local Rotation Sets the camera’s local rotation.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
unit		Unit			The unit owning the camera.
camera		Camera			The camera whose position you want to set.
quaternion		Rotation			The rotation of the camera.
event		In			This event triggers the evaluation of this node.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Set Camera Near Range Sets the camera’s near range distance.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
unit		Unit			The unit owning the camera.
camera		Camera			The camera whose near range you want to set.
float		Distance			The near range distance.
event		In			This event triggers the evaluation of this node.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Set Camera Vertical FOV Sets the camera’s vertical field of view

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
unit		Unit			The unit owning the camera.
camera		Camera			The camera whose vertical FOV you want to set.
float		Angle			The vertical FOV angle in radians.
event		In			This event triggers the evaluation of this node.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

World To Screen Converts a world position into a screen position.

Outputs
		Screen Position		vector3	The converted point in screen coordinates.
		Depth		float	The converted point depth value.
Inputs
unit		Unit			The unit owning the camera.
camera		Camera			The camera whose position and rotation defines the mapping between screen space and world space.
vector3		World Position			A point in world coordinates.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.