File: ConversationCommandInfo.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 (76 lines) | stat: -rw-r--r-- 1,791 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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
#ifndef CONVERSATION_COMMAND_INFO_H_
#define CONVERSATION_COMMAND_INFO_H_

#include "ieclass.h"
#include <vector>

namespace conversation {

// Information about a single conversation command argument
struct ArgumentInfo
{
	enum ArgumentType {
		ARGTYPE_INT,
		ARGTYPE_FLOAT,
		ARGTYPE_STRING,
		ARGTYPE_VECTOR,
		ARGTYPE_SOUNDSHADER,
		ARGTYPE_ACTOR,
		ARGTYPE_ENTITY,
		ARGTYPE_BOOL,
		NUM_ARGTYPES,
	};

	ArgumentType type;

	std::string description;
	std::string title;

	bool required;
};

/**
 * greebo: This structure holds information about a certain
 * Conversation Command Type (e.g. "WaitSeconds") and its arguments.
 *
 * As the number and type of arguments varies, the CommandEditor GUI
 * needs this structure to build the variable interface.
 */
class ConversationCommandInfo
{
public:
	// The unique id of this conversation command.
	int id;

	// The internal name, like "WaitSeconds" or "InteractWithEntity"
	std::string name;

	// Whether the "wait until finished" checkbox is displayed
	bool waitUntilFinishedAllowed;

	// The "human readable" sentence format (with placeholders)
	std::string sentence;

	typedef std::vector<ArgumentInfo> ArgumentInfoList;
	ArgumentInfoList arguments;

	ConversationCommandInfo() :
		id(++_highestId),
		waitUntilFinishedAllowed(true)
	{}

	// Fills the member variables from the given entityDef
	void parseFromEntityClass(const IEntityClassPtr& eclass);

private:
	// Highest ID so far
	static int _highestId;
};
typedef std::shared_ptr<ConversationCommandInfo> ConversationCommandInfoPtr;

// A mapping between command typenames ("WalkToActor") to actual information structures
typedef std::map<std::string, ConversationCommandInfoPtr> ConversationCommandInfoMap;

} // namespace conversation

#endif /* CONVERSATION_COMMAND_INFO_H_ */