GetSkyBox(object)

Gets the SKYBOX_* constant being used in the calling area.

int GetSkyBox(
    object oArea = OBJECT_INVALID
);

Parameters

oArea

The area for which the skybox will be returned.

Description

Gets the SKYBOX_* constant being used in the calling area.

If no valid area (or object) is specified, the area of the caller is used.

If an object other than an area is specified, it will use the area that the object is currently in.

Remarks

If the area's skybox is set to a custom skybox defined in the skyboxes.2da file, the function returns the row number in the skyboxes.2da file occupied by that custom skybox's definition.

Version

1.65

Example

See SetSkyBox.