https://oldwiki.devbox.themanaworld.org/api.php?action=feedcontributions&feedformat=atom&user=Move+page+scriptThe Mana World - User contributions [en]2026-05-06T03:16:28ZUser contributionsMediaWiki 1.43.8https://oldwiki.devbox.themanaworld.org/index.php?title=Dev:Working_With_Git&diff=59583Dev:Working With Git2024-03-27T03:56:50Z<p>Move page script: Move page script moved page Dev:Working With Git to Development:Working With Git: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Development:Working With Git]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Development:Working_With_Git&diff=59582Development:Working With Git2024-03-27T03:56:50Z<p>Move page script: Move page script moved page Dev:Working With Git to Development:Working With Git: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>Git is a distributed revision control and source code management system.<br />
<br />
[https://github.com/ GitHub] and [https://gitlab.com/ GitLab] are web-based hosting service for projects that use the Git revision control system.<br />
<br />
Together, these two tools allow developers working on The Mana World to easily collaborate and merge changes into the game.<br />
<br />
== Installing Git ==<br />
<br />
To install Git, select the appropriate Operating System at [http://git-scm.com/downloads/ Git Downloads] and follow the instructions. (For Windows users, accept all the default settings for the installer.)<br />
*Please note that although the download for Windows includes a GUI tool, we will focus on the Git Bash command line tool in order to maintain consistency across platforms.<br />
<br />
After installation, please follow the basic setup instructions at [https://help.github.com/articles/set-up-git/ GitHub] under the Set Up Git heading.<br />
<br />
You will likely also want to set up SSH authentication for GitHub. This can be done by following their [https://help.github.com/articles/generating-ssh-keys/ SSH Guide].<br />
<br />
== Preparing To Use Git ==<br />
<br />
=== Creating a Fork ===<br />
Once you have installed Git, your first task should be to create a personal copy (also known as a fork) of the server data on your GitLab account. This will allow you to make changes and save them to a place where the content leaders can retrieve copies to include in the main server. It's also easier to work with.<br />
<br />
To create a fork, login to your GitLab account and go to the [https://git.themanaworld.org/evolved/serverdata/ TMW Repository].<br />
*You will see a button on the page that says Fork. Click it.<br />
*You should now see a page that has some details and history for the fork you just created. At the top will be a series of buttons including one that says SSH. Clicking the SSH button will create a link for you to copy which will be needed in the next step. It will look like ''https://git.themanaworld.org/yournamehere/serverdata.git''. Copy that link or keep the page open; we'll need it later.<br />
<br />
If you will be working with client-data or music, you will need to create separate forks for those repositories as well.<br />
*[https://git.themanaworld.org/evolved/clientdata/ client-data]<br />
*[https://gitlab.com/themanaworld/tmw-music/ music]<br />
<br />
Keep in mind you'll need more tools to run a localhost, see appropriate pages regarding that.<br />
<br />
=== Creating a Clone ===<br />
You now need to create a copy of the data on your computer to work with (also known as a clone). We will create a clone from the main repository and set up Git to allow you to push changes to your personal fork.<br />
<br />
If you are using Windows, open the Git Bash tool which you installed earlier.<br />
<br />
If you are using Linux, open a terminal window.<br />
*Navigate to the folder where you want to create your clone.<br />
*Now issue the command to have Git create a copy: '''''git clone --recursive https://git.themanaworld.org/evolved/serverdata.git serverdata'''''<br />
**The ''--recursive'' command tells Git to copy all of the data from the included submodules (client-data and music). If you don't plan on working with these, it can be omitted.<br />
** Currently, only TMWA has these as submodules, so it can also be omitted.<br />
**The ''serverdata'' at the end of the command is the name of the folder you want the data in. In the example, ''git clone --recursive https://git.themanaworld.org/evolved/serverdata.git serverdata'' will create a new folder called serverdata and put the files inside that folder. You can use any folder name that makes sense to you.<br />
<br />
Note that copying the data may take some time.<br />
<br />
After the data is finished cloning to your computer, you need to tell it how to keep track of changes.<br />
<br />
=== Creating Remotes ===<br />
<br />
When a repo (short for repository) is cloned, it has a default remote called ''origin'' that points to the repo it was cloned from. To allow you to make changes on your personal fork, you need to add another remote which we will name ''fork''.<br />
*Change to the directory you created when you cloned your repo: '''''cd serverdata'''''<br />
*Using the link we found at the end of the Creating a Fork section, issue the command '''''git remote add fork https://git.themanaworld.org/yournamehere/serverdata.git'''''<br />
<br />
We'll also need to add remote pointers and select the correct branch for the submodules, if you cloned them. This currently only applies to tmwa servers.<br />
*'''''cd client-data'''''<br />
*'''''git remote add client-data https://git.themanaworld.org/yournamehere/clientdata.git'''''<br />
*'''''git checkout master'''''<br />
*'''''cd music'''''<br />
*'''''git remote add music https://git.themanaworld.org/yournamehere/tmw-music.git'''''<br />
*'''''git checkout master'''''<br />
<br />
Git includes the ability to work with ''branches'', or multiple versions of files. This can provide a way to work on separate projects without having to create a new clone for each one. We won't be going too deeply into this option, but the option is there once you are more comfortable. By default, you will be working on the ''master'' branch. The command above, ''git checkout master'', tells the submodule which branch you want to use.<br />
<br />
At this point you now have a personal fork, a local clone, and remote pointers for your fork. You're ready to start making changes! You are free to use whatever tools work for you to make your changes, but please ensure that the final results are in harmony with The Mana World's formatting guidelines. There's [[TmwAthena Scripting Standards]] and Evol2 Scripting Standards (the later based on Linux Kernel Convention).<br />
<br />
== Day-to-day Use ==<br />
<br />
=== Retrieving Changes ===<br />
<br />
Because many developers are working on the project at the same time, you will want to make sure you have all the latest changes before making a commit. This will ensure that your changes do not conflict with changes another developer has made. <br />
<br />
If you have not made any changes yet and want to make sure your clone is up-to-date before starting to work, you can simply pull from the repo.<br />
*'''''git pull'''''<br />
<br />
If you have made local changes and want to get the latest updates before continuing, you will need to tell Git to get the updates and then apply your changes on top of them.<br />
*'''''git pull --rebase'''''<br />
<br />
=== Making Commits ===<br />
<br />
After making changes to any of the source files (maps, graphics, scripts) you will want to save those changes so other developers can see and review them. You need to commit those changes to Git. When committing files to Git, you will need to have a terminal or Git Bash open in the directory containing the changes. For example, if you are changing music files, you will need to be in the ''TMW/clientdata/music'' folder.<br />
<br />
Your first step toward making a commit is to verify that Git recognizes there have been changes.<br />
*'''''git status'''''<br />
You will receive a result that tells you what branch you are working on, what files (if any) have been modified, and what files (if any) are untracked. At this point, we want to add our changed or untracked files to Git.<br />
*Issue the command '''''git add <file>''''' replacing <file> with the path and filename of the file to be added. Be careful: the commands ARE case sensitive!<br />
*Repeat as needed until your changed files are all added.<br />
*Issue the command '''''git commit -m 'your message here''''''<br />
**Using the ''-m'' switch in the command allows you to specify a brief commit message which will tell others what the changes are.<br />
**For example, ''git commit -m 'Spelling corrections for Beer quest''' will tell others that we made corrections that might apply to multiple files, without giving an overload of detail. If you aren't sure how much detail to include in a commit message, you can check with the development team on IRC for suggestions.<br />
<br />
=== Pushing to a Fork ===<br />
<br />
Once you have committed your changes to your local clone, you now have to put them where they can be seen: your fork. To ensure that your fork will match what you have in your local clone, we will tell Git to force the changes to the repo.<br />
*'''''git push -f fork master'''''<br />
**Please note that using the -f option to force your changes causes Git to overwrite commit history on the repo. This option should only ever be used on personal forks to bring them into the same state as the main repo.<br />
If you have been working on and committing changes to music or client-data, you will need to push those to their respective forks.<br />
*'''''git push -f client-data master'''''<br />
*'''''git push -f music master'''''</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Dev:Units.xml&diff=59581Dev:Units.xml2024-03-27T03:56:50Z<p>Move page script: Move page script moved page Dev:Units.xml to Development:Units.xml: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Development:Units.xml]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Development:Units.xml&diff=59580Development:Units.xml2024-03-27T03:56:50Z<p>Move page script: Move page script moved page Dev:Units.xml to Development:Units.xml: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>This file describes the various units used in the interface, like currency and weight.<br />
<br />
==Structure==<br />
Unit files are in XML format.<br />
<br />
===&lt;units&gt;===<br />
This is the root element of the file.<br />
<br />
===&lt;unit&gt;===<br />
And individual unit definition. <code>unit</code>s have <code>type</code>s, <code>base</code>s, <code>mixed</code>, and <code>round</code>, and <code>conversion</code> values. The <code>type</code> describes the function of this unit, like "currency" or "weight". The <code>base</code> is the symbol of the base unit, like "gold" or "g" (gram). The optional <code>mixed</code> describes how to handle different units (described later; default tbd). <code>round</code> describes how many decimal places to round decimals (defaults to 2 places). <code>conversion</code> is the factor applied to the internal units to reach these units (defaults to 1).<br />
<br />
===&lt;level&gt;===<br />
Each unit can have multiple levels. <code>level</code>s have <code>symbol</code>s, <code>count</code>s, and <code>round</code>s. <code>symbol</code> is the symbol to use for this level. <code>count</code> describes how many of the previous level is needed to for this level. <code>round</code> is as above, except it only applies to this level.<br />
<br />
==Example==<br />
<br />
<code><br />
&lt;units&gt;<br />
&lt;unit type="currency" base="GP"/&gt;<br />
&lt;unit type="weight" base="g" mixed="no"&gt;<br />
&lt;level symbol="kg" count="1000"/&gt;<br />
&lt;/unit&gt;<br />
...<br />
&lt;/units&gt;<br />
</code><br />
<br />
When <code>mixed</code> is <code>no</code>, a decimal with the largest units needed is used (ex: 1.05kg). When <code>mixed</code> is <code>yes</code>, all non-0 levels are shown (ex: 1kg, 50g).</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Dev:ToDo&diff=59579Dev:ToDo2024-03-27T03:56:49Z<p>Move page script: Move page script moved page Dev:ToDo to Development:ToDo: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Development:ToDo]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Development:ToDo&diff=59578Development:ToDo2024-03-27T03:56:49Z<p>Move page script: Move page script moved page Dev:ToDo to Development:ToDo: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>=== Introduction ===<br />
You can always find the latest and most up to date information on [https://gitlab.com/groups/evol/-/milestones Gitlab Milestones].<br />
<br />
As the gitlab milestones gets automatically updated as tasks are complete, they are often more up-to-date than this file.<br />
<br />
----<br />
<br />
This is currently the ToDo list for The Mana World following the ''TMW-Evol fusion''. The release (progress seen on milestones) should result in the Alpha release from '''TMW: rEvolt'''.<br />
<br />
=== ToDo list ===<br />
====Maps====<br />
* (✔) Add missing block pillars around city houses.<br />
* (✘) Complete the Agora and add more tile variation on the ground of Artis (Map).<br />
* (✘) Warehouse second level.<br />
* (✘) Fix Artis indoor's map names.<br />
* (✘) Add particle effects for pillar's signes on Artis.<br />
<br />
====GFX====<br />
* (✔) Add library poems as items.<br />
* (✔) Robin librairian sprite.<br />
* (✔) Christopher librairian sprite.<br />
* (✔) Leonard librairian sprite.<br />
* (✔) Schemag item.<br />
* (✔) Mona sprite.<br />
* (✔) Hairstyle position fixes.<br />
* (✔) Add missing block pillars on artis-pillar_x2.<br />
* (✔) Oscar NPC.<br />
* (✘) Fishing animation, fishing rod put on a pedestale that move some seconds before to catch a fish.<br />
* (✘) [[http://forums.evolonline.org/viewtopic.php?p=52|New logo]]<br />
* (✘) Add Ilmari Betsu as the library receptionist.<br />
* (✘) Package item icon.<br />
<br />
====XML====<br />
* (✔) Put most of the poems, novels, didactel inside book items.<br />
* (✔) Pillar's sign highlights.<br />
* (✘) Fishing animation, fishing rod put on a pedestale that move some seconds before to catch a fish.<br />
* (✘) Update the Atlas list.<br />
* (✘) Add particle effects for digging locations.<br />
<br />
====Script====<br />
* (✔) Use delayed healing instead of static healing in potion and most usable items.<br />
* (✔) Change the effect of the elixir to a 100% hp/sp recovery.<br />
* (✔) Reduce delay between the use of multiple consumable items.<br />
* (✔) Remove translation from books in the library.<br />
* (✔) Add different store for different kind of dye in calypsan's shop place.<br />
* (✔) Using Vitality inside the rand formula for itemheal.<br />
* (✔) Add Party NPC in the town hall.<br />
* (✔) Add Guild NPC in the town hall.<br />
* (✔) Put most of the poems, novels, didactel inside book items.<br />
* (✔) Add scripts on block pillars that says who own the house or what this is house is for.<br />
* (✔) Increase the number of fishing spots.<br />
* (✔) Rewrite Xilaxa's walk path with graph walk path.<br />
* (✔) Add bleacher NPC that bleach/discolor dyed items.<br />
* (✔) Enable free savepoints on every house where no NPC is near.<br />
* (✔) Mona the woman in the rich hill.<br />
* (✘) Mona's dad quests information over the manhole next to the house.<br />
* (✘) Fishing animation, fishing rod put on a pedestale that move some seconds before to catch a fish.<br />
* (✘) Better explanation of how pets work in Salem and in the library (Script).<br />
* (✘) Distribute poems/novels throughout Artis.<br />
* (✘) Walking/Swimming NPC support for fishing spots.<br />
* (✘) Add missing walking NPCs:<br />
* NPC_DEMON_F_ARTIS,<br />
* PC_HUMAN_M_ARTIS,<br />
* NPC_BINKSAN.<br />
* (✘) Add missing La Johanne NPCs:<br />
* Arpan, INN<br />
* Billy Bons, INN<br />
* Darlin, Dock<br />
* Silvio, INN<br />
* Lean, Dock<br />
* Max, INN<br />
* Sapartan, INN<br />
* Tibbo, ??<br />
* Gulukan, ??<br />
* Q'Muller, Dock<br />
* Astapolos, Dock<br />
* Jalad, ??<br />
* Tarlan, Market Area<br />
* Ale, INN<br />
* Couwan, ??<br />
* (✘) Robin the librarian.<br />
* (✘) Leonard the librarian.<br />
* (✘) Christopher the librarian.<br />
* (✘) Introduce mount dialogue on Taree.<br />
* (✘) Add more tree leaf animation.<br />
* (✔) Add MananaTree mob in Artis.<br />
* (✔) Create a legiontalk function based on the villagertalk that introduce some gamestory element.<br />
* (✘) Introduce Alex Grothendieck as the ex-member of the Legion and the now-chief of the Brotherhood movement.<br />
* (✘) Add in Chef Gado the list of mobs that correspond to the drops that he asks to search.<br />
* (✘) Prevent the cookie to be used too long, and too many time.<br />
* (✘) Add Legion training room that spawn X waves of Dummy mobs.<br />
* (✘) Add Legion fighting room that create a survival PvE game mode against the Legion.<br />
* (✘) Improve the fighting room with instance support.<br />
* (✘) Add legion basic PvP support.<br />
* (✘) Add Wedding NPC in the town hall.<br />
* (✘) Add Ilmari Betsu as the library receptionist.<br />
* (✘) Implement new CookieMaster.<br />
* (✘) Reduce delay for monster respawn in the introduction island.<br />
* (✘) Salem gives pet's instruction book.<br />
* (✘) Add a generic special function for door warps in Artis that will block mounts and barrels to enter in houses.<br />
* (✘) Add book collector quests with the possibility to add a book in the library to complete the collection or to keep it for self.<br />
* (✘) Limit to only one the number of fishing action per player.<br />
<br />
====Guidelines====<br />
* (✘) Set some guidelines for insult, trashtalk, etc... in NPC dialogue that somehow equal the European PEGI-12 classification.<br />
<br />
====Music====<br />
* (✘) Music theme for the legion.<br />
* (✘) Music theme for a "battle" background.</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Dev:TmwAthena_Scripting_Standards/Warp_Details&diff=59577Dev:TmwAthena Scripting Standards/Warp Details2024-03-27T03:56:49Z<p>Move page script: Move page script moved page Dev:TmwAthena Scripting Standards/Warp Details to Development:TmwAthena Scripting Standards/Warp Details: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Development:TmwAthena Scripting Standards/Warp Details]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Development:TmwAthena_Scripting_Standards/Warp_Details&diff=59576Development:TmwAthena Scripting Standards/Warp Details2024-03-27T03:56:49Z<p>Move page script: Move page script moved page Dev:TmwAthena Scripting Standards/Warp Details to Development:TmwAthena Scripting Standards/Warp Details: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>This subpage details information on warp usage.<br />
<br />
==Warp Sizes==<br />
Warp sizes are nonintuitive. This article aims to help describe them.<br />
<br />
Width and height work basically the same, so only one will be described here. What applies to west, applies to north. What applies to east, applies to south. Here is an overview of how it works:<br />
<br />
{|<br />
| <br />
!colspan=4| West<br />
| <br />
!colspan=4| East<br />
|-<br />
! Tiles<br />
| ...<br />
| 4<br />
| 3<br />
| 2<br />
| 1<br />
! 0<br />
| 1<br />
| 2<br />
| 3<br />
| 4<br />
| ...<br />
|-<br />
! Width<br />
| ...<br />
| 6<br />
| 4<br />
| 2<br />
| 0<br />
| -1<br />
| 1<br />
| 3<br />
| 5<br />
| 7<br />
| ...<br />
|}<br />
<br />
So, a width of negative one restricts the warp to the column of tiles specified by it's location, while a width of four extends it three tiles west, and two tiles east. A width less than negative one makes the warp disappear.<br />
<br />
==Placing warps==<br />
To place warps on maps in a way that the player notices the least hopping during the map transfer the source and the target area of a warp have to be in the same (visual) location. The two warps have to be placed in a way that the outgoing warp is right behind the incomming one. The outgoing warp may not be blocked but the blocked area has to start right behind it.<br />
<pre><br />
MAP A MAP B<br />
<br />
XXXXXXX X X<br />
XOOOOOX X i X <br />
X i X XOOOOOX<br />
X X XXXXXXX<br />
<br />
X: Blocked<br />
O: Outgoing warp<br />
i: Incomming warp<br />
</pre><br />
<br />
[[Category:Server Development]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Dev:TmwAthena_Scripting_Standards/Mob_Details&diff=59575Dev:TmwAthena Scripting Standards/Mob Details2024-03-27T03:56:49Z<p>Move page script: Move page script moved page Dev:TmwAthena Scripting Standards/Mob Details to Development:TmwAthena Scripting Standards/Mob Details: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Development:TmwAthena Scripting Standards/Mob Details]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Development:TmwAthena_Scripting_Standards/Mob_Details&diff=59574Development:TmwAthena Scripting Standards/Mob Details2024-03-27T03:56:49Z<p>Move page script: Move page script moved page Dev:TmwAthena Scripting Standards/Mob Details to Development:TmwAthena Scripting Standards/Mob Details: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>Mob spawn areas are nonintuitive. This article aims to help describe them.<br />
<br />
Width and height work basically the same, so only one will be described here. What applies to west, applies to north. What applies to east, applies to south. Here is an overview of how it works:<br />
<br />
{|<br />
| <br />
!colspan=4| West<br />
| <br />
!colspan=4| East<br />
|-<br />
! Tiles<br />
| ...<br />
| 4<br />
| 3<br />
| 2<br />
| 1<br />
! 0<br />
| 1<br />
| 2<br />
| 3<br />
| 4<br />
| ...<br />
|-<br />
! Width<br />
| ...<br />
| 8<br />
| 6<br />
| 4<br />
| 2<br />
| 0<br />
| 1<br />
| 3<br />
| 5<br />
| 7<br />
| ...<br />
|}<br />
<br />
So, a width of zero restricts the area to the column of tiles specified by it's location, while a width of three extends it one tile west, and two tiles east. A width less than zero will prevent the map server from loading.<br />
<br />
If both the x- and y-coordinates of the area are zero, the width and height are ignored and all individuals can spawn anywhere on the map. If only one is zero, the mob won't be used.<br />
<br />
[[Category:Server Development]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Dev:TmwAthena_Scripting_Standards&diff=59573Dev:TmwAthena Scripting Standards2024-03-27T03:56:49Z<p>Move page script: Move page script moved page Dev:TmwAthena Scripting Standards to Development:TmwAthena Scripting Standards: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Development:TmwAthena Scripting Standards]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Development:TmwAthena_Scripting_Standards&diff=59572Development:TmwAthena Scripting Standards2024-03-27T03:56:49Z<p>Move page script: Move page script moved page Dev:TmwAthena Scripting Standards to Development:TmwAthena Scripting Standards: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Classic:TmwAthena Scripting Standards]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Dev:TmwAthena_Scripting_Reference/unstable/magic-v3&diff=59571Dev:TmwAthena Scripting Reference/unstable/magic-v32024-03-27T03:56:49Z<p>Move page script: Move page script moved page Dev:TmwAthena Scripting Reference/unstable/magic-v3 to Development:TmwAthena Scripting Reference/unstable/magic-v3: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Development:TmwAthena Scripting Reference/unstable/magic-v3]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Development:TmwAthena_Scripting_Reference/unstable/magic-v3&diff=59570Development:TmwAthena Scripting Reference/unstable/magic-v32024-03-27T03:56:49Z<p>Move page script: Move page script moved page Dev:TmwAthena Scripting Reference/unstable/magic-v3 to Development:TmwAthena Scripting Reference/unstable/magic-v3: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div><metakey>Script Language, Code, Source, eAthena Script, AST</metakey> <metadesc>The Mana World Scripting Language Reference</metadesc><br />
<div style="background-color: #f6ebc1; text-align: center; border: 1px solid #e0b713; margin-bottom: 10px;"><br />
'''TMW's scripting wiki pages:'''<br />
<br />
[[Scripting Basics]] - [[Scripting Standards]] - [[Scripting Reference]]<br />
<br />
For questions feel free to contact us on [https://web.libera.chat/?channels=#themanaworld-dev IRC] and/or on our [https://forums.themanaworld.org forum].<br />
</div><br />
<br />
<br />
This page is a reference for commands ''believed'' to work in the eAthena scripting language still used by tmwAthena.<br />
<br />
'''Note:''' A number of problematic commands have been removed from this list, but not all commands have been tested.<br />
<br />
<br />
== Language Commands ==<br />
These are command that are closely tied to the language itself.<br />
<br />
=== goto ===<br />
<pre><br />
goto L_1;<br />
</pre><br />
Unconditionally jump to a label. Often used in an "if" body.<br />
<br />
=== callsub ===<br />
<pre><br />
callsub S_labelname;<br />
</pre><br />
Jump to the given label. When the "return" statement is executed, continue on the next line.<br />
<br />
It might also be possible to use this as a function, if the form of return with a value is used, but we use temporary variables instead.<br />
<br />
=== callfunc ===<br />
<pre><br />
callfunc "function_name";<br />
</pre><br />
Jump to the given function script. When the "return" statement is executed, continue on the next line of this script.<br />
<br />
It might also be possible to use this as a function, if the form of return with a value is used, but we use temporary variables instead.<br />
<br />
"return" is broken if this is used from within an if(). If you need a conditional callfunc, first goto a label.<br />
<br />
=== return ===<br />
<pre><br />
return;<br />
</pre><br />
Return from this script or sublabel to the calling function.<br />
<br />
It is unknown what happens if this is used from the top-level script, use "close" or "end" instead.<br />
<br />
=== set ===<br />
<pre><br />
set variable, expression;<br />
</pre><br />
Very common command, to set variables.<br />
<br />
=== setarray ===<br />
<pre><br />
setarray arrayvariable, val1, val2, ...;<br />
</pre><br />
Set elements of an array. Previous elements are not cleared. At most 128 elements can be assigned.<br />
<br />
It is currently possible, but deprecated, to specify a (zero-based) array index to start at the given part of an array. It's pretty amazing that that code works anyway.<br />
<br />
Remember that there are no permanent arrays, only temporary.<br />
<br />
=== cleararray ===<br />
<pre><br />
cleararray variable, value, count;<br />
</pre><br />
Fill an array with "count" copies of "value".<br />
<br />
=== getarraysize ===<br />
<pre><br />
getarraysize variable;<br />
</pre><br />
Get the size of an array. Returns 1 even when empty.<br />
<br />
The size of an array is simply one more than the index of the last nonzero integer or nonempty string.<br />
<br />
WARNING: most functions that set an array do not bother to clear out high indices. You should almost always use an explicitly-provided size instead.<br />
<br />
=== getelementofarray ===<br />
<pre><br />
arrayname[index_expr]<br />
</pre><br />
returns index_expr of that array.<br />
<br />
=== if ===<br />
<pre><br />
if (condition) condition_command [conditional_command_args, ...];<br />
</pre><br />
If condition is zero, do nothing. Else, evaluate the conditional command.<br />
<br />
The only thing special about the if command is the lack of commas during parsing (from my reading this is only a warning?). During execution it is perfectly normal.<br />
<br />
Note: you must not use a callsub or callfunc as conditional_command.<br />
<br />
=== end ===<br />
<pre><br />
end;<br />
</pre><br />
Stop executing the script.<br />
<br />
Don't use this if you have opened a dialog to the player, use "close" instead. Or, use "close2" and *then* "end".<br />
<br />
=== debugmes ===<br />
<pre><br />
debugmes "string"<br />
</pre><br />
Print a message to stdout.<br />
<br />
== Message Commands ==<br />
These are commands for dialog or one-way chat with players.<br />
<br />
=== mes ===<br />
<pre><br />
mes "string";<br />
</pre><br />
Display a line of text to the player. If a dialog box is not already open for the attached NPC, one will be created.<br />
<br />
If you need to include the '''"''' character inside the message, (especially for dialogs) insert it as '''\"'''.<br />
When doing several messages without a next; in between, there should be only a single \" at the beginning and the end each.<br />
<br />
'''Example''':<br />
mes "[Me Myself]";<br />
mes;<br />
mes "(I clear my throat)"<br />
mes;<br />
mes "\"I start talking here, and don't close the quotation marks, because I'm not yet done talking.";<br />
mes "And start a new line, but without new quotation marks.";<br />
mes "Here I stop talking, so I close the quotation marks.\"";<br />
gives:<br />
[Me Myself]<br />
<br />
(I clear my throat)<br />
<br />
"I start talking here, and don't close the quotation marks, because I'm not yet done talking.<br><br />
And start a new line, but without new quotation marks.<br><br />
Here I stop talking, so I close the quotation marks."<br />
<br />
=== next ===<br />
<pre><br />
next;<br />
</pre><br />
Stop the script until the user presses "Next" in the dialog.<br />
<br />
=== close ===<br />
<pre><br />
close;<br />
</pre><br />
Stop executing the script and give the user a "Close" button in the dialog.<br />
<br />
=== close2 ===<br />
<pre><br />
close2;<br />
</pre><br />
Stop the script until the user presses the "Close" button in the dialog, then keep executing the script.<br />
<br />
WARNING: unlike close, this command is a blocking command, the usual caveats apply.<br />
<br />
=== menu ===<br />
<pre><br />
menu<br />
"option 1", L_1,<br />
"option 2", L_2;<br />
</pre><br />
Display a list of choices to the player, then branch to the specified label.<br />
<br />
Additionally, the temporary variable "@menu" is set to the 1-based index of the choice.<br />
<br />
The options must not contain the character ":", as the protocol uses it as a separator.<br />
<br />
=== input ===<br />
<pre><br />
input variable_name;<br />
</pre><br />
Input an integer or string to the given variable, depending on whether has the '$' string postfix.<br />
<br />
The implementation allows variable_name to be omitted if input is an integer, in case l14 is used. Don't use this.<br />
<br />
=== announce ===<br />
<pre><br />
announce "message", flag;<br />
</pre><br />
Do a GM message.<br />
<br />
If flag & 0xF == 0 forward it to all map servers.<br />
If flag & 0x8, message is from the OID (NPC? usually?) rather than the RID (player).<br />
<br />
If (flag & 0x7) == 1, send to all on map.<br />
If (flag & 0x7) == 2, send to all in line of sight.<br />
If (flag & 0x7) == 3, send to self only.<br />
If (flag & 0x7) == anything else, send to all clients.<br />
<br />
=== mapannounce ===<br />
<pre><br />
mapannounce "mapname", "message", flag;<br />
</pre><br />
Send an announcement to all players in map.<br />
<br />
Only flag & 0x10 is interpreted, which does not work with the Mana client. So, flag must be 0.<br />
<br />
=== message ===<br />
<pre><br />
message "player", "message";<br />
</pre><br />
Display (in chat) a message from the server to a single user.<br />
<br />
=== npctalk ===<br />
<pre><br />
npctalk "message";<br />
</pre><br />
Make an NPC say something publicly.<br />
<br />
Note: in many cases areaannounce is a better choice.<br />
<br />
== Character Commands ==<br />
These have to do with attributes of the player.<br />
<br />
=== setlook ===<br />
<pre><br />
setlook type, value;<br />
</pre><br />
Set an aspect of a character's appearance. Used e.g. by the barber.<br />
<br />
There are constant provided for the LOOK type, and for hair color and hair style.<br />
<br />
=== heal ===<br />
<pre><br />
heal hp, sp[, boolean];<br />
</pre><br />
Increase or decrease the player's hp and sp. Add ,1 at the end to make it heal gradually.<br />
<br />
=== readparam ===<br />
<pre><br />
readparam(type[, "playername"])<br />
</pre><br />
Return one of the core parameters of a player.<br />
<br />
type is one of the bCamelCase constants, see db/const.txt<br />
<br />
=== getcharid ===<br />
<pre><br />
getcharid(type[ "playername"])<br />
</pre><br />
Get an id of the attached (or given) player.<br />
<br />
Type is:<br />
0: char id<br />
1: party id<br />
2: guild id (deprecated)<br />
3: account id<br />
<br />
You usually want 3.<br />
<br />
=== strcharinfo ===<br />
<pre><br />
strcharinfo(num)<br />
</pre><br />
Return string information about an account:<br />
num==0: name<br />
num==1: party name<br />
num==2: guild name (deprecated)<br />
<br />
=== sc_start ===<br />
<pre><br />
sc_start type, tick, val1[, beingid];<br />
</pre><br />
Apply a status effect to a player (or monster?).<br />
<br />
type is one of the sc_* constants.<br />
<br />
=== sc_end ===<br />
<pre><br />
sc_end type;<br />
</pre><br />
Immediately end status effect on current player.<br />
<br />
=== sc_check ===<br />
<pre><br />
sc_check(type)<br />
</pre><br />
Whether a status effect is currently active.<br />
<br />
=== resetstatus ===<br />
<pre><br />
resetstatus;<br />
</pre><br />
<br />
=== changesex ===<br />
<pre><br />
changesex;<br />
</pre><br />
Ask the login server (via the char server) to toggle this account's sex, then kick the player.<br />
<br />
=== attachrid ===<br />
<pre><br />
attachrid(id)<br />
</pre><br />
Change the being associated with this script.<br />
<br />
Return true if such a player is logged in.<br />
<br />
=== detachrid ===<br />
<pre><br />
detachrid;<br />
</pre><br />
Detach the player associated with this script.<br />
<br />
=== isloggedin ===<br />
<pre><br />
isloggedin(id)<br />
</pre><br />
Return true if the given ID is logged in.<br />
<br />
Often you shouldn't use this, but attachrid(id) instead<br />
<br />
=== marriage ===<br />
<pre><br />
marriage("otherplayer")<br />
</pre><br />
Marry the attached player to the other player.<br />
<br />
Return 1 on success and 0 on failure.<br />
<br />
=== divorce ===<br />
<pre><br />
divorce()<br />
</pre><br />
Divorce the attached player from their partner<br />
<br />
Return 1 on success and 0 on failure.<br />
<br />
=== getpartnerid2 ===<br />
<pre><br />
getpartnerid2()<br />
</pre><br />
Return the ID of the attached player's partner (0 is none).<br />
<br />
=== getexp ===<br />
<pre><br />
getexp base, job;<br />
</pre><br />
Increase the types of experience.<br />
<br />
=== getinventorylist ===<br />
<pre><br />
getinventorylist;<br />
</pre><br />
Fill in some arrays of useful information: "@inventorylist_id", "@inventorylist_amount", "@inventorylist_equip".<br />
<br />
The arrays are not cleared between calls, use "@inventory_count".<br />
<br />
=== getactivatedpoolskilllist ===<br />
<pre><br />
getactivatedpoolskilllist;<br />
</pre><br />
Same, but only activated pool skills.<br />
<br />
=== getunactivatedpoolskilllist ===<br />
<pre><br />
getunactivatedpoolskilllist;<br />
</pre><br />
Same, but only unactivated pool skills.<br />
<br />
=== poolskill ===<br />
<pre><br />
poolskill skill_id;<br />
</pre><br />
Activate a poolable skill.<br />
<br />
=== unpoolskill ===<br />
<pre><br />
unpoolskill skill_id;<br />
</pre><br />
Deactivate a poolable skill.<br />
<br />
=== misceffect ===<br />
<pre><br />
misceffect type, "player_name";<br />
misceffect type, being_id;<br />
misceffect type;<br />
</pre><br />
Display a miscellaneous effect on a being.<br />
<br />
In the third form, it will use the OID if possible, and fallback to the RID.<br />
<br />
=== getlook ===<br />
<pre><br />
getlook(type)<br />
</pre><br />
Return part of the player's appearance:<br />
val==1: hair<br />
val==2: weapon<br />
val==3: bottom<br />
val==4: middle<br />
val==5: top<br />
val==6: hair color<br />
val==8: shield<br />
val==9: shoes<br />
<br />
On failure, return -1.<br />
<br />
=== getsavepoint ===<br />
<pre><br />
getsavepoint(type)<br />
</pre><br />
type==0: Return savepoint map<br />
type==1: Return savepoint x<br />
type==2: Return savepoint y<br />
<br />
This is believed to be the only function (other than callfunc and callsub of course) that returns a different type depending on its arguments.<br />
<br />
=== shop ===<br />
<pre><br />
shop "npcname";<br />
</pre><br />
Close the script and open the given NPC's shop.<br />
<br />
=== isdead ===<br />
<pre><br />
isdead()<br />
</pre><br />
Return 1 if the attached player is dead, else 0.<br />
<br />
=== fakenpcname ===<br />
<pre><br />
fakenpcname "name", "newname", new_sprite_id;<br />
</pre><br />
Change the appearance of an NPC.<br />
<br />
== Location Commands ==<br />
These are commands that have to do with the location of players<br />
<br />
=== warp ===<br />
<pre><br />
warp "mapname", x, y;<br />
</pre><br />
Warp the attached player to the given location. "mapname" may have the special values "Random", "SavePoint", and "Save" (case-sensitive), but x and y are still required.<br />
<br />
=== isat ===<br />
<pre><br />
isat("mapname", x, y)<br />
</pre><br />
Return 1 if the attached player is at the given location, 0 otherwise.<br />
<br />
=== areawarp ===<br />
<pre><br />
areawarp "src_map", x0, y0, x1, y1, "dst_map", x, y;<br />
</pre><br />
Warp all players in the given area to the given location. The area is of square shape which has the diagonals x0,y0 and x1,y1.<br />
<br />
=== getusers ===<br />
<pre><br />
getusers(type)<br />
</pre><br />
Count users.<br />
<br />
If flag & 0x8, base on OID instead of RID.<br />
If (flag & 0x7) == 0, return users on the map.<br />
If (flag & 0x7) == 1, return users on the server.<br />
<br />
=== getmapusers ===<br />
<pre><br />
getmapusers("mapname")<br />
</pre><br />
Count users on a given map.<br />
<br />
=== getareausers ===<br />
<pre><br />
getareausers("mapname", x0, y0, x1, y1, z)<br />
</pre><br />
Count users in an area.<br />
z can be set to 1 or be left out to check for players who are alive.<br />
<br />
=== mapwarp ===<br />
<pre><br />
mapwarp "src_map", "dst_map", x, y;<br />
</pre><br />
Warp all players from source map to destination location.<br />
<br />
=== npcwarp ===<br />
<pre><br />
npcwarp x, y, "npcname";<br />
</pre><br />
Move an NPC to a different location on the same map.<br />
<br />
=== isin ===<br />
<pre><br />
isin("mapname", x0, y0, x1, y1)<br />
</pre><br />
Check if the player is in the area.<br />
<br />
=== getx ===<br />
<pre><br />
getx()<br />
</pre><br />
Return attached player's x coordinate.<br />
<br />
=== gety ===<br />
<pre><br />
gety()<br />
</pre><br />
Return attached player's y coordinate.<br />
<br />
=== getmap ===<br />
<pre><br />
getmap()<br />
</pre><br />
Return attached player's current map.<br />
<br />
== Item Commands ==<br />
These have to do with items or inventory.<br />
<br />
=== getitem ===<br />
<pre><br />
getitem "itemname", count[, unused_argument[, playerid]];<br />
getitem itemid, count[, unused_argument[, playerid]];<br />
"ii**"<br />
</pre><br />
Grant the attached player (or the given player) "count" copies of an item.<br />
<br />
If itemname is unrecognized you get an iten (727) instead.<br />
<br />
;Warning:<br />
<pre><br />
delitem: only deletes one item if applied to not-stackable item (equipment)<br />
getitem: gives item stacked, even if it's equipment<br />
fix: use a loop and only delete/give one item at a time</pre><br />
<br />
=== makeitem ===<br />
<pre><br />
makeitem "itemname", count, "mapname", x, y;<br />
makeitem itemid, count, "mapname", x, y;<br />
</pre><br />
Drop items on the ground.<br />
<br />
The special "mapname" value "this" means the map of the attached player.<br />
<br />
=== delitem ===<br />
<pre><br />
delitem "itemname", count;<br />
delitem itemid, count;<br />
</pre><br />
Remove items from the attached player's inventory.<br />
<br />
This command is buggy if the player does not have enough of the item. And if the item is not stackable, the command will delete only one of them, even if a higher number is specified.<br />
;Warning:<br />
<pre><br />
delitem: only deletes one item if applied to not-stackable item (equipment)<br />
getitem: gives item stacked, even if it's equipment<br />
fix: use a loop and only delete/give one item at a time</pre><br />
<br />
=== countitem ===<br />
<pre><br />
countitem("itemname")<br />
countitem(itemid)<br />
</pre><br />
Return the number of the given item in the player's inventory.<br />
<br />
=== checkweight ===<br />
<pre><br />
checkweight("itemname", count)<br />
checkweight(itemid, count)<br />
</pre><br />
Return 0 if adding "count" of the item would put player above max weight, 1 if it would still be less than max weight.<br />
Also returns 0 if item does not exist.<br />
<br />
=== getequipid ===<br />
<pre><br />
getequipid(equip_point)<br />
</pre><br />
Return the ID of the item in the given equip slot.<br />
<br />
equip_point is one of the equip_* constants<br />
<br />
=== getequipname ===<br />
<pre><br />
getequipname(equip_point)<br />
</pre><br />
Return the name of the item in the given equip slot.<br />
<br />
equip_point is one of the equip_* constants<br />
<br />
=== statusup2 ===<br />
<pre><br />
statusup2 bType, delta;<br />
</pre><br />
Permanently increase or decrease a stat.<br />
<br />
=== bonus ===<br />
<pre><br />
bonus bType, delta<br />
</pre><br />
Temporarily increase a stat. For use in item scripts only.<br />
<br />
=== skill ===<br />
<pre><br />
skill id, level[, flag = 1];<br />
</pre><br />
Grant a skill.<br />
<br />
flag==0: permanent skill<br />
flag==1: temporary skill (item scripts only)<br />
<br />
(Untested)<br />
<br />
=== setskill ===<br />
<pre><br />
setskill id, level;<br />
</pre><br />
Grant a skill permanently.<br />
<br />
=== getskilllv ===<br />
<pre><br />
getskilllv(skill)<br />
</pre><br />
Return the player's level of the given skill.<br />
<br />
=== getgmlevel ===<br />
<pre><br />
getgmlevel()<br />
</pre><br />
Return the player's GM level.<br />
<br />
=== getopt2 ===<br />
<pre><br />
getopt2()<br />
</pre><br />
Return the player's opt2 flags.<br />
<br />
=== setopt2 ===<br />
<pre><br />
setopt2 flags;<br />
</pre><br />
Set the player's opt2 flags.<br />
<br />
=== savepoint ===<br />
<pre><br />
savepoint "mapname", x, y;<br />
</pre><br />
Set the player's save point. Used e.g. by Soul Menhirs, and during the time travel quest.<!-- Don't remove this just because you can't figure out how to start it from this end. --><br />
<br />
=== openstorage ===<br />
<pre><br />
openstorage;<br />
</pre><br />
Open the player's storage.<br />
<br />
=== getitemname ===<br />
<pre><br />
getitemname("itemname")<br />
getitemname(itemid)<br />
</pre><br />
Return the name of the item, or "Unknown Item".<br />
<br />
=== nude ===<br />
<pre><br />
nude;<br />
</pre><br />
Unequip all items.<br />
<br />
=== unequipbyid ===<br />
<pre><br />
unequipbyid slot_id;<br />
</pre><br />
Unequip whatever is in the slot<br />
<br />
=== getareadropitem ===<br />
<pre><br />
getareadropitem("mapname", x0, y0, x1, y1, "itemname"[, delitems = 0]);<br />
getareadropitem("mapname", x0, y0, x1, y1, itemid[, delitems = 0]);<br />
</pre><br />
Count items on the floor in an area. If delitems, the items will be deleted as well.<br />
<br />
== Common Functions ==<br />
These are not mostly not related to the RPG or the scripting language.<br />
<br />
=== rand ===<br />
<pre><br />
rand(range)<br />
rand(min, max)<br />
</pre><br />
In the first form, return a random number between 0 (inclusive) and range (exclusive). Return 0 if range is not positive.<br />
In the second form, return a random number between min and max, inclusive. Min and max may be swapped.<br />
<br />
=== gettimetick ===<br />
<pre><br />
gettimetick(type)<br />
</pre><br />
Return one of the ticks<br />
<br />
type==0 (or other): milliseconds since some point in time, wraps every 50 days.<br />
type==1: time since midnight, UTC.<br />
type==2: seconds since the epoch.<br />
<br />
You should almost always use type 2.<br />
<br />
=== gettime ===<br />
<pre><br />
gettime(type)<br />
</pre><br />
Get a component of the time (UTC).<br />
<br />
1: second (0-59)<br />
2: minute (0-59)<br />
3: hour (0-23)<br />
4: day of week (0-6)<br />
5: day of month (1-31)<br />
6: month (1-12)<br />
7: year (1902-2038)<br />
<br />
== Timers and Events ==<br />
These have to do with transfering control in ways that are not immediately obvious.<br />
<br />
The most common ones are initnpctimer or startnpctimer, stopnpctimer, and setnpctimer.<br />
<br />
=== donpcevent ===<br />
<pre><br />
donpcevent "NpcName::Event";<br />
</pre><br />
Manually invoke an NPC event.<br />
<br />
=== addtimer ===<br />
<pre><br />
addtimer tick, "event";<br />
</pre><br />
Invoke an NPC event after a delay, for the attached NPC.<br />
<br />
This command does the same thing as areatimer, but for only the attached player.<br />
<br />
=== initnpctimer ===<br />
<pre><br />
initnpctimer;<br />
</pre><br />
Set the NPC's attached timer to tick 0 and start it.<br />
<br />
This is equivalent to setnpctimer, 0; startnpctimer;<br />
<br />
=== stopnpctimer ===<br />
<pre><br />
stopnpctimer;<br />
</pre><br />
Stop the NPC's attached timer.<br />
<br />
This DOES NOT do anything about the tick. But that's okay, you should normally be starting it with initnpctimer.<br />
<br />
=== startnpctimer ===<br />
<pre><br />
startnpctimer;<br />
</pre><br />
Start the NPC's attached timer, without setting the tick.<br />
<br />
=== setnpctimer ===<br />
<pre><br />
setnpctimer tick;<br />
</pre><br />
Set the NPC's timer to a specific tick. Generally, this is only useful for tick 0.<br />
<br />
=== getnpctimer ===<br />
<pre><br />
getnpctimer(type)<br />
</pre><br />
Get the current tick of an NPC's timer.<br />
<br />
type==0: timer event tick (like setnpctimer)<br />
type==1: bool if it has a next timer.<br />
type==2: timer amount<br />
<br />
=== mobcount ===<br />
<pre><br />
mobcount("mapname", "event")<br />
</pre><br />
Count the remaining mobs from the spawn with the given event. Has an offset of -1.<br />
<br />
=== areatimer ===<br />
<pre><br />
areatimer "mapname", x0, y0, x1, y1, tick, "event";<br />
</pre><br />
Add a PC event timer to all players in the area.<br />
<br />
After "tick" milliseconds, the given NPC event will fire with each player as the RID.<br />
<br />
== magic-v3 ==<br />
commands introduced in <i>magic-v3</i>. <b>please move those to unsorted or into the appropriate categories when <i>magic-v3</i> is stable.</b><br />
<br />
=== registercmd ===<br />
<pre><br />
registercmd "command", "npc[::event]";<br />
</pre><br />
Fires the event when the specified command is typed into chat. If you only put the npc name (no event) it does the same as clicking the npc so you can use menus and other things that require user input.<br />
<br />
=== target ===<br />
<pre><br />
target(source id, target id, flag)<br />
</pre><br />
Allows to check multiple things about the target at once. The source and target can by anything (player, npc, mob). The return value is a bitmasking of the tests that succeeded. The flag is a bitmasking of those bits:<br />
* '''0x01''' the target is in the visible range of the source (which is source position plus and minus AREA_SIZE). This means that the source can see the target on their computer screen (providing the screen is big enough)<br />
* '''0x02''' the target is in the attack range of the source (based on the calculated attack range, not the <i>base</i> attack range)<br />
* '''0x04''' the target is walkable, the source has a clear path to target<br />
* '''0x08''' <i>not yet implemented</i><br />
* '''0x10''' the source can attack the target. note: <i>0x10</i> in hexadecimal is <i>16</i> in decimal, not <i>10</i><br />
* '''0x20''' the target is in the line of sight of the source. note: <i>0x20</i> in hexadecimal is <i>32</i> in decimal, not <i>20</i><br />
<br />
=== get ===<br />
<pre><br />
get(variable or param, being id or name)<br />
</pre><br />
Allows to get a variable or param from another player, a mob or a npc. Useful to do things like <i>get(Hp, @mobID)</i><br />
<br />
=== min ===<br />
<pre><br />
min(number, number)<br />
</pre><br />
returns the smallest number of the two<br />
<br />
=== max ===<br />
<pre><br />
max(number, number)<br />
</pre><br />
returns the biggest number of the two<br />
<br />
=== pow ===<br />
<pre><br />
pow(number, exponent)<br />
</pre><br />
returns the <i>number</i> at the power of <i>exponent</i>.<br />
<br />
=== sqrt ===<br />
<pre><br />
sqrt(number)<br />
</pre><br />
returns the square root of <i>number</i>.<br />
<br />
=== cbrt ===<br />
<pre><br />
cbrt(number)<br />
</pre><br />
returns the cubic root of <i>number</i>.<br />
<br />
=== elttype ===<br />
<pre><br />
elttype(being id)<br />
</pre><br />
returns the element type of the being<br />
<br />
=== eltlvl ===<br />
<pre><br />
eltlvl(being id)<br />
</pre><br />
returns the element level of the being<br />
<br />
== Unsorted Commands ==<br />
These are commands that still need sorting, please edit this page, see talk page for category (and subcategory?) suggestions.<br />
<br />
=== strnpcinfo ===<br />
<pre><br />
strnpcinfo(number[, "npc"])<br />
</pre><br />
Returns information about the current npc or specified npc. '''0''' => full name. '''1''' => anything that comes before # in the name. '''2''' => anything that comes after the # in the name. '''3''' => map name.<br />
<br />
=== getnpcx ===<br />
<pre><br />
getnpcx(["npc"])<br />
</pre><br />
Returns the X location of the current or specified npc.<br />
<br />
=== getnpcy ===<br />
<pre><br />
getnpcy(["npc"])<br />
</pre><br />
Returns the Y location of the current or specified npc.<br />
<br />
=== monster ===<br />
<pre><br />
monster "mapname", x, y, "string", class, count[, "event"];<br />
</pre><br />
Spawn monsters at a point. If you define an OnDead event using a trigger area then the event is shot only inside that area, hence the event is ignored when the monster is killed outside the trigger area.<br />
<br />
=== areamonster ===<br />
<pre><br />
areamonster "mapname", x0, y0, x1, y1, "string", class, count[, "event"];<br />
</pre><br />
Spawn monsters in an area. If you define an OnDead event using a trigger area then the event is shot only inside that area, hence the event is ignored when the monster is killed outside the trigger area.<br />
<br />
=== killmonster ===<br />
<pre><br />
killmonster "mapname", "event";<br />
</pre><br />
Kill monsters on a map.<br />
<br />
Unless it is "All", "event" must match the one used at spawn time.<br />
<br />
If "All" is given, this function properly preserves permanently respawning monsters.<br />
<br />
=== enablenpc ===<br />
<pre><br />
enablenpc "name";<br />
</pre><br />
Enable an NPC.<br />
<br />
=== disablenpc ===<br />
<pre><br />
disablenpc "name";<br />
</pre><br />
Disable an NPC.<br />
<br />
=== setmapflag ===<br />
<pre><br />
setmapflag "mapname", flag;<br />
</pre><br />
Set an arbitrary mapflag.<br />
<br />
=== removemapflag ===<br />
<pre><br />
removemapflag "mapname", flag;<br />
</pre><br />
Unset an arbitrary mapflag.<br />
<br />
=== getmapflag ===<br />
<pre><br />
getmapflag("mapname", flag);<br />
</pre><br />
Check an arbitrary mapflag.<br />
<br />
=== pvp ===<br />
<pre><br />
pvp number;<br />
</pre><br />
Changes the pvp channel of the attached user to the specified channel. Please only use channels above 19 as 0-19 are reserved as special channels. To remove a user from the channel simply do pvp 0;<br />
<br />
=== getpvpflag ===<br />
<pre><br />
getpvpflag(number)<br />
</pre><br />
Gets pvp information for the attached user. 0 returns the pvp channel of the user. 1 returns true if the user is on @hide or else false.<br />
<br />
<br />
=== pvpon ===<br />
<pre><br />
pvpon "mapname";<br />
</pre><br />
Allow PvP on a map.<br />
<br />
=== pvpoff ===<br />
<pre><br />
pvpoff "mapname";<br />
</pre><br />
Deny PvP on a map.<br />
<br />
=== emotion ===<br />
<pre><br />
emotion emote_index;<br />
</pre><br />
Show a smiley above the OID.<br />
<br />
=== getspellinvocation ===<br />
<pre><br />
getspellinvocation("spell-identifier")<br />
</pre><br />
Return the #invocation used for a spell, or "...".<br />
<br />
=== specialeffect ===<br />
<pre><br />
specialeffect type;<br />
</pre><br />
Display a special effect on the OID.<br />
<br />
Same as "misceffect", but does not fallback when there is no OID.<br />
<br />
=== specialeffect2 ===<br />
<pre><br />
specialeffect2 type;<br />
</pre><br />
Same as "misceffect", but works when there is an OID.<br />
<br />
=== gmcommand ===<br />
<pre><br />
gmcommand "@command maybe with arguments";<br />
</pre><br />
Run a GM command, at level 99. [[GM_Commands]]<br />
<br />
=== mapexit ===<br />
<pre><br />
mapexit;<br />
</pre><br />
Exits the map server.<br />
<br />
=== bonus2 ===<br />
<pre><br />
bonus2 player, type, Amount, Tick;<br />
</pre><br />
Currently the only type is bHPDrainRate. This takes Amount per Tick in HPs from player.<br />
<br />
=== getitemlink ===<br />
<pre><br />
getitemlink("ItemName");<br />
</pre><br />
Returns the Manaplus link for use in scripts [@@ID|JName@@]<br />
<br />
=== npcareawarp ===<br />
<pre><br />
npcareawarp x0, y0, x1, y1, CollisionBool, "NPC Name";<br />
</pre><br />
Warps a NPC to somewhere within the area. If Collision Bool is set to 1 it will spawn on collision, else 0 is not on collision.<br />
<br />
=== iscollision ===<br />
<pre><br />
iscollision map.gat, x, y, type;<br />
</pre><br />
Checks if collision is of a type. (Types will be cast as CONST in the const.txt file)<br />
<br />
== Deprecated ==<br />
<br />
=== itemheal ===<br />
This command has been merged into [[Dev:TmwAthena_Scripting_Reference#heal|heal]]. The equivalent is :<br />
<pre><br />
heal Hp, Sp, true;<br />
</pre><br />
<br />
=== percentheal ===<br />
This command has been completely removed. Please use inline math instead. For example to remove 30% hp you would do:<br />
<pre><br />
heal ((MaxHp/10) * -3), 0;<br />
</pre><br />
<br />
=== killmonsterall ===<br />
This command has been deprecated and [[Dev:TmwAthena_Scripting_Reference#killmonster|killmonster]] should be used instead:<br />
<pre><br />
killmonster "mapname", "All";<br />
</pre><br />
<br />
=== cmdothernpc ===<br />
This command has been deprecated in favor of [[Dev:TmwAthena_Scripting_Reference#donpcevent|donpcevent]].<br />
<br />
[[Category:Development]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Dev:TmwAthena_Scripting_Reference&diff=59569Dev:TmwAthena Scripting Reference2024-03-27T03:56:49Z<p>Move page script: Move page script moved page Dev:TmwAthena Scripting Reference to Development:TmwAthena Scripting Reference: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Development:TmwAthena Scripting Reference]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Development:TmwAthena_Scripting_Reference&diff=59568Development:TmwAthena Scripting Reference2024-03-27T03:56:49Z<p>Move page script: Move page script moved page Dev:TmwAthena Scripting Reference to Development:TmwAthena Scripting Reference: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Classic:TmwAthena Scripting Reference]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Dev:TmwAthena_Scripting_Basics&diff=59567Dev:TmwAthena Scripting Basics2024-03-27T03:56:49Z<p>Move page script: Move page script moved page Dev:TmwAthena Scripting Basics to Development:TmwAthena Scripting Basics: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Development:TmwAthena Scripting Basics]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Development:TmwAthena_Scripting_Basics&diff=59566Development:TmwAthena Scripting Basics2024-03-27T03:56:49Z<p>Move page script: Move page script moved page Dev:TmwAthena Scripting Basics to Development:TmwAthena Scripting Basics: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Classic:TmwAthena Scripting Basics]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Dev:TmwAthena_Packets&diff=59565Dev:TmwAthena Packets2024-03-27T03:56:49Z<p>Move page script: Move page script moved page Dev:TmwAthena Packets to Development:TmwAthena Packets: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Development:TmwAthena Packets]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Development:TmwAthena_Packets&diff=59564Development:TmwAthena Packets2024-03-27T03:56:48Z<p>Move page script: Move page script moved page Dev:TmwAthena Packets to Development:TmwAthena Packets: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Archive:TmwAthena Packets]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Dev:Tilesets&diff=59563Dev:Tilesets2024-03-27T03:56:48Z<p>Move page script: Move page script moved page Dev:Tilesets to Development:Tilesets: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Development:Tilesets]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Development:Tilesets&diff=59562Development:Tilesets2024-03-27T03:56:48Z<p>Move page script: Move page script moved page Dev:Tilesets to Development:Tilesets: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>{{Category_art}}<br />
{{Status_green}}<br />
{{Status Under Construction}}<br />
== Getting started ==<br />
<br />
To get started on tileset development, please look into what kind of areas we plan to add to the game or what kind of changes we would still want to make to existing maps. See for example [[Geography]] and [[concept art]]. Ideas of your own are welcome too!<br />
<br />
== General specifications ==<br />
<br />
* '''Tile size:''' 32x32<br />
* '''Tileset size:''' Width: 512, Max height: 512 (for 1x1 sets)<br />
* '''Color Depth:''' 24 or 32 (alpha layer optional, no magic colors)<br />
* '''File Format:''' [http://www.libpng.org/pub/png/ PNG]<br />
* '''Current tilesets:''' https://github.com/themanaworld/tmwa-client-data/tree/master/graphics/tiles<br />
<br />
Please also note our [[Guidelines|style guidelines]].<br />
<br />
== Guidelines ==<br />
*Please keep in mind how maps are made (see [[Map development]]). The lowest layer is usually used for ground tiles/walls.<br />
<br />
*Although we prefer high quality tiles over low quality ones, please keep in mind that we try to resemble the look of old SNES games. So please try not to make the tiles too realistic. Please don't use realistic textures, such as a photo of a wooden piece, and use it for your tiles. We strongly encourage you to '''manually pixelate every tile''' and '''avoid to use gradients or filters (such as blur)''' excessively.<br />
<br />
*Regarding '''color choice''': Keep your color palette narrow. Don't use more shades per color than necessary. 3 shades of one color are usually enough for small objects. Even very large objects shouldn't use more than 5 or 7 shades. But how many shades you use is in the end left up to the artists discretion. Keep in mind that dithering is usually used for structure effects in TMW and rarely for blending one color into another. When a structure effect is not needed you shoud better add an additional shade instead of applying too much dithering just for color blending. <br />
*Try to use the '''same color palette for the whole tileset'''. The selection of color is important for the feeling of the tileset. Cold colors with a low saturation are good for a sad and cold feeling for example while warm and saturated colors create a warm and cheerful atmosphere (but please don't overdo the saturation). Whatever atmosphere you choose, it should be consistent through the whole tileset. When you create new tiles for existing tilesets you should try to use only colors that are already used in the tileset. Otherwise your new tiles will stand out and look weird when next to the old tiles.<br />
<br />
*'''Visible outlines''' are reserved for sprites. Please avoid them when creating map tiles.<br />
<br />
*The '''light direction''' is south-west for outdoor tilesets. Imagine the light source to be over your left shoulder. Of course there can be exceptions to this rule. Different or special areas may have a different direction of light to give it a subtle different feeling, such as lava caves with subtle orange light from the bottom, and deep in the dark forest with glowing mushrooms. For indoor tilesets diffused light is nice, but overusage could lead into problems with contrast between the inside and the outside.<br />
<br />
*'''Perspective:''' top-down 45° view angle (see the schematic to the right).[[Image:Perspective_Reference.png|right|384px]] SVG version: [http://lasdomogrod.pl/tmw/perspective-reference/TMW-PerspectiveReference.svg TMW-PerspectiveReference.svg]<br />
<br />
*'''Proportions:''' A character is approximately one tile wide and two tiles high. Don't be afraid to copy a player character into your image from time to time to check the size relation.<br />
<br />
*'''Drop shadows:''' Large objects on outdoor tilesets (like buildings, for example) should have drop shadows cast to the northeast. The shadows should be pure black with an opacity of 30%. The edges of the shadows should only have an opacity of 15%.<br />
<br />
*'''Reuse:''' The tiles in one tileset should be able to be put together in as many different ways as possible to allow the mapper to express his creativity.<br />
<br />
== Which tilesets are needed? ==<br />
Feel free to ask that question on IRC:<br />
irc://chat.freenode.net/themanaworld-dev<br />
<br />
[[Category:Development]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Dev:Testing_Server&diff=59561Dev:Testing Server2024-03-27T03:56:48Z<p>Move page script: Move page script moved page Dev:Testing Server to Development:Testing Server: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Development:Testing Server]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Development:Testing_Server&diff=59560Development:Testing Server2024-03-27T03:56:48Z<p>Move page script: Move page script moved page Dev:Testing Server to Development:Testing Server: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>=Testing=<br />
Before developers release game content onto the official server, they'd like feedback from other developers and play-testers. This testing server regularly restarts for content additions, fixes and tweaks. <br />
<br />
There are several ways to test:<br />
* '''Developer testing''' : Developers need to test their content in realistic conditions. They more or less would know about potential weaknesses and try to figure out possible solutions. No one, however, can be protected against the developer's biggest fear: the bug; because they know their work too much.<br />
<br />
* '''Player testing''' : A play-tester needs to perform the tests in conditions as close as possible to those that the players will meet in-game after the content is released. Thus, "cheats" on the test server are forbidden to them except in special situations approved by developers. Even items in the inventory should be close to the ones they would have in the real game. Testers must expect too that they can make errors in answering NPCs or bringing wrong items or an insufficient number of them when testing quests.<br />
<br />
Test-related discussions happen on the forums in the [https://forums.themanaworld.org/viewforum.php?f=43 Tester Reports] section.<br />
<br />
=== To become a play-tester ===<br />
<br />
You must first be reasonably familiar with the game, be registered on the forums and create an account on the [[#Location |test server]] and begin to test. You can coordinate your testing with the developers involved in the creation of the content you are testing either on the forums in the [https://forums.themanaworld.org/viewforum.php?f=43 Tester Reports] section or on live-chat on IRC at [https://web.libera.chat/?channel=#themanaworld-dev Libera Chat] channel #evol-dev.<br />
<br />
After a significant enough test contribution, you are entitled to be part of the Tester group on the forums, ask a dev or admin to invite you to it if you think you might be eligible.<br />
<br />
=Test Reporting=<br />
====Where to report :====<br />
Reports should be made in the [https://forums.themanaworld.org/viewforum.php?f=43 Tester Reports] section of the forums. Please read the forum rules and be respectful of developers. Thank you for helping them improve their work.<br />
<br />
====How to report :====<br />
:Reporting a test is basically like [[Reporting Bugs]] except that you can control the starting conditions of the test, and that it is possible (at least theoretically) to repeat the trials. To perform a good test you must<br />
* Specify precisely the starting conditions: level, class, status and job status, skills.... equipment employed if necessary, maybe client.<br />
* Do NOT use unrealistic Status for serious job.<br />
* Note even schematically the main steps of the steps and the remarks that come to your mind, they can be useful (even if you think they are not important).<br />
* Do not try to presume anything about the developers intentions.<br />
* Avoid @commands as much as possible (they can biase your feelings too) and generally speaking: '''do not try to cheat'''<br />
* Read Dialogs carefully: Effort was made by developer to make the story and dialogs nice. When not bugs, misspellings are still issues.<br />
* Watch the graphic environment: Effort was made by developers to make it pleasant. It may hide issues too.<br />
As a summary: be a fair and wise player, take notes about what you feel and do.<br />
<br />
=Client=<br />
Client may (will) have an influence on the way you play and on the impressions you have. It may have to be tested too.<br />
* Manaplus client: [http://manaplus.evolonline.org http://manaplus.evolonline.org]<br />
<br />
=GM Abilities (outdated)=<br />
There are several levels of GM ability, depending on the person's role on the development team.<br />
Note that the primary purpose of this server is to allow developers and testers to test new and unfinished content. To keep it open to the public, we've restricted access to certain GM commands which have been abused to interfere with testing.<br />
<br />
;Everyone: To get access to this commands type "@gm gm" in normal chat.<br />
*@warp to map locations<br />
*@item to make items for your character<br />
*@zeny to make money for your character<br />
*@heal, @alive, @die<br />
*@hide to avoid being attacked by monsters<br />
*@who who is online?<br />
*@whogm same but with GM status<br />
Use the Debug NPCs in each town to set levels and skills<br />
<br />
;Official Testers<br />
*all the above plus<br />
*@goto another player<br />
*@spawn monsters to fight<br />
*@broadcast announcements to others on the server<br />
*@pvpon/pvpoff on maps<br />
*@killmonster/killmonster2<br />
*@blvl and @jlvl to change level<br />
<br />
;Official Content Developers<br />
*access to almost all GM commands<br />
<br />
=Location=<br />
Our server is located at <span style="color:Teal">testing.themanaworld.org, port 6902</span>.<br />
<br />
=See Also=<br />
* [[Reporting Bugs]]<br />
* [[How to Develop]]<br />
* [[Projects and Teams]]<br />
<br />
[[Category:Development]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Dev:TMW_Brand&diff=59559Dev:TMW Brand2024-03-27T03:56:48Z<p>Move page script: Move page script moved page Dev:TMW Brand to Development:TMW Brand: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Development:TMW Brand]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Development:TMW_Brand&diff=59558Development:TMW Brand2024-03-27T03:56:48Z<p>Move page script: Move page script moved page Dev:TMW Brand to Development:TMW Brand: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>==TMW Brand==<br />
<br />
* Maintain theme across all web sites (including social)<br />
* Maintain an recent video on [https://www.youtube.com/user/TheManaWorldOfficial Youtube]<br />
* Maintain 5-6 recent [[screenshots]]<br />
* Connect Forum posts to social to recent activity<br />
* Promote Player & GM events in-game and via social<br />
* Maintain a Broadcast message in-game pointing to recent/hot topics.<br />
<br />
==Current Active Brand Sites==<br />
<br />
See ''Template:Branding'' below:<br />
<br />
{{Template:Branding}}<br />
<br />
[[Category:Development]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Dev:Stunning_and_knockback&diff=59557Dev:Stunning and knockback2024-03-27T03:56:48Z<p>Move page script: Move page script moved page Dev:Stunning and knockback to Development:Stunning and knockback: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Development:Stunning and knockback]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Development:Stunning_and_knockback&diff=59556Development:Stunning and knockback2024-03-27T03:56:48Z<p>Move page script: Move page script moved page Dev:Stunning and knockback to Development:Stunning and knockback: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>{{Category_gameconcept}}<br />
{{Status_red}}<br />
Intense testing of the new game mechanics by the HMC dev group has lead them to the hypothesis that stunning a being for a short period of time (and thus making it unable to move or act in any way) when hit would enrich the gameplay.<br />
<br />
The problem with this is that network latency would frequently lead to the situation that a being is on different positions on the server and the clients when stunned. This could lead to implausible events. Attempting to correct this by sending the position together with the stun messages would ineviteably lead to a sudden "jump" of the being.<br />
<br />
For that reason I would suggest to combine stunning with a knockback effect. This means that the being is hit away several pixels from the attacker after getting hit. This has the advantage that it justifies and conceals a slight dislocation of the being and that it makes combat feel even more action-laden.<br />
<br />
==knockback effect mechanics==<br />
Knockback distance should be influenced by:<br />
* Used weapon (blunt weapons should have a larger knockback in relation to their damage than sharp ones)<br />
* Attackers strength<br />
* Victims strength<br />
* Additional factor by special attacks (a property of some special attacks could be a better or worse knockback)<br />
<br />
Proposed formula:<br />
knockback_distance ~ (1 / weapon_penetration) * (attacker_strength / victim_strength) * attack_factor<br />
<br />
==stun effect mechanics==<br />
The stun time should be inflienced by:<br />
* Used weapon (blunt weapons should stun longer than sharp ones)<br />
* Severity of the hit (in percent of total HP)<br />
* Target vitality (already covered by the last point considering that HP is derived from vitality)<br />
* Additional factor by special attacks (a property of some special attacks could be a better or worse stunning)<br />
<br />
Proposed formula:<br />
stun_time ~ (1 / weapon_penetration) * (damage / max_hp) * attack_factor<br />
<br />
==Game balance considerations==<br />
===stunlocking===<br />
When it would be possible to use the stun effect to immobilize a being permanently it would be quite a game-breaker. To make this impossible the stun time should not be cumulative. This means that the stun time of a being which is already stunned can not be increased by hitting it again while already being stunned. This would mean that the only way to permanently stun a being would be to always hit it exactly in the moment it recovers from the last blow. This would require considerable timing skill and thus would rather enrich the gameplay instead of breaking it.<br />
<br />
==="holding off" with knockback===<br />
When the attacker got a long range and a fast attack speed and the defender got a short range and a slow move speed the attacker could be able to keep the enemy outside of its attack range by permanent attacking.<br />
<br />
This method would not be failsave because it is impossible to have a [[hitting and dodging|100% hit probability]] (unless the enemy got 0 evade) but could still make combat against some enemies very easy. My suggestion to minimize this effect would be to avoid giving long-range weapons a high attack speed. A fast attack speed would be implausible for most long range weapons, anyway. Projectile weapons need to be reloaded and long range melee weapons have to be very bulky.</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Dev:Special_NPCs&diff=59555Dev:Special NPCs2024-03-27T03:56:48Z<p>Move page script: Move page script moved page Dev:Special NPCs to Development:Special NPCs: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Development:Special NPCs]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Development:Special_NPCs&diff=59554Development:Special NPCs2024-03-27T03:56:48Z<p>Move page script: Move page script moved page Dev:Special NPCs to Development:Special NPCs: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>= Server reserved npcs =<br />
{| class="wikitable" border="1"<br />
|-<br />
! ID<br />
! Description<br />
|-<br />
| -1<br />
| Used '''only''' for map-less (floating) npcs<br />
|-<br />
| 45<br />
| Displays a warp tile (depending on the client settings). '''Does not display warp particles'''<br />
|-<br />
| 139<br />
| Used by Hercules for hidden warps<br />
|-<br />
| 722<br />
| Displays a debug warp tile (used by battleconfig.warp_point_debug). '''Does not display warp particles'''<br />
|-<br />
| 127<br />
| Displays a transparent non target-able npc. Used by tmwa for area effects (magic) and specialeffect<br />
|-<br />
| 32767<br />
| NPCs with this ID exist only server-side and are not sent to the client. Usually you should prefer this over 127. However if your npc need to display particle (specialeffect) you should use 127<br />
|}<br />
<br><br />
<br />
= Custom special npcs =<br />
{| class="wikitable" border="1"<br />
|-<br />
! ID<br />
! Description<br />
|-<br />
| 400<br />
| Displays a transparent target-able npc<br />
|}<br />
<br />
<br> '''TODO:''' add a transparent target-able npc with pickup cursor<br />
<br> '''TODO:''' add a transparent target-able npc with fight cursor<br />
<br />
<br><br />
<br />
[[Category:Development]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Dev:Skills.xml&diff=59553Dev:Skills.xml2024-03-27T03:56:48Z<p>Move page script: Move page script moved page Dev:Skills.xml to Development:Skills.xml: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Development:Skills.xml]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Development:Skills.xml&diff=59552Development:Skills.xml2024-03-27T03:56:48Z<p>Move page script: Move page script moved page Dev:Skills.xml to Development:Skills.xml: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>This file describes the skills recognized by the eAthena client.<br />
<br />
==Structure==<br />
Skill DBs are in XML format.<br />
<br />
===&lt;skills&gt;===<br />
This is the root element of the file.<br />
<br />
===&lt;skill&gt;===<br />
An individual skill definition. <code>skill</code>s have <code>id</code>s, <code>names</code>s, and <code>fixed</code> values. The <code>id</code> corresponds to the skill ID on the server. The <code>name</code> is the name to give the skill in the GUI. The optional <code>fixed</code> value says if the skill is fixed (not changeable through the GUI) or not. A value of 0 (the default) means it can be changed through the GUI and a value of 1 means it can't.<br />
<br />
==Example==<br />
<br />
<code><br />
&lt;skills&gt;<br />
&lt;skill id="1" name="Basic"/&gt;<br />
&lt;skill id="340" name="Magic" fixed="1"/&gt;<br />
...<br />
&lt;/skills&gt;<br />
</code><br />
<br />
{{Template:Content XML}}</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Dev:Scripting_Reference&diff=59551Dev:Scripting Reference2024-03-27T03:56:48Z<p>Move page script: Move page script moved page Dev:Scripting Reference to Development:Scripting Reference: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Development:Scripting Reference]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Development:Scripting_Reference&diff=59550Development:Scripting Reference2024-03-27T03:56:48Z<p>Move page script: Move page script moved page Dev:Scripting Reference to Development:Scripting Reference: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Classic:TmwAthena Scripting Reference]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Dev:SFX&diff=59549Dev:SFX2024-03-27T03:56:47Z<p>Move page script: Move page script moved page Dev:SFX to Development:SFX: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Development:SFX]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Development:SFX&diff=59548Development:SFX2024-03-27T03:56:47Z<p>Move page script: Move page script moved page Dev:SFX to Development:SFX: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>{{Category_audio}}<br />
{{Category:Outdated}}<br />
<br />
== Monster sounds ==<br />
<br />
Number of existing sound effects wired in for the monsters. (Note that the categories have no in-game correspondency.)<br />
<br />
{| border="1" cellspacing="0" cellpadding="5"<br />
|-<br />
! style="background: #efdead" rowspan="2" colspan="2" | Category<br />
! style="background: #efdead" rowspan="2" | Monster<br />
! style="background: #efdead" rowspan="2" | ID<br />
! style="background: #efdead" colspan="5" | Sound effects<br />
|-<br />
! style="background: #efdead" | hit<br />
! style="background: #efdead" | miss<br />
! style="background: #efdead" | hurt<br />
! style="background: #efdead" | die<br />
! style="background: #efdead" | misc<br />
|-<br />
| rowspan="4" | Arachnids<br />
| rowspan="3" | Scorpions<br />
| Black Scorpion<br />
| 7<br />
| {{good|4}}<br />
| {{good|1}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Red Scorpion<br />
| 2<br />
| {{good|4}}<br />
| {{good|1}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Scorpion<br />
| 1<br />
| {{good|4}}<br />
| {{good|1}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| rowspan="1" | Spiders<br />
| [[Spider]]<br />
| 10<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| rowspan="1" | Birds<br />
| rowspan="1" | Waterfowls<br />
| Duck<br />
| 46<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| rowspan="2" | Fungi<br />
| rowspan="2" | Mushrooms<br />
| Evil Mushroom<br />
| 11<br />
| {{good|1}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Spiky Mushroom<br />
| 17<br />
| {{good|1}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| rowspan="1" | Gastropods<br />
| rowspan="1" | Snails<br />
| Snail<br />
| 39<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| rowspan="3" | Insects<br />
| rowspan="3" | Maggots<br />
| Maggot<br />
| 0<br />
| {{good|2}}<br />
| {{good|1}}<br />
| {{bad|0}}<br />
| {{good|1}}<br />
| {{bad|0}}<br />
|-<br />
| Giant Maggot<br />
| 4<br />
| {{good|2}}<br />
| {{good|1}}<br />
| {{bad|0}}<br />
| {{good|1}}<br />
| {{bad|0}}<br />
|-<br />
| Silkworm<br />
| 33<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| rowspan="5" | Mammals<br />
| rowspan="1" | [[Bat|Bats]]<br />
| Bat<br />
| 15<br />
| {{good|1}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{good|1}}<br />
| {{bad|0}}<br />
|-<br />
| rowspan="2" | Fluffies<br />
| Easter Fluffy<br />
| 25<br />
| {{good|3}}<br />
| {{good|1}}<br />
| {{good|1}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Fluffy<br />
| 18<br />
| {{good|3}}<br />
| {{good|1}}<br />
| {{good|1}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| rowspan="1" | Mouboos<br />
| Mouboo<br />
| 26<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| colspan="1" | Squirrels<br />
| Squirrel<br />
| 36<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{good|2}}<br />
| {{good|2}}<br />
| {{bad|0}}<br />
|-<br />
| rowspan="7" | Plants<br />
| rowspan="1" | Flowers<br />
| Flower<br />
| 12<br />
| {{good|2}}<br />
| {{good|1}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| rowspan="5" | Herbs<br />
| Alizarin Plant<br />
| 30<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Clover Patch<br />
| 35<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Cobalt Plant<br />
| 28<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Gamboge Plant<br />
| 29<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Mauve Plant<br />
| 27<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| rowspan="1" | Trees<br />
| Log Head<br />
| 23<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{good|5}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| rowspan="6" | Reptiles<br />
| rowspan="1" | Lizards<br />
| Fire Lizard<br />
| 37<br />
| {{good|2}}<br />
| {{good|1}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| rowspan="5" | Snakes<br />
| Cave Snake<br />
| 19<br />
| {{good|1}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Grass Snake<br />
| 32<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Mountain Snake<br />
| 24<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Snake<br />
| 8<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Snake Lord<br />
| 44<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| rowspan="7" | Undead<br />
| rowspan="1" | Ghosts<br />
| Jack O<br />
| 20<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| rowspan="3" | Skeletons<br />
| Fallen<br />
| 43<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| [[Lady Skeleton]]<br />
| 42<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Skeleton<br />
| 41<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| rowspan="2" | Skulls<br />
| Fire Skull<br />
| 21<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Poison Skull<br />
| 22<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| rowspan="1" | Zombies<br />
| Zombie<br />
| 34<br />
| {{good|2}}<br />
| {{good|1}}<br />
| {{bad|0}}<br />
| {{good|1}}<br />
| {{good|2}}<br />
|-<br />
| rowspan="11" | ?<br />
| rowspan="1" | Goblins<br />
| Fire Goblin<br />
| 9<br />
| {{good|2}}<br />
| {{good|1}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| rowspan="1" | Pinkies<br />
| Pinkie<br />
| 16<br />
| {{good|1}}<br />
| {{good|1}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| rowspan="6" | Slimes<br />
| Green Slime<br />
| 3<br />
| {{good|1}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Red Slime<br />
| 6<br />
| {{good|1}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Rudolph Slime<br />
| 14<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Santa Slime<br />
| 13<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Sea Slime<br />
| 31<br />
| {{good|1}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| [[Yellow Slime]]<br />
| 5<br />
| {{good|1}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| rowspan="3" | Wisps<br />
| Poltergeist<br />
| 45<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Spectre<br />
| 40<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Wisp<br />
| 38<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|}<br />
<br />
== Weapon sounds ==<br />
<br />
Number of existing sound effects wired in for the weapons.<br />
<br />
{| border="1" cellspacing="0" cellpadding="5"<br />
|-<br />
!rowspan="2" style="background:#efdead;"| Category<br />
!rowspan="2" style="background:#efdead;"| Weapon<br />
!rowspan="2" style="background:#efdead;"| ID<br />
!colspan="3" style="background:#efdead;"| Sound effects<br />
|-<br />
!style="background:#efdead;"| hit<br />
!style="background:#efdead;"| strike<br />
!style="background:#efdead;"| swing<br />
|-<br />
|colspan="3" style="text-align:center;"| (Punch)<br />
| {{good|1}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
|rowspan="4"| Axes<br />
| Axe<br />
| 549<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Blacksmith's Axe<br />
| 550<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Meat Cleaver<br />
| 605<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Hatchet<br />
| 606<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
|rowspan="4"| Bows<br />
| Bow<br />
| 1200<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{good|1}}<br />
|-<br />
| Desert Bow<br />
| 575<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Forest Bow<br />
| 545<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Short Bow<br />
| 530<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
|rowspan="7"| Knives<br />
| Bone Knife<br />
| 570<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Dagger<br />
| 521<br />
| {{good|1}}<br />
| {{good|1}}<br />
| {{bad|0}}<br />
|-<br />
| Knife<br />
| 1201<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Rock Knife<br />
| 579<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Setzer<br />
| 571<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Sharp Knife<br />
| 522<br />
| {{bad|0}}<br />
| {{good|1}}<br />
| {{bad|0}}<br />
|-<br />
| Stiletto<br />
| 592<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
|rowspan="1"| Maces<br />
| Club<br />
| 609<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
|rowspan="11"| Polearms<br />
| Bardiche<br />
| 547<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Dual Spear<br />
| 598<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Halberd<br />
| 548<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Heavy Pike<br />
| 597<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Heavy Spear<br />
| 595<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Pike<br />
| 596<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Scorpion<br />
| 574<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Scythe<br />
| 623<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Spear<br />
| 594<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Trident<br />
| 607<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Wooden Staff<br />
| 758<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
|rowspan="4"| Staves<br />
| Crescent Rod<br />
| 581<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Staff of Fire<br />
| 582<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Staff of Ice<br />
| 583<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Staff of Life<br />
| 580<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
|rowspan="15"| Swords<br />
| Baselard<br />
| 590<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Bastard Sword<br />
| 588<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Beheader<br />
| 576<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Broad Sword<br />
| 589<br />
| {{good|1}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Falchion<br />
| 573<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Fire Sword<br />
| 599<br />
| {{bad|0}}<br />
| {{good|1}}<br />
| {{bad|0}}<br />
|-<br />
| Jackal<br />
| 584<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Long Sword<br />
| 591<br />
| {{good|2}}<br />
| {{good|1}}<br />
| {{bad|0}}<br />
|-<br />
| Rapier<br />
| 593<br />
| {{good|1}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Sabre<br />
| 561<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Sand Cutter<br />
| 578<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Scimitar<br />
| 572<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Short Sword<br />
| 536<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Sword<br />
| 587<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|-<br />
| Toy Sabre<br />
| 1215<br />
| {{good|1}}<br />
| {{good|1}}<br />
| {{bad|0}}<br />
|-<br />
|rowspan="1"| Thrown<br />
| Bone Darts<br />
| 577<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
| {{bad|0}}<br />
|}<br />
<br />
== Other sounds ==<br />
<br />
=== Done ===<br />
<br />
Weapons:<br />
* Bow shooting arrow (miss/hit)<br />
<br />
Location based:<br />
* [http://wiki.themanaworld.org/index.php/Image:Boil.ogg| Boiling water] (not in Git)<br />
* Burning fire<br />
* River<br />
* Waterfall<br />
<br />
Miscellaneous:<br />
* Level-up (probably better for a composer to create)<br />
<br />
=== Needed ===<br />
<br />
Miscellaneous:<br />
* Player taking damage (several ones to avoid repetition)<br />
* Button click<br />
* Death<br />
* Picking up item<br />
* Dropping item<br />
<br />
Walking:<br />
* Plants<br />
* Sand<br />
* Stone outdoors<br />
* Stone indoors<br />
* Wood<br />
* Dirt<br />
* Carpet<br />
* Metal<br />
* Ankle deep water<br />
<br />
== Specification of file format ==<br />
<br />
Naming convention:<br />
* name-action#.ogg (for example <code>short-sword-miss2.ogg</code>)<br />
<br />
In-game format:<br />
* Ogg Vorbis (<code>.ogg</code>)<br />
* 128 kbps stereo<br />
<br />
Format for archival:<br />
* PCM (<code>.wav</code>)<br />
* 44.1 K 16 bit stereo<br />
<br />
== References ==<br />
<br />
Client data:<br />
* [http://gitorious.org/tmwdata/mainline/trees/master/sfx sfx/] — the directory containing the sound effects<br />
* [http://gitorious.org/tmwdata/mainline/blobs/raw/master/monsters.xml monsters.xml] — where sound effects are wired in for monsters<br />
* [http://gitorious.org/tmwdata/mainline/blobs/raw/master/items.xml items.xml] — where sound effects are wired in for items<br />
<br />
Client source:<br />
* [http://gitorious.org/tmw/mainline/blobs/raw/master/src/localplayer.cpp src/localplayer.cpp] — where the punching sound effect is hardcoded in<br />
* [http://gitorious.org/tmw/mainline/blobs/raw/master/src/resources/monsterdb.cpp src/resources/monsterdb.cpp] — the types of sound effects used for monsters<br />
* [http://gitorious.org/tmw/mainline/blobs/raw/master/src/resources/itemdb.cpp src/resources/itemdb.cpp] — the types of sound effects used for items<br />
<br />
Sound Technology:<br />
*[http://forums.themanaworld.org/viewtopic.php?f=2&t=9992 3D Soundscape system discussion].</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Dev:Quests.xml&diff=59547Dev:Quests.xml2024-03-27T03:56:47Z<p>Move page script: Move page script moved page Dev:Quests.xml to Development:Quests.xml: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Development:Quests.xml]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Development:Quests.xml&diff=59546Development:Quests.xml2024-03-27T03:56:47Z<p>Move page script: Move page script moved page Dev:Quests.xml to Development:Quests.xml: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div><br />
== Quest Log in Client Data ==<br />
<br />
quests.xml<br />
<br />
<quests><br />
<var id="[0-9]"><br />
<effect map="Map.tmx" npc="NpcIdServerDataUses" value="QuestValue(s)" effect="EffectId"/><br />
<quest name="Name" group="GroupName" (in)complete="QuestValue"><br />
<name>Name</name><br />
<text>Quest Info</text><br />
</quest><br />
</var><br />
</quests><br />
<br />
Example:<br />
<br />
<?xml version="1.0" encoding="utf-8"?><br />
<quests><br />
<var id="1"><br />
<effect map="029-2.tmx" npc="154" value="0" effect="45"/><br />
<effect map="029-2.tmx" npc="154" value="1,2,3" effect="46"/><br />
<effect map="029-2.tmx" npc="114" value="4,5,6,7" effect="46"/><br />
<quest name="Tutorial" group="Candor Island" incomplete="1"><br />
<name>Welcome</name><br />
<text>Walk to the carpet</text><br />
<text/><br />
<text>Quest giver: Sorfina.</text><br />
<text>Coordinates: Candor Island Indoor (27,27)</text><br />
</quest><br />
<quest name="Tutorial" group="Candor Island" incomplete="2"><br />
<name>Welcome</name><br />
<text>Retrieve items from the Chest</text><br />
<text/><br />
<text>Quest giver: Sorfina.</text><br />
<text>Coordinates: Candor Island Indoor (27,27)</text><br />
</quest><br />
<quest name="Tutorial" group="Candor Island" incomplete="3"><br />
<name>Welcome</name><br />
<text>Open inventory and equip clothes (###keyWindowEquipment;)</text><br />
<text/><br />
<text>Quest giver: Sorfina.</text><br />
<text>Coordinates: Candor Island Indoor (27,27)</text><br />
</quest><br />
<quest name="Tutorial" group="Candor Island" incomplete="4"><br />
<name>Welcome</name><br />
<text>Find Tanisha</text><br />
<text/><br />
<text>Quest giver: Sorfina.</text><br />
<text>Coordinates: Candor Island Indoor (27,27)</text><br />
</quest><br />
<quest name="Tutorial" group="Candor Island" incomplete="5"><br />
<name>Welcome</name><br />
<text>Help Tanisha kill maggots</text><br />
<text/><br />
<text>Quest giver: Tanisha.</text><br />
<text>Coordinates: Candor Island Indoor (100,88)</text><br />
</quest><br />
<quest name="Tutorial" group="Candor Island" incomplete="6"><br />
<name>Welcome</name><br />
<text>Help Tanisha kill maggots</text><br />
<text/><br />
<text>Quest giver: Tanisha.</text><br />
<text>Coordinates: Candor Island Indoor (100,88)</text><br />
</quest><br />
<quest name="Tutorial" group="Candor Island" incomplete="7"><br />
<name>Welcome</name><br />
<text>Get reward from Tanisha</text><br />
<text/><br />
<text>Quest giver: Tanisha.</text><br />
<text>Coordinates: Candor Island Indoor (100,88)</text><br />
</quest><br />
<quest name="Tutorial" group="Candor Island" complete="8"><br />
<name>Welcome</name><br />
<text>Complete.</text><br />
<text/><br />
<text>Quest giver: Tanisha.</text><br />
<text>Coordinates: Candor Island Indoor (100,88)</text><br />
</quest><br />
<quest name="Bully" group="Candor Island" incomplete="9"><br />
<name>Hasan</name><br />
<text>Some guy named Hasan is picking on people</text><br />
</quest><br />
<quest name="Bully" group="Candor Island" incomplete="10"><br />
<name>Trick</name><br />
<text>Hasan needs to be taught a lesson</text><br />
<text>Talk to sorfina.</text><br />
</quest><br />
<quest name="Bully" group="Candor Island" incomplete="11"><br />
<name>Trick known</name><br />
<text>Hasan is afraid of scorpions</text><br />
</quest><br />
<quest name="Bully" group="Candor Island" incomplete="12"><br />
<name>Scorpion</name><br />
<text>Goto Hasan and have Kaan summon a scorpion</text><br />
</quest><br />
<quest name="Bully" group="Candor Island" incomplete="13"><br />
<name>Saved Hasan</name><br />
<text>Killed the scorpion</text><br />
</quest><br />
<quest name="Bully" group="Candor Island" complete="14"><br />
<name>Talk to Hasan</name><br />
<text>Hasan changed his ways</text><br />
</quest><br />
</var><br />
</quests></div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Dev:Quest_log.txt&diff=59545Dev:Quest log.txt2024-03-27T03:56:47Z<p>Move page script: Move page script moved page Dev:Quest log.txt to Development:Quest log.txt: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Development:Quest log.txt]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Development:Quest_log.txt&diff=59544Development:Quest log.txt2024-03-27T03:56:47Z<p>Move page script: Move page script moved page Dev:Quest log.txt to Development:Quest log.txt: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Archive:Quest log.txt]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Dev:Quest_ideas&diff=59543Dev:Quest ideas2024-03-27T03:56:47Z<p>Move page script: Move page script moved page Dev:Quest ideas to Development:Quest ideas: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Development:Quest ideas]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Development:Quest_ideas&diff=59542Development:Quest ideas2024-03-27T03:56:47Z<p>Move page script: Move page script moved page Dev:Quest ideas to Development:Quest ideas: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>=Quest ideas=<br />
<br />
The Quests as of now in the Mana world do have very similar structures: You got to collect stuff and bring a certain amount of things to the npc. Some nice story around, and that is how most of the quests are build up.<br />
<br />
That is what got to be changed: <br />
Quests like the monster oil or orum&waric or Rauk are challenging and more exciting to players.<br />
These minigames do have more worth to enjoy the players.<br />
<br />
<br />
Here come some ideas:<br />
<br />
==The confused professor==<br />
probable story:<br />
a confused professor will do experiments. But he always looses his notices and results written down. <br />
So the player needs to help him, by making up a diary for the professor.<br />
Maybe the professor even tells you how long the experiment goes and the player needs to tell the professor that<br />
the experiment is finished that specific day.<br />
<br />
reward: to be determined<br />
<br />
technical idea:<br />
the player has to remember some numbers.<br />
Every day you are told another number.<br />
At the end (between 10-20 days, chosen by random) you have to tell the npc the sum of all numbers told.<br />
players need to be careful, since the npc wont remember if you have visited him already at that day.<br />
<br />
redoable: yes<br />
<br />
<br />
==Seeking a group of NPC's== <br />
story:<br />
1) Children playing hiding in tulimshar<br />
A group of children in Tulimshar wants to play with you. They ask you to find all of them.<br />
<br />
2) A group of geologist doing some research in the Hurnscald mines<br />
Because of their work, they can't leave their place, but need something to eat and ask you to bring them something.<br />
(might be random, which food they want?)<br />
<br />
reward: to be determined, if you serve all the npc at one day you get an extra reward<br />
<br />
technical idea:<br />
might be done as a daily quest, each NPC gives you a very small <br />
reward for visiting it, but if you find all of them <br />
within a day, you get a bigger reward.<br />
(is it possible to choose from a random pool of positions every time the server is restarted? <br />
or something similar to change positions sometimes?)<br />
<br />
if you have found an npc this could be saved via bitmasking, there also have to be a saving <br />
of the date, which has to be reset after 24 hours<br />
<br />
redoable: yes</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Dev:Projects_and_Teams&diff=59541Dev:Projects and Teams2024-03-27T03:56:47Z<p>Move page script: Move page script moved page Dev:Projects and Teams to Development:Projects and Teams: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Development:Projects and Teams]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Development:Projects_and_Teams&diff=59540Development:Projects and Teams2024-03-27T03:56:47Z<p>Move page script: Move page script moved page Dev:Projects and Teams to Development:Projects and Teams: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[TMW Team]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Dev:Playersets&diff=59539Dev:Playersets2024-03-27T03:56:47Z<p>Move page script: Move page script moved page Dev:Playersets to Development:Playersets: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Development:Playersets]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Development:Playersets&diff=59538Development:Playersets2024-03-27T03:56:47Z<p>Move page script: Move page script moved page Dev:Playersets to Development:Playersets: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>{{Category_art}}<br />
{{Category:Outdated}}<br />
<br />
== Current Playerset Sprite Sheets ==<br />
[https://github.com/themanaworld/tmwa-client-data/tree/master/graphics/sprites/model/male.png|Current Male Player Sprite]<br />
[https://github.com/themanaworld/tmwa-client-data/tree/master/graphics/sprites/model/female.png|Current Female Player Sprite]<br />
<br />
== Sprite Sheet Specification ==<br />
* '''Frame size:''' 64x64<br />
* '''Color depth:''' 32 bpp (including alpha layer)<br />
* '''Directions:''' 4 (north, south, east, west)<br />
* '''Dye Channels:''' 3 (W;R;B;)<br />
<br />
== Total List of Playerset Actions ==<br />
* walk<br />
* sit<br />
* dead<br />
* attack<br />
* attack_sword_stab<br />
* attack_bow<br />
* attack_spear<br />
* attack_chop<br />
* attack_2hand<br />
* cast<br />
<br />
== Mechanics and Layering ==<br />
The Player Sprite is a 3 Channel Dye which is why it looks so weird. The Channels are WRB (Greyscale, Red & Blue). This is to facilitate our the sprite [[Dev:Image_dyeing|Dye system]]. The Male and Female sprites share frame numbering and just about the same xmls for a wide variety of gear. The player sprite is also the Npc base for the humuniod Npcs. Between the Dye channels, clothing and layering equipment it makes something like millions of unique Npc combinations. <br />
<br />
== Improvements ==<br />
* Death frames need a good animation<br />
* Extra Dye Channels added to "texture" the base player<br />
* Facial Expressions<br />
* Body Modifications (Horns, Spikes, Wings, etc.)<br />
* Large and small size of player sprite.<br />
<br />
[[Category:Development]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Dev:Particle_engine&diff=59537Dev:Particle engine2024-03-27T03:56:47Z<p>Move page script: Move page script moved page Dev:Particle engine to Development:Particle engine: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Development:Particle engine]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Development:Particle_engine&diff=59536Development:Particle engine2024-03-27T03:56:46Z<p>Move page script: Move page script moved page Dev:Particle engine to Development:Particle engine: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>{{Category_programming}}<br />
{{Category_art}}<br />
{{status_green}}<br />
<br />
==What is the particle engine?==<br />
<br />
The particle engine is a system that allows to create beautiful dynamic special effects based on creating and managing a large number of small, independent, moving sprites. For more information about particle engines see [http://en.wikipedia.org/wiki/Particle_system the Wikipedia article about particle systems].<br />
<br />
The particle engine allows us to create a large variety of beautiful special effects with minimal effort that could outclass those of most other sprite based rpgs. The areas where particle effects could be used include but are not limited to:<br />
* Environmental effects like waterfalls, fires, fountains or smoke comming out of chimneys<br />
* Visualisation of mystical phenomenons like teleporters or other points of interest<br />
* Graphic effects for spells<br />
* Visualisation of status effects<br />
<br />
== The effect definition file ==<br />
Particle effects are described in xml documents. They describe one or more single particles or particle emitters.<br />
<br />
=== <effect> ===<br />
Is the root element of the XML document.<br />
<br />
=== <particle> ===<br />
Every effect is based on at least one particle. Often but not always these root particles function only as emitters that spawn new particles and have no appearance of their own. They have the following three required properties:<br />
;position-x: (initial) position on map relative to the position where the effect is created (pixel-based)<br />
;position-y: (initial) position on map relative to the position where the effect is created (pixel-based)<br />
;position-z: (initial) position on map relative to the position where the effect is created (pixel-based)<br />
The following properties are optional:<br />
;lifetime: Lifetime in game-ticks. (default: unlimited)<br />
In addition they can have any number of emitters and a visual representation in form of an <animation> or an <image>.<br />
<br />
=== <image> ===<br />
Root particles can have an <image> childtag that contains the path to an image in its content. In that case this image is used as the visual representation of the root particle.<br />
<br />
=== <emitter> ===<br />
Emitters are always child-elements of a particle or another emitter. They create new particles themself which can also include emitters and so on. They also include a number of <property> child elements that define the initial properties of the created particles. When one of the following propertiy elements is missing the default value is used. The property elements must have either ''name'' and ''value'' or ''name'', ''min'' and ''max''. In addition they can also have some change-''X'' options which control their change over time.<br />
<br />
They can also have any number of <emitter> childtags (when these exist all child-particles will be equipped with these emitters) and an <animation> childtag that replaces the image with an animation.<br />
<br />
==== <property> ====<br />
:;name: The property controlled by this tag<br />
:;value: (fixed property value ) Value assigned to the created particles<br />
:;min, max: (randomized property value) Range of random values assigned to the created particles<br />
:;change-function: shape of the change-over-time function. Possible values are: "sinus", "saw", "triangle" and "square"<br />
:;change-period: Time in ticks until the function is repeated<br />
:;change-amplitude: Maximum change applied to min and max<br />
:;change-phase: Phase offset of the function in ticks<br />
<br />
====Property types====<br />
<br />
:;position-x: (initial) position on map relative to the parent particle (pixel-based) (default: 0)<br />
:;position-y: (initial) position on map relative to the parent particle (pixel-based) (default: 0)<br />
:;position-z: (initial) position on map relative to the parent particle (pixel-based) (default: 0)<br />
:;image: path to the image that should be drawn at the position of the particles (default: no image)<br />
:;horizontal-angle: clockwise angle of initial vector on horizontal plane in degree. 0° means straight right. (default: 0)<br />
:;vertical-angle: angle between ground and initial vector in degree. 0° means parallel to the ground. Positive values are upwards, negative downwards. (default: 0 = parallel to ground)<br />
:;power: Initial speed of the particles in pixels/ game-tick (default: 0)<br />
:;gravity: Downward acceleration of particles in pixels/game-tick² (default: 0)<br />
:;randomness: Random changes in the X, Y and Z vector. The unit is maximum pixels/game-tick/1000. (only integers, default: 0)<br />
:;lifetime: lifetime in game ticks (only integers, default: -1 = unlimited)<br />
:;fade-out: Number of game ticks of lifetime left when the particle starts to disappear by fading into alpha. (only integers, default: 0 = disabled)<br />
:;fade-in: Number of game ticks while the particles fade in to their full opacity. (only integers, default: 0 = spawned with full opacity)<br />
:;alpha: Opacity of the created particles after fade-in and before fade-out. (default: 1 = full opacity)<br />
:;output: Numbers of particles created per output (only integers, default: 1)<br />
:;output-pause: Pause in ticks between two particle outputs (only integers, default: 0)<br />
:;acceleration: acceleration of particles towards the target in pixels/game-tick² (default: 0)<br />
:;momentum: Momentum of the particles. Before adding the acceleration the old vectors are multiplied by this. A momentum of 1 creates a perfect newtonian object. A slightly lower momentum gives the impression that the particles are breaked. A higher momentum makes the particles accelerate forward. This looks rather weird but could be useful for some effects. A negative momentum looks really ugly. (default: 1)<br />
:;die-distance: Only used together with acceleration. Distance in pixels to the target that causes the destruction of the particles when reached. (Default: 0 = not destroyed on contact)<br />
:;bounce: When higher than 0 particles don't disappear when they touch the ground. Instead they bounce off with a vector equal to their old vector multiplied with this property. It is recommended to add a limited lifetime to bouncing particles because otherwise they are immortal. (Default: 0)<br />
:;follow-parent: When this property is there the particles are moved when the parent particle is moved. This is especially useful for avoiding distortion of being-based particle effects when the being moves. This property has no value - its existence alone creates this behavior.<br />
<br />
=== <animation> ===<br />
The animation tag can be used as a childtag of the <particle> tag to make the root particle appear as an animated image or it can be used as a childtag for an emitter. In that case the emitter spawns animated particles instead of a static ones.<br />
<br />
The usage is similar like the animation tag described in [[Animations#.3Canimation.3E]]. You can use the same child elements with the same syntax. The only difference are the properties of the animation tag itself. There is no direction property. Instead the used imageset is described in the animation tag with the properties ''imageset'', ''width'' and ''height''. All three properties are required.<br />
<br />
== Particle engine related config setting ==<br />
===particleFastPhysics===<br />
Replaces the cpu intense squareroot calculations for calculating the vectors of target-based particles by less intense but less accurate calculations. 0 uses the slow but accurate and reliable function from the C standard library. Setting it to 1 uses a squareroot approximation function that is much faster while being only slightly less accurate but doesn't work on some architectures. 2 is an even faster method that shouldn't have any portability problems but it is very inaccurate.<br />
'''Default: 0'''<br />
<br />
===particleMaxCount===<br />
Maximum number of particles in the game world. When this limit is reached no new particles will be spawned by emitters until some particles disappeared. This limit is only respected by emitters and not when spawning new effects to make sure that they are spawned when the particle limit is maxed out. <br />
<br />
When the limit is maxed out the result is a quite unregular output of the particle emitters that looks quite ugly. So this situation should be avoided. The main reason this setting exists is to encourage the particle effect creators to keep the particle output of their emitters on a reasonable level and to keep the game playable in unusual particle-intense situations by accepting a glitchy appearance of the particle effects in this cases. <br />
<br />
Please note that a few very large particles can reduce the framerate more than a lot of very small particles.<br />
<br />
'''Default: 3000'''<br />
<br />
===particleEmitterSkip===<br />
The number of game ticks each emitter is inactive between two particle spawns. Setting this to a higher value keeps the numbers of particles down by reducing the output of the emitters.<br />
<br />
This is a more useful way for the user to reduce the particle count than reducing particleMaxCount because it doesn't change the look of particle effects that much.<br />
<br />
'''Default: 0'''<br />
<br />
==Putting particle effects on maps==<br />
An important application of particle effects are map-based effects. For that reason particle effects can be placed on maps in form of map objects. The current version of our map editor Tiled does only support map objects partially. So the best way to place particle effects on maps is by editing the map files with a text editor.<br />
<br />
This is done by adding an <objectgroup> tag as a child tag of the <map> tag (when the map has't got an objectgroup tag yet). Then you add an <object> childtag for each particle effect you want to add to the map. The object tag has 4 properties:<br />
;type: Must be "PARTICLE_EFFECT"<br />
;name: The filename of the effect definition file of the effect.<br />
;x: Distance from the left border of the map in pixels.<br />
;y: Distance from the upper border of the map in pixels.<br />
<br />
As an example here the objectgroup block from the bat cave:<br />
<syntaxhighlight lang="xml"><br />
<objectgroup name="Object Group 1" width="0" height="0"><br />
<object name="graphics/particles/flame.particle.xml" type="PARTICLE_EFFECT" x="928" y="960" width="32" height="32"><br />
<properties/><br />
</object><br />
<object name="graphics/particles/flame.particle.xml" type="PARTICLE_EFFECT" x="992" y="960" width="32" height="32"><br />
<properties/><br />
</object><br />
</objectgroup><br />
</syntaxhighlight><br />
Note that this example includes a lot of unnecessary meta-information added by Tiled. The minimal version that can be parsed by the TMW client would be the following:<br />
<syntaxhighlight lang="xml"><br />
<objectgroup><br />
<object name="graphics/particles/flame.particle.xml" type="PARTICLE_EFFECT" x="928" y="960" /><br />
<object name="graphics/particles/flame.particle.xml" type="PARTICLE_EFFECT" x="992" y="960" /><br />
</objectgroup><br />
</syntaxhighlight><br />
Map-based particle effects are initialized when the player enters the map and are also calculated when the effect isn't on the screen of the player. For that reason you should not put too many effects with a lot of particles on one map. Otherwise you could hit the particleMaxCount limit.<br />
<br />
==Using the particle engine for programmers==<br />
The basic element of the particle engine is a special particle named "particleEngine". It maintains a tree of particle effects. Each particle has a position in three dimensional space (in this case the two dimensional game world is treated as a flat plane in a three dimensional space). Based on the type of particle it might or might not have:<br />
* Movement based on physical properties<br />
* A visual representation (a single image or an animation)<br />
* A list of emitters that create additional particles.<br />
<br />
The Particles are derived class from the "Sprite" class so that they can be added to the maps sprite list to be drawn together with the other sprites by the "map" class. <br />
<br />
=== Creation of effects ===<br />
Effects are created by calling particleEngine->addEffect(). The arguments are a particle effect definition file, the map coordinates (pixel-based) and the map on which the effect should be created. This creates a host particle that can have any number of emitters. The host particle is returned so it can be manipulated further. It is possible to create multiple host particles in one particle effect file. In that case only the last particle is returned.<br />
<br />
=== Effects that follow beings ===<br />
Beings can gain control of a particle. This happens by calling the controlParticle() member function of the Being class.<br />
<br />
The usual method to create a particle that follows a being is by calling particleEngine->addEffect() and pass the returned particle to controlParticle().<br />
<br />
Note that when a Being takes control of a particle it disables the automatic deletion of the particle. The being is now responsible for requesting the deletion of the particle by calling Particle::kill(). When it does the particle will be deleted after its next update.<br />
<br />
=== Homing particles ===<br />
A particle will be attracted by another particle when its acceleration is greater than 0. When a particle is created by an emitter the attracting particle is the host particle of the effect but it can be changed by calling Particle::setDestination(). I would always recommend to use a parent particle of the particle as a target because a segfault will occur when the target particle is deleted.<br />
<br />
==Possible Additions==<br />
<br />
Below is a list of proposed additions to the Particle System.<br />
===Delayed effects===<br />
In composite effects, it is often desirable to start a certain effect only after a certian amount of time has passed; for example, we might want to fade in a circle and only then suddenly flash a pentagram in its centre. This could be accomplished by an `on-death' emitter that is spawned when its parent particle dies.<br />
===Random animation===<br />
Random animation entry points/cel choices Right now, animation cels are looped through sequentially. For some effects, randomly picking one element each interval, or at least starting out at a random entry, may be preferable.<br />
===Orbiting particle improvement ===<br />
Orbitting particles need a reference point; right now this is fixed to be the `base' particle. We need an option to choose the parent, grandparent, ... instead.<br />
<br />
==In client particles testing==<br />
In ManaPlus possible to attach particle to player.<br />
For this can be used command:<br />
<br />
<code>/testparticle path/to/particle.xml</code><br />
<br />
For stop particle testing need run command:<br />
<br />
<code>/testparticle</code><br />
<br />
<br />
Client can automatically reload particle if it was changed.<br />
<br />
==Current problems and limitations==<br />
[[Image:Particle-engine-problem.png|thumb|250px]]<br />
<br />
Crush, I see the particles surrounding the player got across the wall because those tiles aren't marked as above the player. This happens in every map, I think. The solution would be to put the problematic a level up. This is not a limitation on the engine actually, but something that has to be fixed before committing to trunk. Unless you had something better in mind.<br />
<br />
: This can't be fixed that easily. The particles have to be drawn on the object layer so that they can be sorted with the other objects. Also note that it is usually the desired behavior that objects on the over layer are drawn over particles on the sprite layer. As a workaround i would suggest to use more thorough mapping in the future. That means to fill "empty" areas with black tiles on layer 2 instead of black tiles on the ground layer and to map cliffs that are clearly on the upper layer on layer 2.--[[User:Crush|Crush]] 21:58, 9 February 2007 (CET)<br />
<br />
I know. But it's still a problem. My intention was to bring it to light before the engine is merged to trunk and used extensively. --[[User:Pajarico|Pajarico]] 13:23, 10 February 2007 (CET)<br />
<br />
[[Category:Development]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Dev:Other_Xmls&diff=59535Dev:Other Xmls2024-03-27T03:56:46Z<p>Move page script: Move page script moved page Dev:Other Xmls to Development:Other Xmls: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>#REDIRECT [[Development:Other Xmls]]</div>Move page scripthttps://oldwiki.devbox.themanaworld.org/index.php?title=Development:Other_Xmls&diff=59534Development:Other Xmls2024-03-27T03:56:46Z<p>Move page script: Move page script moved page Dev:Other Xmls to Development:Other Xmls: Rename Dev: to Development: so the miraheze import works</p>
<hr />
<div>==Paths.xml==<br />
<br />
This file controls the main settings and layout of the rest of the Manaplus files.<br />
<br />
The Mana Worlds: [https://github.com/themanaworld/tmwa-client-data/blob/master/paths.xml TMW Paths.xml]<br />
<br />
Manaplus Documentation: [http://manaplus.org/paths.xml Paths.xml]<br />
<br />
==Features.xml==<br />
<br />
This file allows you to pre-configure or turn certain settings on/off by default in the client.<br />
<br />
The Mana Worlds: [https://github.com/themanaworld/tmwa-client-data/blob/master/features.xml TMW Features.xml]<br />
<br />
==Effects.xml==<br />
<br />
This file assigns ids to particle effects. These can then be used on sprites, monsters and players.<br />
<br />
The Mana Worlds: [https://github.com/themanaworld/tmwa-client-data/blob/master/effects.xml TMW Effects.xml]<br />
<br />
[[Category:Development]]</div>Move page script