The Corona Command


Usage

    corona texture [mask=mask] [size=size] [name=name]

Description

Note: the corona command is new in Outerworlds 3.3 and requires 3.3 or later in order to function.

The corona command places a corona over an object. A corona is a transparent image that is stamped on to the 3D scene on top of an object whenever that object is visible to the user. Although similar in some ways to sprites, they differ in that their size does not vary with distance from the camera, and the entire corona is either visible or not visible depending on whether the corona's source object is currently visible (i.e. not obscured by any other object.) The primary purpose of coronas is for creating "halo" effects around local light sources.

The texture specifies the name of the texture to use for the corona. The texture must come from the world's object path. While technically any texture can be used as a corona, obviously for a good effect the texture should be one that has been specifically designed to be a corona.

If the object also has a light on it, the corona will automatically be colored the same as the light, if it is a non-white light. Thus, a single corona texture can be used for multiple light sources even if they are different colors.

The optional mask argument specifies a texture mask file for masking the corona texture, also from the world's object path. If no mask is specified, the texture is self-masking. Self-masking means a transparency mask for the texture is generated from a grayscale version of the same texture. Self-masking is usually sufficient for most corona effects.

The optional size argument controls the size of the corona relative to the size of the 3D viewport. The default is 100.

The optional name argument specifies the name of the object to place the corona on. Object names are assigned via the name command.

Example

    create corona halo size=50

This downloads the texture halo.jpg from the current object path, masks it with itself, and uses it to draw a small corona over the object whenever that object is visible.