Help and Related Stuff

Help files, help text.... More...

Classes
struct	help_entry

Functions
struct help_entry *	help_find (char *keyword)
void	help_cmd (char *cmd, char *help, size_t help_sz)
void	help_usage (char *help, size_t help_sz)

Variables
const char *	help_chatlog_warning
const char *	help_chatlog_enabled
const char *	help_chatlog_enable_error
const char *	help_mainscreen
const char *	help_invfull_on
const char *	help_invfull_off
struct help_entry	help_commands []

Detailed Description

Help files, help text....

Function Documentation

void help_cmd	(	char *	cmd,
		char *	help,
		size_t	help_sz
	)

This function returns the help for command cmd into the buffer pointed to by help

Parameters

[in]	cmd	Help topic/command to search the help for
[out]	help	Help string
[in]	help_sz	Size of the buffer pointed to by help

struct help_entry* help_find

(

char *

keyword)

Find help text for keyword

Parameters

[in]

keyword

Help topic

Returns

This function returns a pointer to a help_entry structure or NULL if help not found

void help_usage	(	char *	help,
		size_t	help_sz
	)

Generate a list of all topics available and store it to the help variable

Parameters

[out]	help	Variable pointing to the buffer where to save the help text
[in]	help_sz	Space available for the help text in bytes

Variable Documentation

const char* help_chatlog_enable_error

Initial value:

=
"Error enabling the chatlog. Restart the application to try again.\n"

Error enabling chatlog

const char* help_chatlog_enabled

Initial value:

=
"The chatlog is now enabled. You must restart the AION game client\n"
"in order to apply the new settings.\n"
"\n"
"At any point in time, you can remove the SYSTEM.OVR file in\n"
"the client directory to disable the chatlog.\n"
"\n"

Chatlog enabled help text

const char* help_chatlog_warning

Initial value:

=
"!!!!! WARNING!!!!!! !!!!! WARNING!!!!!! !!!!! WARNING!!!!!! \n"
"\n"
"USE THIS APPLICATION AT YOUR OWN RISK\n"
"\n"
"The chatlog feature of the AION client must be enable in order for"
" APme to work properly.\n"
"\n"
"Unofficially, representatives from NCSoft and later Gameforge confirmed that"
" the use of chatlog and chatlog parsers is *tolerated*, but they reserve the"
" right to change this policy at any time without notice.\n"
"\n"
"Do you wish to enable the chatlog feature of the AION client?\n"
"\n"

Chatlog warning text

struct help_entry help_commands[]

This is the help used for the ?help command

const char* help_invfull_off

Initial value:

= 
"OFF: Users with full inventory will be warned only."

Inventory full policy disabled text

const char* help_invfull_on

Initial value:

=
"ON: Users with full inventory will be temporarily excluded from the AP fair loot system."

Inventory full policy enabled text

const char* help_mainscreen

Initial value:

= 
"Type \"?command <PARAMS>\", selecte the text and copy-paste.\nFor more info, please use the \"?help <TOPIC>\" command.\n"

Main screen help