C4MapScript.h File Reference

#include "c4group/C4ComponentHost.h"
#include "graphics/CSurface8.h"
#include "landscape/C4Landscape.h"
#include "lib/C4Rect.h"
#include "script/C4Aul.h"
#include "script/C4ScriptHost.h"

Include dependency graph for C4MapScript.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	C4MapScriptMatTexMask
class	C4MapScriptAlgo
class	C4MapScriptAlgoLayer
class	C4MapScriptAlgoRndChecker
class	C4MapScriptAlgoRect
class	C4MapScriptAlgoEllipse
class	C4MapScriptAlgoPolygon
class	C4MapScriptAlgoLines
class	C4MapScriptAlgoModifier
class	C4MapScriptAlgoAnd
class	C4MapScriptAlgoOr
class	C4MapScriptAlgoNot
class	C4MapScriptAlgoXor
class	C4MapScriptAlgoOffset
class	C4MapScriptAlgoScale
class	C4MapScriptAlgoRotate
class	C4MapScriptAlgoTurbulence
class	C4MapScriptAlgoBorder
class	C4MapScriptAlgoFilter
class	C4MapScriptAlgoSetMaterial
class	C4MapScriptLayer
class	C4MapScriptMap
class	C4MapScriptHost

Enumerations
enum	C4MapScriptAlgoType {   MAPALGO_None = 0 , MAPALGO_Layer = 1 , MAPALGO_RndChecker = 10 , MAPALGO_Rect = 20 ,   MAPALGO_Ellipsis = 21 , MAPALGO_Polygon = 22 , MAPALGO_Lines = 23 , MAPALGO_Ellipse = 24 ,   MAPALGO_And = 30 , MAPALGO_Or = 31 , MAPALGO_Not = 32 , MAPALGO_Xor = 33 ,   MAPALGO_Offset = 40 , MAPALGO_Scale = 41 , MAPALGO_Rotate = 42 , MAPALGO_Turbulence = 43 ,   MAPALGO_Border = 50 , MAPALGO_Filter = 51 }

Functions
bool	FnParTexCol (C4String *mattex, uint8_t &fg, uint8_t &bg)

Variables
C4MapScriptHost	MapScript

Enumeration Type Documentation

C4MapScriptAlgoType

enum C4MapScriptAlgoType

Enumerator
MAPALGO_None
MAPALGO_Layer
MAPALGO_RndChecker
MAPALGO_Rect
MAPALGO_Ellipsis
MAPALGO_Polygon
MAPALGO_Lines
MAPALGO_Ellipse
MAPALGO_And
MAPALGO_Or
MAPALGO_Not
MAPALGO_Xor
MAPALGO_Offset
MAPALGO_Scale
MAPALGO_Rotate
MAPALGO_Turbulence
MAPALGO_Border
MAPALGO_Filter

Definition at line 66 of file C4MapScript.h.

{
    MAPALGO_None       = 0,
 
    MAPALGO_Layer      = 1,
 
    MAPALGO_RndChecker = 10,
 
    MAPALGO_Rect       = 20,
    MAPALGO_Ellipsis   = 21, // This is "MAPALGO_Ellipse", but misspelled. Use will result in a warning.
    MAPALGO_Polygon    = 22,
    MAPALGO_Lines      = 23,
    MAPALGO_Ellipse    = 24,
 
    MAPALGO_And        = 30,
    MAPALGO_Or         = 31,
    MAPALGO_Not        = 32,
    MAPALGO_Xor        = 33,
 
    MAPALGO_Offset     = 40,
    MAPALGO_Scale      = 41,
    MAPALGO_Rotate     = 42,
    MAPALGO_Turbulence = 43,
 
    MAPALGO_Border     = 50,
    MAPALGO_Filter     = 51,
};

Function Documentation

FnParTexCol()

bool FnParTexCol	(	C4String *	mattex,
		uint8_t &	fg,
		uint8_t &	bg
	)

Definition at line 48 of file C4MapScript.cpp.

{
    // Return index of material-texture definition for a single color
    // Defaults to underground (tunnel background) color. Prefix material with ^ to get overground (sky background) color,
    // or specify as mattex1:mattex2 for foreground-background pair.
    if (!mattex || !mattex->GetCStr()) return false;
 
    int sep_pos = SCharPos(':', mattex->GetCStr());
    if (sep_pos == -1)
    {
        const char *cmattex = mattex->GetCStr();
        bool ift = true;
        if (*cmattex == '^') { ift=false; ++cmattex; }
        
        uint8_t col;
        if (!TexColSingle(cmattex, col)) return false;
 
        fg = col;
        if (ift)
            bg = ::MapScript.pTexMap->DefaultBkgMatTex(fg);
        else
            bg = C4M_MaxTexIndex; // sky
 
        return true;
    }
    else
    {
        const char *cmattex = mattex->GetCStr();
        std::string fg_mattex(cmattex, cmattex + sep_pos);
        std::string bg_mattex(cmattex + sep_pos + 1);
 
        uint8_t fg_col, bg_col;
        if (!TexColSingle(fg_mattex.c_str(), fg_col)) return false;
        if (!TexColSingle(bg_mattex.c_str(), bg_col)) return false;
 
        fg = fg_col; bg = bg_col;
        return true;
    }
}

References C4M_MaxTexIndex, C4TextureMap::DefaultBkgMatTex(), C4String::GetCStr(), MapScript, C4MapScriptHost::pTexMap, SCharPos(), and TexColSingle().

Here is the call graph for this function:

Variable Documentation

MapScript

C4MapScriptHost MapScript

extern

Definition at line 767 of file C4MapScript.cpp.

Referenced by c4_mapgen_handle_deinit_script_engine(), c4_mapgen_handle_init_script_engine(), c4_mapgen_handle_new_script(), C4Game::Clear(), C4MapScriptMap::CreateLayer(), FnParTexCol(), and C4Game::InitScriptEngine().