ScummVM API documentation
Public Member Functions | List of all members
hpl::iScript Class Referenceabstract
Inheritance diagram for hpl::iScript:
hpl::iResourceBase hpl::cSqScript

Public Member Functions

 iScript (const tString &asName)
 
bool reload ()
 
void unload ()
 
void destroy ()
 
virtual bool CreateFromFile (const tString &asFile)=0
 
virtual int GetFuncHandle (const tString &asFunc)=0
 
virtual void AddArg (const tString &asArg)=0
 
virtual bool Run (const tString &asFuncLine)=0
 
virtual bool Run (int alHandle)=0
 
- Public Member Functions inherited from hpl::iResourceBase
 iResourceBase (tString asName, unsigned long alPrio)
 
tString GetName ()
 
unsigned long GetHandle ()
 
void SetHandle (unsigned long alHandle)
 
tString GetFilePath ()
 
unsigned long GetTime ()
 
unsigned long GetPrio ()
 
unsigned long GetSize ()
 
void SetLogDestruction (bool abX)
 
unsigned int GetUserCount ()
 
void IncUserCount ()
 
void DecUserCount ()
 
bool HasUsers ()
 

Additional Inherited Members

- Static Public Member Functions inherited from hpl::iResourceBase
static bool GetLogCreateAndDelete ()
 
static void SetLogCreateAndDelete (bool abX)
 
- Protected Attributes inherited from hpl::iResourceBase
unsigned int mlPrio
 
unsigned long mlTime
 
unsigned long mlSize
 
unsigned int mlUserCount
 
unsigned long mlHandle
 
tString msName
 
tString msFilePath
 
bool mbLogDestruction
 
- Static Protected Attributes inherited from hpl::iResourceBase
static bool mbLogCreateAndDelete
 

Member Function Documentation

◆ reload()

bool hpl::iScript::reload ( )
inlinevirtual

virtual bool Reload()=0;

Returns
true is reload was successful, else false.

Implements hpl::iResourceBase.

◆ unload()

void hpl::iScript::unload ( )
inlinevirtual

Free most the memory, save info to get started again.

Implements hpl::iResourceBase.

◆ destroy()

void hpl::iScript::destroy ( )
inlinevirtual

Free all memory.

Implements hpl::iResourceBase.

◆ Run()

virtual bool hpl::iScript::Run ( const tString &  asFuncLine)
pure virtual

Runs a func in the script, for example "test(15)"

Parameters
asFuncLinethe line of code
Returns
true if everything was ok, else false

Implemented in hpl::cSqScript.

The documentation for this class was generated from the following file: