kzu_script.h File Reference

A script container file. More...

#include <system/kzs_types.h>
#include <system/debug/kzs_error.h>
#include <system/kzs_header.h>

Enumerations
enum	KzuScriptingLanguage { KZU_SCRIPTING_LANGUAGE_INVALID }
	Type of bounding volume. More...
enum	KzuScriptDataType { KZU_SCRIPT_DATA_TYPE_BINARY, KZU_SCRIPT_DATA_TYPE_SOURCE }
	Type of bounding volume. More...

Functions
kzsError	kzuScriptCreateBinary (const struct KzcMemoryManager *memoryManager, kzString name, enum KzuScriptingLanguage language, const void *data, kzUint dataSize, struct KzuScript **out_script)
	Creates and initializes script structure. More...
kzsError	kzuScriptCreateSource (const struct KzcMemoryManager *memoryManager, kzString name, enum KzuScriptingLanguage language, kzString text, struct KzuScript **out_script)
	Creates and initializes script structure. More...
kzsError	kzuScriptDelete (struct KzuScript *script)
	Deletes script structure. More...
enum KzuScriptDataType	kzuScriptGetDataType (const struct KzuScript *script)
	Gets the data type from script. More...
enum KzuScriptingLanguage	kzuScriptGetLanguage (const struct KzuScript *script)
	Gets the set language from script. More...
kzsError	kzuScriptGetSource (const struct KzuScript *script, kzString *out_source)
	Gets the script source from script. More...
kzsError	kzuScriptGetBinary (const struct KzuScript *script, void **out_binary, kzUint *out_size)
	Gets the script data from script. More...

Detailed Description

A script container file.

Holds the content of single script file.

Copyright 2008-2019 by Rightware. All rights reserved.

Enumeration Type Documentation

enum KzuScriptingLanguage

Type of bounding volume.

Enumerator
KZU_SCRIPTING_LANGUAGE_INVALID	Invalid scripting language.

enum KzuScriptDataType

Type of bounding volume.

Enumerator
KZU_SCRIPT_DATA_TYPE_BINARY	Script content is precompiled binary.
KZU_SCRIPT_DATA_TYPE_SOURCE	Script content is text.

Function Documentation

kzsError kzuScriptCreateBinary	(	const struct KzcMemoryManager *	memoryManager,
		kzString	name,
		enum KzuScriptingLanguage	language,
		const void *	data,
		kzUint	dataSize,
		struct KzuScript **	out_script
	)

Creates and initializes script structure.

kzsError kzuScriptCreateSource	(	const struct KzcMemoryManager *	memoryManager,
		kzString	name,
		enum KzuScriptingLanguage	language,
		kzString	text,
		struct KzuScript **	out_script
	)

Creates and initializes script structure.

kzsError kzuScriptDelete

(

struct KzuScript *

script)

Deletes script structure.

enum KzuScriptDataType kzuScriptGetDataType

(

const struct KzuScript *

script)

Gets the data type from script.

enum KzuScriptingLanguage kzuScriptGetLanguage

(

const struct KzuScript *

script)

Gets the set language from script.

kzsError kzuScriptGetSource	(	const struct KzuScript *	script,
		kzString *	out_source
	)

Gets the script source from script.

Throws error if the data type is not source.

kzsError kzuScriptGetBinary	(	const struct KzuScript *	script,
		void **	out_binary,
		kzUint *	out_size
	)

Gets the script data from script.

Throws error if the data type is not binary.