From The Mana World
Line 215: Line 215:
}
}
</pre>
</pre>
=== 2nd proposal ===
Instead of using : as a separator, we could use a comma and put strings in quotes so you could do something like 19,"ba,z" and ba,z would not be parsed as 2 different strings.
<br><br>


=== Automatically added variables ===
=== Automatically added variables ===

Revision as of 14:46, 25 March 2015

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 "store" instead of "callfunc".

Store npc

Object type: npc
Object name: FooBar#Baz

Property Value
sprite 112
store Item:*1,Item:*1,Item:9

Gives:

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

When using "store" instead of "callfunc" the optional "sprite" and "direction" properties can be used

Basic npc

Object type: npc
Object name: FooBar#Baz

Property Value
callfunc Qux

Gives:

009-1,25,25,0|script|FooBar#Baz|127
{
    set @npcname$, "FooBar";
    callfunc "Qux";
    end;
}

That's nice but the npc does not have a visible sprite, it defaults to 127. 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: FooBar#Baz

Property Value
sprite 161
callfunc Qux

Gives:

009-1,25,25,0|script|FooBar#Baz|161
{
    set @npcname$, "FooBar";
    callfunc "Qux";
    end;
}

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

Setting the direction

Tiled has a built-in "Rotation" properties for objects. To set the direction, set the rotation to any multiple of 90. For example, 90 is facing west and 180 is facing north.

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

Property Value
sprite 161
callfunc Qux

Gives:

009-1,25,25,3|script|FooBar#Baz|161
{
    set @npcname$, "FooBar";
    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:

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


Adding a trigger area

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

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

Gives:

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


Passing arguments to the function (hercules)

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

Property Value
arguments 19:ba,z
trigger 2,4
debug true
sprite 161
callfunc Qux

Gives:

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

2nd proposal

Instead of using : as a separator, we could use a comma and put strings in quotes so you could do something like 19,"ba,z" and ba,z would not be parsed as 2 different strings.

Automatically added variables

Variable Value
@npcname$ Anything that comes before the # (if any) in the object name



Examples

Debug npc

Object type: npc
Object name: Debug#3

Property Value
sprite 154
debug true
callfunc Debug

Gives:

020-1,75,85,0|script|Debug#3|154
{
    set @npcname$, "Debug";
    callfunc "Debug";
    end;
OnInit:
    if(DEBUG) end;
    disablenpc "Debug#3";
    end;
}


Banker

Object type: npc
Object name: Richard

Property Value
sprite 161
callfunc Banker

Gives:

009-2,20,99,0|script|Richard|161
{
    set @npcname$, "Richard";
    callfunc "Banker";
    end;
}