kzu_state_manager.h File Reference

State manager. More...

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

Functions
kzsError	kzuStateManagerCreateEmpty (const struct KzcMemoryManager *memoryManager, struct KzuUIDomain *uiDomain, kzString name, struct KzuStateManager **out_stateManager)
	Create an empty state manager. More...
kzsError	kzuStateManagerCreate (const struct KzcMemoryManager *memoryManager, struct KzuUIDomain *uiDomain, kzString name, struct KzuStateManager **out_stateManager)
	Create a state manager. More...
kzsError	kzuStateManagerDelete (struct KzuStateManager *stateManager)
	Delete a state manager. More...
kzsError	kzuStateManagerGoToStateAsync (struct KzuObjectNode *objectNode, kzString stateName)
	Attempt to go to a state. More...
kzsError	kzuStateManagerLoadFromKZB (struct KzuStateManager *stateManager, struct KzcInputStream *inputStream, const struct KzuBinaryFileInfo *file)
	Load a state manager from kzb. More...
struct KzuPropertyManager *	kzuStateManagerGetPropertyManager (const struct KzuStateManager *stateManager)
	Get the property manager of a state manager. More...
kzsError	kzuStateManagerAttach (struct KzuStateManager *stateManager, struct KzuObjectNode *objectNode, struct KzuStateManagerRuntime **out_stateManagerRuntime)
	Attach a state manager. More...
kzsError	kzuStateManagerDetach (struct KzuStateManagerRuntime *stateManagerRuntime)
	Detach a state manager. More...
struct KzuStateManager *	kzuStateManagerRuntimeGetStateManager (const struct KzuStateManagerRuntime *stateManagerRuntime)
	Gets state manager from state manager runtime. More...
struct KzuResource *	kzuStateManagerToResource (const struct KzuStateManager *stateManager)
	Converts state manager to resource. More...
struct KzuStateManager *	kzuStateManagerFromResource (const struct KzuResource *resource)
	Converts state manager from resource. More...
struct KzuStateManager *	kzuStateManagerCastFromResource (const struct KzuResource *resource)
	Casts state manager from resource, KZ_NULL if invalid type. More...
void	kzuStateManagerSetUIDomain (struct KzuStateManager *stateManager, struct KzuUIDomain *uiDomain)
	Sets UI domain to state manager. More...

Variables
const KzuResourceType	KZU_RESOURCE_TYPE_STATE_MANAGER
	Resource type identifier for state manager. More...

Detailed Description

State manager.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

kzsError kzuStateManagerCreateEmpty	(	const struct KzcMemoryManager *	memoryManager,
		struct KzuUIDomain *	uiDomain,
		kzString	name,
		struct KzuStateManager **	out_stateManager
	)

Create an empty state manager.

kzsError kzuStateManagerCreate	(	const struct KzcMemoryManager *	memoryManager,
		struct KzuUIDomain *	uiDomain,
		kzString	name,
		struct KzuStateManager **	out_stateManager
	)

Create a state manager.

kzsError kzuStateManagerDelete

(

struct KzuStateManager *

stateManager)

Delete a state manager.

kzsError kzuStateManagerGoToStateAsync	(	struct KzuObjectNode *	objectNode,
		kzString	stateName
	)

Attempt to go to a state.

kzsError kzuStateManagerLoadFromKZB	(	struct KzuStateManager *	stateManager,
		struct KzcInputStream *	inputStream,
		const struct KzuBinaryFileInfo *	file
	)

Load a state manager from kzb.

struct KzuPropertyManager* kzuStateManagerGetPropertyManager

(

const struct KzuStateManager *

stateManager)

Get the property manager of a state manager.

kzsError kzuStateManagerAttach	(	struct KzuStateManager *	stateManager,
		struct KzuObjectNode *	objectNode,
		struct KzuStateManagerRuntime **	out_stateManagerRuntime
	)

Attach a state manager.

kzsError kzuStateManagerDetach

(

struct KzuStateManagerRuntime *

stateManagerRuntime)

Detach a state manager.

struct KzuStateManager* kzuStateManagerRuntimeGetStateManager

(

const struct KzuStateManagerRuntime *

stateManagerRuntime)

Gets state manager from state manager runtime.

struct KzuResource* kzuStateManagerToResource

(

const struct KzuStateManager *

stateManager)

Converts state manager to resource.

struct KzuStateManager* kzuStateManagerFromResource

(

const struct KzuResource *

resource)

Converts state manager from resource.

struct KzuStateManager* kzuStateManagerCastFromResource

(

const struct KzuResource *

resource)

Casts state manager from resource, KZ_NULL if invalid type.

void kzuStateManagerSetUIDomain	(	struct KzuStateManager *	stateManager,
		struct KzuUIDomain *	uiDomain
	)

Sets UI domain to state manager.

Variable Documentation

const KzuResourceType KZU_RESOURCE_TYPE_STATE_MANAGER

Resource type identifier for state manager.