Dev Branch Documentation# Expert API

Protocol Documentation

Table of Contents

• protos/expert/expert_api.proto

  • CommandList

  • CommandResultList

  • ConditionalCommand

  • ConditionalCommandResult

  • ExpertAPI

• Scalar Value Types

Top

protos/expert/expert_api.proto

RPC calls provided by the Expert API subsystem.

CommandList

ExecuteCommandList call parameters.

Field	Type	Label	Description
playerNumber	int32		player number from 1-8 on which to execute the commands, must be an AI player
commands	google.protobuf.Any	repeated	list of commands to execute on behalf of that player

CommandResultList

ExecuteCommandList call reply.

Field	Type	Label	Description
playerNumber	int32		player number from 1-8 on which the commands were executed on
results	google.protobuf.Any	repeated	list of results for each command in the same order as the originally sent in the command list

ConditionalCommand

An optional structure that can be put in the CommandList message commands list. The server will evaluate the fact and compare it to the specified value using the operator given. The command to be conditionally executed can be anything, including a fact.

Field	Type	Label	Description
fact	google.protobuf.Any
compareOp	string
inConstValue	int32
inGoalValue	int32
inSnValue	int32
command	google.protobuf.Any

ConditionalCommandResult

Field	Type	Label	Description
fired	bool
result	google.protobuf.Any

ExpertAPI

Method Name	Request Type	Response Type	Description
ExecuteCommandList	CommandList	CommandResultList	Send a list of expert actions and facts (commands) to the AI Module. The list will be processed during the next AI tick for the specified player. If that does not occur in 5 seconds, an error code will be returned.

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)