3 * =============================================================================
4 * SourceMod (C)2004-2008 AlliedModders LLC. All rights reserved.
5 * =============================================================================
7 * This file is part of the SourceMod/SourcePawn SDK.
9 * This program is free software; you can redistribute it and/or modify it under
10 * the terms of the GNU General Public License, version 3.0, as published by the
11 * Free Software Foundation.
13 * This program is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
18 * You should have received a copy of the GNU General Public License along with
19 * this program. If not, see <http://www.gnu.org/licenses/>.
21 * As a special exception, AlliedModders LLC gives you permission to link the
22 * code of this program (as well as its derivative works) to "Half-Life 2," the
23 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
24 * by the Valve Corporation. You must obey the GNU General Public License in
25 * all respects for all other code used. Additionally, AlliedModders LLC grants
26 * this exception to all derivative works. AlliedModders LLC defines further
27 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
28 * or <http://www.sourcemod.net/license.php>.
33 #if defined _clientprefs_included
36 #define _clientprefs_included
39 * Cookie access types for client viewing
43 CookieAccess_Public, /**< Visible and Changeable by users */
44 CookieAccess_Protected, /**< Read only to users */
45 CookieAccess_Private, /**< Completely hidden cookie */
49 * Cookie Prefab menu types
53 CookieMenu_YesNo, /**< Yes/No menu with "yes"/"no" results saved into the cookie */
54 CookieMenu_YesNo_Int, /**< Yes/No menu with 1/0 saved into the cookie */
55 CookieMenu_OnOff, /**< On/Off menu with "on"/"off" results saved into the cookie */
56 CookieMenu_OnOff_Int, /**< On/Off menu with 1/0 saved into the cookie */
62 * An option is being drawn for a menu.
64 * INPUT : Client index and data if available.
65 * OUTPUT: Buffer for rendering, maxlength of buffer.
67 CookieMenuAction_DisplayOption = 0,
70 * A menu option has been selected.
72 * INPUT : Client index and any data if available.
74 CookieMenuAction_SelectOption = 1,
80 * A successful return value/result on any client prefs native only guarantees that the local cache has been updated.
81 * Database connection problems can still prevent the data from being permanently saved. Connection problems will be logged as
82 * errors by the clientprefs extension.
86 * Creates a new Client preference cookie.
88 * @param name Name of the new preference cookie.
89 * @param description Optional description of the preference cookie.
90 * @param access What CookieAccess level to assign to this cookie.
91 * @return A handle to the newly created cookie. If the cookie already exists, a handle to it will still be returned.
92 * @error Cookie name is blank.
94 native Handle:RegClientCookie(const String:name[], const String:description[], CookieAccess:access);
97 * Searches for a Client preference cookie.
99 * @param name Name of cookie to find.
100 * @return A handle to the cookie if it is found. INVALID_HANDLE otherwise.
102 native Handle:FindClientCookie(const String:name[]);
105 * Set the value of a Client preference cookie.
107 * @param client Client index.
108 * @param cookie Client preference cookie handle.
109 * @param value String value to set.
111 * @error Invalid cookie handle or invalid client index.
113 native SetClientCookie(client, Handle:cookie, const String:value[]);
116 * Retrieve the value of a Client preference cookie.
118 * @param client Client index.
119 * @param cookie Client preference cookie handle.
120 * @param buffer Copyback buffer for value.
121 * @param maxlen Maximum length of the buffer.
123 * @error Invalid cookie handle or invalid client index.
125 native GetClientCookie(client, Handle:cookie, String:buffer[], maxlen);
128 * Checks if a clients cookies have been loaded from the database.
130 * @param client Client index.
131 * @return True if loaded, false otherwise.
132 * @error Invalid client index.
134 native bool:AreClientCookiesCached(client);
137 * Called once a client's saved cookies have been loaded from the database.
139 * @param client Client index.
141 forward OnClientCookiesCached(client);
144 * Cookie Menu Callback prototype
146 * @param client Client index.
147 * @param action CookeMenuAction being performed.
148 * @param data Info data passed.
149 * @param buffer Outbut buffer.
150 * @param maxlen Max length of the output buffer.
152 functag CookieMenuHandler public(client, CookieMenuAction:action, any:info, String:buffer[], maxlen);
155 * Add a new prefab item to the client cookie settings menu.
157 * Note: This handles everything automatically and does not require a callback
159 * @param cookie Client preference cookie handle.
160 * @param type A CookieMenu prefab menu type.
161 * @param display Text to show on the menu.
162 * @param handler Optional handler callback for translations and output on selection
163 * @param info Info data to pass to the callback.
165 * @error Invalid cookie handle.
167 native SetCookiePrefabMenu(Handle:cookie, CookieMenu:type, const String:display[], CookieMenuHandler:handler=CookieMenuHandler:-1, info=0);
170 * Adds a new item to the client cookie settings menu.
172 * Note: This only adds the top level menu item. You need to handle any submenus from the callback.
174 * @param handler A MenuHandler callback function.
175 * @param info Data to pass to the callback.
176 * @param display Text to show on the menu.
178 * @error Invalid cookie handle.
180 native SetCookieMenuItem(CookieMenuHandler:handler, any:info, const String:display[]);
183 * Displays the settings menu to a client.
185 * @param client Client index.
188 native ShowCookieMenu(client);
191 * Gets a cookie iterator. Must be freed with CloseHandle().
193 * @return A new cookie iterator.
195 native Handle:GetCookieIterator();
198 * Reads a cookie iterator, then advances to the next cookie if any.
200 * @param iter Cookie iterator Handle.
201 * @param name Name buffer.
202 * @param nameLen Name buffer size.
203 * @param access Access level of the cookie.
204 * @param desc Cookie description buffer.
205 * @param descLen Cookie description buffer size.
207 * @return True on success, false if there are no more commands.
209 native bool:ReadCookieIterator(Handle:iter,
212 &CookieAccess:access,
217 * Returns the access level of a cookie
219 * @param cookie Client preference cookie handle.
220 * @return CookieAccess access level.
221 * @error Invalid cookie handle.
223 native CookieAccess:GetCookieAccess(Handle:cookie);
226 * Do not edit below this line!
228 public Extension:__ext_clientprefs =
230 name = "Client Preferences",
231 file = "clientprefs.ext",
233 #if defined REQUIRE_EXTENSIONS
