dvander@2168: /**
dvander@2168: * vim: set ts=4 :
dvander@2168: * =============================================================================
dvander@2168: * SourceMod (C)2004-2008 AlliedModders LLC. All rights reserved.
dvander@2168: * =============================================================================
dvander@2168: *
dvander@2168: * This file is part of the SourceMod/SourcePawn SDK.
dvander@2168: *
dvander@2168: * This program is free software; you can redistribute it and/or modify it under
dvander@2168: * the terms of the GNU General Public License, version 3.0, as published by the
dvander@2168: * Free Software Foundation.
dvander@2168: *
dvander@2168: * This program is distributed in the hope that it will be useful, but WITHOUT
dvander@2168: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
dvander@2168: * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
dvander@2168: * details.
dvander@2168: *
dvander@2168: * You should have received a copy of the GNU General Public License along with
dvander@2168: * this program. If not, see .
dvander@2168: *
dvander@2168: * As a special exception, AlliedModders LLC gives you permission to link the
dvander@2168: * code of this program (as well as its derivative works) to "Half-Life 2," the
dvander@2168: * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
dvander@2168: * by the Valve Corporation. You must obey the GNU General Public License in
dvander@2168: * all respects for all other code used. Additionally, AlliedModders LLC grants
dvander@2168: * this exception to all derivative works. AlliedModders LLC defines further
dvander@2168: * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
dvander@2168: * or .
dvander@2168: *
dvander@2168: * Version: $Id$
dvander@2168: */
dvander@2168:
dvander@2168: #if defined _clientprefs_included
dvander@2168: #endinput
dvander@2168: #endif
dvander@2168: #define _clientprefs_included
dvander@2168:
dvander@2168: /**
dvander@2168: * Cookie access types for client viewing
dvander@2168: */
dvander@2168: enum CookieAccess
dvander@2168: {
dvander@2168: CookieAccess_Public, /**< Visible and Changeable by users */
dvander@2168: CookieAccess_Protected, /**< Read only to users */
dvander@2168: CookieAccess_Private, /**< Completely hidden cookie */
dvander@2168: };
dvander@2168:
dvander@2168: /**
dvander@2168: * Cookie Prefab menu types
dvander@2168: */
dvander@2168: enum CookieMenu
dvander@2168: {
dvander@2168: CookieMenu_YesNo, /**< Yes/No menu with "yes"/"no" results saved into the cookie */
dvander@2168: CookieMenu_YesNo_Int, /**< Yes/No menu with 1/0 saved into the cookie */
dvander@2168: CookieMenu_OnOff, /**< On/Off menu with "on"/"off" results saved into the cookie */
dvander@2168: CookieMenu_OnOff_Int, /**< On/Off menu with 1/0 saved into the cookie */
dvander@2168: };
dvander@2168:
dvander@2168: enum CookieMenuAction
dvander@2168: {
dvander@2168: /**
dvander@2168: * An option is being drawn for a menu.
dvander@2168: *
dvander@2168: * INPUT : Client index and data if available.
dvander@2168: * OUTPUT: Buffer for rendering, maxlength of buffer.
dvander@2168: */
dvander@2168: CookieMenuAction_DisplayOption = 0,
dvander@2168:
dvander@2168: /**
dvander@2168: * A menu option has been selected.
dvander@2168: *
dvander@2168: * INPUT : Client index and any data if available.
dvander@2168: */
dvander@2168: CookieMenuAction_SelectOption = 1,
dvander@2168: };
dvander@2168:
dvander@2168: /**
dvander@2168: * Creates a new Client preference cookie.
dvander@2168: *
dvander@2168: * @param name Name of the new preference cookie.
dvander@2168: * @param description Optional description of the preference cookie.
dvander@2168: * @param access What CookieAccess level to assign to this cookie.
dvander@2168: * @return A handle to the newly created cookie. If the cookie already exists, a handle to it will still be returned.
dvander@2168: * @error Cookie name is blank.
dvander@2168: */
dvander@2168: native Handle:RegClientCookie(const String:name[], const String:description[], CookieAccess:access);
dvander@2168:
dvander@2168: /**
dvander@2168: * Searches for a Client preference cookie.
dvander@2168: *
dvander@2168: * @param name Name of cookie to find.
dvander@2168: * @return A handle to the cookie if it is found. INVALID_HANDLE otherwise.
dvander@2168: */
dvander@2168: native Handle:FindClientCookie(const String:name[]);
dvander@2168:
dvander@2168: /**
dvander@2168: * Set the value of a Client preference cookie.
dvander@2168: *
dvander@2168: * @param client Client index.
dvander@2168: * @param cookie Client preference cookie handle.
dvander@2168: * @param value String value to set.
dvander@2168: * @noreturn
dvander@2168: * @error Invalid cookie handle or invalid client index.
dvander@2168: */
dvander@2168: native SetClientCookie(client, Handle:cookie, const String:value[]);
dvander@2168:
dvander@2168: /**
dvander@2168: * Retrieve the value of a Client preference cookie.
dvander@2168: *
dvander@2168: * @param client Client index.
dvander@2168: * @param cookie Client preference cookie handle.
dvander@2168: * @param buffer Copyback buffer for value.
dvander@2168: * @param maxlen Maximum length of the buffer.
dvander@2168: * @noreturn
dvander@2168: * @error Invalid cookie handle or invalid client index.
dvander@2168: */
dvander@2168: native GetClientCookie(client, Handle:cookie, String:buffer[], maxlen);
dvander@2168:
dvander@2168: /**
dvander@2168: * Checks if a clients cookies have been loaded from the database.
dvander@2168: *
dvander@2168: * @param client Client index.
dvander@2168: * @return True if loaded, false otherwise.
dvander@2168: * @error Invalid client index.
dvander@2168: */
dvander@2168: native bool:AreClientCookiesCached(client);
dvander@2168:
dvander@2168: /**
dvander@2168: * Called once a client's saved cookies have been loaded from the database.
dvander@2168: *
dvander@2168: * @param client Client index.
dvander@2168: */
dvander@2168: forward OnClientCookiesCached(client);
dvander@2168:
dvander@2168: /**
dvander@2168: * Cookie Menu Callback prototype
dvander@2168: *
dvander@2168: * @param client Client index.
dvander@2168: * @param action CookeMenuAction being performed.
dvander@2168: * @param data Info data passed.
dvander@2168: * @param buffer Outbut buffer.
dvander@2168: * @param maxlen Max length of the output buffer.
dvander@2168: */
dvander@2168: functag CookieMenuHandler public(client, CookieMenuAction:action, any:info, String:buffer[], maxlen);
dvander@2168:
dvander@2168: /**
dvander@2168: * Add a new prefab item to the client cookie settings menu.
dvander@2168: *
dvander@2168: * Note: This handles everything automatically and does not require a callback
dvander@2168: *
dvander@2168: * @param cookie Client preference cookie handle.
dvander@2168: * @param type A CookieMenu prefab menu type.
dvander@2168: * @param display Text to show on the menu.
dvander@2168: * @param handler Optional handler callback for translations and output on selection
dvander@2168: * @param info Info data to pass to the callback.
dvander@2168: * @noreturn
dvander@2168: * @error Invalid cookie handle.
dvander@2168: */
dvander@2168: native SetCookiePrefabMenu(Handle:cookie, CookieMenu:type, const String:display[], CookieMenuHandler:handler=CookieMenuHandler:-1, info=0);
dvander@2168:
dvander@2168: /**
dvander@2168: * Adds a new item to the client cookie settings menu.
dvander@2168: *
dvander@2168: * Note: This only adds the top level menu item. You need to handle any submenus from the callback.
dvander@2168: *
dvander@2168: * @param handler A MenuHandler callback function.
dvander@2168: * @param info Data to pass to the callback.
dvander@2168: * @param display Text to show on the menu.
dvander@2168: * @noreturn
dvander@2168: * @error Invalid cookie handle.
dvander@2168: */
dvander@2168: native SetCookieMenuItem(CookieMenuHandler:handler, any:info, const String:display[]);
dvander@2168:
dvander@2168: /**
dvander@2168: * Displays the settings menu to a client.
dvander@2168: *
dvander@2168: * @param client Client index.
dvander@2168: * @noreturn
dvander@2168: */
dvander@2168: native ShowCookieMenu(client);
dvander@2168:
dvander@2168: /**
dvander@2168: * Gets a cookie iterator. Must be freed with CloseHandle().
dvander@2168: *
dvander@2168: * @return A new cookie iterator.
dvander@2168: */
dvander@2168: native Handle:GetCookieIterator();
dvander@2168:
dvander@2168: /**
dvander@2168: * Reads a cookie iterator, then advances to the next cookie if any.
dvander@2168: *
dvander@2168: * @param iter Cookie iterator Handle.
dvander@2168: * @param name Name buffer.
dvander@2168: * @param nameLen Name buffer size.
dvander@2168: * @param access Access level of the cookie.
dvander@2168: * @param desc Cookie description buffer.
dvander@2168: * @param descLen Cookie description buffer size.
dvander@2168: * @param
dvander@2168: * @return True on success, false if there are no more commands.
dvander@2168: */
dvander@2168: native bool:ReadCookieIterator(Handle:iter,
dvander@2168: String:name[],
dvander@2168: nameLen,
dvander@2168: &CookieAccess:access,
dvander@2168: String:desc[]="",
dvander@2168: descLen=0);
dvander@2168:
dvander@2168: /**
dvander@2168: * Returns the access level of a cookie
dvander@2168: *
dvander@2168: * @param cookie Client preference cookie handle.
dvander@2168: * @return CookieAccess access level.
dvander@2168: * @error Invalid cookie handle.
dvander@2168: */
dvander@2168: native CookieAccess:GetCookieAccess(Handle:cookie);
dvander@2168:
dvander@2168: /**
dvander@2168: * Do not edit below this line!
dvander@2168: */
dvander@2168: public Extension:__ext_clientprefs =
dvander@2168: {
dvander@2168: name = "Client Preferences",
dvander@2168: file = "clientprefs.ext",
dvander@2168: autoload = 1,
dvander@2168: #if defined REQUIRE_EXTENSIONS
dvander@2168: required = 1,
dvander@2168: #else
dvander@2168: required = 0,
dvander@2168: #endif
dvander@2168: };