CKS reference
CKS stands for Celtic Kings Script. It is Imperivm’s scripting language for maps, adventures and mods. Check the complete signature before applying a description to your script.
Enable JavaScript to filter, or browse the families below.
void Sleep(int)Pauses the current script. The duration unit is not documented here.
Globalvoid KillScript()Stops the current script.
Globalint +=(int&, int)Description pending.
Globalint -=(int&, int)Description pending.
Globalint &(int, int)Description pending.
Globalint |(int, int)Description pending.
Globalint +(int, int)Description pending.
Globalint -(int, int)Description pending.
Globalint -(int)Description pending.
Globalvoid =(int&, int)Description pending.
Globalint *(int, int)Description pending.
Globalint /(int, int)Description pending.
Globalint %(int, int)Description pending.
Globalbool ==(int, int)Description pending.
Globalbool !=(int, int)Description pending.
Globalbool <(int, int)Description pending.
Globalbool >(int, int)Description pending.
Globalbool <=(int, int)Description pending.
Globalbool >=(int, int)Description pending.
Globalint abs(int)Returns the absolute value of an integer.
Globalvoid Write(int)Consumes four bytes and delegates the integer to format %ld in the shared formatting buffer.
Globalint MIN(int, int)Returns the smaller of the two values.
Globalint MAX(int, int)Returns the larger of the two values.
Globalint CLAMP(int, int, int)Limits a value to the supplied lower and upper bounds.
Browse by family
Section titled “Browse by family”- Global · 714
- Building · 46
- Catapult · 14
- Conversation · 4
- Druid · 12
- Flying · 8
- GAIKA · 51
- Gate · 9
- Hero · 29
- IntArray · 3
- Item · 11
- ItemHolder · 5
- NamedObj · 3
- Obj · 151
- ObjList · 42
- point · 13
- Query · 34
- rect · 12
- Sacrifice · 8
- Settlement · 139
- Ship · 20
- Squad · 45
- SquadList · 13
- StrArray · 3
- StrMap · 3
- Teleport · 3
- Unit · 117
- Wagon · 11
Origins and limitations
Section titled “Origins and limitations”This documentation builds on the work of David Campos Rodríguez and the descriptions published by the CKS Visual Studio Code extension. Coverage is incomplete: some primitives and descriptions are still missing. Undocumented variants retain their signature and any available notes. Suggest improvements from each entry; proposals are reviewed before publication.