Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Camera.GetAllCameras

Switch to Manual
static function GetAllCameras(cameras: Camera[]): int;
static int GetAllCameras(Camera[] cameras);
static def GetAllCameras(cameras as Camera[]) as int

Parameters

camerasAn array to be filled up with cameras currently in the scene.

Description

Fills an array of Camera with the current cameras in the scene, without allocating a new array.

The passed in array needs to be of minimum size of what allCamerasCount .

When the array size is larger than the allCamerasCount value, only the first elements up to allCamerasCount will be filled up.

When the array size is smaller than the allCamerasCount value, an argument exception is thrown.

When the array argument passed in is null, this call will throw a nullreference exception.

The return value will indicate how many cameras where put into the array.