File: ConversationCommandLibrary.h

package info (click to toggle)
darkradiant 3.9.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 41,080 kB
  • sloc: cpp: 264,743; ansic: 10,659; python: 1,852; xml: 1,650; sh: 92; makefile: 21
file content (55 lines) | stat: -rw-r--r-- 1,508 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
#pragma once

#include "ConversationCommandInfo.h"

class wxChoice;

namespace conversation
{

namespace
{
	const std::string GKEY_CONVERSATION_COMMAND_INFO_PREFIX =
		"/conversationSystem/conversationCommandPrefix";
}

/**
 * greebo: This class holds all the possible conversation command types,
 * indexed by name. Each conversation commmand is parsed from an entityDef
 * matching a given prefix and holding a bunch of information about that command.
 *
 * The ConversationCommand editor is using this information to construct
 * the UI elements.
 */
class ConversationCommandLibrary
{
	// The map containing the named information
	ConversationCommandInfoMap _commandInfo;

	// Private constructor, loads all matching entityDefs
	ConversationCommandLibrary();

public:
	// Accessor to the singleton instance
	static ConversationCommandLibrary& Instance();

	/**
	 * Returns the command info with the given typename or ID. Throws an exception if not found.
	 *
	 * @throws: std::runtime error if the named info structure could not be found.
	 */
	const ConversationCommandInfo& findCommandInfo(const std::string& name);
	const ConversationCommandInfo& findCommandInfo(int id);

	/**
	 * greebo: This populates the given choice field with all available commands. The command ID
	 * will be attached to the items as wxStringClientData.
	 */
	void populateChoice(wxChoice* choice);

private:
	// Loads all entityDefs matching the given prefix
	void loadConversationCommands();
};

} // namespace conversation