List pet eggs in your inventory

Just like signed items, which use 255 or 254 in the card1 field


Hercules Pet egg uses -256 in the card1 field
rathena use 256 ... without the negative

the earliest ... traceable topic is over here
https://rathena.org/board/topic/76954-can-i-request-script-evolution-pet/?sortby=date

and now for the latest script available...
https://drive.google.com/file/d/1hQgJO4MbHIQtymKxnsrxsi37nkJ1eruz/view

the way to retrieve the pet ID is almost similar to the signed item

Signed Item
card1 = 255 or 254
card2 = star crumb + element
card3 = CHAR_ID & (( 1 << 16 ) -1)
card4 = CHAR_ID >> 16

Pet ID
card1 = -256 (Hercules) or 256 (rAthena)
card2 = CHAR_ID & (( 1 << 16 ) -1)
card3 = CHAR_ID >> 16
card4 = 0

External Links:

Pet egg renewal fixing

Hercules script engine is case-sensitive, rAthena isn't

I still remember when I was still Scripting Moderator in rAthena, there was this old bug report ...
...  after rAthena switched to IPB4 ... forum bug tracker down ....
anyway, it goes like this

Joseph open a bug report, claiming some official script doesn't execute the monster label properly
after some debate between the developers, I posted a script and prove them it is true
prontera,155,185,5 script qwer 1_F_MARIA,{ monster "this",-1,-1, "--ja--", 1002, 1, "qwer::OnDead"; end; OnDead: dispbottom "1"; end; } prontera,157,185,5 script asdf 1_F_MARIA,{ monster "this",-1,-1, "--ja--", 1002, 1, "asdf::Ondead"; end; Ondead: dispbottom "2"; end; }make one npc with the capital letter, and another one without capital letter -> OnDead - Ondead
click on 'asdf' npc, after kill the monster, the map-server.exe spam error
[Error]: npc_event: event not found [asdf::Ondead]BrianL immediately add tag [Confirmed] and [Severity-Medium] to this bug report
within a few weeks, both Euphy and Joseph fix all the npc scripts in the emulator, and they mark it as [Solved]

..... the truth is, if you try the above script in latest rAthena, this bug still happen TODAY
this bug can't reproduce in Hercules because Hercules has case-sensitive script engine



Now let's talk about how crazy the script can be, if the script engine is not case-sensitive

prontera,150,185,5 script kjhdsfks 1_F_MARIA,{ .@MobID = 1002; mOnSteR "this",-1,-1, "--ja--", .@mobid, 1; SC_Start sc_blessing, 3000,10; sLeep 3000; if ( MobCount( strnpcINFO(4), "all" ) ) Killmonster STRnpcinfo(4), "All"; end; }other than npc header, 'prontera' and '1_F_MARIA',
script commands, labels, variables and constants are case-insensitive in rAthena
strings that enclosed in " double-quotation mark are not affected
means "this" "--ja--" "all" "All" still has to retain its format


prontera,152,185,5 script kjhdsfks 1_F_MARIA,{ if (true) goto L_Asdf; end; L_asdf: dispbottom "1"; end; L_Asdf: dispbottom "2"; end; }This will throw duplicate label error in rAthena
in Hercules, click on the npc will display "2" properly

So, rAthena users, remember, don't simply use Onmobdead: label in your scripts
because official script already uses OnMobDead, OnMyMobDead, ... etc
... anyways, any official script already using that label name, Don't change into small letters in your scripts


... btw, SQL commands are still case-insensitive,
so me as Hercules user still uses small letters in *query_sql script commands

External Links:

Player Checker NPC
... once rAthena forum bug tracker up, will post that bug tracker ID here ...

messagecolor

make the NPC or monster object display chat-box in colorize message

prontera,155,185,5 script kjsdhfksjf 1_F_MARIA,{ messagecolor getcharid(3), "asdfasdf", C_BLUE; messagecolor getnpcid(), "asdfasdf", C_BLUE; messagecolor getnpcid(), "asdfasdf", C_RED; messagecolor getnpcid(), "asdfasdf", C_YELLOW; messagecolor getnpcid(), "asdfasdf", C_PINK; messagecolor getnpcid(), "asdfasdf", C_PURPLE; messagecolor getnpcid(), "asdfasdf", C_ORANGE; end; }

Download :

Hercules Plugin
rAthena Patch

Note: this 0.3 version can display chat-box for the player
however the chat-box above your head isn't colorize because there are no known way to do it

Hercules' @fontcolor actually use a trick to disguise the player
https://github.com/HerculesWS/Hercules/issues/1217
https://github.com/HerculesWS/Hercules/issues/1930
and it has some bugs, so its better not to emulate that pattern
.... apparently rAthena @fontcolor is broken ...

What is dynamic_mob and how it affects scripts

What is dynamic_mob ?

conf/map/battle/monster.conf
// Dynamic Mobs Options // Use dynamic mobs? (recommended for small-medium sized servers) dynamic_mobs: true // Remove Mobs even if they are hurt mob_remove_damaged: true // Delay before removing mobs from empty maps (default 5 min = 300 secs) mob_remove_delay: 300000
This setting means, monsters only spawn on the map when there is a player warp in.
if the map is left empty for 5 minutes, all dynamic spawned monsters, except spawn by boss_monster will remove from the map

it is recommend to turn on dynamic_mob because it help save memory on your live server

Example:
guild_vs2,0,0,0,0 monster Poring 1002,1,0,0,"asdf::On111" guild_vs2,0,0,0,0 boss_monster Golden Thief Bug 1086,1,20000,10000,"asdf::On222" - script asdf FAKE_NPC,{ OnInit: monster "guild_vs2", 0,0, "--ja--", POPORING, 1, strnpcinfo(NPC_NAME)+"::On333"; bindatcmd "asdf", strnpcinfo(NPC_NAME)+"::Onaaa"; end; Onaaa: dispbottom mobcount( "guild_vs2", "asdf::On111" ) +""; dispbottom mobcount( "guild_vs2", "asdf::On222" ) +""; dispbottom mobcount( "guild_vs2", "asdf::On333" ) +""; end; On111: On222: On333: end; }
Let's say you login in Prontera town, and type "@asdf", poring and golden_bug are not spawn, only poporing has been spawn
"@rura guild_vs2", warp into the map, all 3 monsters are spawned
"@go 0", return to prontera, after 5 minutes, the poring is remove from the map, only golden_bug and poporing remain
"@reloadscript", return everything as normal, only poporing remain

This means :-
1. All monster spawn dynamically are affected by dynamic_mob, *monster script command are not affected
2. once a player warp into the map, all monsters will spawn normally
3. after 5 minutes the map left empty, all non-boss_monster will be remove

This can cause problem to the script if you want to count how many monsters left in the map
because dynamic_mob will NOT load the monster until a player warp into the map

External Links:

mobs on server start
MVP board

Allow OnNPCKillEvent to increase kill counter for party members

I still see a lot members struggle with this issue,
however this is entirely done with scripting alone

this is a normal template to increase kill counter normally for the killer alone prontera,155,185,5 script kjsfhksh 1_F_MARIA,{ dispbottom "You have total kill "+ poring_kill +" poring"; end; OnNPCKillEvent: if ( killedrid == PORING ) ++poring_kill; end; }

and this is for party supportprontera,155,185,5 script kjsfhksh 1_F_MARIA,{ dispbottom "You have total kill "+ poring_kill +" poring"; end; OnNPCKillEvent: .@pid = getcharid(CHAR_ID_PARTY); if ( !.@pid ) { if ( killedrid == PORING ) ++poring_kill; } else { .@killedrid = killedrid; getpartymember .@pid, 1; getpartymember .@pid, 2; getmapxy .@map1$, .@x1, .@y1, UNITTYPE_PC; for ( .@i = 0; .@i < $@partymembercount; ++.@i ) { if ( isloggedin( $@partymemberaid[.@i], $@partymembercid[.@i] ) ) { attachrid $@partymemberaid[.@i]; getmapxy .@map2$, .@x2, .@y2, UNITTYPE_PC; if ( .@map1$ == .@map2$ && distance( .@x1, .@y1, .@x2, .@y2 ) <= 30 && Hp ) { if ( .@killedrid == PORING ) { ++poring_kill; } } } } } end; }

Now to break it down part by part

.@pid = getcharid(CHAR_ID_PARTY); if ( !.@pid ) { if ( killedrid == PORING ) ++poring_kill; }this part is obvious, prevent *getpartymember throw error when the player doesn't own a party



.@killedrid = killedrid;change the scope of the killedrid from player based to script state
so there is no need to use *getvariableofpc (hercules) or *getvar (rAthena)


getpartymember .@pid, 1; getpartymember .@pid, 2; for ( .@i = 0; .@i < $@partymembercount; ++.@i ) { if ( isloggedin( $@partymemberaid[.@i], $@partymembercid[.@i] ) ) { attachrid $@partymemberaid[.@i];copy paste this part from script commands.txt

// loop through both and use 'isloggedin' to count online party members
    for (.@i = 0; .@i < $@partymembercount; ++.@i)
        if (isloggedin($@partymemberaid[.@i], $@partymembercid[.@i]))
            .@count_online++;
// We search accountID & charID because a single party can have
// multiple characters from the same account. Without searching
// through the charID, if a player has 2 characters from the same
// account inside the party but only 1 char online, it would count
// their online char twice.



if ( .@map1$ == .@map2$ && distance( .@x1, .@y1, .@x2, .@y2 ) <= 30 && Hp ) { the first 2 conditions is to check the party members are within range of the killer
means if the attached party member having same map with the killer, and within 30 cells of the killer

Why 30 ?? this is actually a magical number
you see, because the OnNPCKillEvent return the mob ID (1002) instead of game ID (11000021)
we can't really use mob controller system to retrieve the coordinate of the monster
so we use the range from the killer instead
I have actually tried to use getbattleflag("area_size") before, but players complained it doesn't work
so I increased the distance to 30 (about twice the length), and they say the script is fixed
weird ... I know, so the number 30 is kinda stuck in most of my scripts

1 possible explanation is this

if the Archer shoot long distances, like using a bow, throw arrow, or mage firebolt, crusader throw shield
then the party member from across the screen should gets the kill
"area_size" is 14, so 14+14 = 28, so 30 works for them


Hp ... you don't want the counter to increase for dead party member
so if that player is dead, Hp is 0, and the condition will become false there
this is to prevent having players increase the kill count by just AFK there

External Links:

Euphy's Hunting Mission ( check this line )
Party Share Kill ( tr0n's Quest Board )

Regular Expression Replace in Notepad++

Notepad++ can search strings and replace them using regular expression
Regular_Expression (Wikipedia)
it can be use to :-
1. generate a huge list of mapflags
2. fix outdated format on the script commands
3. apply a quick fix on CVS style database
4. convert client side item list into array

Example 1. Generate a huge list of mapflags

1. goto db/map_index.txt, copy over the map list

2. there are some lines commented, so find the line with // and remove them by doing this
Find with regular expression^//[a-z0-9_@-]*$ Replace with empty string, this effectively leave the line blank

3. Edit -> Line Operations -> Remove Empty lines

4. Find with regular expression^//([a-z0-9_@-]*)$ Replace with \1 mapflag nobranch

Example 2. Fix outdated format on the script commands

Find with regular expressionpow.(([ 0-9]*),([. a-z0-9_@-]*).) Replace with \(\2**\3\)

Example 3. Apply a quick fix on CVS style database

rathena only, Hercules has switched to libconfig format
goto db/re/item_db.txt

Find with regular expression ^([0-9]*),([^,]*),([^,]*),4, Replace with \1,\2,\3,99, Find with regular expression ^([0-9]*),([^,]*),([^,]*),5, Replace with \1,\2,\3,4, Find with regular expression ^([0-9]*),([^,]*),([^,]*),99, Replace with \1,\2,\3,5,

Example 4: Convert client side item list into array

goto kro/data/cardprefixnametable.txt

Find with regular expression ([0-9]+)#([][&0-9a-z_'.()]*)# Replace with $@cardprefix$[\1] = "\2";

External Links:

Disable dead branch (Example 1) 
Convert pow(a,b) into a**b (Example 2)
Swap item type IT_ARMOR and IT_WEAPON (Example 3)
getitemname2 function (Example 4)

One Character per GM account

Download:

Hercules Patch
Hercules Plugin

Very simple trick, only allow them to create/login their character on slot 0

if you want to make them limit to 3 characters, then allow them to only use slot 0,1,2
if ( slot >= 3 && sd->group_id > 10 && sd->group_id < 99 )

 

External Links:

One char per GM Account

OnPCStatCalcEvent

Let's have a little history lesson shall we ?

it all started by me, found this modification in this topic
about update character's status


since then I have been using it VERY frequently
I'm sure those of you dealing with patch understand this,
I have to upkeep the patch to the latest server revision
eventually I was so fed up, and finally brought it to the development suggestion
See -> OnPCStatCalcEvent <- that's how rAthena got it

When I switch to Hercules, somebody else actually made a pull request on it
https://github.com/HerculesWS/Hercules/pull/351
but it was denied, and thus I released it as a plugin

For a long period of time, the *recalculatestat script command is still broken,
but I finally fix it during my time in Hercules period

Download:

Hercules Plugin

here's the catch
the reason why the *recalculatestat is still broken on rathena,
is because how the way script handling the event queue

Supposedly, we want the bonuses from the OnPCStatCalcEvent: to execute before running the status_calc_pc function
but what actually happen is the script queue up the OnPCStatCalcEvent: label, execute status_calc_pc first
thus all the bonuses from equipment/job bonuses etc has been applied, then OnPCStatCalcEvent: come in too late

since I figure it out, my little trick is delay the OnPCStatCalcEvent: to run AFTER the script execution finish, using a delay timer
I actually explained this to Secret, rathena developer, but she doesn't agree with my method, because this is not thread safe
but whatever ~ at least it working for me

OnPCStatCalcEvent can't run during npc dialog, and spam map-server error along with it

easy to reproduce prontera,155,185,4 script Test 1_F_MARIA,{ @a ^= 1; mes "hmm..."; close2; recalculatestat(); // if player under a dialog, MUST use close2; then only recalculate end; OnPCStatCalcEvent: if ( @a ) bonus bStr, 1000; end; } during the npc dialog, keep change the equipment, you'll lose the str bonus and map-server spam error
[Warning]: npc_event: player's event queue is full, can't add event 'Test::OnPCStatCalcEvent' !
conf/map/battle/items.conf
// Enable all NPC to allow changing of equipments while interacting? (Note 1) // Script commands 'enable_items/disable_items' will not be override. (see doc/script_commands.txt) // Default: true (official) item_enabled_npc: truechange this to false should stop it

showdigit

official documentation from script_commands.txt
*showdigit <value>{,<type>}; Displays given numeric 'value' in large digital clock font on top of the screen. The optional parameter 'type' specifies visual aspects of the "clock" and can be one of the following values: 0 - Displays the value for 5 seconds (default). 1 - Incremental counter (1 tick/second). 2 - Decremental counter (1 tick/second). Does not stop at zero, but overflows. 3 - Decremental counter (2 ticks/second). Two digits only, stops at zero. Except for type 3 the value is interpreted as seconds and formatted as time in days, hours, minutes and seconds. Note, that the official script command does not have the optional parameter. // displays 23:59:59 for 5 seconds showdigit 86399; // counter that starts at 60 and runs for 30 seconds showdigit 60,3;
there is much more than this

because the decremental counter for type 3 runs 2 ticks per seconds, it is not advise to use type 3
type 2 is much preferred, but it risk in going into negative value, so this is usually how I do it
prontera,155,185,5 script kjdshfkshfj 1_F_MARIA,{ .@a = 60; showdigit ~.@a, 2; sleep2 .@a * 1000; showdigit 0, 3; end; }use showdigit type 2 for the countdown, then sleep for the duration, type 3 with 0 value will remove it

and to use this practically for an event, let's say the event only last 5 minute
prontera,155,185,5 script kjdsfhksdjfh 1_F_MARIA,{ if ( .start == false ) { mes "no event atm"; close; } warp "guild_vs2", 0,0; .@timeleft = .event_duration - gettimetick(2) + .starttime; dispbottom .@timelieft; showdigit ~.@timeleft, 2; sleep2 .@timeleft * 1000; showdigit 0, 3; end; OnStart: announce "event start", bc_all; .starttime = gettimetick(2); .start = true; sleep .event_duration * 1000; .start = false; end; OnInit: .event_duration = 5*60; bindatcmd "eventstart", strnpcinfo(0)+"::OnStart", 99, 100; end; }
========================================================

Now for the weird part of this script command

No.1 it run together with pvp counter

if you enter a PVP map, and try to showdigit, it actually show both of them

 so NEVER use showdigit inside a PVP map

No.2 log out and log in , the counter continues

this is another weird bug about *showdigit, it only send a value to the client
the countdown is totally handle by the client

for example from the script above,
if you log out inside the guild_vs2 map, just change character, log in back, the counter still shows
OnPCLogoutEvent also fail to remove it
prontera,158,185,5 script kjdfksjdf 1_F_MARIA,{ showdigit 0, 1; bug_showdigit = true; end; //OnPCLogoutEvent: // doesn't work showdigit 0, 3; end; OnPCLoginEvent: if ( bug_showdigit ) { showdigit 0, 3; bug_showdigit = false; } end; }

External Links:

How to put countdown
showdigit will continue to countdown if the player logout

Units move diagonally then move in straight line

I'm sure those who have play firewall mage understand this

Because it is moving in such a weird behavior,
a normal distance script command, or Pythagoras distance check isn't accurate

function script travel_time { .@x = getarg(3) - getarg(1); .@y = getarg(4) - getarg(2); if ( .@x < 0 ) .@x = -.@x; if ( .@y < 0 ) .@y = -.@y; .@min = ( .@x < .@y )? .@x : .@y; .@max = ( .@x > .@y )? .@x : .@y; return ( sqrt( pow(.@min, 2) *2 ) + .@max - .@min )* getarg(0); } function script pythagoras_distance { return sqrt( pow( getarg(0)-getarg(2), 2 ) + pow( getarg(1)-getarg(3), 2 ) ); } prontera,155,188,5 script distance-time 1_F_MARIA,{ mes "input X"; .@area_size = getbattleflag("area_size"); next; if ( input( .@ix, -.@area_size, .@area_size ) ) close; clear; mes "input Y"; if ( input( .@iy, -.@area_size, .@area_size ) ) close; getmapxy .@map$, .@x, .@y, UNITTYPE_NPC; .@des_x = .@x + .@ix; .@des_y = .@y + .@iy; if ( checkcell( .@map$, .@des_x, .@des_y, cell_chknopass ) ) { mes "destination failed"; close; } close2; movenpc "time-check", .@des_x, .@des_y; monster .@map$, .@x, .@y, "--ja--", 1002, 1, ""; setunitdata $@mobid, UMOB_MODE, MD_CANMOVE; setunitdata $@mobid, UMOB_SPEED, 150; // default player speed unitwalk $@mobid, .@des_x, .@des_y; npctalk "Expected Time = "+( pythagoras_distance( .@x, .@y, .@des_x, .@des_y ) * 150 )+" mili-seconds"; npctalk "Expected Time = "+( travel_time( 150, .@x, .@y, .@des_x, .@des_y ) )+" mili-seconds"; initnpctimer; end; OnCountTimer: stopnpctimer; npctalk sprintf( "Time taken = %d mili-seconds", getnpctimer(0) ); end; } prontera,0,0,0 script time-check 111,0,0,{ end; OnTouchNPC: donpcevent "distance-time::OnCountTimer"; unitkill playerattached(); end; }When input X +5, Y -10, phythagoras distance function expected 1650 mili-seconds,
but travel_time function expected 1800 mili-seconds
the result is 1872 mili-seconds

Thus travel_time function should be use instead,
simple, just  (2min)² + (max - min) where min is X or Y, which one is smaller, and the opposite for max

See also:

Ragnarok Online use number of Squares to count distance  
A simple walking npc script

Daily Quest - use gettimetick(2) or gettimestr ?

Most people when thinking about Daily Quest, they think it as a quest repeatable every 24-hours
prontera,155,185,5 script kjdshfksh 1_F_MARIA,{ if ( apple_taken + 24*60*60 > gettimetick(2) ) { mes "You have already taken this quest"; close; } getitem Apple, 1; apple_taken = gettimetick(2); end; }

but my experience playing other MMORPG games, it actually reset at 12am
yes, I can finish this quest by 11.59pm, and redo it again at 12.00am
prontera,155,185,5 script kjdshfksh 1_F_MARIA,{ .@today = atoi( gettimestr( "%Y%m%d", 9 ) ); if ( apple_taken == .@today ) { mes "You have already taken this quest"; close; } getitem Apple, 1; apple_taken = .@today; end; }


I would prefer to use *gettimestr method, unless being explicitly ask redeem the prize every 24 hours
I prefer *gettimestr over gettime(GETTIME_DAYOFYEAR) because I can read the value clearly
gettimestr("%Y%m%d", 9) return 20190128 

External Link:

OnHour00 players value recover 
Daily Rewards
Delete on char_reg_num on a specific time

The importance of *gettimestr

*gettimestr is probably another underused script command,
because members always think *gettime can do the same, but actually its the opposite

it can simplify an hourly announcer script
OnMinute00: .@hour = gettime(GETTIME_HOUR); if ( .@hour == 0 ) .@hour = 12; else if ( .@hour > 12 ) .@hour -= 12; .@minute = gettime(GETTIME_MINUTE); if ( .@minute < 10 ) .@minute$ = "0"+ .@minute; else .@minute$ = .@minute; if ( .@hour < 12 ) .@ampm$ = "am"; else .@ampm$ = "pm"; announce "The time now is "+ .@hour +":"+ .@minute$ + .@ampm$, bc_all; end;into
OnMinute00: announce "The time now is "+ gettimestr("%I:%M%p", 9), bc_all; end;


This is the script tested on Microsoft Visual Studio 2017prontera,156,192,4 script Time Sample 8W_SOLDIER,{ mes "System Tick : "+ gettimetick(0); mes " Time Tick : "+ gettimetick(1); mes " UNIX Tick : "+ gettimetick(2); mes " GetTime(1) : "+ gettime(GETTIME_SECOND) +" (Sec)"; // 15 (second 0~59) mes " GetTime(2) : "+ gettime(GETTIME_MINUTE) +" (Min)"; // 04 (minute 0~59) mes " GetTime(3) : "+ gettime(GETTIME_HOUR) +" (Hour)"; // 5 (hour 0~23) mes " GetTime(4) : "+ gettime(GETTIME_WEEKDAY) +" (WeekDay)"; // 2 (Sun=0,Sat=6 0~6) mes " GetTime(5) : "+ gettime(GETTIME_DAYOFMONTH) +" (MonthDay)"; // 22 (day 1~31) mes " GetTime(6) : "+ gettime(GETTIME_MONTH) +" (Month)"; // 12 (month 1~12) mes " GetTime(7) : "+ gettime(GETTIME_YEAR) +" (Year)"; // 2015 (year) mes " GetTime(8) : "+ gettime(GETTIME_DAYOFYEAR) +" (No.day in year)"; // 356 (day of the year) mes " GetTimeStr : %Y-%m/%d %H:%M:%S,40"; mes gettimestr("%Y-%m/%d %H:%M:%S",40); // 2015-12/22 05:04:15 next; mes "%a : "+ gettimestr("%a",19); // Tue (short week) mes "%A : "+ gettimestr("%A",19); // Tuesday (long week) mes "%b : "+ gettimestr("%b",19); // Dec (short month) mes "%B : "+ gettimestr("%B",19); // December (long month) mes "%c : "+ gettimestr("%c",19); // this is blank mes "%d : "+ gettimestr("%d",19); // 22 (day 01~31) mes "%H : "+ gettimestr("%H",19); // 05 (hour 00~23) mes "%I : "+ gettimestr("%I",19); // 05 (hour 01~12) mes "%j : "+ gettimestr("%j",19); // 356 (day of the year) mes "%m : "+ gettimestr("%m",19); // 12 (month 01~12) mes "%M : "+ gettimestr("%M",19); // 04 (minute 00~59) mes "%p : "+ gettimestr("%p",19); // AM (AM / PM) mes "%S : "+ gettimestr("%S",19); // 15 (second 00~59) mes "%U : "+ gettimestr("%U",19); // 51 (Week number with the first Sunday as the first day of week one (00-53)) mes "%w : "+ gettimestr("%w",19); // 2 (Sun=0,Sat=6 0~6) mes "%W : "+ gettimestr("%W",19); // 51 (Week number with the first Monday as the first day of week one (00-53)) mes "%x : "+ gettimestr("%x",19); // 12/22/15 (== %m/%d/%y) mes "%X : "+ gettimestr("%X",19); // 05:04:15 (== %H:%M:%S) mes "%y : "+ gettimestr("%y",19); // 15 (year 00~99) mes "%Y : "+ gettimestr("%Y",19); // 2015 (year) mes "%z : "+ gettimestr("%z",19); // +0800 (timezone) mes "%Z : "+ gettimestr("%Z",19); // cannot determine timezone, this is blank mes "%% : "+ gettimestr("%%",19); // print '%' sign close; }Note: if you found some other format, then you have to try it out yourself
if it crash, means not compatible

External Links:

https://herc.ws/wiki/Gettimestr

How to create your own WOE castle map

/* db\castle_db.txt 99,prontera,Prontera Test Castle,test flag,1 */ prontera,152,185,4 script test flag GUILD_FLAG,{ dispbottom "========================="; .@gid = getcastledata("prontera", 1); dispbottom "owner of the castle : "+( ( .@gid )? "["+ getguildname(.@gid) +"]" : "<none>" ); dispbottom "agit check : "+( ( agitcheck() )?"on":"off" ); dispbottom "gvg_castle mapflag : "+( ( getmapflag( strcharinfo(3), mf_gvg_castle )?"on":"off" ) ); dispbottom "========================="; end; OnInit: if ( agitcheck() == false && !getcastledata("prontera", 1) || agitcheck() == true ) donpcevent strnpcinfo(0)+"::OnAgitStart"; setmapflag "prontera", mf_gvg_castle; flagemblem getcastledata("prontera", 1); end; OnAgitStart: .@mobid = monster("prontera",151,181,"EMPERIUM",1288,1,strnpcinfo(0)+"::OnEmpBreak"); // setunitdata .@mobid, UDT_HP, 5; end; OnAgitEnd: killmonster strnpcinfo(4), strnpcinfo(0)+"::OnEmpBreak"; end; OnEmpBreak: announce "The Emperium has fallen", bc_map; setcastledata "prontera", 1, getcharid(2); donpcevent "::OnRecvCastle123"; sleep 7000; if ( agitcheck() == false ) end; goto OnAgitStart; OnAgitInit: requestguildinfo getcastledata("prontera", 1); OnRecvCastle123: flagemblem getcastledata("prontera", 1); end; OnGuildBreak: setcastledata "prontera", 1, 0; donpcevent "::OnRecvCastle123"; end; } This is the simplest woe script I could make, remember to add a line in db/castle_db.txt !!
There are too many things to cover in this article, so have to break it down bits-by-bits

gvg_castle mapflag is the unique mapflag meant for this situation, this is what is does
1. with agitcheck() on, players with different guild ID can kill each other
2. the emperium unable to kill by its own guild member
the rest are all done by scripting, example like emperium spawn in empty castle, refresh of the guild emblem ...
remember the guild MUST have Guild Approval skill learned to hit the emperium !!

GUILD_FLAG(722) is a special npc ID that can shows the emblem of the guild, and it can be use outside of woe script
1. *flagemblem script command only works on this npc ID
2. donpcevent "::On1234" can be use to execute all npc with this label name, this can be use in other situation too
3. *requestguildinfo script command is needed when you want to show the emblem during server start-up -> OnAgitInit:

OnAgitInit: label only execute when the map-server successfully connect to char-server
the reason for using OnAgitInit: is because the guild information are usually store in char-server,
so map-server doesn't need to load unneeded information

if you trying to use OnInit: expecting to load the flag emblem during server startup, you'll find it is not loading the emblem
BUT it can solve the problem if you want the emblem to shows during @reloadscript

*setcastledata script command has a bunch of info that can use, all these are done with scripting,
there is totally nothing in the source code to change this whatsoever
in other words, if you want to make a custom woe script, you can abuse value 6/7/8 which is currently unused to use for your custom idea !
Note: in rAthena they are constant names CD_NEXT_TIME, CD_PAY_TIME, CD_CREATE_TIME

OnGuildBreak: works when the guild disband and the guild owns a castle, it will run this label
it is directly run from the source when the guild master /breakguild "guild name"

External Link:

woe auto assign on guild (script) 

classchange - npc shown only to certain players

The npc is shown only to 1 player, this screenshot must be fake !!

just kidding, this script command is available since the new novice training ground released

And again ... as always, Hercules and rAthena having different ways to do this

Hercules
prontera,155,186,5 script kjhdfks 1_F_MARIA,{ classchange HIDDEN_WARP_NPC, 0, getcharid(CHAR_ID_CHAR); end; }

rAthena
prontera,156,186,5 script kjhdfks 1_F_MARIA,{ classchange HIDDEN_WARP_NPC, strnpcinfo(0), bc_self; end; }

---- This has been tested on both Hercules and rAthena, both behave the same way -----

*classchange ... the way is works is ...
IF you are within the sight range of the npc, it will change its sprite ID

as example above, this npc was visible from the beginning, and hides upon clicking it
BUT if you walk away from it, and come back again, it will mysteriously appear again

so in order to have only selective players can see this npc, (GMs, players with variables)
the only way I think of, is using OnTouch

//prontera,158,186,5 script asfsfd 1_F_MARIA,14,14,{ //prontera,158,186,5 script asfsfd HIDDEN_NPC,14,14,{ //prontera,158,186,5 script asfsfd WARPNPC,14,14,{ //prontera,158,186,5 script asfsfd FAKE_NPC,14,14,{ prontera,158,186,5 script asfsfd HIDDEN_WARP_NPC,14,14,{ //prontera,158,186,5 script asfsfd 1_SHADOW_NPC,14,14,{ if ( strcharinfo(PC_NAME) != "AnnieRuru" ) end; // double protection mes "hi"; close; OnTouch: if ( strcharinfo(PC_NAME) == "AnnieRuru" ) classchange 1_F_MARIA, 0, getcharid(CHAR_ID_CHAR); end; }
even with that, my test result shows certain npc ID are unable to change sprite. These are :-
1. FAKE_NPC (-1)
2. WARPNPC (45)
3. HIDDEN_NPC (111)

HIDDEN_WARP_NPC (139) works fine, make this is the only npc ID that hides your npc

-------------------------------------------------------

another thing I want to make note is ...
because Hercules use <char id> instead of  bc_flag, seems can do like this
prontera,158,186,5 script asfsfd HIDDEN_WARP_NPC,{ mes "hi"; close; OnInit: if ( isloggedin(2000000) ) classchange 1_F_MARIA, 0, 150000; end; }but actually it is not.
If you load the script upon server startup, and login later, you wont able to see the npc
after all, *classchange only effective if you are standing in range with the npc

How to compare a value within an array

setarray .@abc[0], 1,2,6,8,9,11,21,34,55,61;
how to determine the value 6 is in the array ?

I'm sure most people will loop it
for ( .@i = 0; .@i < 10; ++.@i ) if ( .@abc[.@i] == 6 ) dispbottom "OK";yeah ~ this is so basic ~

Now let me show you 3 other methods

 

Method No.1 -> use while loop

while ( .@i < 10 && .@abc[.@i] != 6 ) ++.@i; if ( .@i < 10 ) dispbottom "OK";

Method No.2 -> compare with strings

for ( .@i = 0; .@i < 10; ++.@i ) .@compare$ += "#"+ .@abc[.@i] +"#"; if ( compare( .@compare$, "#"+ 6 +"#" ) ) dispbottom "OK";

Method No.3 -> use array as pointers

for ( .@i = 0; .@i < 10; ++.@i ) .@value[.@abc[.@i]] = true; if ( .@value[6] ) dispbottom "OK";

And of course don't forget, rAthena's *countinarray

if ( countinarray(.@abc, 6) ) dispbottom "OK";OK seriously this one is cheating


-------------------------------------------------------

Of course all 3 methods has its own weakness

Method no.1 - it run an extra index within the while-loop
setarray .@mobid, 1001, 1002, 1004, 1005; while ( .@i < 4 && (getmonsterinfo( .@mobid[.@i], MOB_MODE ) & 1) ) ++.@i;
this one will throw error


Method no.2 - when using *countstr, countstr("#1#1#1#", "#1#"); will return 2
means, "#1#1#1#" is for *compare script command,
"#1##1##1#" is for *countstr


Method no.3 cannot use string, like IP address
.@abc["127.0.0.1"]  <-- of course doesn't work

External Links:

Help removing duplicate value from array
How to make list ID for mobs (method No. 1)
Special Party Warper (method No.2)
Please help this script about mac-address (method No.2)
getitemname2 function (method No.3)
party soul link (method No.3)

Stylist

updated Stylist script with Summoner Class range support, and 3rd class body style support
Current version is 1.4
Hercules Download
rAthena Download


this time doesn't use blacklist range, but use allow range in CSV format
.list$[LOOK_HAIR] = "0-5,11-18,20-23"; .list$[Job_Summoner + LOOK_CLOTHES_COLOR] = "0-1";This means, the ID range for hair style is 0,1,2,3,4,5,11,12,13,14,15,16,17,18,20,21,22,23
2nd line means Summoner job can only use clothing range 0 and 1, this prevent crash client

1.0 - script
- there is a bug on Euphy's stylist npc, the style number should start with 0, but his script always start with 1
- and the naming sense very bad, .@style and .@styles, should be avoided

1.1 - script
- allow blacklist certain styles

1.2 - script
- change from blacklist into CSV format, this one is understood by many

1.3 - Hercules . rAthena
- add Job_Summoner, to prevent client crash from invalid cloth color

1.4 - Hercules . rAthena
- add 3rd job body style change

The reason why *getmapxy uses UNITTYPE constants

Ever wonder why *getmapxy introduced a new constant using the same value as *getunittype ?

That reason is because I wanted to allow *getmapxy can retrieve the coordinate of the unit

You see, the *getunitdata script command can only return integer value,
thus the map name return as string is not recommended
- although *getmonsterinfo with MOB_NAME can return string while others return integer...
--- I wonder why aleos never think about it ?

And ... with my Pull Request merge, Hercules can do like this
OnPCDieEvent: if ( !killerrid ) end; getmapxy .@map$, .@x, .@y, getunittype(killerrid), killerrid; dispbottom .@map$ +" "+ .@x +" "+ .@y; end; however this cannot be done in rAthena

so rAthena has to stuck with *getunitdata
the worst thing is it doesn't return map name, it return map ID
and have to use another script command *mapid2name to turn map ID into map name
OnPCDieEvent: if ( !killerrid ) end; switch ( getunittype(killerrid) ) { // case BL_PC: default: getmapxy .@map$, .@x, .@y, BL_PC, killerrid; dispbottom .@map$ +" "+ .@x +" "+ .@y; break; case BL_MOB: getunitdata killerrid, .@unitdata; dispbottom mapid2name(.@unitdata[UMOB_MAPID]) +" "+ .@unitdata[UMOB_X] +" "+ .@unitdata[UMOB_Y]; break; case BL_PET: getunitdata killerrid, .@unitdata; dispbottom mapid2name(.@unitdata[UPET_MAPID]) +" "+ .@unitdata[UPET_X] +" "+ .@unitdata[UPET_Y]; break; case BL_HOM: getunitdata killerrid, .@unitdata; dispbottom mapid2name(.@unitdata[UHOM_MAPID]) +" "+ .@unitdata[UHOM_X] +" "+ .@unitdata[UHOM_Y]; break; case BL_MER: getunitdata killerrid, .@unitdata; dispbottom mapid2name(.@unitdata[UMER_MAPID]) +" "+ .@unitdata[UMER_X] +" "+ .@unitdata[UMER_Y]; break; case BL_ELEM: getunitdata killerrid, .@unitdata; dispbottom mapid2name(.@unitdata[UELE_MAPID]) +" "+ .@unitdata[UELE_X] +" "+ .@unitdata[UELE_Y]; break; case BL_NPC: getunitdata killerrid, .@unitdata; dispbottom mapid2name(.@unitdata[UNPC_MAPID]) +" "+ .@unitdata[UNPC_X] +" "+ .@unitdata[UNPC_Y]; break; } end;


Update, it seems rAthena has updated *getmapxy script command, and changed UNITTYPE_ into BL_
however it still couldn't search with BL_MOB type, so it doesn't change much

External Links:

https://github.com/HerculesWS/Hercules/pull/871
https://github.com/rathena/rathena/issues/3100

mapmoblist - script version

Since the source modification are untrustworthy ... always break in updates,
sometimes its better to do in script version if possible
so I made the script version for this

rAthena
// pre-re/mobs/fields/prontera.txt //================================================== // prt_fild07 - Prontera Field //================================================== prt_fild07,0,0 monster Rocker 1052,80 prt_fild07,0,0 monster Poporing 1031,30 prt_fild07,0,0 monster Vocal 1088,1,1800000,1200000 prt_fild07,225,110,5,5 monster Black Mushroom 1084,3,360000,180000 - script mapmoblist -1,{ OnInit: bindatcmd "mapmoblist", strnpcinfo(3)+"::Onaaa"; end; Onaaa: if (.@atcmd_numparameters) { if (getmapusers(.@atcmd_parameters$) == -1) { dispbottom "Map not exist"; end; } .@map$ = .@atcmd_parameters$; } else .@map$ = strcharinfo(3); .@size = getmapunits(BL_MOB, .@map$, .@bl); freeloop true; for (.@i = 0; .@i < .@size; ++.@i) { .@string$ = rid2name(.@bl[.@i]); if (!getd(".@"+ .@string$)) { .@mobname$[.@c] = .@string$; getunitdata .@bl[.@i], .@unitdata; .@mobx[.@c] = .@unitdata[UMOB_X]; .@moby[.@c] = .@unitdata[UMOB_Y]; .@mobhp[.@c] = .@unitdata[UMOB_HP]; .@mobmaxhp[.@c] = .@unitdata[UMOB_MAXHP]; ++.@c; } setd ".@"+ .@string$, getd(".@"+ .@string$) +1; } dispbottom " === These are monsters in "+ .@map$ +" ==="; for (.@i = 0; .@i < .@c; ++.@i) if (getd(".@"+ .@mobname$[.@i]) > 1) dispbottom (++.@j)+". "+ .@mobname$[.@i] +" : "+ getd(".@"+ .@mobname$[.@i])+"x"; if (getgmlevel() < 99) end; // admin only access, lucky you mention it so I make extra checks dispbottom " === Location of unique monsters === "; for (.@i = 0; .@i < .@c; ++.@i) if (getd(".@"+ .@mobname$[.@i]) == 1 && .@mobhp[.@i]) dispbottom .@mobname$[.@i] +" --> X = "+ .@mobx[.@i] +" Y = "+ .@moby[.@i] +" | Hp left = "+ .@mobhp[.@i] +"/"+ .@mobmaxhp[.@i]; end; }

when converted into Hercules however, I found out *getunits doesn't catch dead monsters being alive
// pre-re/mobs/fields/prontera.txt //================================================== // prt_fild07 - Prontera Field //================================================== prt_fild07,0,0,0,0 monster Rocker 1052,80,0,0,0 prt_fild07,0,0,0,0 monster Poporing 1031,30,0,0,0 prt_fild07,0,0,0,0 monster Vocal 1088,1,1800000,1200000,0 prt_fild07,225,110,5,5 monster Black Mushroom 1084,3,360000,180000,1 - script mapmoblist FAKE_NPC,{ OnInit: bindatcmd "mapmoblist", strnpcinfo(NPC_NAME_UNIQUE)+"::Onaaa"; end; Onaaa: if (.@atcmd_numparameters) { if (getmapusers(.@atcmd_parameters$) == -1) { dispbottom "Map not exist"; end; } .@map$ = .@atcmd_parameters$; } else .@map$ = strcharinfo(PC_MAP); .@size = getunits(BL_MOB, .@bl, false, .@map$); freeloop true; for (.@i = 0; .@i < .@size; ++.@i) { .@string$ = rid2name(.@bl[.@i]); if (!getd(".@"+ .@string$)) { .@mobname$[.@c] = .@string$; getmapxy .@map$, .@x, .@y, UNITTYPE_MOB, .@bl[.@i]; .@mobx[.@c] = .@x; .@moby[.@c] = .@y; .@mobhp[.@c] = getunitdata(.@bl[.@i], UDT_HP); .@mobmaxhp[.@c] = getunitdata(.@bl[.@i], UDT_MAXHP); ++.@c; } setd ".@"+ .@string$, getd(".@"+ .@string$) +1; } dispbottom " === These are monsters in "+ .@map$ +" ==="; for (.@i = 0; .@i < .@c; ++.@i) if (getd(".@"+ .@mobname$[.@i])) dispbottom ( ++.@j )+". "+ .@mobname$[.@i] +" : "+ getd(".@"+ .@mobname$[.@i])+"x"; if (getgmlevel() < 99) end; // Hercules doesn't catch dead monsters as being alive dispbottom " === Location of unique monsters === "; for (.@i = 0; .@i < .@c; ++.@i ) if (getd(".@"+ .@mobname$[.@i]) == 1) dispbottom .@mobname$[.@i] +" --> X = "+ .@mobx[.@i] +" Y = "+ .@moby[.@i] +" | Hp left = "+ .@mobhp[.@i] +"/"+ .@mobmaxhp[.@i]; end; }

So this is another difference between Hercules<->rAthena

On a side note, when I did a forum search on Hercules,
this script incidentally solve the question on the board :P

External Links

I got error when applying custom commands
Dastgir's Plugin Collections

The meaning behind the value of movement speed

Note: due to Hercules' mob controller system broken, this guide is demonstrate in rAthena

The value of normal player movement speed is 150
if type @speed 150, even you have agi up buff, it says your movement speed return to normal
so what is the meaning of 150 ?

simple, it means it take 150 mili-seconds to walk 1 cell (horizontal/vertically)
mathematics !! 5 cells = 150 * 5 = 750 mili-seconds reach there

now for poring ... it is set to 400 means, it takes 400 mili-seconds to walk 1 cell
scorpion is 200, means 200 mili-seconds to walk 1 cell
in other words, poring in 2 seconds can walk 5 cells, and scorpion can walk 10 cells in 2 seconds

walk 5 cells at 400 speed = sleep 400 * 5; = 2000 mili-seconds
walk 10 cells at 200 speed = sleep 200 * 10; = 2000 mili-seconds

and here I make this script for fun to demonstrate the distance-time relations

prontera,155,185,5 script skdfjhskdf 1_F_MARIA,{ if ( input( .@distance, 1, 5 ) ) close; if ( input( .@speed, 20, 1000 ) ) close; getmapxy .@map$, .@x, .@y, UNITTYPE_NPC; monster .@map$, .@x - .@distance, .@y + .@distance, "--ja--", 1002, 1, ""; .@mobid = $@mobid; setunitdata .@mobid, UMOB_SPEED, .@speed; setunitdata .@mobid, UMOB_MODE, MD_CANMOVE|MD_NORANDOM_WALK; while ( true ) { unitwalk .@mobid, .@x + .@distance, .@y + .@distance; sleep ( .@speed * .@distance *2 ) * 11/10; // add 10% extra time unitwalk .@mobid, .@x + .@distance, .@y - .@distance; sleep ( .@speed * .@distance *2 ) * 11/10; unitwalk .@mobid, .@x - .@distance, .@y - .@distance; sleep ( .@speed * .@distance *2 ) * 11/10; unitwalk .@mobid, .@x - .@distance, .@y + .@distance; sleep ( .@speed * .@distance *2 ) * 11/10; } end; // never reach } prontera mapflag nomobloot

See Also

Ragnarok Online use number of Squares to count distance 

External Links:

walking monster

Mathematics - Pythagorean theorem

in previous article, we cover why monster take 7 cells to the right is same amount of time moving 5 cells diagonally

reason ? Pythagorean theorem
A² + B² = C²
since monster is moving diagonally (45º), A = B
5² + 5² = C²
2(25) = C²
50^½ = C
C = 7.07106...

so, what if it is the opposite ?
let's say I have 30 cells to the right, and I want to know how many cells needed to travel diagonally in the same amount of time
the formula is
2(A²) = C²
where C = 30
2(A²) = 30²
2(A²) = 900
A² = 450
A =  21.21320....

Run a macro in Notepad++

Notepad++ has macro feature, very useful if you want to repeat the same action over again in a file
A fine example is generate a huge array list

Example 1: Generate a full map list in your server

1. goto db/map_index.txt, copy over the map list
2. there are some lines commented, so find the line with // and remove them
3. start the line with setarray .map$, "
4. on the Macro menu, select Start Recording

5. now the macro will record your action. Input the follow keystroke in sequence
 a. double quotation mark
 b. comma
 c. double quotation mark
 d. delete key
 e. End key
6. on the Macro menu, select Stop Recording
7. on the Macro menu, select Run a Macro multiple times
8. Select Run until the end of the file

Example 2: Generate a list from SQL database

1. run the SQL command.
2. export the record set into external format

.... and repeat the above process

External Links:

kill 20k mobs to summon a world boss invasion
npc mix cards

Display Item description inside npc dialog

very unpopular, yet useful for displaying item names inside npc dialog

function script F_MesItemInfo { .@item = getarg(0); .@itemname$ = getitemname(.@item); if (.@itemname$ == "null") .@itemname$ = "Unknown Item"; if (PACKETVER >= 20150729) return sprintf("<ITEM>%s<INFO>%d</INFO></ITEM>", .@itemname$, .@item); else if (PACKETVER >= 20130130) return sprintf("<ITEMLINK>%s<INFO>%d</INFO></ITEMLINK>", .@itemname$, .@item); else return .@itemname$; } prontera,155,185,5 script sfsdfsdf 1_F_MARIA,{ mes F_MesItemInfo(Knife); close; }

Note: This link doesn't show the Item Slot
example, Item ID 1201,1202,1203 are all Knife with different amount of slots
when you have these items in your inventory, it display the slot just below the item description
but when you display it inside mes, right click on it, it doesn't show the slot

External Link:

Add F_MesItemInfo function to show item name with description link

Ragnarok Online use number of Squares to count distance

This is something very weird with Ragnarok Online
the distance check in straight line and diagonally are the same value
dispbottom distance(0,0,5,0) +""; // return 5 dispbottom distance(0,0,5,5) +""; // return 5
both return 5 !!
even though the 2nd one should return 7

and this causes some problem when we try to count the time needed to move from point A to B

Here is a script that you can test
prontera,150,190,5 script distance-time 1_F_MARIA,{ select "Go Right", "Go Down-Right"; if ( input( .@length, 1, getbattleflag("area_size") ) ) close; getmapxy .@map$, .@x, .@y, UNITTYPE_NPC; .@des_x = .@x + .@length; .@des_y = .@y +( ( @menu == 1 )? 0 : -.@length ); movenpc "time-check", .@des_x, .@des_y; monster .@map$, .@x, .@y, "--ja--", 1002, 1, ""; setunitdata $@mobid, UMOB_MODE, MD_CANMOVE; setunitdata $@mobid, UMOB_SPEED, 150; // default player speed unitwalk $@mobid, .@des_x, .@des_y; initnpctimer; end; OnCountTimer: stopnpctimer; npctalk sprintf( "Time taken = %d mili-seconds", getnpctimer(0) ); end; } prontera,0,0,0 script time-check 111,0,0,{ end; OnTouchNPC: donpcevent "distance-time::OnCountTimer"; unitkill playerattached(); end; }
let's say input 5, go to the right takes 827 mili-seconds in-game
go to the down-right actually takes 1123 mili-seconds -> means longer

to actually make the travel time same for straight line and diagonal line
the straight line needs 7 cells distance to match the 5 cells distance diagonally - 1123 mili-seconds
same, straight line takes 14 cells distance to match 10 cells distance diagonally - 2168 mili-seconds

There IS a circular check in the source code where you can enable it
however, the circular check, I'm not so sure about its accuracy
that formula is taken from here


function script pythagoras_distance { return sqrt( pow( getarg(0)-getarg(2), 2 ) + pow( getarg(1)-getarg(3), 2 ) ); } function script radius_distance { .@x = getarg(2) - getarg(0); .@y = getarg(3) - getarg(1); if ( .@x < 0 ) .@x = -.@x; if ( .@y < 0 ) .@y = -.@y; .@min = ( .@x < .@y )? .@x : .@y; .@max = ( .@x > .@y )? .@x : .@y; if ( !.@min ) return .@max; return ( ( ( .@max << 8 ) + ( .@max << 3 ) - ( .@max << 4 ) - ( .@max << 1 ) + ( .@min << 7 ) - ( .@min << 5 ) + ( .@min << 3 ) - ( .@min << 1 ) ) >> 8 ); } prontera,155,185,5 script sjfhksfh 1_F_MARIA,{ .@a = 0; .@b = 0; .@c = 8; .@d = 8; dispbottom distance(.@a, .@b, .@c, .@d); // display 8 dispbottom radius_distance(.@a, .@b, .@c, .@d); // display 10 dispbottom pythagoras_distance(.@a, .@b, .@c, .@d); // display 11 end; }All 3 gave different answer. When test in-game however,
the straight line needs 11 cells distance to match 8 cells distance diagonally - 1747 mili-seconds
means the formula encode inside our emulator, it might calculate the distance wrong ??
well ... I think this is minor though, because I think nobody actually compile with CIRCULAR_AREA enabled


PS: Currently this feature cannot test on Hercules server because Hercules mob controller is still broken

prontera,150,190,5 script distance-time 1_F_MARIA,{ select "Go Right", "Go Down-Right"; if ( input( .@length, 1, getbattleflag("area_size") ) ) close; getmapxy .@map$, .@x, .@y, UNITTYPE_NPC; .@des_x = .@x + .@length; .@des_y = .@y +( ( @menu == 1 )? 0 : -.@length ); movenpc "time-check", .@des_x, .@des_y; .@mobid = monster( .@map$, .@x, .@y, "--ja--", PORING, 1, "" ); setunitdata .@mobid, UDT_MODE, 1; setunitdata .@mobid, UDT_SPEED, 15; // default player speed unitwalk .@mobid, .@des_x, .@des_y; initnpctimer; end; OnCountTimer: stopnpctimer; npctalk sprintf( "Time taken = %d mili-seconds", getnpctimer(0) ); end; } prontera,0,0,0 script time-check HIDDEN_NPC,0,0,{ end; OnTouchNPC: donpcevent "distance-time::OnCountTimer"; unitkill playerattached(); end; }

See also :

Previous -> The meaning behind the value of movement speed
Mathematics - Phythagorean Theorem
next article -> Units move diagonally then move in straight line

MVP vs MVP Event

Looks fun ?
however this event is not control by scripts, but entirely control by GM commands

This is how you do it

Step 1:

login multi 2 GM clients, then @hide both of them

Step 2:

@warp g_room1-1 75 153
then @duel between them

Step 3:

one GM "@summon 1916 60", another GM "@summon 2022 60"



Enjoy the result

Note: have to "@summon 1916 60" with the 60 on it,
without it, it will last only 1 minute, but with 60, it will last 60 minutes


External Links:
Request MVP tournament
MVP vs MVP event

weird, the retaliate to master is no longer needed, I leave it as yes // When a mob is attacked by another monster, will the mob retaliate against the master of said mob instead of the mob itself? // NOTE: Summoned mobs are both those acquired via @summon and summoned by Alchemists retaliate_to_master: yes

Dressing Girl

Dressing Room script

Players can preview these headgear from the array
the reason why I didn't use dynamic shop is because player can abuse it


version 1.1 has tested in rAthena, just change the Item constants into Item ID
OnInit: setarray .headgear, // add as many as possible 5083, 5140;

Hercules has version 1.3



the room part isn't done however, this is just the npc

The reason why *checkwall exist

During that time, I was cleaning up my battleground script template,
I didn't notice the *delwall script command was used twice <-- thanks to Atemo !
thus I made a pull request to throw a debug message when *delwall use twice

it was done that way because I thought *delwall script command is only meant for event script
when event commence = *setwall, and when start = *delwall ... simple as that

then I immediately receive complaints many server throw errors on them because of my pull request
when I ask how they get the error, answer was shocking for me
they actually use the *setwall/*delwall for Utility script !!

I can't remember the conversation or the script, but its something like this
- script sdfsdf -1,{ OnInit: switch ( gettime(GETTIME_WEEKDAY) ) { case SUNDAY: goto OnSun0000; case MONDAY: goto OnMon0000; case TUESDAY: goto OnTue0000; case WEDNESDAY: goto OnWed0000; case THURSDAY: goto OnThu0000; case FRIDAY: goto OnFri0000; case SATURDAY: goto OnSat0000; } OnMon0000: OnWed0000: OnFri0000: delwall "Weekday_wall2"; delwall "Weekend_wall"; setwall <map>,<x>,<y>,<size>,<dir>,0,"Weekday1_wall"; end; OnTue0000: OnThu0000: delwall "Weekday_wall1"; delwall "Weekend_wall"; setwall <map>,<x>,<y>,<size>,<dir>,0,"Weekday1_wall2"; end; OnSat0000: OnSun0000: delwall "Weekday_wall1"; delwall "Weekday_wall2"; setwall <map>,<x>,<y>,<size>,<dir>,0,"Weekend_wall"; end; }

Honestly I have no answer for them at the time ...

and thus the *checkwall script command was added later to fix this issue


Moral of the story : never underestimate the creativity of the community =/
well ... enablenpc/disablenpc ... this script command also doesn't throw error when use multiple times
imagine if we actually throw error for the *disablenpc .... hahaha~

Bitmask

This was a good discussion topic while I was still rAthena scripting moderator


Basically, script_commands.txt already explained quite well
I also had a template script to play around with it
prontera,155,187,4 script Guess the number 1_F_MARIA,{ .@bit = 4; // how many bits .@ans = rand( 1 << .@bit ); mes "Guess this number -> "+ .@ans; next; while (true) { for ( .@i = 0; .@i < .@bit; ++.@i ) .@menu$[.@i] = ( ( .@guess & 1<<.@i )? "^009900":"^FF0000" )+"2^"+ .@i +"^000000 -> "+( 1 << .@i ); .@s = select( implode( .@menu$, ":" ) ) -1; // .@guess ^= 1 << .@s; // can use this line if don't want to use IF-ELSE if ( .@guess & 1 << .@s ) .@guess &= ~(1 << .@s); else .@guess |= 1 << .@s; if ( .@guess == .@ans ) break; } mes "You got it !"; close; }

one example that explained not so well in script_commands.txt about getnameditem
basically, what he is trying to tell, is just like this
getitem2 Apple, 1, 1, 0, 0, 254, 0, getcharid(0) % 2**16, getcharid(0) / 2**16; .@charid = .@card4 * 2**16 + .@card3;

both Hercules and rAthena script engine has every script variable as int signed, which is 31 bits
but with this template provided by Keyworld, the upper limit becomes 2040 bits (255*8=2040)
I remember Keyworld said that might be useful for saving a player's skill tree into SQL table, but he never complete it

A simple walking npc script

prontera,155,185,4 script Shy Eclipse 4_DOG01,{ addtimer 1, strnpcinfo(0)+"::OnEndTalk"; ++.talking; mes "[Eclipse]"; mes "!! Squik..!"; emotion e_panic; next; if ( select("Pet it.:Scare it away.") == 1 ){ mes "[Eclipse]"; mes "**Squik~**"; emotion e_lv; } else { mes "[Eclipse]"; mes "SQUIK!"; emotion e_omg; } close; OnEndTalk: OnPCLogoutEvent: --.talking; end; OnInit: npcspeed 100; while ( true ) { if ( !.talking ) { getmapxy .@map$, .@x, .@y, UNITTYPE_NPC; while ( checkcell( .@map$, .@x2 = .@x + rand(-10,10), .@y2 = .@y + rand(-10,10), cell_chknopass ) ); npcwalkto .@x2, .@y2; } sleep rand(1000,3000); } }

External Links:
Walking NPC script

Compare dynamic shop between rathena & hercules

I wonder how many of you still remember that old dynamic shop script ?
- shop market2#hidden -1,501:1000 prontera,156,182,5 script market 100,{ dispbottom "You currently have "+ countitem(.currency) +" "+ getitemname(.currency); callshop .shopname$, 1; end; OnInit: function addshopitem { npcshopdelitem .shopname$, 501; .@count = getargcount(); for ( .@i = 0; .@i < .@count; .@i++ ) { if ( .@i % 2 == 0 ) .itemid[.@i /2] = getarg(.@i); else { .itemcost[.@i /2] = getarg(.@i); npcshopadditem .shopname$, .itemid[.@i /2], getarg(.@i); } } } // ----- Configuration ------ .shopname$ = "market2#hidden"; // shop name that match the 1st line in this script .currency = 674; // item used for currency addshopitem // adds shop items here 512,10, 513,20, 514,30, 515,40, 516,50, 607,1; // ------------------------- .itemsize = getarraysize( .itemid ); for ( .@i = 0; .@i < .itemsize; .@i++ ) setd ".item"+ .itemid[.@i] +"cost", .itemcost[.@i]; npcshopattach .shopname$; end; OnBuyItem: if ( !@bought_quantity ) end; .@size = getarraysize( @bought_nameid ); for ( .@i = 0; .@i < .@size; .@i++ ) .@itemcost = .@itemcost + getd( ".item"+ @bought_nameid[.@i] +"cost" ) * @bought_quantity[.@i]; if ( .@itemcost > countitem(.currency) ) { mes "you don't have enough "+ getitemname(.currency); close; } if ( !checkweight2( @bought_nameid, @bought_quantity ) ) { mes "you can't carry all these items !"; close; } delitem .currency, .@itemcost; for ( .@i = 0; .@i < .@size; .@i++ ) getitem @bought_nameid[.@i], @bought_quantity[.@i]; end; OnSellItem: if ( !@sold_quantity ) end; .@size = getarraysize( @sold_nameid ); for ( .@i = 0; .@i < .@size; .@i++ ) .@itemgain = .@itemgain + getd( ".item"+ @sold_nameid[.@i] +"cost" ) * @sold_quantity[.@i]; if ( !.@itemgain ) end; if ( !checkweight( .currency, .@itemgain ) ) { mes "you can't carry all these items !"; close; } for ( .@i = 0; .@i < .@size; .@i++ ) if ( getd( ".item"+ @sold_nameid[.@i] +"cost" ) ) delitem @sold_nameid[.@i], @sold_quantity[.@i]; getitem .currency, .@itemgain; end; }
because no one is using this method anymore ~ so long eAthena legacy ~



Hercules
prontera,153,182,1 trader TestCustom2 1_F_MARIA,{ end; OnInit: tradertype NST_CUSTOM; sellitem Apple,10; sellitem Banana,20; sellitem Grape,30; sellitem Carrot,40; sellitem Sweet_Potato,50; sellitem Yggdrasilberry,1; end; OnPayFunds: if ( countitem(Mithril_Coin) < @price ) end; delitem Mithril_Coin, @price; purchaseok(); end; OnCountFunds: setcurrency Mithril_Coin, 0; end; }
rAthena
prontera,156,182,5 itemshop market 1_F_MARIA,674,512:10,513:20,514:30,515:40,516:50,607:1


Hercules seems longer because Hercules encourage use Item/Mob constants instead of numbers, for better readability

This one is pretty straightforward
if you want to learn more, refer to script_commands.txt for more detail information

Compare Instance script between rAthena & Hercules

Hercules
prontera,155,180,0 script Test Instance 1_F_MARIA,{ if (has_instance2("guild_vs2") >= 0) instance_destroy has_instance2("guild_vs2"); if ((.@ins = instance_create( "Test Instance", getcharid(CHAR_ID_ACCOUNT), IOT_CHAR)) < 0) { mes "error : "+ .@ins; close; } if (!getstrlen(instance_attachmap("guild_vs2", .@ins, true, .@ins +"INST" ))) { mes "error : 5"; instance_destroy .@ins; close; } instance_set_timeout 3600, 15, .@ins; instance_init .@ins; warp has_instance("guild_vs2"), 49,49; end; } guild_vs2,49,49,5 script test dialog 1_F_MARIA,{ dispbottom strnpcinfo(NPC_MAP); mesf "%d monsters on this map", 'amount; next; select "Destroy"; instance_destroy; end; OnInstanceInit: monster instance_mapname("guild_vs2"), 49,49, "--ja--", PORING, 10, instance_npcname(strnpcinfo(NPC_NAME))+"::OnMobDead"; 'amount = 10; end; OnMobDead: --'amount; if (!'amount) { instance_announce -1, "all monster killed", bc_map; sleep 1000; instance_destroy instance_id(); } end; }

1. Hercules has more instance related script commands, but also make this more flexible and versatile once you learn to use them
   
   • Hercules has *instance_attach script command, make sure this script command is added AFTER *instance_init if you want the script to do some other stuffs inside the instance during the registration phase.
   • Hercules has to emulate the map name with *instance_attachmap if the map name doesn't follow the syntax <number>@<5 string limit>
2. Hercules instance ID start from 0, rathena instance ID start from 1
   
   • Make sure the instance_announce is set to -1

-------------------------------

rAthena
// db/import/instance_db.yml Body: - Id: 34 Name: Test Instance TimeLimit: 3600 IdleTimeOut: 15 Enter: Map: guild_vs2 X: 49 Y: 49
prontera,155,180,0 script Test Instance 1_F_MARIA,{ if (instance_id(IM_PARTY)) { instance_destroy instance_id(IM_PARTY); close; } if (instance_create("Test Instance", IM_PARTY) < 0) { mes "failed to create instance"; close; } instance_enter "Test Instance"; end; } guild_vs2,49,49,5 script test dialog 1_F_MARIA,{ dispbottom strnpcinfo(4); mes sprintf("%d monsters on this map", 'amount); next; select "Destroy"; instance_destroy; end; OnInstanceInit: monster instance_mapname("guild_vs2"), 49,49, "--ja--", 1002, 10, instance_npcname(strnpcinfo(0))+"::OnMobDead"; 'amount = 10; end; OnMobDead: --'amount; if ( !'amount ) { instance_announce 0, "all monster killed", bc_map; sleep 2000; instance_destroy; } end; }

1. rathena has instance_db.yml file ... make sure you add these line then @reloadinstancedb 
• dealing with .yml file in rathena is really a headche, sometimes it spits error that doesn't make sense, and all you have to do is add/remove a single space or new line ...
  
2. rAthena relies on instance_id(IM_type) to know which instance ID the player belongs in.
   
3. rathena has much less instance related script command, making rathena instance script easier to learn, but there is a drawback
   
   • not as flexible as hercules having *instance_timeout script command ... this value is hardcoded into database so all party has to use the same timeout value
4.  rathena instance ID start from 1, hercules instance ID start from 0
   • make sure the instance_announce is set to 0 

rAthena *instance_enter doesn't work with IM_NONE .... wait is rathena only works with IM_PARTY, all other types doesn't work at this moment

Note: I didn't file a bug report because I was assuming they going to fix in this pull request rAthena has a bug that prevents you from entering multiple instance
34,Instance ONE,3600,15,guild_vs1,49,49 35,Instance TWO,3600,15,guild_vs3,49,49
prontera,150,180,0 script Check Instance 1_F_MARIA,{ OnClick: dispbottom strcharinfo(3); dispbottom instance_id() +""; // this line sux ... but I saw a pull request addressing this issue end; OnInit: bindatcmd "test", strnpcinfo(0)+"::OnClick"; end; } prontera,155,180,0 script Instance ONE 1_F_MARIA,{ if ( getstrlen( instance_mapname("guild_vs1") ) ) { instance_enter "Instance ONE"; end; } if ( instance_create( "Instance ONE", IM_PARTY ) < 0 ) { mes "failed to create instance"; close; } instance_enter "Instance ONE"; end; } prontera,158,180,0 script Instance TWO 1_F_MARIA,{ if ( getstrlen( instance_mapname("guild_vs2") ) ) { instance_enter "Instance TWO"; end; } if ( instance_create( "Instance TWO", IM_GUILD ) < 0 ) { mes "failed to create instance"; close; } instance_enter "Instance TWO"; end; }
Player A has same party with player B.
Player A has same guild with player C.

Player B create Instance ONE for party.
Player C create Instance TWO for guild.

Player A supposedly can go in both instance, but player A can only go to the party instance, not the guild
Hercules doesn't suffer from this issue.
prontera,150,180,0 script Check Instance 1_F_MARIA,{ OnClick: dispbottom strcharinfo(3); dispbottom instance_id() +""; // this script command is useless in hercules, always return -1 on non-instanced npc. An instanced npc don't need to use this script command anyway dispbottom has_instance2("guild_vs1") +""; dispbottom has_instance2("guild_vs2") +""; end; OnInit: bindatcmd "test", strnpcinfo(0)+"::OnClick"; end; } prontera,155,180,0 script Instance ONE 1_F_MARIA,{ if ( has_instance2("guild_vs1") >= 0 ) { warp has_instance("guild_vs1"), 49,49; end; } if ( ( .@ins = instance_create( "Instance ONE", getcharid(CHAR_ID_PARTY), IOT_PARTY ) ) < 0 ) { mes "error : "+ .@ins; close; } if ( !getstrlen( instance_attachmap( "guild_vs1", .@ins, true, .@ins +"INS1" ) ) ) { mes "error : 5"; instance_destroy .@ins; close; } instance_set_timeout 3600, 15, .@ins; instance_init .@ins; warp has_instance("guild_vs1"), 49,49; end; } prontera,158,180,0 script Instance TWO 1_F_MARIA,{ if ( has_instance2("guild_vs2") >= 0 ) { warp has_instance("guild_vs2"), 49,49; end; } if ( ( .@ins = instance_create( "Instance ONE", getcharid(CHAR_ID_GUILD), IOT_GUILD ) ) < 0 ) { mes "error : "+ .@ins; close; } if ( !getstrlen( instance_attachmap( "guild_vs2", .@ins, true, .@ins +"INS2" ) ) ) { mes "error : 5"; instance_destroy .@ins; close; } instance_set_timeout 3600, 15, .@ins; instance_init .@ins; warp has_instance("guild_vs2"), 49,49; end; }

External Links

Help learning instance and how it works - rAthena & Hercules
Doubt about instance_create command

Private MVP Room

not much to say about this ...
other than ... my scripts buried deep inside Script Request section ...
at this moment lazy to write a detail description about ... ahhh ~~ just lazy



Private MVP room 1.4b
https://rathena.org/board/topic/72376-mvp-summon-script/?do=findComment&comment=245270

Private MVP room 1.4c
http://herc.ws/board/topic/4841-annies-mvp-room-disable-spawn/


and of course the cleanest version, thanks to Euphy for asking ~
https://github.com/rathena/rathena/blob/master/npc/custom/etc/mvp_room.txt


when I feel like do instance ... urgh .... rathena and hercules has different methods ... damn

How to install a plugin

Step 1

Download the YourProject.c file in the \src\plugins\ folder

Step 2

If using MSVC 2017, navigate to \vcproj-15\

Step 3

Select plugin-sample.vcxproj, copy paste it

Step 4

Rename plugin-sample - Copy.vcxproj into YourProject.vcxproj
While renaming, Highlight the word YourProject and Copy it by Ctrl+C

Step 5

Right-Click on YourFile.vcxproj, Select Edit with Notepad++, or Microsoft Notepad

Step 6

Find this line
<ProjectName>plugin-sample</ProjectName>

Rename plugin-sample to YourProject by Ctrl+V

Step 7

Find this line
<TargetName Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">sample</TargetName>

Rename sample to YourProject by Ctrl+V
<TargetName Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">YourProject</TargetName>

Step 8

Find this line
<ClCompile Include="..\src\plugins\sample.c" /> 

Rename sample to YourProject by Ctrl+V

Step 9

Press Ctrl+S to save the file.

Step 10

Open Hercules-15.sln,

Step 11

Right-click Hercules-10', Select Add -> Existing Project...

Step 12

Select YourProject.vcxproj in the \vcproj-15\ folder

Step 13

Right-click Hercules-10, Select Build-Solution

 

External Link:

http://herc.ws/wiki/Building_HPM_Plugin_for_MSVC