CAOS Language Guide

Macro

Description

These commands work at a level above the in-game operations and allow for such operations as pausing the game, altering the scriptorium etc.

SCRP family genus species event

Indicates that the rest of this macro is to be installed into the scriptorium, making it available as a new/replacement event script for a given type of object.

family genus species - indicate the owner of this script, if values of 0 are used for any of these then the script will be installed as a default script for a wide range of objects. i.e. if species is 0 then the script will apply to all who share the same family and genus.

event - indicates the event that will invoke this script, see the reference section for a list of event numbers.

Command only

SCRX family genus species event

Removes the script matching this description from the scriptorium.

Command only

PAUS

PAUSe game. 0=normal, 1=pause

Note that Creatures already calls a dispatch method for each applet currently running when the game pauses.

RValue and LValue

GAME category variable [state]

GAME flow state. Sets or queries game flow state.

Category: 0 = Applet custom condition,

Variable: Applet slot number.

Category: 1 = Applet advanced option,

Variable: Applet slot number. 5 for Science Kit, 6 for Neuroscience Kit.

Category: 2 = Game feature enable.

Variable: 0 = Select Ettins/ Grendels, 1 = Infinite scroll

RValue and LValue

LOCK

Prevents the execution of other event scripts taking place on this object and hence interrupting this script.

Note that this will result in lost events and messages. Any script that contains a LOCK should also contain an UNLK. This will not prevent the execution of a SCRIPTEXCEPTION macro script however.

Command only.

UNLK

Enables the execution of other event scripts on this object. This should be paired with command LOCK.

Command only

EVNT targ

Adds an event label to the Event Bar, the three types possible are BIRTH, DEATH and EGG.

To get a death event call this macro with targ as OWNR in it's death script.

To get a birth event call this macro with targ as a new creature

To get an egg event call this macro with targ as a newly created egg object.

Command only

RMEV targ

Removes an event label from the event bar. The value for targ works the same as EVNT.

Command only

SCOR item

Returns chronicle information concerning a particular game item. The values for item are:

0 - Generation 1 eggs used

1 - Number of natural eggs laid

2 - Number of deaths

3 - Number of creatures imported

4 - Number of creatures exported

5 - Number of creatures alive

RValue only

HOUR

Returns the number of game hours elapsed since game start.

RValue only

MINS

Returns the number of game minutes elapsed since game start.

RValue only

SYS: EDIT left top right bottom

Draw a rectangle on the game window with the corners given by the co-ordinates left top right bottom.

Command only

SYS: DMAP

Draw map.

1 -> draw room box, floor and vehicle cabins over backdrop.

0 -> do not draw room data.

Command only

SYS: WTOP

Set the world window to be the foreground window.

Command only

SYS: QUIT

Saves the world and closes the game window

Command only

SYS: ABRT

Abandons changes to world and closes the game window

Command only

SYS: WRLD world

Saves the current world and opens the named one

Command only

SYS: CONV filespec p

CONVert sprite file. Command converts a given sprite file (located in the images directory) to the current system image format. If the file is already in the correct format it is not modified.

Filespec - a 4 letter sprite file specifier.

p - p=0 no progress dialog is displayed. p=1 a progress dialog is displayed.

Command only

RNDR

ReNDereR image format. Returns 0 if image format is 555 and 1 if it is 565.

RValue only

VRSN

VRSN number

Return the Creatures Build ID or Only run this script if the Creatures Build ID is equivalent or higher than number.

LValue and Command

LANG

Primary LANGuage of Windows desktop. Values are (in hexidecimal) as follows:

Neutral 0x00

Chinese 0x04

Czech 0x05

Danish 0x06

Dutch 0x13

English 0x09

Finnish 0x0b

French 0x0c

German 0x07

Greek 0x08

Hungarian 0x0e

Icelandic 0x0F

Italian 0x10

Japanese 0x11

Korean 0x12

Norwegian 0x14

Polish 0x15

Portuguese 0x16

Russian 0x19

Serbo Croatian 0x1a

Slovak 0x1b

Spanish 0x0a

Swedish 0x1d

Turkish 0x1F

RValue only

LNG+

Sub LaNGuage of Windows desktop. Values are (in hexidecimal) as follows:

Neutral 0x00

Default 0x01

System Default 0x02

Chinese (Simplified) 0x02

Chinese (Traditional) 0x01

Dutch 0x01

Dutch (Belgian) 0x02

English (U.S.) 0x01

English (U.K.) 0x02

English (Australian) 0x03

English (Canadian) 0x04

English (Irish) 0x06

English (New Zealand) 0x05

French 0x01

French (Belgian) 0x02

French (Canadian) 0x03

French (Swiss) 0x04

German 0x01

German (Swiss) 0x02

German (Austrian) 0x03

Greek 0x01

Icelandic 0x01

Italian 0x01

Italian (Swiss) 0x02

Japanese 0x01

Korean 0x01

Norwegian (Bokmal) 0x01

Norwegian (Nynorsk) 0x02

Portuguese 0x02

Portuguese (Brazilian) 0x01

Serbo Croatian (Latin) 0x01

Spanish (Castilian)1 0x01

Spanish (Mexican) 0x02

Spanish (Modern)1 0x03

Turkish 0x01

RValue only