group Script Helpers

Description

Various functions for creating, loading and deleting script objects

group contents
Functions
function ferite_duplicate_script(FeriteScript) - Duplicate a script object
function ferite_new_script() - This will allocate a new script and set it up ready for use.
function ferite_script_being_deleted(FeriteScript) - Find out if the script in question is being deleted.
function ferite_script_clean(FeriteScript) - Clean a script structure of all non-error/warning reporting structures
function ferite_script_delete(FeriteScript) - Delete a script object - it calls ferite_script_clean() first so you dont need to
function ferite_script_load(FeriteScript,char) - Load the text of a script so that it may be compiled.

Functions
function ferite_duplicate_script Click to go up to the list
Duplicate a script object
Declaration:
    FeriteScript *ferite_duplicate_script( FeriteScript *script )
Parameters:
    Parameter #1: FeriteScript *script - The script to make a copy of
Returns:
    A brand new script object that can be executed and used as if it had been compiled

function ferite_new_script Click to go up to the list
This will allocate a new script and set it up ready for use.
Declaration:
    FeriteScript *ferite_new_script()
Returns:
    A pointer to the script

function ferite_script_being_deleted Click to go up to the list
Find out if the script in question is being deleted.
Declaration:
    int ferite_script_being_deleted( FeriteScript *script )
Description:
This function is often useful for making decisions within a native destructor.
Parameters:
    Parameter #1: FeriteScript *script - The script to check
Returns:
    FE_TRUE if the script is being deleted, FE_FALSE otherwise

function ferite_script_clean Click to go up to the list
Clean a script structure of all non-error/warning reporting structures
Declaration:
    int ferite_script_clean( FeriteScript *script )
Parameters:
    Parameter #1: FeriteScript *script - A pointer to the script to be cleaned
Returns:
    Returns 0 on fail and 1 on success

function ferite_script_delete Click to go up to the list
Delete a script object - it calls ferite_script_clean() first so you dont need to
Declaration:
    int ferite_script_delete( FeriteScript *script )
Parameters:
    Parameter #1: FeriteScript *script - The script to delete
Returns:
    1 on success, 0 on fail

function ferite_script_load Click to go up to the list
Load the text of a script so that it may be compiled.
Declaration:
    int ferite_script_load( FeriteScript *script, char *filename )
Parameters:
    Parameter #1: FeriteScript *script - The script to load the text into
    Parameter #2: char *filename - The name of the script to load.
Returns:
    Returns 0 on fail and 1 on success

Automatically generated at 12:07PM, Wednesday 25 May 2005 by feritedoc.