diguy_author.h File Reference

#include <diguy_constants.h>
#include <diguyAuthorInterface.h>
#include <declspec_diguy.h>

Go to the source code of this file.

Functions
Initialization Functions
int	diguy_author_initialize (diguyAuthorInterfaceCreateFunc *create_func)
	This function enables DI-Guy Author. More...
int	diguy_author_get_author_enabled ()
	This function returns whether or not DI-Guy Author functionality is enabled. More...
diguyAuthorInterface *	diguy_author_get_author_interface ()
	This function returns a pointer to a diguyAuthorInterface object. More...

Variables
	LALALALALA

Function Documentation

int diguy_author_initialize

(

diguyAuthorInterfaceCreateFunc *

create_func

)

This function enables DI-Guy Author.

It should be called after the main DI-Guy initialize call.

Note that DI-Guy Author will deinitialize automatically when DI-Guy shuts down.

Parameters

create_func

pointer to function that creates a diguyAuthorInterface subclass object

DI-Guy Author relies on receiving input from the Host IG that is integrating DI-Guy Author functionality. To do this, the diguyAuthorInterface class needs to be subclassed, with the proper virtual functions overridden.

DI-Guy uses this indirect approach to creating objects instead of just setting the object directly to avoid potential memory model problems on some platforms, that can result in difficult to debug problems.

Callable From:

• C++

Returns:

0 on success, -1 on failure

int diguy_author_get_author_enabled

(

)

This function returns whether or not DI-Guy Author functionality is enabled.

Returns:

1 if DI-Guy Author enabled and initialized, 0 if not

diguyAuthorInterface* diguy_author_get_author_interface

(

)

This function returns a pointer to a diguyAuthorInterface object.

Member functions in this object can be used to communicate input, e.g. mouse clicks or key presses, to DI-Guy so it can create and edit DI-Guy characters and objects in the Host IG.

Returns:

pointer of type diguyAuthorInterface

Variable Documentation

LALALALALA