zCParser
related functions
This Ikarus part provides some useful functions to work with parser, its instances, symbols and stack.
Danger
Remember to always assign an instance to a correct class. If you assign an oCNpc
pointer to oCItem
class you won't be able to read any data from it.
Implementation
Initialization
The best way to initialize all Ikarus functions is to call MEM_InitAll()
in the Init_Global()
initialization function.
Warning
If you want to use Ikarus in Gothic 1, it is best to define your own Init_Global()
function and call it from every world initialization function.
MEM_ReinitParser
MEM_ReinitParser
Parser operations are initialized with this function.
Tip
It's worth noting that MEM_ReinitParser
is also invoked by the MEM_InitAll
function.
Pointers and instances
MEM_PtrToInst
MEM_PtrToInst
Returns an instance pointed to by the pointer. If the pointer is null an error is thrown.
var int ptr
Pointer to return an instance from
Shortcut
In addition there is a function _^
with the same signature and functionality as MEM_PtrToInst
. It is used as a shortcut, since the converting pointer to instance is commonly used while working with Ikarus.
MEM_NullToInst
MEM_AssignInst
MEM_AssignInst
Takes an instance from a pointer and assigns it to a given instance. If the pointer is null an error is thrown.
var int ptr
Pointer to assign an instance fromvar int inst
Instance to which the pointer will be assigned
MEM_AssignInstNull
MEM_AssignInstNull
Assigns null pointer to a given instance.
var int inst
Instance to which the null pointer will be assigned
MEM_InstToPtr
MEM_InstToPtr
Returns a pointer to given instance.
var int inst
The instance to which the pointer is returned
MEM_InstGetOffset
MEM_InstGetOffset
Alias to MEM_InstToPtr
. Returns a pointer to given instance.
var int inst
The instance to which the pointer is returned
MEM_CpyInst
MEM_CpyInst
Returns a copy of a given instance
var int inst
Instance to copy
Call function
You don't always know at compile time when you want to call which function. For example, if you want to call the condition function of a mob that the player has in focus, you are at a loss at compile time because you have no idea which mob the player will choose. Ikarus provides a way to call functions based on their name or symbol index. In the example of the mob, the name of the condition function can simply be looked up in the mob.
Note
The functions below also work for externals without any restrictions.
Passing Parameters
If the function to be called has parameters, these must first be placed on the data stack. The parameters must be pushed in the correct order, from left to right.
MEM_PushIntParam
MEM_PushIntParam
Passes an integer as a parameter to the called function.
var int param
Integer to pass as a function parameter
MEM_PushInstParam
MEM_PushInstParam
Passes an instance as a parameter to the called function.
var int inst
Instance to pass as a function parameter
MEM_PushStringParam
1 2 3 4 5 6 7 8 9 |
|
The call
MEM_Call
MEM_Call
Calls a function.
var func fnc
Function to be called
MEM_CallByID
MEM_CallByID
Calls a function by its ID.
var int symbID
The ID of the function to be called
MEM_CallByPtr
MEM_CallByPtr
Calls a function by its pointer.
var int ptr
The pointer of the function to be called
MEM_CallByOffset
MEM_CallByOffset
Calls a function by its offset.
var int offset
The offset of the function to be called
MEM_CallByString
MEM_CallByString
Calls a function by its name.
var string fnc
The name of the function IN CAPITAL LETTERS.
Return value
If a function has a return value, it should be fetched from the data stack after it is called, otherwise stack overflows can occur under unfavorable circumstances (aside from that, you may simply want the return value because it contains important information).
MEM_PopIntResult
MEM_PopIntResult
Retrieves an integer returned by the called function.
The function returns an integer returned by the previously called script function.
MEM_PopStringResult
MEM_PopStringResult
Retrieves a daedalus string returned by the called function.
The function returns a string returned by the previously called script function.
MEM_PopInstResult
MEM_PopInstResult
Retrieves an instance returned by the called function.
The function returns an instance returned by the previously called script function.
Function stuff
MEM_GetFuncID
MEM_GetFuncID
Returns the ID of the given function.
var func fnc
The function whose ID is returned
MEM_GetFuncPtr
MEM_GetFuncPtr
Returns the pointer of the given function.
var func fnc
The function whose pointer is returned
MEM_GetFuncOffset
MEM_GetFuncOffset
Returns the offset of the given function.
var func fnc
The function whose offset is returned
MEM_GetFuncIDByOffset
MEM_GetFuncIDByOffset
MEM_GetFuncID
, but with an offset as a parameter.
var int offset
Offset of a function whose ID is returned
Return value
The function returns an ID of a function with a given offset.
MEM_ReplaceFunc
MEM_ReplaceFunc
Replaces the f1
function with f2
function so if you call the first function, the second function is called.
var func f1
Function to replacevar func f2
Function called instead off1
Parser stack
MEM_GetFrameBoundary
MEM_GetFrameBoundary
Returns the address/pointer to the boundary of a stack frame (ESP).
MEM_GetCallerStackPos
MEM_GetCallerStackPos
Retrieves the stack position (pop position) of the caller's caller (look at the example for better understanding).
The function returns an integer representing the stack position of the caller's caller.
Example
After calling B()
from within A()
, when MEM_GetCallerStackPos()
is invoked in function B()
, it retrieves the stack position of the caller's caller, which is function A()
in this case. Therefore, the variable adr
will contain the stack position of function A()
.
MEM_SetCallerStackPos
MEM_SetCallerStackPos
Sets the stack position (pop position) of the caller's caller.
var int popPos
An integer parameter representing the new stack position of the caller's caller
Get address
MEM_GetAddress_Init
MEM_GetAddress_Init
Initializes the MEM_GetIntAddress
, MEM_GetFloatAddress
and MEM_GetStringAddress
functions.
Tip
It's worth noting that MEM_GetAddress_Init
is also invoked by the MEM_InitAll
function.
MEM_GetIntAddress
MEM_GetIntAddress
Returns an address of a given integer.
var int i
Integer whose address is returned
Shortcut
In addition there is a function _@
with the same signature and functionality as MEM_GetIntAddress
.
MEM_GetFloatAddress
MEM_GetFloatAddress
Returns an address of a given daedalus float.
var float f
Float whose address is returned
Shortcut
In addition there is a function _@f
with the same signature and functionality as MEM_GetFloatAddress
.
MEM_GetStringAddress
MEM_GetStringAddress
Returns an address of a given string.
var string s
String whose address is returned
Shortcut
In addition there is a function _@s
with the same signature and functionality as MEM_GetStringAddress
.
STR_GetAddressInit
STR_GetAddress
STR_GetAddress
Function similar to MEM_GetStringAddress
. There is a guarantee, that this function works initialized i.e. invokes MEM_GetAddress_Init
, but the first time may only return an address of a copy of the string.
Static arrays
Accessing static arrays like this below is very tedious in Daedalus.
myStaticArray[i]
with a variable index i, but only with a constant. This changes with the following functions. Danger
Neither function performs any kind of validity check. If the value passed is not an array or offsets are beyond the boundaries of the array passed, the behavior is undefined.
MEM_InitStatArrs
MEM_WriteStatArr
MEM_WriteStatArr
Changes the value at the offset
of a static integer-array.
var int array
Array which will be editedvar int offset
Array index at which value will be editedvar int value
The new value
MEM_ReadStatArr
MEM_ReadStatArr
Reads the value at the specific offset of a static integer-array.
var int array
Array to get a value fromvar int offset
Array index of the value to return
Return value
The function returns an integer value from the offset
of a given static array.
MEM_WriteStatStringArr
MEM_WriteStatStringArr
Changes the value at the offset
of a static string-array.
var string array
Array which will be editedvar int offset
Array index at which value will be editedvar string value
The new value
MEM_ReadStatStringArr
MEM_ReadStatStringArr
Reads the value at the specific offset of a static string-array.
var string array
Array to get a value fromvar int offset
Array index of the value to return
Return value
The function returns a string form the offset
of a given static array.
Parser symbol
MEM_SetCurrParserSymb
MEM_SetCurrParserSymb
Makes currParserSymb
point to the symbol of the specified instance.
var int inst
Instance to whose symbolcurrParserSymb
will be set
currParserSymb
currParserSymb
An instance representing current parser symbol.
MEM_FindParserSymbol
MEM_FindParserSymbol
Returns the index of the parser symbol with name inst
if such a symbol exists.
var string inst
Name of the symbol to be found
Return value
The function returns the index of the parser symbol with name inst
if such a symbol exists. If non exists, a warning is issued and -1
is returned.
MEM_GetSymbolIndex
MEM_GetSymbolIndex
Alias to MEM_FindParserSymbol
. Returns the index of the parser symbol with name inst
if such a symbol exists.
var string inst
Name of the symbol to be found
Return value
The function returns the index of the parser symbol with name inst
if such a symbol exists. If non exists, a warning is issued and -1
is returned.
MEM_GetParserSymbol
MEM_GetParserSymbol
Looks for the parser symbol with the name inst
and returns a pointer to the appropriate zCPar_Symbol
structure.
var string inst
Name of the symbol to be found
Return value
The function returns the appropriate zCPar_Symbol
structure of the parser symbol with name inst
if such a symbol exists. If non exists, a warning is issued and 0
is returned.
MEM_GetSymbol
MEM_GetSymbol
Alias to MEM_GetParserSymbol
. Looks for the parser symbol with the name inst
and returns a pointer to the appropriate zCPar_Symbol
structure.
var string inst
Name of the symbol to be found
Return value
The function returns the appropriate zCPar_Symbol
structure of the parser symbol with name inst
if such a symbol exists. If non exists, a warning is issued and 0
is returned.
MEM_GetSymbolByIndex
MEM_GetSymbolByIndex
MEM_GetParserSymbol
, but with ID (index) as a parameter.
var string inst
ID (index) of the symbol to be found
Return value
The function returns the appropriate zCPar_Symbol
structure of the parser symbol with name inst
if such a symbol exists. If non exists, a warning is issued and 0
is returned.