Kaim::Result Namespace Reference

Namespace description

Defines a set of return values used by Gameware Navigation methods and functions, and utilities for managing those values.

Functions
bool	Check (KyResult result)
bool	Fail (KyResult result)

Variables
static const KyResult	Failure = 0
static const KyResult	Success = 1

Function Documentation

bool Kaim::Result::Check ( KyResult  result )

inline

Returns true if the specified result code indicates that the requested operation successfully completed.

Examples:

bool Kaim::Result::Fail ( KyResult  result )

inline

Returns true if the specified result code indicates that the requested operation failed.

Examples:

Variable Documentation

const KyResult Kaim::Result::Failure = 0

static

Indicates that the requested operation could not be successfully completed. This return indicates the failure of a "Try" request.

const KyResult Kaim::Result::Success = 1

static

Indicates that the requested operation was successfully completed.