Duke::FInputHelper Struct Reference

#include "InputHelper.h"

Static Public Member Functions
static bool	TryKeyToChar (const FKey &key, TCHAR &output)
static bool	TryCharToDigit (TCHAR character, int32 radix, int32 &output)
static bool	TryKeyToDigit (const FKey &key, int32 radix, int32 &output)

Detailed Description

Provides helper methods for working with user input

Member Function Documentation

TryCharToDigit()

static bool Duke::FInputHelper::TryCharToDigit ( TCHAR  character, int32  radix, int32 &  output  )

staticFlavor:Static

Tries to convert a character to a digit.

Parameters

character	The character to convert
radix	The radix of digit to convert. Valid range is 2 thru 36. For radices greater than 10, A-Z (case insensitive) are used to supply remaining digits (i.e. 0-9 and A-F for hexadecimal).
output	On successful return, contains the converted digit. In the case where the conversion fails due to the digit being outside the range of the radix, the converted digit is still returned, but failure is indicated via the return value.

Implements Opcode:

Flavor:Static B ← chtoi4 CH I4 I4&

Returns

True if conversion was successful, otherwise false.

TryKeyToChar()

DBN_FORCEINLINE bool FInputHelper::TryKeyToChar ( const FKey &  key, TCHAR &  output  )

staticFlavor:Static

Tries to convert an input event key to a character.

Parameters

key	The key to convert
output	On successful return, contains the converted character. Otherwise returns null ('\0');

Returns

True if conversion was successful, otherwise false.

Implements Opcode:

Flavor:Static B ← kytoch KY CH&

TryKeyToDigit()

DBN_FORCEINLINE bool FInputHelper::TryKeyToDigit ( const FKey &  key, int32  radix, int32 &  output  )

staticFlavor:Static

Tries to convert an input event key to a digit.

Parameters

key	The key to convert
radix	The radix of digit to convert. Valid range is 2 thru 36. For radices greater than 10, A-Z (case insensitive) are used to supply remaining digits (i.e. 0-9 and A-F for hexadecimal).
output	On successful return, contains the converted digit. In the case where the conversion fails due to the digit being outside the range of the radix, the converted digit is still returned, but failure is indicated via the return value.

Returns

True if conversion was successful, otherwise false.

Implements Opcode:

Flavor:Static B ← kytoi4 KY I4 I4&

---

The documentation for this struct was generated from the following files:

• InputHelper.h
• InputHelper.inl