Editor Camera

From Wolfire Games Wiki
Revision as of 04:00, 19 November 2017 by Merlyn (talk | contribs) (Created page with "= Overview = Category: Modding Category:Overgrowth Cameras let you control where the player's view is positioned and what it is pointing at. Same with the editor camera. ...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search


Cameras let you control where the player's view is positioned and what it is pointing at. Same with the editor camera.

They also let you apply effects like depth of field, the view angle (FOV), and camera shake.

TODO: More useful description. Multiple cameras - are those even a thing? How does it work for split-screen?


Callable functions and data available inside camera scripts

The camera script gets an instances of the camera itself (a variable defined as [email protected] camera), so it can call functions on the Camera interface.

It also gets an instance of the editor camera controller object (a variable defined as [email protected] co), so it can access properties that are editor specific.

A list of functions, data, etc, is created automatically whenever you run the game, in a file on your hard drive. This lists some of the external code you get "for free" and can call from inside a camera script. (Some of this code in this list is not usable from a camera script - see the links below for more info).

  • Windows: My Documents\Wolfire\Overgrowth\aslevel_docs.h
  • Mac: ~/Library/Application Support/Overgrowth/aslevel_docs.h
  • Linux: ~/.local/share/Overgrowth/aslevel_docs.h

This documentation will change with each version of the game, so keep checking back on this aslevel_docs.h file to see the most up to date information.

There are also wiki pages which have more detailed documentation many of these functions. These pages have a danger of going out of date, but give more detailed documentation on some of the code:

Camera instances in other scripts

The camera is exposed to other scripts as instances of the Camera class (as [email protected] camera).

Camera object instances are not entirely like other objects in the game. They aren't derived from Object, and only support a limited subset of functionality.

How to create a custom camera script

The camera script always has this path: Data/Scripts/cam.as

If you are overriding this in a mod, it will have this path: Data/Mods/<your_mod_name>/Scripts/cam.as

Camera script hook functions

All functions inside a camera script are required

Init function

void Init() { }


Init is called when the camera is first loaded, upon level load.

Be careful, this may be called before some objects or script params are present in the level.

It is most useful for setting initial values for file-scope angelscript state.

Update function

void Update() { }


Update is called regularly by the engine so you can perform work.

It may be useful to do initialization once in this function, if you need to delay camera updates until other objects have loaded.

Be careful to keep this function short, sweet, and fast. Update gets called 120 times a second as of the time of this writing. TODO: Is this accurate for camera scripts?

FrameSelection function

void FrameSelection(bool increased_distance) { }


FrameSelection is called when the "frame selection" action called in editor. This is invoked in one of two ways:

  • Via hotkeys (F or SHIFT + F)
  • Via the Go To Selected action in the menu. Top Bar -> Selected -> Go To Selected

The increased_distance parameter will be set to true if the desired action is to frame all selected items within the camera (the F hotkey, or the Go To Selected menu item set this to true).

The increased_distance parameter will be set to false if the desired action is to teleport to the selected items (the SHIFT + F hotkey sets this to false).