CAOS Language Guide

Macro

Description

A rain cloud object is something that can generate a tiling image underneath it - these were not used in the release version of Creatures 2 but have been left in for completeness. The use of this type of object relies on the fact that there is a sprite file called RAIN.S16 which contains 12 images of size 64x64. If this file does not exist then strange things can happen.

The NEW: command is used to create a rain cloud object and the RAIN command is used to start/stop the effect and change it's appearance.

NEW: RAIN imagefile numimages imagenumber plane clone

Creates a new rain cloud object, these are like Simple Objects but have a weather effect underneath.

imagefile - the sprite file to use for the cloud itself

numimages - the total number of images to be used for this object

imagenumber - the number of the first image belonging to this object

plane - the image plane to plot the object at.

clone - create a cloned image gallery yes/no

Command only

RAIN property

RAIN property value

Get/set a property of the weather effect of a RAIN object.

0=x position, relative to object

1=y position, relative to object

2=width

3=height

4=angle of effect (updated by wind)

5=speed - number of pixels moved per update

6=mode - (0=stopped, 1=running, 2=start!, 3=stop!)

7=rain image number (0-11)

Command and RValue.