OrxConsole

Macros
#define	orxCONSOLE_KZ_CONFIG_HISTORY_FILE_EXTENSION   "cih"
#define	orxCONSOLE_KZ_INPUT_AUTOCOMPLETE   "AutoComplete"
#define	orxCONSOLE_KZ_INPUT_DELETE   "Delete"
#define	orxCONSOLE_KZ_INPUT_DELETE_AFTER   "DeleteAfter"
#define	orxCONSOLE_KZ_INPUT_END   "End"
#define	orxCONSOLE_KZ_INPUT_ENTER   "Enter"
#define	orxCONSOLE_KZ_INPUT_LEFT   "Left"
#define	orxCONSOLE_KZ_INPUT_NEXT   "Next"
#define	orxCONSOLE_KZ_INPUT_PASTE   "Paste"
#define	orxCONSOLE_KZ_INPUT_PREVIOUS   "Previous"
#define	orxCONSOLE_KZ_INPUT_RIGHT   "Right"
#define	orxCONSOLE_KZ_INPUT_SCROLL_DOWN   "ScrollDown"
#define	orxCONSOLE_KZ_INPUT_SCROLL_UP   "ScrollUp"
#define	orxCONSOLE_KZ_INPUT_SET   "-=ConsoleSet=-"
#define	orxCONSOLE_KZ_INPUT_START   "Start"
#define	orxCONSOLE_KZ_INPUT_TOGGLE   "Toggle"
#define	orxCONSOLE_KZ_INPUT_TOGGLE_MODE   "ToggleMode"

Functions
orxDLLAPI void orxFASTCALL	orxConsole_Enable (orxBOOL _bEnable)
orxDLLAPI void orxFASTCALL	orxConsole_Exit ()
orxDLLAPI const orxSTRING orxFASTCALL	orxConsole_GetCompletion (orxU32 _u32Index, orxBOOL *_pbActive)
orxDLLAPI orxU32 orxFASTCALL	orxConsole_GetCompletionCount (orxU32 *_pu32MaxLength)
orxDLLAPI const orxFONT *orxFASTCALL	orxConsole_GetFont ()
orxDLLAPI const orxSTRING orxFASTCALL	orxConsole_GetInput (orxU32 *_pu32CursorIndex)
orxDLLAPI orxU32 orxFASTCALL	orxConsole_GetLogLineLength ()
orxDLLAPI const orxSTRING orxFASTCALL	orxConsole_GetTrailLogLine (orxU32 _u32TrailLineIndex)
orxDLLAPI orxU32 orxFASTCALL	orxConsole_GetTrailLogLineOffset ()
orxDLLAPI orxSTATUS orxFASTCALL	orxConsole_Init ()
orxDLLAPI orxBOOL orxFASTCALL	orxConsole_IsEnabled ()
orxDLLAPI orxBOOL orxFASTCALL	orxConsole_IsInsertMode ()
orxDLLAPI orxSTATUS orxFASTCALL	orxConsole_Log (const orxSTRING _zText)
orxDLLAPI orxSTATUS orxFASTCALL	orxConsole_SetFont (const orxFONT *_pstFont)
orxDLLAPI orxSTATUS orxFASTCALL	orxConsole_SetLogLineLength (orxU32 _u32LineLength)
orxDLLAPI orxSTATUS orxFASTCALL	orxConsole_SetToggle (orxINPUT_TYPE _eInputType, orxENUM _eInputID, orxINPUT_MODE _eInputMode)
orxDLLAPI void orxFASTCALL	orxConsole_Setup ()

Detailed Description

Console module Module that can execute consoles and log info at runtime

Macro Definition Documentation

#define orxCONSOLE_KZ_CONFIG_HISTORY_FILE_EXTENSION   "cih"

Config history file extension

Definition at line 69 of file orxConsole.h.

#define orxCONSOLE_KZ_INPUT_AUTOCOMPLETE   "AutoComplete"

Autocomplete input

Definition at line 54 of file orxConsole.h.

#define orxCONSOLE_KZ_INPUT_DELETE   "Delete"

Delete input

Definition at line 55 of file orxConsole.h.

#define orxCONSOLE_KZ_INPUT_DELETE_AFTER   "DeleteAfter"

Delete after input

Definition at line 56 of file orxConsole.h.

#define orxCONSOLE_KZ_INPUT_END   "End"

Cursor move end

Definition at line 64 of file orxConsole.h.

#define orxCONSOLE_KZ_INPUT_ENTER   "Enter"

Enter input

Definition at line 58 of file orxConsole.h.

#define orxCONSOLE_KZ_INPUT_LEFT   "Left"

Cursor move left

Definition at line 61 of file orxConsole.h.

#define orxCONSOLE_KZ_INPUT_NEXT   "Next"

Next input

Definition at line 60 of file orxConsole.h.

#define orxCONSOLE_KZ_INPUT_PASTE   "Paste"

Paste input

Definition at line 65 of file orxConsole.h.

#define orxCONSOLE_KZ_INPUT_PREVIOUS   "Previous"

Previous input

Definition at line 59 of file orxConsole.h.

#define orxCONSOLE_KZ_INPUT_RIGHT   "Right"

Cursor move right

Definition at line 62 of file orxConsole.h.

#define orxCONSOLE_KZ_INPUT_SCROLL_DOWN   "ScrollDown"

Log scroll down

Definition at line 66 of file orxConsole.h.

#define orxCONSOLE_KZ_INPUT_SCROLL_UP   "ScrollUp"

Log scroll up

Definition at line 67 of file orxConsole.h.

#define orxCONSOLE_KZ_INPUT_SET   "-=ConsoleSet=-"

InputsConsole input set

Definition at line 51 of file orxConsole.h.

#define orxCONSOLE_KZ_INPUT_START   "Start"

Cursor move start

Definition at line 63 of file orxConsole.h.

#define orxCONSOLE_KZ_INPUT_TOGGLE   "Toggle"

Toggle input

Definition at line 53 of file orxConsole.h.

#define orxCONSOLE_KZ_INPUT_TOGGLE_MODE   "ToggleMode"

Toggle mode input

Definition at line 57 of file orxConsole.h.

Function Documentation

orxDLLAPI void orxFASTCALL orxConsole_Enable

(

orxBOOL

_bEnable

)

Enables/disables the console

Parameters

[in]

_bEnable

Enable / disable

orxDLLAPI void orxFASTCALL orxConsole_Exit

(

)

Exits from the console module

orxDLLAPI const orxSTRING orxFASTCALL orxConsole_GetCompletion	(	orxU32	_u32Index,
		orxBOOL *	_pbActive
	)

Gets completion

Parameters

[in]	_u32Index	Index of the active completion
[out]	_pbActive	Is completion active, orxNULL to ignore

Returns

Completion string if found, orxSTRING_EMPTY otherwise

orxDLLAPI orxU32 orxFASTCALL orxConsole_GetCompletionCount

(

orxU32 *

_pu32MaxLength

)

Gets current completions count

Parameters

[out]

_pu32MaxLength

Max completion length, orxNULL to ignore

Returns

Current completions count

orxDLLAPI const orxFONT* orxFASTCALL orxConsole_GetFont

(

)

Gets the console font

Returns

Current in-use font, orxNULL

orxDLLAPI const orxSTRING orxFASTCALL orxConsole_GetInput

(

orxU32 *

_pu32CursorIndex

)

Gets input text

Parameters

[out]

_pu32CursorIndex

Index (ie. character position) of the cursor (any character past it has not been validated)

Returns

orxTRING / orxSTRING_EMPTY

orxDLLAPI orxU32 orxFASTCALL orxConsole_GetLogLineLength

(

)

Gets the console log line length

Returns

Console log line length

orxDLLAPI const orxSTRING orxFASTCALL orxConsole_GetTrailLogLine

(

orxU32

_u32TrailLineIndex

)

Gets log line from the end (trail), using internal offset

Parameters

[in]

_u32TrailLineIndex

Index of the line starting from end

Returns

orxTRING / orxSTRING_EMPTY

orxDLLAPI orxU32 orxFASTCALL orxConsole_GetTrailLogLineOffset

(

)

Gets log line offset from the end

Returns

Log line offset from the end

orxDLLAPI orxSTATUS orxFASTCALL orxConsole_Init

(

)

Inits the console module

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxBOOL orxFASTCALL orxConsole_IsEnabled

(

)

Is the console enabled?

Returns

orxTRUE if enabled, orxFALSE otherwise

orxDLLAPI orxBOOL orxFASTCALL orxConsole_IsInsertMode

(

)

Is the console input in insert mode?

Returns

orxTRUE if insert mode, orxFALSE otherwise (overwrite mode)

orxDLLAPI orxSTATUS orxFASTCALL orxConsole_Log

(

const orxSTRING

_zText

)

Logs to the console

Parameters

[in]

_zText

Text to log

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConsole_SetFont

(

const orxFONT *

_pstFont

)

Sets the console font

Parameters

[in]

_pstFont

Font to use

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConsole_SetLogLineLength

(

orxU32

_u32LineLength

)

Sets the console log line length

Parameters

[in]

_u32LineLength

Line length to use

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxConsole_SetToggle	(	orxINPUT_TYPE	_eInputType,
		orxENUM	_eInputID,
		orxINPUT_MODE	_eInputMode
	)

Sets the console toggle

Parameters

[in]	_eInputType	Type of input peripheral
[in]	_eInputID	ID of button/key/axis
[in]	_eInputMode	Mode of input

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxConsole_Setup

(

)

Console module setup