List of return values used in this script. More...

Functions
	printErrorDescription ($arg1)
	Prints a descriptive error message based on the given error code.

Variables
const	$C_SUCCESS = 255
const	$C_EMPTY_COLUMN = 254
	Indicates the selected column to take a card from is emtpy.
const	$C_MOVE_INVALID = 253
	Indicates the given move is not a valid move.
const	$C_CARD_NOT_FOUND = 252
	Indicates the card asked for is not available for a move.
const	$C_COLUMN_NOT_EXISTS = 251
	Indicates the given column does not exist.
const	$C_INVALID_ARGUMENT = 250
	Indicates the argument given does not exist.
const	$C_NULL_CARD = 249
	Indicates the card given is empty.
const	$C_NO_BLINDS = 248
	The request to turn a blind card cannot be fulfilled as there are no blind cards.
const	$C_NOT_ENOUGH_CARDS = 247
	The card stack is too small to give the requested cards.
const	$C_INCORRECT_CARD_NAME = 246
	The given name is not a valid card name.
const	$C_TERMINAL_SIZE_ERROR = 245
	The size of the terminal is not large enough to show the patience board.
const	$C_DEBUG_STOP = 70
	Returned prematurely for debug purposes.

Detailed Description

List of return values used in this script.

Function Documentation

◆ printErrorDescription()

printErrorDescription ( $arg1 )

Prints a descriptive error message based on the given error code.

Parameters

$arg1 The error code to give the description for.

Definition at line 97 of file patience.sh.

Variable Documentation

◆ $C_CARD_NOT_FOUND

const $C_CARD_NOT_FOUND = 252

Indicates the card asked for is not available for a move.

Definition at line 77 of file patience.sh.

◆ $C_COLUMN_NOT_EXISTS

const $C_COLUMN_NOT_EXISTS = 251

Indicates the given column does not exist.

Definition at line 79 of file patience.sh.

◆ $C_DEBUG_STOP

const $C_DEBUG_STOP = 70

Returned prematurely for debug purposes.

Definition at line 93 of file patience.sh.

◆ $C_EMPTY_COLUMN

const $C_EMPTY_COLUMN = 254

Indicates the selected column to take a card from is emtpy.

Definition at line 73 of file patience.sh.

◆ $C_INCORRECT_CARD_NAME

const $C_INCORRECT_CARD_NAME = 246

The given name is not a valid card name.

Definition at line 89 of file patience.sh.

◆ $C_INVALID_ARGUMENT

const $C_INVALID_ARGUMENT = 250

Indicates the argument given does not exist.

Definition at line 81 of file patience.sh.

◆ $C_MOVE_INVALID

const $C_MOVE_INVALID = 253

Indicates the given move is not a valid move.

Definition at line 75 of file patience.sh.

◆ $C_NO_BLINDS

const $C_NO_BLINDS = 248

The request to turn a blind card cannot be fulfilled as there are no blind cards.

Definition at line 85 of file patience.sh.

◆ $C_NOT_ENOUGH_CARDS

const $C_NOT_ENOUGH_CARDS = 247

The card stack is too small to give the requested cards.

Definition at line 87 of file patience.sh.

◆ $C_NULL_CARD

const $C_NULL_CARD = 249

Indicates the card given is empty.

Definition at line 83 of file patience.sh.

◆ $C_SUCCESS

const $C_SUCCESS = 255

Return value for success.

Todo: Shouldn´t this be 0?? if not add note.

Definition at line 71 of file patience.sh.

◆ $C_TERMINAL_SIZE_ERROR

const $C_TERMINAL_SIZE_ERROR = 245

The size of the terminal is not large enough to show the patience board.

Definition at line 91 of file patience.sh.

Functions

Variables