Sample Sidebar Module

This is a sample module published to the sidebar_top position, using the -sidebar module class suffix. There is also a sidebar_bottom position below the menu.
Register

Sample Sidebar Module

This is a sample module published to the sidebar_bottom position, using the -sidebar module class suffix. There is also a sidebar_top position below the search.
Camera Class

Search our Site


The Camera class allows you to access a camera object within your zone from its object ID. All settings can be manipulated through script.

Constructors
new(int ObjectID) Description
Gets a camera object in the current zone from its object ID.

Parameters
int ObjectID
  • The object ID of the camera you want to access in the script.
  • This can be found in the World Editor under the Object General Properties Tab.

Returns
Camera


Functions
MoveBackward(float velocity) Description
Moves the camera backward from the direction it is currently facing.

Parameters
float velocity
  • The speed at which the camera will be moved in meters per second.

Returns
Void
MoveDown(float velocity) Description
Moves the camera Down from the direction it is currently facing.

Parameters
float velocity
  • The speed at which the camera will be moved in meters per second.

Returns
Void
MoveForward(float velocity) Description
Moves the camera forward in the direction it is currently facing.

Parameters
float velocity
  • The speed at which the camera will be moved in meters per second.

Returns
Void
MoveLeft(float velocity) Description
Moves the camera Left of the direction it is currently facing.

Parameters
float velocity
  • The speed at which the camera will be moved in meters per second.

Returns
Void
MoveRight(float velocity) Description
Moves the camera Right of the direction it is currently facing.

Parameters
float velocity
  • The speed at which the camera will be moved in meters per second.

Returns
Void
MoveUp(float velocity) Description
Moves the camera Up from the direction it is currently facing.

Parameters
float velocity
  • The speed at which the camera will be moved in meters per second.

Returns
Void


Properties
float aperture Gets or sets the Aperture of the Camera.
float exposureCompensation Gets or sets the Exposure Compensation of the Camera.
int exposureMethod Gets or sets the Exposure Method of the Camera.
  • 0 : Manual
  • 1 : Automatic
float far Gets or sets the Far Plane of the Camera.
float fov Gets or sets the Field of View of the Camera.
float horizontalSensor Gets or sets the Length of the Horizontal Sensor of the Camera.
float maxExposure Gets or sets the Maximum Exposure of the Camera.
float minExposure Gets or sets the Minimum Exposure of the Camera.
float near Gets or sets the Near Plane of the Camera.
float orthographicHeight Gets or sets the Orthographic Height of the Camera.
float orthographicWidth Gets or sets the Orthographic Width of the Camera.
Vector3D position Gets or sets the Position of the Camera.
float positionX Gets or sets the X Position of the Camera.
float positionY Gets or sets the Y Position of the Camera.
float positionZ Gets or sets the Z Position of the Camera.
Vector3D rotation Gets or sets the Rotation of the Camera.
float rotationX Gets or sets the X Position of the Camera.
float rotationY Gets or sets the Y Position of the Camera.
float rotationZ Gets or sets the Z Position of the Camera.
float sensitivity Gets or sets the Sensitivity of the Camera.
float shutterTime Gets or sets the Shutter Time of the Camera.
int viewMode Gets or sets the View Mode of the Camera.
  • 0 : Perspective
  • 1 : Orthographic