EQ2Emulator - User contributions [en]

LUA:Stealth

2016-08-22T11:56:03Z

Scribble: /* Usage */

This function will set a spawn to stealth or invis. For the second parameter 1 = stealth, any other value = invis.

==== Syntax ====
Stealth([Spawn] Target, [int8] stealth_type)

==== Usage ====
<pre>
function hailed(NPC, Spawn)
Say(NPC, "must hidez!!!")
Stealth(NPC, 1)
end
</pre>

When an npc with this function is hailed, they will say must hidez!!! Followed immediately by activating stealth.

[[LUA:SpawnFunctions|Back to LUA Spawn Functions Index]]

Note*

If you use the invisibility function: remove with RemoveInvis() as RemoveStealth causes a crash.
If using RemoveInvis() the icon will still be visible(bug).

LUA:Stealth

2016-08-22T11:54:42Z

Scribble: /* Usage */

This function will set a spawn to stealth or invis. For the second parameter 1 = stealth, any other value = invis.

==== Syntax ====
Stealth([Spawn] Target, [int8] stealth_type)

==== Usage ====
<pre>
function hailed(NPC, Spawn)
Say(NPC, "must hidez!!!")
Stealth(NPC, 1)
end
</pre>

When an npc with this function is hailed, they will say must hidez!!! Followed immediately by activating stealth.

[[LUA:SpawnFunctions|Back to LUA Spawn Functions Index]]

Note*

If you use the invisibility function remove with RemoveInvis() as RemoveStealth causes a crash. If using RemoveInvis() the icon will still be visible(bug).

Project:About

2016-08-01T16:11:42Z

Scribble:

EQ2Emulator is an Open Source project dedicated to replicating the MMORPG game "Everquest 2". Emulators have been around for some time, but their general purpose is two-fold; to provide a gaming experience to players who otherwise cannot pay-to-play the commercial game, and to allow Server Administrators the freedom to customize the world being emulated to create a unique, never before seen gaming experience. Emulators are generally always under construction, and never 100% complete in either functionality or data - since all knowledge of the game we are emulating comes from the official published games - so they are not meant to be a replacement for the live gaming experience, only an alternative. For a genuine, accurate, social gaming experience, players should always turn to the actual commercial games.

----
''' The People of EQ2Emu

John Adams: Project Administrator, database schema and raw data processing

LethalEncounter: Lead developer of the EQ2Emulator source code.

Scatman: Content team leader, sole C++ developer, scripting

Zcoretri: Content team, parser, spell data and scripting

ZexisStryfe: Content team, models master list guru

''' Occasional Contributors

Those who have helped the community and the project in anyway they could.

Image: Developer of the Minilogin solution and of the core source code

paulgh: C++ development, server features

Bolly: Parallax Server admin, WIKI re-design and author, Items editor

Benas: Log Collector

Woody: Log Collector

Arremis: Log Collector

Many others have collected data for us, these are just the major contributors.

''' Gone but not forgotten -

These lost souls have left for greener pastures, but their efforts will not be forgotten.

Bion: Content team, items data expert

Nalandial: Content team, loot table development

Xanibunib: Content team, quest scripter

Secrets: Assembly, Opcodes

----
''' The Database '''

The EQ2Emulator and it's Database are symbiotic - one cannot truly function without the other. Without an emulator.exe there of course would be no need for data... however, without data, the emulator.exe would be an empty shell that allowed the player only to move from zone to zone absent of content. Each and every "spawn" from the live game needs to be replicated in the emulator DB. Anyone familiar with EQ2 will understand this is a huge, daunting task. There are literally hundreds of thousands of Spawns in EQ2. Luckily, the development teams have tools to help collect Live data for use in "our world". Otherwise, this task would be too big for this small team to manage.

----
''' EQ2 Emulator Wants YOU! '''

EQ2 Emulator is always welcoming more help, and the more people help, the faster this project comes along. There is always something you can do, testing the emulator, helping out with the programming, working behind the scenes, and collecting data from the live servers. Keep a look out at the [http://www.eq2emulator.net/phpBB3/index.php Forum Index] for threads asking for your help.

----
If you would like to know how things are coming along, check the [http://www.eq2emulator.net/index.php?page=25 Project Status Page].

----
Sources
www.eq2emulator.net
John Adams (Interview)

----
--[[User:Ilythor|Ilythor]] 03:00, 17 January 2009 (CST)

LUA

2016-07-29T14:03:56Z

Scribble: /* General Functions */

{{PageHeaderParent|LUA}}

{{Header|EQ2Emulator: LUA Scripting|BackgroundColor=3d78b4|FontColor=ffffff}}
''LUA Scripting'' is extending the functionality of the server without the need to recompile the code each time you wish to add some form of interaction with an NPC, an event happening in a zone, quest steps for players to work through, etc.

{{Header|What is "LUA"?|BackgroundColor=3d78b4|FontColor=ffffff}}
For a comprehensive look at what LUA is, please visit the [http://www.lua.org lua.org] website and read their own [http://www.lua.org/about.html About] information. On this Wiki, we shall only discuss our own implementation of LUA.

We have chosen LUA as our script engine for EQ2Emulator. Things like Quests, Spawn movement or interaction, Spells, and Zone-wide events are ''scripted'' in LUA using custom '''functions''' specific to the emulator core. Below you will find a list of current EQ2Emulator LUA Functions with links to what they do and examples of how to use them.

You will quickly see that the ease of the LUA Scripting language and it's tight integration with EQ2Emulator make our server extremely dynamic and customizable.

Currently, EQ2Emulator employs LUA scripting for the following systems:

[[LUA:SpawnScripts | Spawns]]

[[LUA:Spells | Spells]]

[[LUA:Quests | Quests]]

[[LUA:ItemScripts | Items]]

[[LUA:ZoneScripts | Zones]]

Follow any of these links for a closer look at the system. Below is a general list of LUA functions we'll keep at this top-level for easier reference.

{{Header|LUA Parameter Basics|BackgroundColor=3d78b4|FontColor=ffffff}}
EQ2Emulator LUA Functions normally have ''parameters'' - that is, some value required to be passed from the World to the Script or vice-versa. An example of this is the '''function hailed(NPC, Spawn)'''. Note that there are 2 parameters for '''function hailed()'''. What the parameter ''names'' are is up to you, as long as there are the proper number of parameters in the () parens.

Example: Here, the Player says Hello to the NPC.
function hailed(NPC, Player)
Say(Player, "Hello NPC!")
end

Current ''standards'' we have adopted are to use '''NPC''' as the value for the NPCs parameters, and depending on the type of script, '''Spawn''' or '''Player''' for the Players parameters. Nearly all other parameter values are dynamic - that is, they can be any valid variable name you choose. But when coding scripts for the Official EQ2Emulator Project, be sure to follow ''our guidelines'' or your scripts will get rejected.

{{Header|LUA Functions|BackgroundColor=3d78b4|FontColor=ffffff}}
Our LUA Functions list is broken into several categories for clarity of functionality. New functions are added often, so check this page often for changes.

=== IMPORTANT ===
When adding LUA Command documentation to this Wiki, please be sure to use the
[[LUA:CommandTemplate|LUA Command Template]] provided to maintain consistency across all our pages.

Below are the function names and a brief description of what the function does. For details on required parameters and usage, click the function name.

=== All Functions ===
All the LUA functions EQ2Emu currently has.

[[LUA:AllFunctions|All Functions]]

=== Get Functions ===
This set of functions will ''GET'' info from the World or Database for use within any LUA script.

[[LUA:GetFunctions|Get Functions]]

=== Set Functions ===
This set of functions will ''SET'' info in the World or Database from within any LUA script

[[LUA:SetFunctions|Set Functions]]

=== Item Functions ===
This set of function are used to make game Items perform special tasks (clickies or quest items)

[[LUA:ItemFunctions|Item Functions]]

=== Quest Functions ===
These functions are for use within Quest scripts, and are some of the more complex LUA Functions in the EQ2Emulator.

[[LUA:QuestFunctions|Quest Functions]]

=== Spell Functions ===
These functions are used within Spell scripts to generate the expected effect of casting spells or using abilities.

[[LUA:SpellFunctions|Spell Functions]]

=== Spawn Functions ===
These are functions that normally go into SpawnScripts for interacting with NPCs or other types of Spawns.

[[LUA:SpawnFunctions|Spawn Functions]]

=== General Functions ===
These are general functions that do not fall under any other classification.

[[LUA:MiscFunctions|Miscellaneous Functions]]

{{Header|LUA Script Examples|BackgroundColor=3d78b4|FontColor=ffffff}}
Just a few examples of what you can do with LUA Scripting and EQ2Emulator custom functions... This is by no means a comprehensive list, just some concepts in use:

function hailed(NPC, Spawn)
Say(NPC, "Your class is " .. GetClass(Spawn) .. "!")
end

This makes the NPC respond to the player who hails it with the players class.

function ChangePlayerClass(NPC, Spawn)
''var'' = GetClass(Spawn)
SetClass(Spawn, 1) -- changes Spawn to class 1
.
.
.
SetClass(Spawn, ''var'') -- changes Spawn back to original class
end

Sets variable ''var'' to the value of the function for use in other parts of the script, for example returning to original value after function has completed.

{{Header|SpawnScripts|BackgroundColor=3d78b4|FontColor=ffffff}}
[[ContentDesigner:SpawnScripts|SpawnScripts]] are what gives your NPC's life. The emulator uses LUA as its scripting engine, and combined with spawnscripts a NPC can preform actions like move, attack, and have conversations.

{{Header|Quests|BackgroundColor=3d78b4|FontColor=ffffff}}
Coming Soon

{{Header|Conclusion|BackgroundColor=3d78b4|FontColor=ffffff}}
LUA functions are added often, usually when we discover some new way that DayBreak does their spawns, quests or other content. If you find you are unable to achieve your goal in your scripting, it is possible you need a LUA function added. You can either choose to develop your own LUA function and submit it to the core Devs for inclusion, or post your requirements in the Feature Request forum for a script dev to add to the server.

[[Systems|Back to Systems]]