kzu_message.h File Reference

Message object. More...

#include <user/properties/kzu_property_common.h>
#include <core/util/math/kzc_vector2.h>
#include <core/util/math/kzc_vector3.h>
#include <core/util/math/kzc_vector4.h>
#include <core/util/math/kzc_matrix2x2.h>
#include <core/util/math/kzc_matrix3x3.h>
#include <core/util/math/kzc_matrix4x4.h>
#include <core/util/color/kzc_color.h>
#include <core/util/string/kzc_string.h>
#include <system/kzs_types.h>
#include <system/debug/kzs_error.h>
#include <system/kzs_header.h>

Functions
kzUint	kzuMessageGetTimestamp (const struct KzuMessage *message)
	Gets the relative timestamp of a message. More...
struct KzuMessageDispatcher *	kzuMessageGetDispatcher (const struct KzuMessage *message)
	Returns the dispatcher of a message. More...
struct KzuMessageType *	kzuMessageGetType (const struct KzuMessage *message)
	Returns the type of a message. More...
struct KzuObjectNode *	kzuMessageGetSource (const struct KzuMessage *message)
	Get the source of the message. More...
void	kzuMessageSetHandled (struct KzuMessage *message, kzBool handled)
	Sets the handled state of a message. More...
kzBool	kzuMessageIsHandled (const struct KzuMessage *message)
	Gets the handled state of a message. More...
void	kzuMessageSetValid (struct KzuMessage *message, kzBool valid)
	Sets the valid state of a message. More...
kzBool	kzuMessageIsValid (const struct KzuMessage *message)
	Gets the valid state of the message. More...
kzsError	kzuMessageGetArgumentAsVariant (const struct KzuMessage *message, const struct KzuPropertyType *argumentType, enum KzuPropertyField field, struct KzuVariant *variant, kzBool *out_found)
	Get an argument as a variant. More...
kzsError	kzuMessageSetVariantArgument (const struct KzuMessage *message, const struct KzuPropertyType *argumentType, enum KzuPropertyField field, const struct KzuVariant *variant)
	Sets a variant argument. More...
kzFloat	kzuMessageGetFloatArgumentDefault (const struct KzuMessage *message, const struct KzuPropertyType *argumentType)
	Gets a float argument and returns the default value from the type if the argument is not found. More...
kzsError	kzuMessageSetFloatArgument (const struct KzuMessage *message, const struct KzuPropertyType *argumentType, kzFloat value)
	Sets a float argument. More...
kzInt	kzuMessageGetIntArgumentDefault (const struct KzuMessage *message, const struct KzuPropertyType *argumentType)
	Gets a int argument and returns the default value from the type if the argument is not found. More...
kzsError	kzuMessageSetIntArgument (const struct KzuMessage *message, const struct KzuPropertyType *argumentType, kzInt value)
	Sets a int argument. More...
kzBool	kzuMessageGetBoolArgumentDefault (const struct KzuMessage *message, const struct KzuPropertyType *argumentType)
	Gets a bool argument and returns the default value from the type if the argument is not found. More...
kzsError	kzuMessageSetBoolArgument (const struct KzuMessage *message, const struct KzuPropertyType *argumentType, kzBool value)
	Sets a bool argument. More...
struct KzcColorRGBA	kzuMessageGetColorArgumentDefault (const struct KzuMessage *message, const struct KzuPropertyType *argumentType)
	Gets a color argument and returns the default value from the type if the argument is not found. More...
kzsError	kzuMessageSetColorArgument (const struct KzuMessage *message, const struct KzuPropertyType *argumentType, struct KzcColorRGBA value)
	Sets a color argument. More...
struct KzcVector2	kzuMessageGetVector2ArgumentDefault (const struct KzuMessage *message, const struct KzuPropertyType *argumentType)
	Gets a vector2 argument and returns the default value from the type if the argument is not found. More...
kzsError	kzuMessageSetVector2Argument (const struct KzuMessage *message, const struct KzuPropertyType *argumentType, struct KzcVector2 value)
	Sets a vector2 argument. More...
struct KzcVector3	kzuMessageGetVector3ArgumentDefault (const struct KzuMessage *message, const struct KzuPropertyType *argumentType)
	Gets a vector3 argument and returns the default value from the type if the argument is not found. More...
kzsError	kzuMessageSetVector3Argument (const struct KzuMessage *message, const struct KzuPropertyType *argumentType, struct KzcVector3 value)
	Sets a vector3 argument. More...
struct KzcVector4	kzuMessageGetVector4ArgumentDefault (const struct KzuMessage *message, const struct KzuPropertyType *argumentType)
	Gets a vector4 argument and returns the default value from the type if the argument is not found. More...
kzsError	kzuMessageSetVector4Argument (const struct KzuMessage *message, const struct KzuPropertyType *argumentType, struct KzcVector4 value)
	Sets a vector4 argument. More...
struct KzcMatrix2x2	kzuMessageGetMatrix2x2ArgumentDefault (const struct KzuMessage *message, const struct KzuPropertyType *argumentType)
	Gets a matrix2x2 argument and returns the default value from the type if the argument is not found. More...
kzsError	kzuMessageSetMatrix2x2Argument (const struct KzuMessage *message, const struct KzuPropertyType *argumentType, struct KzcMatrix2x2 value)
	Sets a matrix2x2 argument. More...
struct KzcMatrix3x3	kzuMessageGetMatrix3x3ArgumentDefault (const struct KzuMessage *message, const struct KzuPropertyType *argumentType)
	Gets a matrix3x3 argument and returns the default value from the type if the argument is not found. More...
kzsError	kzuMessageSetMatrix3x3Argument (const struct KzuMessage *message, const struct KzuPropertyType *argumentType, struct KzcMatrix3x3 value)
	Sets a matrix3x3 argument. More...
struct KzcMatrix4x4	kzuMessageGetMatrix4x4ArgumentDefault (const struct KzuMessage *message, const struct KzuPropertyType *argumentType)
	Gets a matrix4x4 argument and returns the default value from the type if the argument is not found. More...
kzsError	kzuMessageSetMatrix4x4Argument (const struct KzuMessage *message, const struct KzuPropertyType *argumentType, struct KzcMatrix4x4 value)
	Sets a matrix4x4 argument. More...
void *	kzuMessageGetPointerArgumentDefault (const struct KzuMessage *message, const struct KzuPropertyType *argumentType)
	Gets a pointer argument and returns the default value from the type if the argument is not found. More...
kzsError	kzuMessageSetPointerArgument (const struct KzuMessage *message, const struct KzuPropertyType *argumentType, void *value)
	Sets a pointer argument. More...
kzString	kzuMessageGetStringArgumentDefault (const struct KzuMessage *message, const struct KzuPropertyType *argumentType)
	Gets a string argument and returns the default value from the type if the argument is not found. More...
kzsError	kzuMessageSetStringArgument (const struct KzuMessage *message, const struct KzuPropertyType *argumentType, kzString value)
	Sets a string argument. More...
kzString	kzuMessageGetResourceIDArgumentDefault (const struct KzuMessage *message, const struct KzuPropertyType *argumentType)
	Gets a resourceID argument and returns the default value from the type if the argument is not found. More...
kzsError	kzuMessageSetResourceIDArgument (const struct KzuMessage *message, const struct KzuPropertyType *argumentType, kzString resourceID)
	Sets a string argument. More...

Detailed Description

Message object.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

kzUint kzuMessageGetTimestamp

(

const struct KzuMessage *

message)

Gets the relative timestamp of a message.

struct KzuMessageDispatcher* kzuMessageGetDispatcher

(

const struct KzuMessage *

message)

Returns the dispatcher of a message.

struct KzuMessageType* kzuMessageGetType

(

const struct KzuMessage *

message)

Returns the type of a message.

struct KzuObjectNode* kzuMessageGetSource

(

const struct KzuMessage *

message)

Get the source of the message.

void kzuMessageSetHandled	(	struct KzuMessage *	message,
		kzBool	handled
	)

Sets the handled state of a message.

kzBool kzuMessageIsHandled

(

const struct KzuMessage *

message)

Gets the handled state of a message.

void kzuMessageSetValid	(	struct KzuMessage *	message,
		kzBool	valid
	)

Sets the valid state of a message.

kzBool kzuMessageIsValid

(

const struct KzuMessage *

message)

Gets the valid state of the message.

The message becomes invalid after sending or if the source of the message is destroyed.

kzsError kzuMessageGetArgumentAsVariant	(	const struct KzuMessage *	message,
		const struct KzuPropertyType *	argumentType,
		enum KzuPropertyField	field,
		struct KzuVariant *	variant,
		kzBool *	out_found
	)

Get an argument as a variant.

Writes KZ_TRUE to out_found if the argument is found, KZ_FALSE otherwise.

kzsError kzuMessageSetVariantArgument	(	const struct KzuMessage *	message,
		const struct KzuPropertyType *	argumentType,
		enum KzuPropertyField	field,
		const struct KzuVariant *	variant
	)

Sets a variant argument.

kzFloat kzuMessageGetFloatArgumentDefault	(	const struct KzuMessage *	message,
		const struct KzuPropertyType *	argumentType
	)

Gets a float argument and returns the default value from the type if the argument is not found.

kzsError kzuMessageSetFloatArgument	(	const struct KzuMessage *	message,
		const struct KzuPropertyType *	argumentType,
		kzFloat	value
	)

Sets a float argument.

kzInt kzuMessageGetIntArgumentDefault	(	const struct KzuMessage *	message,
		const struct KzuPropertyType *	argumentType
	)

Gets a int argument and returns the default value from the type if the argument is not found.

kzsError kzuMessageSetIntArgument	(	const struct KzuMessage *	message,
		const struct KzuPropertyType *	argumentType,
		kzInt	value
	)

Sets a int argument.

kzBool kzuMessageGetBoolArgumentDefault	(	const struct KzuMessage *	message,
		const struct KzuPropertyType *	argumentType
	)

Gets a bool argument and returns the default value from the type if the argument is not found.

kzsError kzuMessageSetBoolArgument	(	const struct KzuMessage *	message,
		const struct KzuPropertyType *	argumentType,
		kzBool	value
	)

Sets a bool argument.

struct KzcColorRGBA kzuMessageGetColorArgumentDefault	(	const struct KzuMessage *	message,
		const struct KzuPropertyType *	argumentType
	)

Gets a color argument and returns the default value from the type if the argument is not found.

kzsError kzuMessageSetColorArgument	(	const struct KzuMessage *	message,
		const struct KzuPropertyType *	argumentType,
		struct KzcColorRGBA	value
	)

Sets a color argument.

struct KzcVector2 kzuMessageGetVector2ArgumentDefault	(	const struct KzuMessage *	message,
		const struct KzuPropertyType *	argumentType
	)

Gets a vector2 argument and returns the default value from the type if the argument is not found.

kzsError kzuMessageSetVector2Argument	(	const struct KzuMessage *	message,
		const struct KzuPropertyType *	argumentType,
		struct KzcVector2	value
	)

Sets a vector2 argument.

struct KzcVector3 kzuMessageGetVector3ArgumentDefault	(	const struct KzuMessage *	message,
		const struct KzuPropertyType *	argumentType
	)

Gets a vector3 argument and returns the default value from the type if the argument is not found.

kzsError kzuMessageSetVector3Argument	(	const struct KzuMessage *	message,
		const struct KzuPropertyType *	argumentType,
		struct KzcVector3	value
	)

Sets a vector3 argument.

struct KzcVector4 kzuMessageGetVector4ArgumentDefault	(	const struct KzuMessage *	message,
		const struct KzuPropertyType *	argumentType
	)

Gets a vector4 argument and returns the default value from the type if the argument is not found.

kzsError kzuMessageSetVector4Argument	(	const struct KzuMessage *	message,
		const struct KzuPropertyType *	argumentType,
		struct KzcVector4	value
	)

Sets a vector4 argument.

struct KzcMatrix2x2 kzuMessageGetMatrix2x2ArgumentDefault	(	const struct KzuMessage *	message,
		const struct KzuPropertyType *	argumentType
	)

Gets a matrix2x2 argument and returns the default value from the type if the argument is not found.

kzsError kzuMessageSetMatrix2x2Argument	(	const struct KzuMessage *	message,
		const struct KzuPropertyType *	argumentType,
		struct KzcMatrix2x2	value
	)

Sets a matrix2x2 argument.

struct KzcMatrix3x3 kzuMessageGetMatrix3x3ArgumentDefault	(	const struct KzuMessage *	message,
		const struct KzuPropertyType *	argumentType
	)

Gets a matrix3x3 argument and returns the default value from the type if the argument is not found.

kzsError kzuMessageSetMatrix3x3Argument	(	const struct KzuMessage *	message,
		const struct KzuPropertyType *	argumentType,
		struct KzcMatrix3x3	value
	)

Sets a matrix3x3 argument.

struct KzcMatrix4x4 kzuMessageGetMatrix4x4ArgumentDefault	(	const struct KzuMessage *	message,
		const struct KzuPropertyType *	argumentType
	)

Gets a matrix4x4 argument and returns the default value from the type if the argument is not found.

kzsError kzuMessageSetMatrix4x4Argument	(	const struct KzuMessage *	message,
		const struct KzuPropertyType *	argumentType,
		struct KzcMatrix4x4	value
	)

Sets a matrix4x4 argument.

void* kzuMessageGetPointerArgumentDefault	(	const struct KzuMessage *	message,
		const struct KzuPropertyType *	argumentType
	)

Gets a pointer argument and returns the default value from the type if the argument is not found.

kzsError kzuMessageSetPointerArgument	(	const struct KzuMessage *	message,
		const struct KzuPropertyType *	argumentType,
		void *	value
	)

Sets a pointer argument.

kzString kzuMessageGetStringArgumentDefault	(	const struct KzuMessage *	message,
		const struct KzuPropertyType *	argumentType
	)

Gets a string argument and returns the default value from the type if the argument is not found.

kzsError kzuMessageSetStringArgument	(	const struct KzuMessage *	message,
		const struct KzuPropertyType *	argumentType,
		kzString	value
	)

Sets a string argument.

kzString kzuMessageGetResourceIDArgumentDefault	(	const struct KzuMessage *	message,
		const struct KzuPropertyType *	argumentType
	)

Gets a resourceID argument and returns the default value from the type if the argument is not found.

kzsError kzuMessageSetResourceIDArgument	(	const struct KzuMessage *	message,
		const struct KzuPropertyType *	argumentType,
		kzString	resourceID
	)

Sets a string argument.