cec42bdcae
* Fixed param information * Removed whitespace that prevented the API to generate client_disconnected information * Fixed documentation. * Update lang.inc * Documentation fix (g/s)et_user_hitzones() functions weren't generating properly in the API due to a whitespace in front of the comment blocks. @return for give item() was missing. * Whitespace prevented API documentation from generating * Update lang.inc
101 lines
4.0 KiB
SourcePawn
101 lines
4.0 KiB
SourcePawn
// vim: set ts=4 sw=4 tw=99 noet:
|
|
//
|
|
// AMX Mod X, based on AMX Mod by Aleksander Naszko ("OLO").
|
|
// Copyright (C) The AMX Mod X Development Team.
|
|
//
|
|
// This software is licensed under the GNU General Public License, version 3 or higher.
|
|
// Additional exceptions apply. For full license details, see LICENSE.txt or visit:
|
|
// https://alliedmods.net/amxmodx-license
|
|
|
|
//
|
|
// Time Specific Functions
|
|
//
|
|
|
|
#if defined _time_included
|
|
#endinput
|
|
#endif
|
|
#define _time_included
|
|
|
|
/* Time unit types for get_time_length() */
|
|
enum
|
|
{
|
|
timeunit_seconds = 0,
|
|
timeunit_minutes,
|
|
timeunit_hours,
|
|
timeunit_days,
|
|
timeunit_weeks,
|
|
};
|
|
|
|
/* Seconds in each time unit */
|
|
#define SECONDS_IN_MINUTE 60
|
|
#define SECONDS_IN_HOUR 3600
|
|
#define SECONDS_IN_DAY 86400
|
|
#define SECONDS_IN_WEEK 604800
|
|
|
|
/**
|
|
* Stock by Brad.
|
|
*
|
|
* @note You must add register_dictionary("time.txt") in plugin_init()
|
|
*
|
|
* @param id The player whose language the length should be translated to
|
|
* @param unitCnt The number of time units you want translated into verbose text
|
|
* @param type The type of unit (i.e. seconds, minutes, hours, days, weeks) that you are passing in
|
|
* @param output The variable you want the verbose text to be placed in
|
|
* @param outputLen The length of the output variable
|
|
*
|
|
* @noreturn
|
|
*/
|
|
stock get_time_length(id, unitCnt, type, output[], outputLen)
|
|
{
|
|
if (unitCnt > 0)
|
|
{
|
|
// determine the number of each time unit there are
|
|
new weekCnt = 0, dayCnt = 0, hourCnt = 0, minuteCnt = 0, secondCnt = 0;
|
|
|
|
switch (type)
|
|
{
|
|
case timeunit_seconds: secondCnt = unitCnt;
|
|
case timeunit_minutes: secondCnt = unitCnt * SECONDS_IN_MINUTE;
|
|
case timeunit_hours: secondCnt = unitCnt * SECONDS_IN_HOUR;
|
|
case timeunit_days: secondCnt = unitCnt * SECONDS_IN_DAY;
|
|
case timeunit_weeks: secondCnt = unitCnt * SECONDS_IN_WEEK;
|
|
}
|
|
|
|
weekCnt = secondCnt / SECONDS_IN_WEEK;
|
|
secondCnt -= (weekCnt * SECONDS_IN_WEEK);
|
|
|
|
dayCnt = secondCnt / SECONDS_IN_DAY;
|
|
secondCnt -= (dayCnt * SECONDS_IN_DAY);
|
|
|
|
hourCnt = secondCnt / SECONDS_IN_HOUR;
|
|
secondCnt -= (hourCnt * SECONDS_IN_HOUR);
|
|
|
|
minuteCnt = secondCnt / SECONDS_IN_MINUTE;
|
|
secondCnt -= (minuteCnt * SECONDS_IN_MINUTE);
|
|
|
|
// translate the unit counts into verbose text
|
|
new maxElementIdx = -1;
|
|
new timeElement[5][33];
|
|
|
|
if (weekCnt > 0)
|
|
format(timeElement[++maxElementIdx], charsmax(timeElement[]), "%i %L", weekCnt, id, (weekCnt == 1) ? "TIME_ELEMENT_WEEK" : "TIME_ELEMENT_WEEKS");
|
|
if (dayCnt > 0)
|
|
format(timeElement[++maxElementIdx], charsmax(timeElement[]), "%i %L", dayCnt, id, (dayCnt == 1) ? "TIME_ELEMENT_DAY" : "TIME_ELEMENT_DAYS");
|
|
if (hourCnt > 0)
|
|
format(timeElement[++maxElementIdx], charsmax(timeElement[]), "%i %L", hourCnt, id, (hourCnt == 1) ? "TIME_ELEMENT_HOUR" : "TIME_ELEMENT_HOURS");
|
|
if (minuteCnt > 0)
|
|
format(timeElement[++maxElementIdx], charsmax(timeElement[]), "%i %L", minuteCnt, id, (minuteCnt == 1) ? "TIME_ELEMENT_MINUTE" : "TIME_ELEMENT_MINUTES");
|
|
if (secondCnt > 0)
|
|
format(timeElement[++maxElementIdx], charsmax(timeElement[]), "%i %L", secondCnt, id, (secondCnt == 1) ? "TIME_ELEMENT_SECOND" : "TIME_ELEMENT_SECONDS");
|
|
|
|
switch(maxElementIdx)
|
|
{
|
|
case 0: formatex(output, outputLen, "%s", timeElement[0]);
|
|
case 1: formatex(output, outputLen, "%s %L %s", timeElement[0], id, "TIME_ELEMENT_AND", timeElement[1]);
|
|
case 2: formatex(output, outputLen, "%s, %s %L %s", timeElement[0], timeElement[1], id, "TIME_ELEMENT_AND", timeElement[2]);
|
|
case 3: formatex(output, outputLen, "%s, %s, %s %L %s", timeElement[0], timeElement[1], timeElement[2], id, "TIME_ELEMENT_AND", timeElement[3]);
|
|
case 4: formatex(output, outputLen, "%s, %s, %s, %s %L %s", timeElement[0], timeElement[1], timeElement[2], timeElement[3], id, "TIME_ELEMENT_AND", timeElement[4]);
|
|
}
|
|
}
|
|
}
|