Sheep Namespace Reference

Namespace that contains the C++ Sheep API. More...

Classes
class	ICompiledScriptOutput
class	ICompiler
	Interface to a Compiler object that compiles sheep scripts. More...
class	IDisassembly
	Represents a disassembly of an IScript object. More...
class	IExecutionContext
class	IScript
	Interface to a Script object. More...
class	IVirtualMachine
	Represents a Sheep Virtual Machine which executes compiled Sheep scripts. More...

Typedefs
typedef void(SHP_CALLBACK *	ImportCallback )(IExecutionContext *context)
typedef void(SHP_CALLBACK *	EndWaitCallback )(IVirtualMachine *vm, IExecutionContext *context)

Enumerations
enum	SymbolType { SymbolType::Void = 0, SymbolType::Int = 1, SymbolType::Float = 2, SymbolType::String = 3 }
	Represents a Sheep symbol type. More...
enum	SheepLanguageVersion { SheepLanguageVersion::V100 = 0, SheepLanguageVersion::V200 }
	Represents a specific version of Sheep. More...
enum	ExecutionContextState { ExecutionContextState::Prepared, ExecutionContextState::Executing, ExecutionContextState::Suspended, ExecutionContextState::Finished }
enum	ScriptStatus { ScriptStatus::Success, ScriptStatus::Error, ScriptStatus::Invalid }
	Represents the status of an IScript object. More...

Detailed Description

Namespace that contains the C++ Sheep API.

Enumeration Type Documentation

enum Sheep::ExecutionContextState

strong

Enumerator
Prepared	The context has been prepared for execution and is ready to execute.
Executing	The context is currently executing.
Suspended	The context has been suspended and is ready to resume.
Finished	The context has finished execution.

enum Sheep::ScriptStatus

strong

Represents the status of an IScript object.

Enumerator
Success	The script was successfully compiled and is ready to run.
Error	There was an error compiling the script.
Invalid	The script is not valid and cannot run.

enum Sheep::SheepLanguageVersion

strong

Represents a specific version of Sheep.

Enumerator
V100	Vanilla version of Sheep with no enhancements (Gabriel Knight 3-level features only)
V200	New enhancements.

enum Sheep::SymbolType

strong

Represents a Sheep symbol type.

Enumerator
Void	"Void" symbol type
Int	32-bit integer symbol type
Float	32-bit floating point symbol type
String	Variable length string variable type.