C4GameScript.cpp File Reference

#include "C4Include.h"
#include "C4ForbidLibraryCompilation.h"
#include "game/C4GameScript.h"
#include "control/C4GameControl.h"
#include "control/C4RoundResults.h"
#include "editor/C4Console.h"
#include "game/C4Application.h"
#include "game/C4GraphicsSystem.h"
#include "game/C4Viewport.h"
#include "graphics/C4GraphicsResource.h"
#include "graphics/C4Shader.h"
#include "gui/C4GameMessage.h"
#include "gui/C4MessageInput.h"
#include "gui/C4MouseControl.h"
#include "gui/C4ScriptGuiWindow.h"
#include "landscape/C4Landscape.h"
#include "landscape/C4PXS.h"
#include "landscape/C4Particles.h"
#include "landscape/C4Sky.h"
#include "landscape/C4Texture.h"
#include "landscape/C4Weather.h"
#include "landscape/fow/C4FoW.h"
#include "object/C4Command.h"
#include "object/C4DefList.h"
#include "object/C4GameObjects.h"
#include "platform/C4GamePadCon.h"
#include "player/C4Player.h"
#include "player/C4PlayerList.h"
#include "script/C4AulDefFunc.h"

Include dependency graph for C4GameScript.cpp:

Go to the source code of this file.

Classes
class	C4ValueCompiler
class	C4ValueGetCompiler
struct	PathInfo
struct	SumPathLength

Macros
#define	F(f)   ::AddFunc(p, #f, Fn##f)

Functions
void	MakeAbsCoordinates (C4PropList *_this, int32_t &x, int32_t &y)
void	MakeAbsCoordinates (C4PropList *_this, long &x, long &y)
C4Effect **	FnGetEffectsFor (C4PropList *target)
long	GetValidOwner (C4PropList *_this, Nillable< long > owner)
void	AssignController (C4PropList *_this, C4Object *obj)
C4FindObject *	CreateCriterionsFromPars (C4Value *parameters, C4FindObject **pFOs, C4SortObject **pSOs, const C4Object *context)
C4String *	GetTextureName (int32_t texture_nr)
C4Object *	FnPlaceVegetation (C4PropList *_this, C4PropList *Def, long x, long y, long wdt, long hgt, long growth, C4PropList *shape)
C4Object *	FnPlaceAnimal (C4PropList *_this, C4PropList *Def)
C4Object *	FnObject (C4PropList *_this, long iNumber)
template<class T >
C4Value	GetValByStdCompiler (const char *strEntry, const char *strSection, int iEntryNr, const T &rFrom)
bool	SimFlight (C4Real &x, C4Real &y, C4Real &xdir, C4Real &ydir, int32_t iDensityMin, int32_t iDensityMax, int32_t &iIter)
void	InitGameFunctionMap (C4AulScriptEngine *pEngine)

Variables
C4ScriptConstDef	C4ScriptGameConstMap []
C4ScriptFnDef	C4ScriptGameFnMap []

---

Class Documentation

PathInfo

struct PathInfo

Definition at line 2438 of file C4GameScript.cpp.

Class Members
long	ilen
long	ilx
long	ily

Macro Definition Documentation

F

#define F

(

f

)

::AddFunc(p, #f, Fn##f)

Function Documentation

AssignController()

void AssignController	(	C4PropList *	_this,
		C4Object *	obj
	)

Definition at line 190 of file C4GameScript.cpp.

{
    // Set initial controller to creating controller, so more complicated cause-effect-chains can be traced back to the causing player
    if (obj && Object(_this) && Object(_this)->Controller > NO_OWNER)
    {
        obj->Controller = Object(_this)->Controller;
    }
}

References C4Object::Controller, NO_OWNER, and Object().

Here is the call graph for this function:

CreateCriterionsFromPars()

C4FindObject* CreateCriterionsFromPars	(	C4Value *	parameters,
		C4FindObject **	pFOs,
		C4SortObject **	pSOs,
		const C4Object *	context
	)

Definition at line 296 of file C4GameScript.cpp.

{
    int count = 0;
    int sort_count = 0;
    bool has_layer_check = false;
    // Read all parameters
    for (int i = 0; i < C4AUL_MAX_Par; i++)
    {
        C4Value Data = *(parameters++);
        // No data given?
        if (!Data)
        {
            break;
        }
        // Construct
        C4SortObject *pSO = nullptr;
        C4FindObject *pFO = C4FindObject::CreateByValue(Data, pSOs ? &pSO : nullptr, context, &has_layer_check);
        // Add FindObject
        if (pFO)
        {
            pFOs[count++] = pFO;
        }
        // Add SortObject
        if (pSO)
        {
            pSOs[sort_count++] = pSO;
        }
    }
    // No criterions?
    if (!count)
    {
        for (int i = 0; i < sort_count; ++i)
        {
            delete pSOs[i];
        }
        return nullptr;
    }
    // Implicit layer check
    if (context && !has_layer_check)
    {
        pFOs[count++] = new C4FindObjectLayer(context->Layer);
    }
    // create sort criterion
    C4SortObject *pSO = nullptr;
    if (sort_count)
    {
        if (sort_count == 1)
        {
            pSO = pSOs[0];
        }
        else
        {
            pSO = new C4SortObjectMultiple(sort_count, pSOs, false);
        }
    }
    // Create search object
    C4FindObject *pFO;
    if (count == 1)
    {
        pFO = pFOs[0];
    }
    else
    {
        pFO = new C4FindObjectAnd(count, pFOs, false);
    }
    if (pSO)
    {
        pFO->SetSort(pSO);
    }
    return pFO;
}

References C4AUL_MAX_Par, C4FindObject::CreateByValue(), C4Object::Layer, and C4FindObject::SetSort().

Here is the call graph for this function:

FnGetEffectsFor()

C4Effect** FnGetEffectsFor

(

C4PropList *

target

)

Definition at line 72 of file C4GameScript.cpp.

{
    if (target)
    {
        if (target == ScriptEngine.GetPropList())
        {
            return &ScriptEngine.pGlobalEffects;
        }
        if (target == GameScript.ScenPropList.getPropList())
        {
            return &GameScript.pScenarioEffects;
        }
        C4Object * obj = target->GetObject();
        if (!obj)
        {
            throw C4AulExecError("Effect target has to be an object");
        }
        return &obj->pEffects;
    }
    return &ScriptEngine.pGlobalEffects;
}

References GameScript, C4PropList::GetObject(), C4AulScriptEngine::GetPropList(), C4Value::getPropList(), C4Object::pEffects, C4AulScriptEngine::pGlobalEffects, C4GameScriptHost::pScenarioEffects, C4GameScriptHost::ScenPropList, and ScriptEngine.

Here is the call graph for this function:

FnObject()

C4Object* FnObject	(	C4PropList *	_this,
		long	iNumber
	)

Definition at line 1646 of file C4GameScript.cpp.

{
    return ::Objects.SafeObjectPointer(iNumber);
    // See FnObjectNumber
}

References Objects, and C4GameObjects::SafeObjectPointer().

Here is the call graph for this function:

FnPlaceAnimal()

C4Object* FnPlaceAnimal	(	C4PropList *	_this,
		C4PropList *	Def
	)

Definition at line 964 of file C4GameScript.cpp.

{
    return Game.PlaceAnimal(Def? Def : _this);
}

References Game, and C4Game::PlaceAnimal().

Here is the call graph for this function:

FnPlaceVegetation()

C4Object* FnPlaceVegetation	(	C4PropList *	_this,
		C4PropList *	Def,
		long	x,
		long	y,
		long	wdt,
		long	hgt,
		long	growth,
		C4PropList *	shape
	)

Definition at line 945 of file C4GameScript.cpp.

{
    if (shape)
    {
        // New-style call with scripted shape
        C4PropList *out_pos = C4PropList::New(nullptr);
        C4Value vout_pos = C4VPropList(out_pos);
        return Game.PlaceVegetation(Def, x, y, wdt, hgt, growth, shape, out_pos);
    }
    else
    {
        // Call in old-style shape
        // Local call: relative coordinates
        MakeAbsCoordinates(_this, x, y);
        // Place vegetation
        return Game.PlaceVegetation(Def, x, y, wdt, hgt, growth, nullptr, nullptr);
    }
}

References C4VPropList(), Game, MakeAbsCoordinates(), C4PropList::New(), and C4Game::PlaceVegetation().

Here is the call graph for this function:

GetTextureName()

C4String* GetTextureName

(

int32_t

texture_nr

)

Definition at line 503 of file C4GameScript.cpp.

{
    if (!texture_nr)
    {
        return nullptr;
    }
    // Get material-texture mapping
    const C4TexMapEntry *texture = ::TextureMap.GetEntry(texture_nr);
    if (!texture)
    {
        return nullptr;
    }
    // Return tex name
    return String(texture->GetTextureName());
}

References C4TextureMap::GetEntry(), C4TexMapEntry::GetTextureName(), String(), and TextureMap.

Referenced by C4TextureMap::GetIndex(), C4TextureMap::SaveMap(), and C4TextureMap::StoreMapPalette().

Here is the call graph for this function:

Here is the caller graph for this function:

GetValByStdCompiler()

template<class T >

C4Value GetValByStdCompiler	(	const char *	strEntry,
		const char *	strSection,
		int	iEntryNr,
		const T &	rFrom
	)

Definition at line 1966 of file C4GameScript.cpp.

{
    // Set up name array, create compiler
    const char *szNames[2] = { strSection ? strSection : strEntry, strSection ? strEntry : nullptr };
    C4ValueGetCompiler Comp(szNames, strSection ? 2 : 1, iEntryNr);
 
    // Compile
    try
    {
        Comp.Decompile(rFrom);
        return Comp.getResult();
    }
    // Should not happen, catch it anyway.
    catch (StdCompiler::Exception *)
    {
        return C4VNull;
    }
}

References C4VNull, StdCompiler::Decompile(), and C4ValueGetCompiler::getResult().

Here is the call graph for this function:

GetValidOwner()

long GetValidOwner	(	C4PropList *	_this,
		Nillable< long >	owner
	)

Definition at line 174 of file C4GameScript.cpp.

{
    if (owner.IsNil())
    {
        if (Object(_this))
        {
            return Object(_this)->Controller;
        }
        else
        {
            return NO_OWNER;
        }
    }
    return owner;
}

References C4Object::Controller, Nillable< T >::IsNil(), NO_OWNER, and Object().

Here is the call graph for this function:

InitGameFunctionMap()

void InitGameFunctionMap

(

C4AulScriptEngine *

pEngine

)

Definition at line 3135 of file C4GameScript.cpp.

{
    // add all def constants (all Int)
    for (C4ScriptConstDef *pCDef = &C4ScriptGameConstMap[0]; pCDef->Identifier; pCDef++)
    {
        assert(pCDef->ValType == C4V_Int); // only int supported currently
        pEngine->RegisterGlobalConstant(pCDef->Identifier, C4VInt(pCDef->Data));
    }
    C4PropListStatic * p = pEngine->GetPropList();
    // add all def script funcs
    for (C4ScriptFnDef *pDef = &C4ScriptGameFnMap[0]; pDef->Identifier; pDef++)
        new C4AulDefFunc(p, pDef);
#define F(f) ::AddFunc(p, #f, Fn##f)
    F(GetX);
    F(GetY);
    F(GetDefinition);
    F(GetDefinitionGroupPath);
    F(GetPlayerName);
    F(GetPlayerType);
    F(GetPlayerColor);
    F(GetPlrClonkSkin);
    F(CreateObject);
    F(CreateObjectAbove);
    F(CreateConstruction);
    F(FindConstructionSite);
    F(CheckConstructionSite);
    F(Sound);
    F(SoundAt);
    F(ChangeSoundModifier);
    F(SetGlobalSoundModifier);
    F(Music);
    F(MusicLevel);
    F(SetPlayList);
    F(SetPlrView);
    F(SetPlrKnowledge);
    F(GetPlrViewMode);
    F(ResetCursorView);
    F(GetPlrView);
    F(GetWealth);
    F(SetWealth);
    F(DoPlayerScore);
    F(GetPlayerScore);
    F(GetPlayerScoreGain);
    F(GetWind);
    F(SetWind);
    F(GetTemperature);
    F(SetTemperature);
    F(ShakeFree);
    F(DigFree);
    F(DigFreeRect);
    F(ClearFreeRect);
    F(Hostile);
    F(SetHostility);
    F(PlaceVegetation);
    F(PlaceAnimal);
    F(GameOver);
    F(GetHiRank);
    F(GetCrew);
    F(GetCrewCount);
    F(GetPlayerCount);
    F(GetPlayerByIndex);
    F(EliminatePlayer);
    F(SurrenderPlayer);
    F(GetLeagueScore);
    F(SetLeaguePerformance);
    F(SetLeagueProgressData);
    F(GetLeagueProgressData);
    F(CreateScriptPlayer);
    F(GetCursor);
    F(GetViewCursor);
    F(SetCursor);
    F(SetViewCursor);
    F(GetMaterial);
    F(GetBackMaterial);
    F(GetTexture);
    F(GetBackTexture);
    F(GetAverageTextureColor);
    F(GetMaterialCount);
    F(GBackSolid);
    F(GBackSemiSolid);
    F(GBackLiquid);
    F(GBackSky);
    F(Material);
    F(BlastFree);
    F(InsertMaterial);
    F(CanInsertMaterial);
    F(ExecutePXS);
    F(LandscapeWidth);
    F(LandscapeHeight);
    F(SetAmbientBrightness);
    F(GetAmbientBrightness);
    F(SetSeason);
    F(GetSeason);
    F(SetClimate);
    F(GetClimate);
    F(SetPlayerZoomByViewRange);
    F(GetPlayerZoomLimits);
    F(SetPlayerZoom);
    F(SetPlayerViewLock);
    F(DoBaseMaterial);
    F(DoBaseProduction);
    F(GainScenarioAccess);
    F(IsNetwork);
    F(IsEditor);
    F(GetLeague);
    ::AddFunc(p, "TestMessageBoard", FnTestMessageBoard, false);
    ::AddFunc(p, "CallMessageBoard", FnCallMessageBoard, false);
    ::AddFunc(p, "AbortMessageBoard", FnAbortMessageBoard, false);
    F(SetFoW);
    F(SetMaxPlayer);
    F(Object);
    F(GetTime);
    F(GetScenarioAccess);
    F(MaterialName);
    F(DrawMap);
    F(DrawDefMap);
    F(CreateParticle);
    F(ClearParticles);
    F(SetSky);
    F(SetSkyAdjust);
    F(SetMatAdjust);
    F(GetSkyAdjust);
    F(GetMatAdjust);
    F(SetSkyParallax);
    F(ReloadDef);
    F(ReloadParticle);
    F(SetGamma);
    F(ResetGamma);
    F(AddFragmentShader);
    F(RemoveShader);
    F(FrameCounter);
    F(DrawMaterialQuad);
    F(SetFilmView);
    F(AddMsgBoardCmd);
    ::AddFunc(p, "SetGameSpeed", FnSetGameSpeed, false);
    ::AddFunc(p, "DrawMatChunks", FnDrawMatChunks, false);
    F(GetPathLength);
    F(SetTextureIndex);
    F(RemoveUnusedTexMapEntries);
    F(SimFlight);
    F(LoadScenarioSection);
    F(SetViewOffset);
    ::AddFunc(p, "SetPreSend", FnSetPreSend, false);
    F(GetPlayerID);
    F(GetPlayerTeam);
    F(SetPlayerTeam);
    F(GetScriptPlayerExtraID);
    F(GetTeamConfig);
    F(GetTeamName);
    F(GetTeamColor);
    F(GetTeamByIndex);
    F(GetTeamCount);
    ::AddFunc(p, "InitScenarioPlayer", FnInitScenarioPlayer, false);
    F(SetScoreboardData);
    ::AddFunc(p, "GetScoreboardString", FnGetScoreboardString, false);
    ::AddFunc(p, "GetScoreboardData", FnGetScoreboardData, false);
    F(DoScoreboardShow);
    F(SortScoreboard);
    F(AddEvaluationData);
    F(HideSettlementScoreInEvaluation);
    F(ExtractMaterialAmount);
    F(CustomMessage);
    F(GuiOpen);
    F(GuiUpdateTag);
    F(GuiClose);
    F(GuiUpdate);
    ::AddFunc(p, "PauseGame", FnPauseGame, false);
    F(PathFree);
    F(PathFree2);
    F(SetNextScenario);
    F(GetPlayerControlState);
    F(SetPlayerControlEnabled);
    F(GetPlayerControlEnabled);
    F(GetPlayerControlAssignment);
    F(PlayRumble);
    F(StopRumble);
    F(GetStartupPlayerCount);
    F(GetStartupTeamCount);
    F(EditCursor);
    F(GainScenarioAchievement);
    F(GetPXSCount);
    F(GetPlrKnowledge);
    F(GetBaseMaterial);
    F(GetBaseProduction);
    F(GetDefCoreVal);
    F(GetObjectVal);
    F(GetObjectInfoCoreVal);
    F(GetScenarioVal);
    F(GetPlayerVal);
    F(GetPlayerInfoCoreVal);
    F(GetMaterialVal);
    F(SetPlrExtraData);
    F(GetPlrExtraData);
    F(PV_Linear);
    F(PV_Random);
    F(PV_Direction);
    F(PV_Step);
    F(PV_Speed);
    F(PV_Wind);
    F(PV_Gravity);
    // F(PV_KeyFrames); added below
    F(PV_Sin);
    F(PV_Cos);
    F(PC_Die);
    F(PC_Bounce);
    F(PC_Stop);
    F(IncinerateLandscape);
    F(GetGravity);
    F(SetGravity);
    F(GetTranslatedString);
#undef F
}

References AddFunc(), C4ScriptGameConstMap, C4ScriptGameFnMap, C4V_Int, C4VInt(), F, GBackLiquid(), GBackSemiSolid(), GBackSolid(), C4AulScriptEngine::GetPropList(), Hostile(), C4ScriptConstDef::Identifier, and C4AulScriptEngine::RegisterGlobalConstant().

Referenced by C4Game::InitScriptEngine().

Here is the call graph for this function:

Here is the caller graph for this function:

MakeAbsCoordinates() [1/2]

void MakeAbsCoordinates	(	C4PropList *	_this,
		int32_t &	x,
		int32_t &	y
	)

Definition at line 52 of file C4GameScript.cpp.

{
    C4Object *obj = Object(_this);
    if (obj)
    {
        x += obj->GetX();
        y += obj->GetY();
    }
}

References C4Object::GetX(), C4Object::GetY(), and Object().

Referenced by FnPlaceVegetation().

Here is the call graph for this function:

Here is the caller graph for this function:

MakeAbsCoordinates() [2/2]

void MakeAbsCoordinates	(	C4PropList *	_this,
		long &	x,
		long &	y
	)

Definition at line 62 of file C4GameScript.cpp.

{
    C4Object *obj = Object(_this);
    if (obj)
    {
        x += obj->GetX();
        y += obj->GetY();
    }
}

References C4Object::GetX(), C4Object::GetY(), and Object().

Here is the call graph for this function:

SimFlight()

bool SimFlight	(	C4Real &	x,
		C4Real &	y,
		C4Real &	xdir,
		C4Real &	ydir,
		int32_t	iDensityMin,
		int32_t	iDensityMax,
		int32_t &	iIter
	)

Definition at line 810 of file C4Movement.cpp.

{
    bool hit_on_time = true;
    bool break_main_loop = false;
    int32_t target_x, target_y;
    int32_t current_x = fixtoi(x);
    int32_t current_y = fixtoi(y);
    int32_t index = iterations;
    do
    {
        if (!--index)
        {
            hit_on_time = false;
            break;
        }
        // If the object isn't moving and there is no gravity either, abort
        if (xdir == 0 && ydir == 0 && GravAccel == 0)
        {
            return false;
        }
        // If the object is above the landscape flying upwards in no/negative gravity, abort
        if (ydir <= 0 && GravAccel <= 0 && current_y < 0)
        {
            return false;
        }
        // Set target position by momentum
        x += xdir;
        y += ydir;
        // Set target position, then iterate towards this position, checking for contact
        target_x = fixtoi(x);
        target_y = fixtoi(y);
        // Is the target position outside of the landscape?
        if (!Inside<int32_t>(target_x, 0, ::Landscape.GetWidth()) || (target_y >= ::Landscape.GetHeight()))
        {
            return false;
        }
        // Check the way towards the target position, by doing minimal movement steps
        do
        {
            // Set next step target
            current_x += Sign(target_x - current_x);
            current_y += Sign(target_y - current_y);
            // Contact check
            if (Inside(GBackDensity(current_x, current_y), min_density, max_density))
            {
                break_main_loop = true;
                break;
            }
        }
        while ((current_x != target_x) || (current_y != target_y));
        // Adjust GravAccel once per frame
        ydir += GravAccel;
    }
    while (!break_main_loop);
    // Write position back
    x = itofix(current_x);
    y = itofix(current_y);
 
    // How many steps did it take to get here?
    iterations -= index;
 
    return hit_on_time;
}

References fixtoi(), GBackDensity(), C4Landscape::GetHeight(), C4Landscape::GetWidth(), GravAccel, Inside(), itofix(), Landscape, and Sign().

Referenced by SimFlightHitsLiquid().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

C4ScriptGameConstMap

C4ScriptConstDef C4ScriptGameConstMap

Definition at line 3348 of file C4GameScript.cpp.

Referenced by InitGameFunctionMap().

C4ScriptGameFnMap

C4ScriptFnDef C4ScriptGameFnMap

Initial value:

=
{
    { "FindObject",    true, C4V_Object, { C4V_Array   ,C4V_Any     ,C4V_Any     ,C4V_Any     ,C4V_Any     ,C4V_Any     ,C4V_Any    ,C4V_Any    ,C4V_Any    ,C4V_Any}, FnFindObject    },
    { "FindObjects",   true, C4V_Array,  { C4V_Array   ,C4V_Any     ,C4V_Any     ,C4V_Any     ,C4V_Any     ,C4V_Any     ,C4V_Any    ,C4V_Any    ,C4V_Any    ,C4V_Any}, FnFindObjects   },
    { "ObjectCount",   true, C4V_Int,    { C4V_Array   ,C4V_Any     ,C4V_Any     ,C4V_Any     ,C4V_Any     ,C4V_Any     ,C4V_Any    ,C4V_Any    ,C4V_Any    ,C4V_Any}, FnObjectCount   },
    { "GameCallEx",    true, C4V_Any,    { C4V_String  ,C4V_Any     ,C4V_Any     ,C4V_Any     ,C4V_Any     ,C4V_Any     ,C4V_Any    ,C4V_Any    ,C4V_Any    ,C4V_Any}, FnGameCallEx    },
    { "PlayerMessage", true, C4V_Int,    { C4V_Int     ,C4V_String  ,C4V_Any     ,C4V_Any     ,C4V_Any     ,C4V_Any     ,C4V_Any    ,C4V_Any    ,C4V_Any    ,C4V_Any}, FnPlayerMessage },
    { "Message",       true, C4V_Bool,   { C4V_String  ,C4V_Any     ,C4V_Any     ,C4V_Any     ,C4V_Any     ,C4V_Any     ,C4V_Any    ,C4V_Any    ,C4V_Any    ,C4V_Any}, FnMessage       },
    { "AddMessage",    true, C4V_Bool,   { C4V_String  ,C4V_Any     ,C4V_Any     ,C4V_Any     ,C4V_Any     ,C4V_Any     ,C4V_Any    ,C4V_Any    ,C4V_Any    ,C4V_Any}, FnAddMessage    },
    { "PV_KeyFrames",  true, C4V_Array,  { C4V_Int     ,C4V_Any     ,C4V_Any     ,C4V_Any     ,C4V_Any     ,C4V_Any     ,C4V_Any    ,C4V_Any    ,C4V_Any    ,C4V_Any}, FnPV_KeyFrames  },
 
    { nullptr,            false, C4V_Nil,    { C4V_Nil     ,C4V_Nil     ,C4V_Nil     ,C4V_Nil     ,C4V_Nil     ,C4V_Nil     ,C4V_Nil    ,C4V_Nil    ,C4V_Nil    ,C4V_Nil}, nullptr               }
}

Definition at line 3486 of file C4GameScript.cpp.

Referenced by InitGameFunctionMap().