4040 */
4141enum CookieAccess
4242{
43- CookieAccess_Public , /* *< Visible and Changeable by users */
44- CookieAccess_Protected , /* *< Read only to users */
45- CookieAccess_Private , /* *< Completely hidden cookie */
43+ CookieAccess_Public , /* *< Visible and Changeable by users */
44+ CookieAccess_Protected , /* *< Read only to users */
45+ CookieAccess_Private /* *< Completely hidden cookie */
4646};
4747
4848/* *
4949 * Cookie Prefab menu types
5050 */
5151enum CookieMenu
5252{
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 */
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 */
5757};
5858
5959enum CookieMenuAction
@@ -71,17 +71,17 @@ enum CookieMenuAction
7171 *
7272 * INPUT : Client index and any data if available.
7373 */
74- CookieMenuAction_SelectOption = 1 ,
74+ CookieMenuAction_SelectOption = 1
7575};
7676
7777/* *
7878 * Cookie Menu Callback prototype
7979 *
80- * @param client Client index.
81- * @param action CookieMenuAction being performed.
82- * @param info Info data passed.
83- * @param buffer Outbut buffer.
84- * @param maxlen Max length of the output buffer.
80+ * @param client Client index.
81+ * @param action CookieMenuAction being performed.
82+ * @param info Info data passed.
83+ * @param buffer Outbut buffer.
84+ * @param maxlen Max length of the output buffer.
8585 */
8686typedef CookieMenuHandler = function void (
8787 int client ,
@@ -176,12 +176,12 @@ methodmap Cookie < Handle {
176176 * Handles returned by RegClientCookie can be closed via CloseHandle() when
177177 * no longer needed.
178178 *
179- * @param name Name of the new preference cookie.
180- * @param description Optional description of the preference cookie.
181- * @param access What CookieAccess level to assign to this cookie.
182- * @return A handle to the newly created cookie. If the cookie already
179+ * @param name Name of the new preference cookie.
180+ * @param description Optional description of the preference cookie.
181+ * @param access What CookieAccess level to assign to this cookie.
182+ * @return A handle to the newly created cookie. If the cookie already
183183 * exists, a handle to it will still be returned.
184- * @error Cookie name is blank.
184+ * @error Cookie name is blank.
185185 */
186186native Handle RegClientCookie (const char [] name , const char [] description , CookieAccess access );
187187
@@ -191,70 +191,69 @@ native Handle RegClientCookie(const char[] name, const char[] description, Cooki
191191 * Handles returned by FindClientCookie can be closed via CloseHandle() when
192192 * no longer needed.
193193 *
194- * @param name Name of cookie to find.
195- * @return A handle to the cookie if it is found. INVALID_HANDLE otherwise.
194+ * @param name Name of cookie to find.
195+ * @return A handle to the cookie if it is found. INVALID_HANDLE otherwise.
196196 */
197197native Handle FindClientCookie (const char [] name );
198198
199199/* *
200200 * Set the value of a Client preference cookie.
201201 *
202- * @param client Client index.
203- * @param cookie Client preference cookie handle.
204- * @param value String value to set.
205- * @error Invalid cookie handle or invalid client index.
202+ * @param client Client index.
203+ * @param cookie Client preference cookie handle.
204+ * @param value String value to set.
205+ * @error Invalid cookie handle or invalid client index.
206206 */
207207native void SetClientCookie (int client , Handle cookie , const char [] value );
208208
209209/* *
210210 * Retrieve the value of a Client preference cookie.
211211 *
212- * @param client Client index.
213- * @param cookie Client preference cookie handle.
214- * @param buffer Copyback buffer for value.
215- * @param maxlen Maximum length of the buffer.
216- * @error Invalid cookie handle or invalid client index.
212+ * @param client Client index.
213+ * @param cookie Client preference cookie handle.
214+ * @param buffer Copyback buffer for value.
215+ * @param maxlen Maximum length of the buffer.
216+ * @error Invalid cookie handle or invalid client index.
217217 */
218218native void GetClientCookie (int client , Handle cookie , char [] buffer , int maxlen );
219219
220220/* *
221221 * Sets the value of a Client preference cookie based on an authID string.
222222 *
223- * @param authID String Auth/STEAM ID of player to set.
224- * @param cookie Client preference cookie handle.
225- * @param value String value to set.
226- * @error Invalid cookie handle.
223+ * @param authID String Auth/STEAM ID of player to set.
224+ * @param cookie Client preference cookie handle.
225+ * @param value String value to set.
226+ * @error Invalid cookie handle.
227227 */
228228native void SetAuthIdCookie (const char [] authID , Handle cookie , const char [] value );
229229
230230/* *
231231 * Checks if a clients cookies have been loaded from the database.
232232 *
233- * @param client Client index.
234- * @return True if loaded, false otherwise.
235- * @error Invalid client index.
233+ * @param client Client index.
234+ * @return True if loaded, false otherwise.
235+ * @error Invalid client index.
236236 */
237237native bool AreClientCookiesCached (int client );
238238
239239/* *
240240 * Called once a client's saved cookies have been loaded from the database.
241241 *
242- * @param client Client index.
242+ * @param client Client index.
243243 */
244244forward void OnClientCookiesCached (int client );
245245
246-
247246/* *
248247 * Add a new prefab item to the client cookie settings menu.
249248 *
250249 * Note: This handles everything automatically and does not require a callback
251250 *
252- * @param cookie Client preference cookie handle.
253- * @param type A CookieMenu prefab menu type.
254- * @param display Text to show on the menu.
255- * @param handler Optional handler callback for translations and output on selection
256- * @param info Info data to pass to the callback.
257- * @error Invalid cookie handle.
251+ * @param cookie Client preference cookie handle.
252+ * @param type A CookieMenu prefab menu type.
253+ * @param display Text to show on the menu.
254+ * @param handler Optional handler callback for translations and output on selection
255+ * @param info Info data to pass to the callback.
256+ * @error Invalid cookie handle.
258257 */
259258native void SetCookiePrefabMenu (Handle cookie , CookieMenu type , const char [] display , CookieMenuHandler handler =INVALID_FUNCTION , any info =0 );
260259
@@ -263,60 +262,60 @@ native void SetCookiePrefabMenu(Handle cookie, CookieMenu type, const char[] dis
263262 *
264263 * Note: This only adds the top level menu item. You need to handle any submenus from the callback.
265264 *
266- * @param handler A MenuHandler callback function.
267- * @param info Data to pass to the callback.
268- * @param display Text to show on the menu.
269- * @error Invalid cookie handle.
265+ * @param handler A MenuHandler callback function.
266+ * @param info Data to pass to the callback.
267+ * @param display Text to show on the menu.
268+ * @error Invalid cookie handle.
270269 */
271270native void SetCookieMenuItem (CookieMenuHandler handler , any info , const char [] display );
272271
273272/* *
274273 * Displays the settings menu to a client.
275274 *
276- * @param client Client index.
275+ * @param client Client index.
277276 */
278277native void ShowCookieMenu (int client );
279278
280279/* *
281280 * Gets a cookie iterator. Must be freed with CloseHandle().
282281 *
283- * @return A new cookie iterator.
282+ * @return A new cookie iterator.
284283 */
285284native Handle GetCookieIterator ();
286285
287286/* *
288287 * Reads a cookie iterator, then advances to the next cookie if any.
289288 *
290- * @param iter Cookie iterator Handle.
291- * @param name Name buffer.
292- * @param nameLen Name buffer size.
293- * @param access Access level of the cookie.
294- * @param desc Cookie description buffer.
295- * @param descLen Cookie description buffer size.
296- * @return True on success, false if there are no more commands.
289+ * @param iter Cookie iterator Handle.
290+ * @param name Name buffer.
291+ * @param nameLen Name buffer size.
292+ * @param access Access level of the cookie.
293+ * @param desc Cookie description buffer.
294+ * @param descLen Cookie description buffer size.
295+ * @return True on success, false if there are no more commands.
297296 */
298297native bool ReadCookieIterator (Handle iter ,
299298 char [] name ,
300299 int nameLen ,
301300 CookieAccess &access ,
302301 char [] desc =" " ,
303302 int descLen =0 );
304-
303+
305304/* *
306305 * Returns the access level of a cookie
307306 *
308- * @param cookie Client preference cookie handle.
309- * @return CookieAccess access level.
310- * @error Invalid cookie handle.
307+ * @param cookie Client preference cookie handle.
308+ * @return CookieAccess access level.
309+ * @error Invalid cookie handle.
311310 */
312311native CookieAccess GetCookieAccess (Handle cookie );
313312
314313/* *
315314 * Returns the last updated timestamp for a client cookie
316315 *
317- * @param client Client index.
318- * @param cookie Cookie handle.
319- * @return Last updated timestamp.
316+ * @param client Client index.
317+ * @param cookie Cookie handle.
318+ * @return Last updated timestamp.
320319 */
321320native int GetClientCookieTime (int client , Handle cookie );
322321
0 commit comments