From 79b69495bbc5d758529a485eb1144bd64b8ea50f Mon Sep 17 00:00:00 2001 From: KirieZ Date: Sun, 5 Mar 2017 20:23:30 -0300 Subject: Added getcalendartime script command Signed-off-by: Haru --- doc/script_commands.txt | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) (limited to 'doc/script_commands.txt') diff --git a/doc/script_commands.txt b/doc/script_commands.txt index 310af13cc..9148e023c 100644 --- a/doc/script_commands.txt +++ b/doc/script_commands.txt @@ -3408,6 +3408,30 @@ Example : --------------------------------------- +*getcalendartime(, {, {, }}) + +This function returns the timestamp of the next ocurrence of given time. + +Day of Month specifies a day between 1 and 31 in the future, by default its value is -1 (don't use). +Day of Week specifies a day in the week and its valid values are: + 0 - SUNDAY + 1 - MONDAY + 2 - TUESDAY + 3 - WEDNESDAY + 4 - THURSDAY + 5 - FRIDAY + 6 - SATURDAY + +In order to use Day of Week, you must use Day of Month as -1. +If for some reason the command fails, it'll return -1. + +Examples : + getcalendartime(19, 00); // Next 7 pm + getcalendartime(19, 00, 6); // Next day 6 of the month, at 7pm + getcalendartime(19, 10, -1, 1); // Next Monday, at 7:10pm + +--------------------------------------- + *gettimestr(, ) This function will return a string containing time data as specified by -- cgit v1.2.3-60-g2f50