HGamer3D.Bindings.CEGUI.ClassScriptModule

Documentation

delete

Arguments

:: HG3DClass

classpointer - pointer of Class instance which is going to be deleted.

-> IO ()

Destructor for ScriptModule

executeScriptFile

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> String

filename - String object holding the filename of the script file that is to be executed

-> String

resourceGroup - Resource group idendifier to be passed to the ResourceProvider when loading the script file.

-> IO ()

Execute a scripted global function. The function should not take any parameters and should return an integer.

Execute a script file.

executeScriptGlobal

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> String

function_name - String object holding the name of the function, in the global script environment, that is to be executed.

-> IO Int

return value - The integer value returned from the script function.

executeScriptedEventHandler

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> String

handler_name - String object holding the name of the scripted handler function.

-> HG3DClass

e - EventArgs based object that should be passed, by any appropriate means, to the scripted function.

-> IO Bool

Execute a scripted global 'event handler' function. The function should take some kind of EventArgsEventArgs

executeString

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> String

str - String object holding the valid script code that should be executed.

-> IO ()

return value - Nothing.

Method called during system initialisation, prior to running any scripts via the ScriptModuleScriptModule

Execute script code contained in the given CEGUI::String object.

createBindings

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO ()

return value - Nothing.

Method called during system destruction, after all scripts have been run via the ScriptModuleScriptModule

destroyBindings

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO ()

return value - Nothing.

Return identification string for the ScriptModuleScriptModule

getIdentifierString

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO String

return value - String object holding a string that identifies the

setDefaultResourceGroup

Arguments

:: String

resourceGroup - String describing the default resource group identifier to be used.

-> IO ()

return value - Nothing.

Returns the default resource group used when loading script files.

Sets the default resource group to be used when loading script files.

getDefaultResourceGroup

Arguments

:: IO String

return value - String describing the default resource group identifier..

delete'_ :: HG3DClassPtr -> IO ()

executeScriptFile'_ :: HG3DClassPtr -> Ptr CChar -> Ptr CChar -> IO ()

executeScriptGlobal'_ :: HG3DClassPtr -> Ptr CChar -> Ptr CInt -> IO ()

executeScriptedEventHandler'_ :: HG3DClassPtr -> Ptr CChar -> HG3DClassPtr -> Ptr CInt -> IO ()

executeString'_ :: HG3DClassPtr -> Ptr CChar -> IO ()

createBindings'_ :: HG3DClassPtr -> IO ()

destroyBindings'_ :: HG3DClassPtr -> IO ()

getIdentifierString'_ :: HG3DClassPtr -> Ptr CChar -> IO ()

setDefaultResourceGroup'_ :: Ptr CChar -> IO ()

getDefaultResourceGroup'_ :: Ptr CChar -> IO ()