Planes¶

Add your own planes to the world. Build one the way the game builds its planes, read it from your own map file, or fill it with your own terrain and monsters.

A plane is newplane, followed by the commands on this page that shape the plane, in any order. Each plane gets a button on the map's top bar. Limits has how many planes all enabled mods can add, and the caps on these commands.

Files: named from your mod's folder as "./<file>", with the capitals the file has.
Terrains: a terrain number, or a terrain's name in double quotes.

To find	Look in
Terrain numbers and names	ctrl+i on a square in the game; "Terrain Data" in the CoE5 Data thread
The game planes' names	The "Plane Numbers" table, in "Monster Modding Numbers" of the official modding manual
Monster names	"Monster Data" in the CoE5 Data thread
The map file format	`aztlan.coem` and `primal.coem` in the game's `data` folder

newplane "<name>"¶

Creates a plane. Follow it with planesize and planefill, planelike, or planefile.

name: The plane's name, in double quotes. No other plane may have it, including a game plane's full or short name ("Celestial Plane", "Celestial"). Other lines must spell it with the same capitals.

.c5se.c5m

newplane "Mordor"

#!@newplane "Mordor"

planesize <w> <h>¶

Sets the plane's width and height in squares. Needed, unless planefile gives the size, or planelike is "Sky", "Agartha", "Hades" or "Inferno", which take the size the game gives that plane.

w: The plane's width in squares, 1 to 999.
h: The plane's height in squares, 1 to 159.

.c5se.c5m

planesize 40 30

#!@planesize 40 30

planefill <terrain>¶

Sets the terrain every square starts as. Needed, unless the plane has planelike or planefile.

terrain: A terrain by number, 0 to 32767, or its name in double quotes.

.c5se.c5m

A terrain by name:

planefill "Tundra"

Or by number:

planefill 0

A terrain by name:

#!@planefill "Tundra"

Or by number:

#!@planefill 0

planelike "<plane>"¶

Builds the plane the way the game builds that plane: its map, its ground pictures, and its independents. CoE5SE skips any step the plane is too small for.

plane: "Celestial", "Sky", "Agartha", "Inferno", "Hades", "Elemental" or "Void".

.c5se.c5m

planelike "Agartha"

#!@planelike "Agartha"

planepopulate "<plane>"¶

Places that vanilla plane's independents on the plane. Without it, the plane gets the independents of its planelike plane.

plane: A vanilla plane's name, or off for none.

.c5se.c5m

A vanilla plane's independents:

planepopulate "Agartha"

Or none:

planepopulate off

A vanilla plane's independents:

#!@planepopulate "Agartha"

Or none:

#!@planepopulate off

planeicon "./<file>"¶

Sets the picture on the plane's map button: a .tga or .png, 64 x 64 like the game's plane icons. Without it, the button shows the planelike plane's icon, or a coloured square.

.c5se.c5m

planeicon "./mordor.tga"

#!@planeicon "./mordor.tga"

planefile "./<file>.coem"¶

Reads the plane's squares from a map file.

Warning

With planelike too, the built terrain replaces the file's. Only square names and portals stay.

.c5se.c5m

planefile "./tol_eressea.coem"

#!@planefile "./tol_eressea.coem"

planepiece "./<file>.coem" <place>¶

Stamps a map file into the built plane.

place: center, random [count] (once without a count), at <x> <y>, or nearportal.

.c5se.c5m

In the middle:

planepiece "./barad_dur.coem" center

Or in random places, 3 times:

planepiece "./orc_camp.coem" random 3

Or at a square:

planepiece "./orc_camp.coem" at 12 8

Or next to a portal:

planepiece "./orc_camp.coem" nearportal

In the middle:

#!@planepiece "./barad_dur.coem" center

Or in random places, 3 times:

#!@planepiece "./orc_camp.coem" random 3

Or at a square:

#!@planepiece "./orc_camp.coem" at 12 8

Or next to a portal:

#!@planepiece "./orc_camp.coem" nearportal

planezone "<name>" around "./<file>.coem" <radius>¶

Creates a zone: every square within the radius of each copy of that planepiece file. The zone lines below it apply to the last planezone above them.

radius: The distance in squares.

.c5se.c5m

planezone "Shadow of Mordor" around "./barad_dur.coem" 3

#!@planezone "Shadow of Mordor" around "./barad_dur.coem" 3

planezoneswap <terrain> <terrain>¶

Turns each square of the first terrain in the zone into the second.

terrain: The terrain to replace, then the terrain it becomes, each by number or its name in double quotes.

.c5se.c5m

planezoneswap "Rock Ground" "Ash Field"

#!@planezoneswap "Rock Ground" "Ash Field"

planezoneunits "<monster>" <count> <chance>¶

Gives the zone only these monsters instead of its independents.

count: How many on a square.
chance: The percent chance on each square.

.c5se.c5m

planezoneunits "Giant Spider" 3 25

#!@planezoneunits "Giant Spider" 3 25

planezonepopulate off¶

Places no independents in the zone.

.c5se.c5m

planezonepopulate off

#!@planezonepopulate off

planeunits "<monster>" <count> <chance>¶

Gives the plane only these monsters, outside zones with their own. Replaces the independents of planelike and planepopulate.

count: How many on a square.
chance: The percent chance on each square.

.c5se.c5m

planeunits "Troglodyte" 2 10

#!@planeunits "Troglodyte" 2 10

planeswap <terrain> <terrain>¶

Turns each square of the first terrain on the plane into the second, after CoE5SE places the independents. Inside a newplane block only; elsewhere planeswap is the game's ritual command.

terrain: The first is a game terrain; the second, any terrain.

.c5se.c5m

planeswap "Rock Ground" "Ash Field"

#!@planeswap "Rock Ground" "Ash Field"

planereq "<plane>"¶

Takes a plane's name in double quotes where the game takes a plane number, for a mod's plane or a game plane. The same works in:

a ritual's noplanereq, setplane, planeloc, planeswap and aionlyplane;
a class's startplane;
an event's +plane, -plane, randloc, +minterrains, -minterrains, +minunits and -minunits.

The game alone can't read the name: put these lines in the .c5se or on #!@ lines.

.c5se.c5m

In a ritual:

planereq "Mordor"

In a class:

startplane "Mordor"

In an event:

+plane "Mordor"

In a ritual:

#!@planereq "Mordor"

In a class:

#!@startplane "Mordor"

In an event:

#!@+plane "Mordor"

planeshape "<plane>" "<monster>"¶

Makes the monster turn into another on a mod's plane, as elysiumshape to voidshape do on the game's planes. Goes after newmonster or selectmonster.

.c5se.c5m

Turns into a Dire Wolf on Mordor:

planeshape "Mordor" "Dire Wolf"

Or no shape there:

planeshape "Mordor" ""

Turns into a Dire Wolf on Mordor:

#!@planeshape "Mordor" "Dire Wolf"

Or no shape there:

#!@planeshape "Mordor" ""

Example planes¶

.c5se.c5m

newplane "Mordor"
planesize 40 30
planelike "Agartha"
planeicon "./mordor.tga"
planepiece "./barad_dur.coem" center
planepiece "./orc_camp.coem" random 3
planezone "Shadow of Mordor" around "./barad_dur.coem" 3
planezoneswap "Rock Ground" "Ash Field"
planezoneunits "Giant Spider" 3 25
planezone "Orc Camps" around "./orc_camp.coem" 1
planezonepopulate off
planeunits "Troglodyte" 2 10
planeswap "Cave Wall" "Rock Ground"

newplane "Forodwaith"
planesize 20 20
planefill "Tundra"
planepopulate "Agartha"

newplane "Tol Eressea"
planefile "./tol_eressea.coem"

selectmonster "Wolf"
planeshape "Mordor" "Dire Wolf"

selectritual "Messenger Crows"
planereq "Mordor"

#!@newplane "Mordor"
#!@planesize 40 30
#!@planelike "Agartha"
#!@planeicon "./mordor.tga"
#!@planepiece "./barad_dur.coem" center
#!@planepiece "./orc_camp.coem" random 3
#!@planezone "Shadow of Mordor" around "./barad_dur.coem" 3
#!@planezoneswap "Rock Ground" "Ash Field"
#!@planezoneunits "Giant Spider" 3 25
#!@planezone "Orc Camps" around "./orc_camp.coem" 1
#!@planezonepopulate off
#!@planeunits "Troglodyte" 2 10
#!@planeswap "Cave Wall" "Rock Ground"

#!@newplane "Forodwaith"
#!@planesize 20 20
#!@planefill "Tundra"
#!@planepopulate "Agartha"

#!@newplane "Tol Eressea"
#!@planefile "./tol_eressea.coem"

selectmonster "Wolf"
#!@planeshape "Mordor" "Dire Wolf"

selectritual "Messenger Crows"
#!@planereq "Mordor"