From aeffcca0162e0f90fea0ed9ec8797b9c8c2cfb93 Mon Sep 17 00:00:00 2001 From: Andrei Karas Date: Tue, 4 Apr 2017 17:37:26 +0300 Subject: Update docs from hercules. --- server/scripts/script_commands.txt | 55 ++++++++++++++++++++++++++++++-------- 1 file changed, 44 insertions(+), 11 deletions(-) (limited to 'server/scripts/script_commands.txt') diff --git a/server/scripts/script_commands.txt b/server/scripts/script_commands.txt index 6df1f6e..581ec18 100644 --- a/server/scripts/script_commands.txt +++ b/server/scripts/script_commands.txt @@ -4321,7 +4321,7 @@ Example: --------------------------------------- -*warpguild("", , , ) +*warpguild("", , , , {""}) Warps a guild to specified map and coordinate given the guild id, which you can get with getcharid(CHAR_ID_GUILD). You can also request another guild id given @@ -4335,9 +4335,12 @@ SavePoint: All guild members are warped to the save point of the currently attached player (will fail if there's no player attached). +If you specify a from_mapname, warpguild() will only affect those on that map. + Example: warpguild("prontera", x, y, Guild_ID); + warpguild("prontera", x, y, Guild_ID, "payon"); // warp member from Payon map only. --------------------------------------- @@ -6475,17 +6478,14 @@ Size is 0 = normal 1 = small 2 = big. //===================================== --------------------------------------- -*addtimer(, "NPC::OnLabel") -*deltimer("NPC::OnLabel") -*addtimercount("NPC::OnLabel", ) +*addtimer(, "NPC::OnLabel"{, }) -These commands will create, destroy, and delay a countdown timer - -addtimer() to create, deltimer() to destroy and addtimercount() to delay -it by the specified number of ticks. For all three cases, the event label -given is the identifier of that timer. The timer runs on the character -object that is attached to the script, and can have multiple instances. -When the label is run, it is run as if the player that the timer runs on -has clicked the NPC. +This command will create a countdown timer. +The event label given is the identifier of that timer. +The timer runs on the character object that is attached to the script, +and can have multiple instances. If is passed, this player +will be used instead. When the label is run, it is run as if the player +that the timer runs on has clicked the NPC. When this timer runs out, a new execution thread will start in the specified NPC object at the specified label. @@ -6509,6 +6509,39 @@ On5secs: --------------------------------------- +*deltimer("NPC::OnLabel"{, }) + +Deletes timers created by addtimer() that matches the given event +label. Refer to addtimer() for additional information. + +--------------------------------------- + +*addtimercount("NPC::OnLabel", {, }) + +Delays a timer that was created with addtimer() by ticks +if it matches the given event label. Refer to addtimer() for additional +information. + +--------------------------------------- + +*gettimer({, {, ""}}) + +Returns informations on timers that were created by addtimer(). + +valid for gettimer() are: + +(0) TIMER_COUNT + Will return the total number of timers for the specified or + attached player. Can be filtered by . +(1) TIMER_TICK_NEXT + Will return the number of ticks until the next timer runs + for the specified or attached player. Can be filtered by . +(2) TIMER_TICK_LAST + Will return the number of ticks until the last timer runs + for the specified or attached player. Can be filtered by . + +--------------------------------------- + *initnpctimer({ "" {, } } | { "" | }) *stopnpctimer({ "" {, } } | -- cgit v1.2.3-70-g09d2