From The Mana World
m (Gumi moved page User:Meko/Tiled/NPC Proposal to User:Gumi/Tiled/NPC Proposal: Automatically moved page while renaming the user "Meko" to "Gumi")
 
(9 intermediate revisions by the same user not shown)
Line 3: Line 3:


= Usage =
= Usage =
For the examples below we will use the map 009-1 and position 25, 25. The only mandatory property to make a npc is "callfunc". To make a store, put "shop" instead of "callfunc".
For the examples below we will use the map 009-1 and position 25, 25. The only mandatory property to make a npc is "callfunc". To make a store, put "items" instead of "callfunc".
<br>
<br>
== Shop npc [RC] ==
== Shop npc [RC] ==
Line 25: Line 25:
</pre>
</pre>
<br>
<br>
== Anonymous npc ==
if you do not care what name your npc has you can set its name to # to get an auto-generated name. This is particularly useful for npcs that only activate when you walk over them.
<br><br>
Object type: npc<br>
Object name: '''#'''
{| class="wikitable" border="1"
|-
! Property
! Value
|-
| callfunc
| Qux
|}
Gives in Hercules: <pre>
009-1,25,25,0    script    #009-1_anon0    32767,{
    callfunc "Qux", "", 25, 25;
    end;
}
</pre>
<br>
Gives in TMWA: <pre>
009-1,25,25,0|script|#009-1_anon0|32767
{
    set @npcname$, "";
    setarray @npcloc, 25, 25;
    callfunc "Qux";
    end;
}
</pre>
<br>
'''''@wushin: it's up to you to decide the naming convention of anonymous npcs'''''
<br><br>


== Semi-anonymous npc ==
== Semi-anonymous npc ==
When you have multiple copies of a npc with the same name, you can add '''#''' at the end '''without anything else''' to append an auto-generated suffix. For example, the barrels would become barrel# instead of barrel#(number). This way you do not have to worry about giving a safe name to a npc.
When you have multiple copies of a npc with the same name, you can add '''#''' at the end '''without anything else''' to append an auto-generated suffix. For example, the barrels would become barrel# instead of barrel#(number). This way you do not have to worry about giving a safe name to a npc.
This also works for npcs starting and ending with # like #Knockback#.
<br><br>
<br><br>
Object type: npc<br>
Object type: npc<br>
Line 76: Line 43:
Gives in Hercules: <pre>
Gives in Hercules: <pre>
009-1,25,25,0    script    FooBar#009-1_0    32767,{
009-1,25,25,0    script    FooBar#009-1_0    32767,{
     callfunc "Qux", "FooBar", 25, 25;
     callfunc "Qux";
     end;
     end;
}
}
Line 82: Line 49:
<br>
<br>
Gives in TMWA: <pre>
Gives in TMWA: <pre>
009-1,25,25,0|script|FooBar#009-1_anon0|32767
009-1,25,25,0|script|FooBar#009-1_0|32767
{
{
    set @npcname$, "FooBar";
    setarray @npcloc, 25, 25;
     callfunc "Qux";
     callfunc "Qux";
     end;
     end;
Line 94: Line 59:
== Named npc ==
== Named npc ==
Object type: npc<br>
Object type: npc<br>
Object name: FooBar#Baz
Object name: FooBar
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 105: Line 70:


Gives in Hercules: <pre>
Gives in Hercules: <pre>
009-1,25,25,0    script    FooBar#Baz   32767,{
009-1,25,25,0    script    FooBar    32767,{
     callfunc "Qux", "FooBar", 25, 25;
     callfunc "Qux";
     end;
     end;
}
}
Line 112: Line 77:
<br>
<br>
Gives in TMWA: <pre>
Gives in TMWA: <pre>
009-1,25,25,0|script|FooBar#Baz|32767
009-1,25,25,0|script|FooBar|32767
{
{
    set @npcname$, "FooBar";
    setarray @npcloc, 25, 25;
     callfunc "Qux";
     callfunc "Qux";
     end;
     end;
Line 126: Line 89:
== Adding a sprite ==
== Adding a sprite ==
Object type: npc<br>
Object type: npc<br>
Object name: FooBar#Baz
Object name: #
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 140: Line 103:


Gives in Hercules: <pre>
Gives in Hercules: <pre>
009-1,25,25,0    script    FooBar#Baz   161,{
009-1,25,25,0    script    #009-1_anon0   161,{
     callfunc "Qux", "FooBar", 25, 25;
     callfunc "Qux";
     end;
     end;
}
}
Line 147: Line 110:
<br>
<br>
Gives in TMWA: <pre>
Gives in TMWA: <pre>
009-1,25,25,0|script|FooBar#Baz|161
009-1,25,25,0|script|#009-1_anon0|161
{
{
    set @npcname$, "FooBar";
    setarray @npcloc, 25, 25;
     callfunc "Qux";
     callfunc "Qux";
     end;
     end;
Line 178: Line 139:
Gives in Hercules: <pre>
Gives in Hercules: <pre>
009-1,25,25,3    script    FooBar#Baz    161,{
009-1,25,25,3    script    FooBar#Baz    161,{
     callfunc "Qux", "FooBar", 25, 25;
     callfunc "Qux";
     end;
     end;
}
}
Line 186: Line 147:
009-1,25,25,3|script|FooBar#Baz|161
009-1,25,25,3|script|FooBar#Baz|161
{
{
    set @npcname$, "FooBar";
    setarray @npcloc, 25, 25;
     callfunc "Qux";
     callfunc "Qux";
     end;
     end;
Line 215: Line 174:
Gives in Hercules: <pre>
Gives in Hercules: <pre>
009-1,25,25,3    script    FooBar#Baz    161,{
009-1,25,25,3    script    FooBar#Baz    161,{
     callfunc "Qux", "FooBar", 25, 25;
     callfunc "Qux";
     end;
     end;
OnInit:
OnInit:
Line 227: Line 186:
009-1,25,25,3|script|FooBar#Baz|161
009-1,25,25,3|script|FooBar#Baz|161
{
{
    set @npcname$, "FooBar";
    set @npcloc, 25, 25;
     callfunc "Qux";
     callfunc "Qux";
     end;
     end;
Line 265: Line 222:
     end;
     end;
OnTouch:
OnTouch:
     callfunc "Qux", "FooBar", 25, 25;
     callfunc "Qux";
     end;
     end;
OnInit:
OnInit:
Line 279: Line 236:
     end;
     end;
OnTouch;
OnTouch;
    set @npcname$, "FooBar";
    set @npcloc, 25, 25;
     callfunc "Qux";
     callfunc "Qux";
     end;
     end;
Line 320: Line 275:
     end;
     end;
OnTouch:
OnTouch:
     callfunc "Qux", "FooBar", 25, 25;
     callfunc "Qux";
     end;
     end;
OnTimer10000:
OnTimer10000:
Line 340: Line 295:
     end;
     end;
OnTouch:
OnTouch:
    set @npcname$, "FooBar";
    set @npcloc, 25, 25;
     callfunc "Qux";
     callfunc "Qux";
     end;
     end;
Line 390: Line 343:
     end;
     end;
OnTouch:
OnTouch:
     callfunc "Qux", "FooBar", 25, 25, 19, "ba,z";
     callfunc "Qux", 19, "ba,z";
     end;
     end;
OnTimer10000:
OnTimer10000:
Line 404: Line 357:
}
}
</pre>
</pre>
=== Automatically added properties ===
{| class="wikitable" border="1"
|-
! Property
! Value
|-
| name
| Anything that comes before the # (if any) in the object name
|-
| X
| the X location of the npc
|-
| Y
| the Y location of the npc
|}
Any custom property is added after the default properties
<br><br>
<br><br>


Line 464: Line 400:
     set @integer, 19;
     set @integer, 19;
     set @string$, "ba,z";
     set @string$, "ba,z";
    set @npcname$, "FooBar";
    setarray @npcloc, 25, 25;
     callfunc "Qux";
     callfunc "Qux";
     end;
     end;
Line 480: Line 414:
}
}
</pre>
</pre>
 
<br>
=== Automatically added variables ===
{| class="wikitable" border="1"
|-
! Variable
! Value
|-
| @npcname$
| Anything that comes before the # (if any) in the object name
|-
| @npcloc
| an array of the X and the Y location of the npc
|}
<br><br>

Latest revision as of 19:42, 15 June 2020

This proposal is to enable npc creation from Tiled. It could even provide a way to add a "npc finder" to manaplus so that players can easily know where a npc is (manaplus would simply have to look at the tmx). Should not be used for floating npcs (no map).

Usage

For the examples below we will use the map 009-1 and position 25, 25. The only mandatory property to make a npc is "callfunc". To make a store, put "items" instead of "callfunc".

Shop npc [RC]

Object type: shop
Object name: FooBar#Baz

Property Value
items Item,Item:*2,Item,Item:9

Gives in Hercules: 

009-1,25,25,0    shop    FooBar#Baz    32767,Item:*1,Item:*2,Item:*1,Item:9


Gives in TMWA: 

009-1,25,25,0|shop|FooBar#Baz|32767,Item:*1,Item:*2,Item:*1,Item:9


Semi-anonymous npc

When you have multiple copies of a npc with the same name, you can add # at the end without anything else to append an auto-generated suffix. For example, the barrels would become barrel# instead of barrel#(number). This way you do not have to worry about giving a safe name to a npc. This also works for npcs starting and ending with # like #Knockback#.

Object type: npc
Object name: FooBar#

Property Value
callfunc Qux

Gives in Hercules: 

009-1,25,25,0    script    FooBar#009-1_0    32767,{
    callfunc "Qux";
    end;
}


Gives in TMWA: 

009-1,25,25,0|script|FooBar#009-1_0|32767
{
    callfunc "Qux";
    end;
}


Named npc

Object type: npc
Object name: FooBar

Property Value
callfunc Qux

Gives in Hercules: 

009-1,25,25,0    script    FooBar    32767,{
    callfunc "Qux";
    end;
}


Gives in TMWA: 

009-1,25,25,0|script|FooBar|32767
{
    callfunc "Qux";
    end;
}

That's nice but this npc is not sent to the client since its ID is 32767. Let's add a sprite.

@wushin: There is a "end;" instead of a "close;" because not all function send "mes" so "close2;" should be put before "return;" in the functions

Adding a sprite

Object type: npc
Object name: #

Property Value
sprite 161
callfunc Qux

Gives in Hercules: 

009-1,25,25,0    script    #009-1_anon0    161,{
    callfunc "Qux";
    end;
}


Gives in TMWA: 

009-1,25,25,0|script|#009-1_anon0|161
{
    callfunc "Qux";
    end;
}

The "sprite" property is non-mandatory and defaults to 32767 when not set.

Setting the direction

Tiled has a built-in "Rotation" property for objects. To set the direction, set the rotation to any multiple of 90 (or a multiple of 45 if your npc supports all 8 directions). The minimum is -180 and the maximum is 180. For example, 90 is facing west and 180 (or -180) is facing north.

Object type: npc
Object name: FooBar#Baz
Rotation: 90

Property Value
sprite 161
callfunc Qux

Gives in Hercules: 

009-1,25,25,3    script    FooBar#Baz    161,{
    callfunc "Qux";
    end;
}


Gives in TMWA: 

009-1,25,25,3|script|FooBar#Baz|161
{
    callfunc "Qux";
    end;
}


Setting as debug npc

Object type: npc
Object name: FooBar#Baz
Rotation: 90

Property Value
debug true
sprite 161
callfunc Qux

Gives in Hercules: 

009-1,25,25,3    script    FooBar#Baz    161,{
    callfunc "Qux";
    end;
OnInit:
    if(DEBUG) end;
    disablenpc "FooBar#Baz";
    end;
}


Gives in TMWA: 

009-1,25,25,3|script|FooBar#Baz|161
{
    callfunc "Qux";
    end;
OnInit:
    if(DEBUG) end;
    disablenpc "FooBar#Baz";
    end;
}


Adding a trigger area

Object type: npc
Object name: FooBar#Baz
Rotation: 90

Use tiled to mark the area of the trigger. To have a 0,0 trigger set the "trigger" property to "true".

Property Value
debug true
sprite 161
callfunc Qux

Gives in Hercules: 

009-1,25,25,3    script    FooBar#Baz    161,2,4,{
    end;
OnTouch:
    callfunc "Qux";
    end;
OnInit:
    if(DEBUG) end;
    disablenpc "FooBar#Baz";
    end;
}


Gives in TMWA: 

009-1,25,25,3|script|FooBar#Baz|161,2,4
{
    end;
OnTouch;
    callfunc "Qux";
    end;
OnInit:
    if(DEBUG) end;
    disablenpc "FooBar#Baz";
    end;
}


Adding a recurring timer

Object type: npc
Object name: FooBar#Baz
Rotation: 90

Property Value
interval 10000,Function
trigger 2,4
debug true
sprite 161
callfunc Qux

Gives: 

009-1,25,25,3    script    FooBar#Baz    161,2,4,{
    end;
OnTouch:
    callfunc "Qux";
    end;
OnTimer10000:
    callfunc "Function";
    initnpctimer;
    end;
OnInit:
    if(DEBUG >= 2) end;
    initnpctimer;
    if(DEBUG) end;
    disablenpc "FooBar#Baz";
    end;
}


Gives in TMWA: 

009-1,25,25,3|script|FooBar#Baz|161,2,4
{
    end;
OnTouch:
    callfunc "Qux";
    end;
OnTimer10000:
    callfunc "Function";
    initnpctimer;
    end;
OnInit:
    if(DEBUG >= 2) end;
    initnpctimer;
    if(DEBUG) end;
    disablenpc "FooBar#Baz";
    end;
}


Passing arguments to the function (Hercules only)

Object type: npc
Object name: FooBar#Baz
Rotation: 90

Property Value
arguments 19,"ba,z"
interval 10000,Function
trigger 2,4
debug true
sprite 161
callfunc Qux

Gives in Hercules: 

009-1,25,25,3    script    FooBar#Baz    161,2,4,{
    end;
OnTouch:
    callfunc "Qux", 19, "ba,z";
    end;
OnTimer10000:
    callfunc "Function";
    initnpctimer;
    end;
OnInit:
    if(DEBUG >= 2) end;
    initnpctimer;
    if(DEBUG) end;
    disablenpc "FooBar#Baz";
    end;
}




Adding custom variables (TMWA only)

For TMWA, any property that starts with @ is interpreted as a custom variable.

Object type: npc
Object name: FooBar#Baz
Rotation: 90

Property Value
@integer 19
@string$ ba,z
interval 10000,Function
trigger 2,4
debug true
sprite 161
callfunc Qux

Gives in TMWA: 

009-1,25,25,3|script|FooBar#Baz|161,2,4
{
    end;
OnTouch:
    set @integer, 19;
    set @string$, "ba,z";
    callfunc "Qux";
    end;
OnTimer10000:
    callfunc "Function";
    initnpctimer;
    end;
OnInit:
    if(DEBUG >= 2) end;
    initnpctimer;
    if(DEBUG) end;
    disablenpc "FooBar#Baz";
    end;
}


Retrieved from "https://oldwiki.themanaworld.org/index.php?title=User:Gumi/Tiled/NPC_Proposal&oldid=51237"