org.starhope.appius.game.npc
Class LuaNPCFactory

java.lang.Object
  org.starhope.appius.game.npc.ScriptableNPCFactory
      org.starhope.appius.game.npc.LuaNPCFactory

public class LuaNPCFactory
extends ScriptableNPCFactory

A non-player character controlled by a chunk of Lua script.

Based upon the Lua port by the Kepler project:

Copyright © 2003-2007 Kepler Project.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Author:

brpocock

Constructor Summary

LuaNPCFactory()

Method Summary

static AbstractUser

getNPC(String script, String klass) WRITEME ...

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LuaNPCFactory

public LuaNPCFactory()

Method Detail

getNPC

public static AbstractUser getNPC(String script,
                                  String klass)

WRITEME ...

The parameter ‘script’ is the filename of the lua script, which must exist in one of two locations. Scripts can be installed in /etc/appius/scripts/ or in a folder named ‘scripts’ installed within the class path of LuaNPC.class.

Parameters:

script - WRITEME

klass - WRITEME

Returns:

WRITEME