Hercules Wiki - User contributions [en]

OnTouch

2014-01-17T18:42:01Z

Pan: OnTouch npc event

=Syntax=
Map,X,Y,facing%tab%script%tab%NPCName%TABID,triggerX,triggerY,{CODE}

OnTouch:
OnTouchNPC:
 
=Description=
Defines an area that when walked into will trigger one of two event labels depending on block type (BL_MOB or BL_PC)
==Calculating spawned area==
[[File:Ontouch.jpg|thumbnail|A 7*7 area spawned by X:3 Y:3]]
These triggers will define an area, centered on the NPC and spanning triggerX cells in every direction across X coordinate axis and triggerY cells in every direction across Y coordinate axis. Thus each one will have N*2 cells, where N is triggerX or triggerY, plus the one that the NPC is. 
Unlike in arithmetics X and Y will also be taken into account when calculating the area that will trigger the NPC. There are four quadrants, each with triggerX*triggerY cells plus both axes. 
 Note that each coordinate is a cell and does not represent map coordinates! 
4*(x*y) + 2*x + 2*y + 1
A simple way to measure the area of any polygon that will be covered by OnTouch is (triggerX*2+1)*(triggerY*2+1)
 
'''Trick''': Using "end;" at the beginning of the script stops players from executing the script by clicking on the NPC, so they can only execute it if they walk into the specified area.
 
==Event labels==
Two event labels are defined and each one handles one of two block types BL_PC or BL_MOB id est a player or a mob.
 
OnTouch:
Handles player types (BL_PC)
OnTouchNPC:
Handles mob types (BL_MOB) 
If no trigger label is defined the code will execute from the beginning of the script, the same way that it would if someone clicked on the NPC.
==Example==
prontera,147,153,3 script Mary 71,3,3,{
end;

OnTouch:
mes "[Mary]";
mes "Have you seen my lamb?";
close;
OnTouchNPC: // NO ONE IS ATTACHED!
announce "A mob passed here",bc_blue|bc_all;
end;
}
This script will spawn 3 cells in each direction plus a cell in the center.
4*3*3+2*3+2*3+1 = 49
Or
(3*2+1) * (3*2+1) =
7*7 = 49

[[Category:Script Command]]

File:Ontouch.jpg

2014-01-17T17:55:06Z

Pan: OnTouch representing a 7*7 area

OnTouch representing a 7*7 area

Adding New Mapflag

2013-12-25T09:05:37Z

Pan:

== Introduction ==

When scripting, or creating custom automated events, you may wish to add your own custom mapflags. In order to do so, you'll need to complete some source edits. This article will explain how.

----

This article was originally created by [http://www.eathena.ws/board/index.php?showuser=273955 TecnoCronus] on the eAthena forums.

== Adding your mapflag ==

=== Open /src/map/map.h ===
----
'''Find:'''
unsigned src4instance : 1; // To flag this map when it's used as a src map for instances

'''Add below:'''
unsigned mymapflag : 1;

=== Open /src/map/map.c ===
----
'''Find:'''
} else if (!strcmpi(flag,"nocashshop")) {
if( state && map->list[m].flag.nocashshop )
;/* nothing to do */
else {
if( state )
map_zone_mf_cache_add(m,"nocashshop\toff");
else if( map->list[m].flag.nocashshop )
map_zone_mf_cache_add(m,"nocashshop");
}
}

'''Add below:'''
else if( !strcmpi(flag,"mymapflag")) {
if( state && map->list[m].flag.mymapflag )
; /* nothing to do */
else {
if( state )
map_zone_mf_cache_add(m,"mymapflag\toff");
else if( map->list[m].flag.mymapflag )
map_zone_mf_cache_add(m,"mymapflag");
}
}

=== Open /src/map/script.h ===
----
'''Find:'''
MF_NOCASHSHOP

'''Replace with:'''
MF_NOCASHSHOP,
MF_MYMAPFLAG

=== Open /src/map/script.c ===
----
'''Find:'''
case MF_GUILDLOCK: script_pushint(st,map[m].flag.guildlock); break;

'''Below add:'''
case MF_MYMAPFLAG: script_pushint(st,map[m].flag.mymapflag); break;

----

'''Find:'''
case MF_GUILDLOCK: map[m].flag.guildlock=1; break;

'''Below add:'''
case MF_MYMAPFLAG: map[m].flag.mymapflag=1; break;

----

'''Find:'''
case MF_GUILDLOCK: map[m].flag.guildlock=0; break;

'''Below add:'''
case MF_MYMAPFLAG: map[m].flag.mymapflag=0; break;

=== Open /src/map/npc.c ===
----
'''Find:'''
else if (!strcmpi(w3,"guildlock"))
map[m].flag.guildlock=state;

'''Below add:'''
else if (!strcmpi(w3,"mymapflag"))
map[m].flag.mymapflag=state;

=== Open /db/const.txt ===
----
'''Find:'''
mf_guildlock<tab>45

'''Below add:'''
mf_mymapflag<tab>46

== Listing your mapflag in atcommands ==

=== Open /src/map/atcommand.c ===
----
'''Find:'''
if (map->list[m_id].flag.nomemo)
strcat(atcmd_output, msg_txt(1064)); // NoMemo |

'''Below add:'''
if (map->list[m_id].flag.mymapflag)
strcat(atcmd_output, "mymapflag |");

'''Find:'''
CHECKFLAG(nocashshop);

'''Below add:'''
CHECKFLAG(mymapflag);

'''Find:'''
SETFLAG(nocashshop);

'''Below add:'''
SETFLAG(mymapflag);

'''Find:'''
clif->message(sd->fd,"guildlock, src4instance, notomb, nocashshop");

'''Replace it with:'''
clif->message(sd->fd,"guildlock, src4instance, notomb, nocashshop, mymapflag");

== Conclusion ==

Recompile and you can now set "mymapflag" to any value. Remember, you can rename the mapflag to whatever, and later use the flag option anywhere else in your source code.

[[Category:Source Snippets]]