C4AulDefFunc.h File Reference

#include "script/C4Aul.h"
#include "object/C4Def.h"
#include "object/C4DefList.h"
#include "script/C4Effect.h"

Include dependency graph for C4AulDefFunc.h:

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

Go to the source code of this file.

Classes
class	C4Void
class	Nillable< T >
class	NeedObjectContext
class	NeedNonGlobalContext
struct	ThisImpl< C4Object >
struct	ThisImpl< C4PropList >
struct	ExecImpl< RType, ThisType, ParTypes >
struct	ExecImpl< void, ThisType, ParTypes... >
struct	C4ValueConv< Nillable< T > >
struct	C4ValueConv< void >
struct	C4ValueConv< int >
struct	C4ValueConv< long >
struct	C4ValueConv< bool >
struct	C4ValueConv< C4ID >
struct	C4ValueConv< C4Object * >
struct	C4ValueConv< C4String * >
struct	C4ValueConv< C4ValueArray * >
struct	C4ValueConv< C4AulFunc * >
struct	C4ValueConv< C4PropList * >
struct	C4ValueConv< C4Effect * >
struct	C4ValueConv< C4Def * >
struct	C4ValueConv< const C4Value & >
struct	C4ValueConv< C4Value >
class	C4AulEngineFunc< RType, ThisType, ParTypes >
struct	C4ScriptConstDef
struct	C4ScriptFnDef
class	C4AulDefFunc

Functions
C4String *	String (const char *str)
C4Object *	Object (C4PropList *_this)
StdStrBuf	FnStringFormat (C4PropList *_this, C4String *szFormatPar, C4Value *Pars, int ParCount)
C4Effect **	FnGetEffectsFor (C4PropList *pTarget)
template<typename RType , typename ThisType , typename ... ParTypes>
void	AddFunc (C4PropListStatic *Parent, const char *Name, RType(*pFunc)(ThisType *, ParTypes...), bool Public=true)

---

Class Documentation

C4Void

class C4Void

Definition at line 44 of file C4AulDefFunc.h.

C4ScriptConstDef

struct C4ScriptConstDef

Definition at line 267 of file C4AulDefFunc.h.

Class Members
long	Data
const char *	Identifier
C4V_Type	ValType

Function Documentation

AddFunc()

template<typename RType , typename ThisType , typename ... ParTypes>

void AddFunc ( C4PropListStatic *  Parent, const char *  Name, RType(*)(ThisType *, ParTypes...)  pFunc, bool  Public = true  )

inline

Definition at line 261 of file C4AulDefFunc.h.

{
    new C4AulEngineFunc<RType, ThisType, ParTypes...>(Parent, Name, pFunc, Public);
}

Referenced by C4MapScriptHost::AddEngineFunctions(), C4ScriptLibraryCrypto::CreateFunctions(), InitCoreFunctionMap(), InitGameFunctionMap(), and InitObjectFunctionMap().

Here is the caller graph for this function:

FnGetEffectsFor()

C4Effect** FnGetEffectsFor

(

C4PropList *

pTarget

)

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:

FnStringFormat()

StdStrBuf FnStringFormat	(	C4PropList *	_this,
		C4String *	szFormatPar,
		C4Value *	Pars,
		int	ParCount
	)

Definition at line 30 of file C4Script.cpp.

{
    int cPar=0;
 
    StdStrBuf StringBuf("", false);
    const char * cpFormat = FnStringPar(szFormatPar);
    const char * cpType;
    char szField[20];
    while (*cpFormat)
    {
        // Copy normal stuff
        while (*cpFormat && (*cpFormat!='%'))
            StringBuf.AppendChar(*cpFormat++);
        // Field
        if (*cpFormat=='%')
        {
            // Scan field type
            for (cpType=cpFormat+1; *cpType && (*cpType == '+' || *cpType == '-' || *cpType == '.' || *cpType == '#' || *cpType == ' ' || Inside(*cpType,'0','9')); cpType++) {}
            // Copy field
            SCopy(cpFormat,szField,std::min<unsigned int>(sizeof szField - 1, cpType - cpFormat + 1));
            // Insert field by type
            switch (*cpType)
            {
                // number
            case 'd': case 'x': case 'X':
            {
                if (cPar >= ParCount) throw C4AulExecError("format placeholder without parameter");
                StringBuf.AppendFormat(szField, Pars[cPar++].getInt());
                cpFormat+=SLen(szField);
                break;
            }
            // character
            case 'c':
            {
                if (cPar >= ParCount) throw C4AulExecError("format placeholder without parameter");
                StringBuf.AppendCharacter(Pars[cPar++].getInt());
                cpFormat+=SLen(szField);
                break;
            }
            // C4ID
            case 'i':
            // C4Value
            case 'v':
            {
                if (cPar >= ParCount) throw C4AulExecError("format placeholder without parameter");
                StringBuf.Append(static_cast<const StdStrBuf&>(Pars[cPar++].GetDataString(10)));
                cpFormat+=SLen(szField);
                break;
            }
            // String
            case 's':
            {
                // get string
                if (cPar >= ParCount) throw C4AulExecError("format placeholder without parameter");
                const char *szStr = "(null)";
                if (Pars[cPar].GetData())
                {
                    C4String * pStr = Pars[cPar].getStr();
                    if (!pStr) throw C4AulExecError("string format placeholder without string");
                    szStr = pStr->GetCStr();
                }
                ++cPar;
                StringBuf.AppendFormat(szField, szStr);
                cpFormat+=SLen(szField);
                break;
            }
            case '%':
                StringBuf.AppendChar('%');
                cpFormat+=SLen(szField);
                break;
                // Undefined / Empty
            default:
                StringBuf.AppendChar('%');
                cpFormat++;
                break;
            }
        }
    }
    return StringBuf;
}

Object()

C4Object* Object ( C4PropList *  _this )

inline

Definition at line 34 of file C4AulDefFunc.h.

{
    return _this ? _this->GetObject() : nullptr;
}

References C4PropList::GetObject().

Referenced by AssignController(), C4MeshDenumerator::C4MeshDenumerator(), C4MeshDenumerator::GetObject(), GetValidOwner(), MakeAbsCoordinates(), and C4AulCompiler::ConstantResolver::visit().

Here is the call graph for this function:

Here is the caller graph for this function:

String()

C4String* String ( const char *  str )

inline

Definition at line 30 of file C4AulDefFunc.h.

{
    return str ? ::Strings.RegString(str) : nullptr;
}

References C4StringTable::RegString(), and Strings.

Referenced by GetTextureName(), C4StringTable::RegString(), and C4LangStringTable::ReplaceStrings().

Here is the call graph for this function:

Here is the caller graph for this function: