C4MapScript.cpp File Reference

#include "C4Include.h"
#include "landscape/C4MapScript.h"
#include "game/C4GameScript.h"
#include "landscape/C4Landscape.h"
#include "landscape/C4Texture.h"
#include "lib/C4Random.h"
#include "script/C4AulDefFunc.h"

Include dependency graph for C4MapScript.cpp:

Go to the source code of this file.

Functions
C4MapScriptAlgo *	FnParAlgo (C4PropList *algo_par)
bool	TexColSingle (const char *mattex, uint8_t &col)
bool	FnParTexCol (C4String *mattex, uint8_t &fg, uint8_t &bg)
bool	FnParRect (C4MapScriptLayer *layer, C4ValueArray *rect, C4Rect *rc_bounds)

Variables
C4MapScriptHost	MapScript

Function Documentation

FnParAlgo()

C4MapScriptAlgo * FnParAlgo

(

C4PropList *

algo_par

)

Definition at line 541 of file C4MapScriptAlgo.cpp.

{
    // Convert script function parameter to internal C4MapScriptAlgo class. Also resolve all parameters and nested child algos.
    if (!algo_par) return nullptr;
 
    C4MapScriptAlgo *inner = FnParAlgoInner(algo_par);
 
    // if the Material property is set, use that material:
    C4String *material = algo_par->GetPropertyStr(P_Material);
    if (material) { // set inner material by wrapping with SetMaterial algo.
        uint8_t fg = 0, bg = 0;
        if (!FnParTexCol(material, fg, bg))
            throw C4AulExecError("Invalid Material in map script algorithm.");
        return new C4MapScriptAlgoSetMaterial(inner, fg, bg);
    }
 
    return inner; // otherwise, just return the original algo
}

Referenced by C4MapScriptAlgoModifier::C4MapScriptAlgoModifier().

Here is the caller graph for this function:

FnParRect()

bool FnParRect	(	C4MapScriptLayer *	layer,
		C4ValueArray *	rect,
		C4Rect *	rc_bounds
	)

Definition at line 221 of file C4MapScript.cpp.

{
    // Convert rect parameter passed to script function to C4Rect structure
    // and makes sure it is completely contained in bounding rectangle of layer
    // rect==nullptr defaults to bounding rectangle of layer
    *rc_bounds = layer->GetBounds();
    if (!rect) return true; // nil is OK for rect parameter. Defaults to bounds rectangle
    if (rect->GetSize() != 4) return false;
    rc_bounds->Intersect(C4Rect(rect->GetItem(0).getInt(), rect->GetItem(1).getInt(), rect->GetItem(2).getInt(), rect->GetItem(3).getInt()));
    return true;
}

References C4MapScriptLayer::GetBounds(), C4Value::getInt(), C4ValueArray::GetItem(), C4ValueArray::GetSize(), and C4Rect::Intersect().

Here is the call graph for this function:

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:

TexColSingle()

bool TexColSingle	(	const char *	mattex,
		uint8_t &	col
	)

Definition at line 37 of file C4MapScript.cpp.

{
    if (SEqual(mattex, DrawFn_Transparent_Name)) { col = 0; return true; }
    if (SEqual(mattex, DrawFn_Sky_Name)) { col = C4M_MaxTexIndex; return true; }
 
    col = ::MapScript.pTexMap->GetIndexMatTex(mattex);
    if (col == 0) return false;
 
    return true;
}

References SEqual().

Referenced by FnParTexCol().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

MapScript

C4MapScriptHost MapScript

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().