From 34037c40d28c9fe179d930949320090448b249e9 Mon Sep 17 00:00:00 2001 From: Haru Date: Sun, 15 Nov 2015 00:54:33 +0100 Subject: Fixed too-generic constant names of gettime() types - Follow-up to 3bd77ffc0daca508352834add828766490075aee - The names were too generic (not namespaced), and were easily clashing with custom (and potential future official) constants or variables. - Constants are now prefixed with a 'GETTIME_' namespace: - GETTIME_SECOND - GETTIME_MINUTE - GETTIME_HOUR - GETTIME_WEEKDAY - GETTIME_DAYOFMONTH - GETTIME_MONTH - GETTIME_YEAR - GETTIME_DAYOFYEAR - Fixed some excessive (and some times incorrect) parentheses in various scripts using gettime(). - Updated documentation. Signed-off-by: Haru --- doc/sample/npc_test_time.txt | 26 +++++++-------- doc/script_commands.txt | 38 +++++++++++----------- doc/woe_time_explanation.txt | 77 +++++++++++++++++++++----------------------- 3 files changed, 67 insertions(+), 74 deletions(-) (limited to 'doc') diff --git a/doc/sample/npc_test_time.txt b/doc/sample/npc_test_time.txt index 2af1dadd8..c3d4eae1d 100644 --- a/doc/sample/npc_test_time.txt +++ b/doc/sample/npc_test_time.txt @@ -3,23 +3,23 @@ //===== By: ================================================== //= rAthena Dev Team //===== Current Version: ===================================== -//= 20070315 -//===== Description: ========================================= +//= 20151115 +//===== Description: ========================================= //= Demonstrates time commands. //============================================================ prontera,157,181,6 script Time Sample 8W_SOLDIER,{ mes "[Time Sample]"; - mes "System Tick : " + gettimetick(0); - mes " Time Tick : " + gettimetick(1); - mes " GetTime(0) : " + gettime(0); - mes " GetTime(1) : " + gettime(1) + " (Sec)"; - mes " GetTime(2) : " + gettime(2) + " (Min)"; - mes " GetTime(3) : " + gettime(3) + " (Hour)"; - mes " GetTime(4) : " + gettime(4) + " (WeekDay)"; - mes " GetTime(5) : " + gettime(5) + " (MonthDay)"; - mes " GetTime(6) : " + gettime(6) + " (Month)"; - mes " GetTime(7) : " + gettime(7) + " (Year)"; - mes " GetTimeStr : " + gettimestr("%Y-%m/%d %H:%M:%S",19); + mes " System Tick : " + gettimetick(0); + mes " Time Tick : " + gettimetick(1); + mes " GETTIME_SECOND : " + gettime(GETTIME_SECOND) + " (Sec)"; + mes " GETTIME_MINUTE : " + gettime(GETTIME_MINUTE) + " (Min)"; + mes " GETTIME_HOUR : " + gettime(GETTIME_HOUR) + " (Hour)"; + mes " GETTIME_WEEKDAY : " + gettime(GETTIME_WEEKDAY) + " (WeekDay)"; + mes "GETTIME_DAYOFMONTH : " + gettime(GETTIME_DAYOFMONTH) + " (MonthDay)"; + mes " GETTIME_MONTH : " + gettime(GETTIME_MONTH) + " (Month)"; + mes " GETTIME_YEAR : " + gettime(GETTIME_YEAR) + " (Year)"; + mes " GETTIME_DAYOFYEAR : " + gettime(GETTIME_DAYOFYEAR) + " (Day of Year)"; + mes " gettimestr : " + gettimestr("%Y-%m/%d %H:%M:%S",19); close; } diff --git a/doc/script_commands.txt b/doc/script_commands.txt index 5219eed47..dff4461af 100644 --- a/doc/script_commands.txt +++ b/doc/script_commands.txt @@ -3181,30 +3181,28 @@ Valid types are : This function returns specified information about the current system time. -Valid types are listed in const.txt: - 1 - SECOND - Seconds (of a minute) - 2 - MINUTE - Minutes (of an hour) - 3 - HOUR - Hour (of a day) - 4 - WEEKDAY - Week day (0 for Sunday, 6 is Saturday) - - Additional: (SUNDAY,MONDAY,TUESDAY,WEDNESDAY,THURSDAY,FRIDAY,SATURDAY) - 5 - DAYOFMONTH - Day of the month. - 6 - MONTH - Number of the month. - - Additional: ( JANUARY,FEBRUARY,MARCH,APRIL,MAY,JUNE,JULY,AUGUST,SEPTEMBER,OCTOBER,NOVEMBER,DECEMBER) - 7 - YEAR - Year. - 8 - DAYOFYEAR - Day of the year. +Valid types: + 1 - GETTIME_SECOND - Seconds (of a minute) + 2 - GETTIME_MINUTE - Minutes (of an hour) + 3 - GETTIME_HOUR - Hour (of a day) + 4 - GETTIME_WEEKDAY - Week day (0 for Sunday, 6 is Saturday) + - Additional: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY + 5 - GETTIME_DAYOFMONTH - Day of the month. + 6 - GETTIME_MONTH - Number of the month. + - Additional: JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER + 7 - GETTIME_YEAR - Year + 8 - GETTIME_DAYOFYEAR - Day of the year. It will only return numbers based on types. Example : - if ( gettime(WEEKDAY) == SATURDAY ) { + if (gettime(GETTIME_WEEKDAY) == SATURDAY) { mes "It's a Saturday. I don't work on Saturdays."; + } else if (gettime(GETTIME_MONTH) == JANUARY) { + mes "It's January. I don't work on January."; + } else if (gettime(GETTIME_MONTH) == OCTOBER && gettime(GETTIME_DAYOFMONTH) == 31) { + mes "It's Halloween."; } - else if ( gettime(MONTH) == JANUARY ) { - mes "It's a January. I don't work on January."; - } - else if ( gettime(MONTH) == OCTOBER && gettime(DAYOFMONTH) == 31 ) { - mes "It's a Halloween."; - } - + --------------------------------------- *gettimestr(,) @@ -7578,7 +7576,7 @@ OnClock0600: end; OnInit: // setting correct mode upon server start-up - if(gettime(3)>=6 && gettime(3)<18) end; + if (gettime(GETTIME_HOUR) >= 6 && gettime(GETTIME_HOUR) < 18) end; OnClock1800: night; end; diff --git a/doc/woe_time_explanation.txt b/doc/woe_time_explanation.txt index 9f288eae7..d030355f8 100644 --- a/doc/woe_time_explanation.txt +++ b/doc/woe_time_explanation.txt @@ -3,7 +3,7 @@ //===== By: ================================================== //= erKURITA //===== Current Version: ===================================== -//= 20120717 +//= 20151115 //===== Description: ========================================= //= Details on the behavior of the default WoE controller. //============================================================ @@ -15,19 +15,8 @@ OnClock