OGRE  1.12.4 Object-Oriented Graphics Rendering Engine

Manages Overlay objects, parsing them from .overlay files and storing a lookup library of them. More...

#include <OgreCgFxScriptLoader.h>

## Public Member Functions

const StringVectorgetScriptPatterns (void) const
Gets the file patterns which should be used to find scripts for this class. More...

void parseScript (DataStreamPtr &stream, const String &groupName)
Parse a script file. More...

## Static Public Member Functions

Get the singleton instance. More...

Get the singleton instance. More...

## Detailed Description

Manages Overlay objects, parsing them from .overlay files and storing a lookup library of them.

Alo manages the creation of OverlayContainers and OverlayElements, used for non-interactive 2D elements such as HUDs.

virtual

## ◆ getScriptPatterns()

 const StringVector& Ogre::CgFxScriptLoader::getScriptPatterns ( void ) const
virtual

Gets the file patterns which should be used to find scripts for this class.

Remarks
This method is called when a resource group is loaded if you use ResourceGroupManager::_registerScriptLoader.
Returns
A list of file patterns, in the order they should be searched in.

## ◆ parseScript()

 void Ogre::CgFxScriptLoader::parseScript ( DataStreamPtr & stream, const String & groupName )
virtual

Parse a script file.

Parameters
 stream Weak reference to a data stream which is the source of the script groupName The name of a resource group which should be used if any resources are created during the parse of this script.

virtual

Remarks
There are dependencies between some kinds of scripts, and to enforce this all implementors of this interface must define a loading order.
Returns
A value representing the relative loading order of these scripts compared to other script users, where higher values load later.