aboutsummaryrefslogtreecommitdiff
path: root/NorthstarDLL/plugin_abi.h
blob: cb7bf8c93d1b53ada5a8cb57b88526c325e940ae (plain)
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
#pragma once
#include <string>

#define ABI_VERSION 1
/// <summary>
/// This enum is used for referencing the different types of objects we can pass to a plugin
/// Anything exposed to a plugin must not a be C++ type, as they could break when compiling with a different compiler.
/// Any ABI incompatible change must increment the version number.
/// Nothing must be removed from this enum, only appended. When it absolutely necessary to deprecate an object, it should return UNSUPPORTED
/// when retrieved
/// </summary>
enum PluginObject
{
	UNSUPPORTED = 0,
	GAMESTATE = 1,
	SERVERINFO = 2,
	PLAYERINFO = 3,
	DUMMY = 0xFFFF
};

enum GameStateInfoType
{
	ourScore = 0,
	secondHighestScore = 1,
	highestScore = 2,
	connected = 3,
	loading = 4,
	map = 5,
	mapDisplayName = 6,
	playlist = 7,
	playlistDisplayName = 8,
	players = 9
};
struct GameState
{
	int (*getGameStateChar)(char* out_buf, size_t out_buf_len, GameStateInfoType var);
	int (*getGameStateInt)(int* out_ptr, GameStateInfoType var);
	int (*getGameStateBool)(bool* out_ptr, GameStateInfoType var);
};

enum ServerInfoType
{
	id = 0,
	name = 1,
	description = 2,
	password = 3,
	maxPlayers = 4,
	roundBased = 5,
	scoreLimit = 6,
	endTime = 7
};
struct ServerInfo
{
	int (*getServerInfoChar)(char* out_buf, size_t out_buf_len, ServerInfoType var);
	int (*getServerInfoInt)(int* out_ptr, ServerInfoType var);
	int (*getServerInfoBool)(bool* out_ptr, ServerInfoType var);
};

enum PlayerInfoType
{
	uid = 0
};
struct PlayerInfo
{
	int (*getPlayerInfoChar)(char* out_buf, size_t out_buf_len, PlayerInfoType var);
	int (*getPlayerInfoInt)(int* out_ptr, PlayerInfoType var);
	int (*getPlayerInfoBool)(bool* out_ptr, PlayerInfoType var);
};