summaryrefslogtreecommitdiff
path: root/sourcemod/scripting/include/updater.inc
blob: f37bdf2998d6e7663a3097695a7d3813ea64c0d0 (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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
#if defined _updater_included
  #endinput
#endif
#define _updater_included

/**
 * Adds your plugin to the updater. The URL will be updated if 
 * your plugin was previously added.
 *
 * @param url		URL to your plugin's update file.
 * @noreturn
 */
native Updater_AddPlugin(const String:url[]);

/**
 * Removes your plugin from the updater. This does not need to 
 * be called during OnPluginEnd.
 *
 * @noreturn
 */
native Updater_RemovePlugin();

/**
 * Forces your plugin to be checked for updates. The behaviour 
 * of the update is dependant on the server's configuration.
 *
 * @return		True if an update was triggered. False otherwise.
 * @error		Plugin not found in updater.
 */
native bool:Updater_ForceUpdate();

/**
 * Called when your plugin is about to be checked for updates.
 *
 * @return		Plugin_Handled to prevent checking, Plugin_Continue to allow it.
 */
forward Action:Updater_OnPluginChecking();

/**
 * Called when your plugin is about to begin downloading an available update.
 *
 * @return		Plugin_Handled to prevent downloading, Plugin_Continue to allow it.
 */
forward Action:Updater_OnPluginDownloading();

/**
 * Called when your plugin's update files have been fully downloaded 
 * and are about to write to their proper location. This should be used 
 * to free read-only resources that require write access for your update.
 *
 * @note OnPluginUpdated will be called later during the same frame.
 *
 * @noreturn
 */
forward Updater_OnPluginUpdating();

/**
 * Called when your plugin's update has been completed. It is safe
 * to reload your plugin at this time.
 *
 * @noreturn
 */
forward Updater_OnPluginUpdated();

/**
 * @brief Reloads a plugin.
 *
 * @param plugin	Plugin Handle (INVALID_HANDLE uses the calling plugin).
 * @noreturn
 */
stock ReloadPlugin(Handle:plugin=INVALID_HANDLE)
{
	decl String:filename[64];
	GetPluginFilename(plugin, filename, sizeof(filename));
	ServerCommand("sm plugins reload %s", filename);
}


public SharedPlugin:__pl_updater = 
{
	name = "updater",
	file = "updater.smx",
#if defined REQUIRE_PLUGIN
	required = 1,
#else
	required = 0,
#endif
};

#if !defined REQUIRE_PLUGIN
public __pl_updater_SetNTVOptional()
{
	MarkNativeAsOptional("Updater_AddPlugin");
	MarkNativeAsOptional("Updater_RemovePlugin");
	MarkNativeAsOptional("Updater_ForceUpdate");
}
#endif