diff --git a/docs/lua_api.md b/docs/lua_api.md index 85065ad..57117cf 100644 --- a/docs/lua_api.md +++ b/docs/lua_api.md @@ -53,26 +53,26 @@ This document will detail all Lua scripting functions available within EQ2Emu. - [`AddSpawnAccess(Spawn, Player)`](./lua_functions/AddSpawnAccess.md) - [`AddSpawnIDAccess(Player, spawn_id, zone)`](./lua_functions/AddSpawnIDAccess.md) - [`AddSpawnToGroup(spawn, new_group_id)`](./lua_functions/AddSpawnToGroup.md) -- [`AddSpellBonus(param1, param2, param3, param4, param5, param6, param7)`](./lua_functions/AddSpellBonus.md) -- [`AddSpellBookEntry(param1, param2, param3, param4, param5, param6)`](./lua_functions/AddSpellBookEntry.md) -- [`AddStepProgress(param1, param2, param3, param4)`](./lua_functions/AddStepProgress.md) -- [`AddTimer(param1, param2, param3, param4, param5, param6, param7, param8)`](./lua_functions/AddTimer.md) -- [`AddTransportSpawn(param1, param2)`](./lua_functions/AddTransportSpawn.md) -- [`ApplySpellVisual(param1, param2)`](./lua_functions/ApplySpellVisual.md) +- [`AddSpellBonus(Spawn, type, value)`](./lua_functions/AddSpellBonus.md) +- [`AddSpellBookEntry(player, spellid, tier, add_silently, add_to_hotbar)`](./lua_functions/AddSpellBookEntry.md) +- [`AddStepProgress(player, quest_id, step, progress)`](./lua_functions/AddStepProgress.md) +- [`AddTimer(spawn, time, function, max_count, player)`](./lua_functions/AddTimer.md) +- [`AddTransportSpawn(spawn)`](./lua_functions/AddTransportSpawn.md) +- [`ApplySpellVisual(target, spell_visual)`](./lua_functions/ApplySpellVisual.md) - [`Attack(NPC, Target)`](./lua_functions/Attack.md) -- [`Bind(param1, param2, param3, param4, param5, param6, param7, param8, param9)`](./lua_functions/Bind.md) -- [`CanReceiveQuest(param1, param2, param3, param4)`](./lua_functions/CanReceiveQuest.md) +- [`Bind(spawn, zone_id, x, y, z, h)`](./lua_functions/Bind.md) +- [`CanReceiveQuest(spawn, quest_id)`](./lua_functions/CanReceiveQuest.md) - [`CastCustomSpell(spell, caster, target)`](./lua_functions/CastCustomSpell.md) - [`CastEntityCommand(caster, target, id, command)`](./lua_functions/CastEntityCommand.md) -- [`CastSpell(param1, param2, param3, param4, param5, param6, param7, param8, param9)`](./lua_functions/CastSpell.md) -- [`ChangeFaction(param1, param2, param3)`](./lua_functions/ChangeFaction.md) -- [`ChangeHandIcon(param1, param2)`](./lua_functions/ChangeHandIcon.md) -- [`ClearChoice(param1, param2, param3, param4)`](./lua_functions/ClearChoice.md) -- [`ClearRunningLocations(param1)`](./lua_functions/ClearRunningLocations.md) -- [`CloseConversation(param1, param2)`](./lua_functions/CloseConversation.md) -- [`CloseItemConversation(param1, param2)`](./lua_functions/CloseItemConversation.md) -- [`CreateChoiceWindow(param1, param2, param3, param4, param5, param6, param7, param8, param9, param10, param11, param12, param13)`](./lua_functions/CreateChoiceWindow.md) -- [`CreateConversation(param1)`](./lua_functions/CreateConversation.md) +- [`CastSpell(target, spell_id, spell_tier, caster, custom_cast_time)`](./lua_functions/CastSpell.md) +- [`ChangeFaction(spawn, faction_id, increase_or_decrease)`](./lua_functions/ChangeFaction.md) +- [`ChangeHandIcon(spawn, displayHandIcon)`](./lua_functions/ChangeHandIcon.md) +- [`ClearChoice(spawn, commandToClear, clearDecline)`](./lua_functions/ClearChoice.md) +- [`ClearRunningLocations(spawn)`](./lua_functions/ClearRunningLocations.md) +- [`CloseConversation(npc, player)`](./lua_functions/CloseConversation.md) +- [`CloseItemConversation(item, player)`](./lua_functions/CloseItemConversation.md) +- [`CreateChoiceWindow(npc, spawn, windowTextPrompt, acceptText, acceptCommand, declineText, declineCommand, time, textBox, textBoxRequired, maxLength)`](./lua_functions/CreateChoiceWindow.md) +- [`CreateConversation()`](./lua_functions/CreateConversation.md) - [`CreatePersistedRespawn(location_id, spawn_type, respawn_time, zone_id)`](./lua_functions/CreatePersistedRespawn.md) - [`CreateWidgetRegion(zone, version, region_name, env_name, grid_id, widget_id, dist)`](./lua_functions/CreateWidgetRegion.md) - [`CureByControlEffect(cure_count, cure_type, cure_name, cure_level, target)`](./lua_functions/CureByControlEffect.md) @@ -248,48 +248,48 @@ This document will detail all Lua scripting functions available within EQ2Emu. - [`HandInCollections(player)`](./lua_functions/HandInCollections.md) - [`Harvest(player, node)`](./lua_functions/Harvest.md) - [`HasCoin(Spawn, Value)`](./lua_functions/HasCoin.md) -- [`HasCollectionsToHandIn(param1)`](./lua_functions/HasCollectionsToHandIn.md) -- [`HasCompletedQuest(param1, param2)`](./lua_functions/HasCompletedQuest.md) +- [`HasCollectionsToHandIn(player)`](./lua_functions/HasCollectionsToHandIn.md) +- [`HasCompletedQuest(player, quest_id)`](./lua_functions/HasCompletedQuest.md) - [`HasControlEffect(spawn, type)`](./lua_functions/HasControlEffect.md) -- [`HasFreeSlot(param1)`](./lua_functions/HasFreeSlot.md) -- [`HasGroup(param1, param2)`](./lua_functions/HasGroup.md) +- [`HasFreeSlot(player)`](./lua_functions/HasFreeSlot.md) +- [`HasGroup(spawn)`](./lua_functions/HasGroup.md) - [`HasItem(Player, ItemID, IncludeBank)`](./lua_functions/HasItem.md) - [`HasItemEquipped(player, item_id)`](./lua_functions/HasItemEquipped.md) - [`HasLanguage(player, language_id)`](./lua_functions/HasLanguage.md) - [`HasLootItem(spawn, item_id)`](./lua_functions/HasLootItem.md) -- [`HasMoved(param1)`](./lua_functions/HasMoved.md) +- [`HasMoved(spawn)`](./lua_functions/HasMoved.md) - [`HasPendingLoot(entity, player)`](./lua_functions/HasPendingLoot.md) - [`HasPendingLootItem(entity, player, item_id)`](./lua_functions/HasPendingLootItem.md) - [`HasPendingQuest(player, quest_id)`](./lua_functions/HasPendingQuest.md) - [`HasQuest(player, quest_id)`](./lua_functions/HasQuest.md) - [`HasQuestRewardItem(quest, item_id)`](./lua_functions/HasQuestRewardItem.md) -- [`HasRecipeBook(param1, param2, param3, param4)`](./lua_functions/HasRecipeBook.md) +- [`HasRecipeBook(player, recipe_id)`](./lua_functions/HasRecipeBook.md) - [`HasRecovered(spawn)`](./lua_functions/HasRecovered.md) - [`HasSkill(player, skill_id)`](./lua_functions/HasSkill.md) - [`HasSpell(player, spellid, tier)`](./lua_functions/HasSpell.md) - [`HasSpellEffect(spawn, spellID, tier)`](./lua_functions/HasSpellEffect.md) - [`HasSpellImmunity(spawn, type)`](./lua_functions/HasSpellImmunity.md) - [`IncreaseSkillCapsByType(player_spawn, skill_type, amount, more_to_increase)`](./lua_functions/IncreaseSkillCapsByType.md) -- [`InFront(param1, param2, param3, param4)`](./lua_functions/InFront.md) +- [`InFront(spawn, target)`](./lua_functions/InFront.md) - [`InLava(Spawn)`](./lua_functions/InLava.md) - [`InstructionWindow(player, duration, text, voice, voice_key1, voice_key2, signal, goal1, task1, goal2, task2, goal3, task3, goal4, task4)`](./lua_functions/InstructionWindow.md) - [`InstructionWindowClose(player)`](./lua_functions/InstructionWindowClose.md) - [`InstructionWindowGoal(player, goal_num)`](./lua_functions/InstructionWindowGoal.md) - [`InWater(Spawn)`](./lua_functions/InWater.md) -- [`IsAlive(param1)`](./lua_functions/IsAlive.md) +- [`IsAlive(spawn)`](./lua_functions/IsAlive.md) - [`IsBehind(spawn, target)`](./lua_functions/IsBehind.md) -- [`IsBindAllowed(param1)`](./lua_functions/IsBindAllowed.md) +- [`IsBindAllowed(spawn)`](./lua_functions/IsBindAllowed.md) - [`IsCasting(spawn)`](./lua_functions/IsCasting.md) -- [`IsCastOnAggroComplete(param1, param2, param3)`](./lua_functions/IsCastOnAggroComplete.md) +- [`IsCastOnAggroComplete(spawn)`](./lua_functions/IsCastOnAggroComplete.md) - [`IsEntity(spawn)`](./lua_functions/IsEntity.md) - [`IsEpic(Spawn)`](./lua_functions/IsEpic.md) - [`IsFlanking(spawn, target)`](./lua_functions/IsFlanking.md) - [`IsFollowing(spawn)`](./lua_functions/IsFollowing.md) -- [`IsGateAllowed(param1, param2)`](./lua_functions/IsGateAllowed.md) +- [`IsGateAllowed(spawn)`](./lua_functions/IsGateAllowed.md) - [`IsGroundSpawn(spawn)`](./lua_functions/IsGroundSpawn.md) - [`IsHeroic(spawn)`](./lua_functions/IsHeroic.md) -- [`IsInCombat(param1)`](./lua_functions/IsInCombat.md) -- [`IsInvis(param1, param2, param3)`](./lua_functions/IsInvis.md) +- [`IsInCombat(spawn)`](./lua_functions/IsInCombat.md) +- [`IsInvis(spawn)`](./lua_functions/IsInvis.md) - [`IsInvulnerable(spawn)`](./lua_functions/IsInvulnerable.md) - [`IsMezzed(spawn)`](./lua_functions/IsMezzed.md) - [`IsMezzedOrStunned(spawn)`](./lua_functions/IsMezzedOrStunned.md) @@ -297,13 +297,13 @@ This document will detail all Lua scripting functions available within EQ2Emu. - [`IsOnAutoMount(player)`](./lua_functions/IsOnAutoMount.md) - [`IsPlayer(Player)`](./lua_functions/IsPlayer.md) - [`IsRunning(spawn)`](./lua_functions/IsRunning.md) -- [`IsSpawnGroupAlive(param1, param2)`](./lua_functions/IsSpawnGroupAlive.md) -- [`IsStealthed(param1, param2, param3)`](./lua_functions/IsStealthed.md) +- [`IsSpawnGroupAlive(zone, group_id)`](./lua_functions/IsSpawnGroupAlive.md) +- [`IsStealthed(spawn)`](./lua_functions/IsStealthed.md) - [`IsStunned(spawn)`](./lua_functions/IsStunned.md) -- [`IsTransportSpawn(param1, param2)`](./lua_functions/IsTransportSpawn.md) +- [`IsTransportSpawn(spawn)`](./lua_functions/IsTransportSpawn.md) - [`IsZoneLoading(zone)`](./lua_functions/IsZoneLoading.md) -- [`KillSpawn(param1, param2, param3)`](./lua_functions/KillSpawn.md) -- [`KillSpawnByDistance(param1, param2, param3, param4)`](./lua_functions/KillSpawnByDistance.md) +- [`KillSpawn(dead, killer)`](./lua_functions/KillSpawn.md) +- [`KillSpawnByDistance(spawn, max_distance, include_players, send_packet)`](./lua_functions/KillSpawnByDistance.md) - [`Knockback(target_spawn, spawn, duration, vertical, horizontal, use_heading)`](./lua_functions/Knockback.md) - [`LastSpellAttackHit()`](./lua_functions/LastSpellAttackHit.md) - [`MakeRandomFloat(min, max)`](./lua_functions/MakeRandomFloat.md) @@ -387,8 +387,8 @@ This document will detail all Lua scripting functions available within EQ2Emu. - [`SetCoinTmpReward(quest, coins)`](./lua_functions/SetCoinTmpReward.md) - [`SetCompletedDescription(quest, description)`](./lua_functions/SetCompletedDescription.md) - [`SetCompleteFlag(quest)`](./lua_functions/SetCompleteFlag.md) -- [`SetCurrentHP(param1, param2)`](./lua_functions/SetCurrentHP.md) -- [`SetCurrentPower(param1, param2)`](./lua_functions/SetCurrentPower.md) +- [`SetCurrentHP(spawn, value)`](./lua_functions/SetCurrentHP.md) +- [`SetCurrentPower(spawn, value)`](./lua_functions/SetCurrentPower.md) - [`SetDeity(spawn, value)`](./lua_functions/SetDeity.md) - [`SetFactionID(spawn, value)`](./lua_functions/SetFactionID.md) - [`SetFailureTimer(spawn)`](./lua_functions/SetFailureTimer.md) diff --git a/docs/lua_functions/CreateConversation.md b/docs/lua_functions/CreateConversation.md index 62ede9e..0f2d0ba 100644 --- a/docs/lua_functions/CreateConversation.md +++ b/docs/lua_functions/CreateConversation.md @@ -1,11 +1,10 @@ -### Function: CreateConversation(conversation) +### Function: CreateConversation() **Description:** Create a new conversation option for the Spawn to use in AddConversationOption. -**Parameters:** -- `conversation` (Conversation) - Conversation object representing `conversation`. +**Parameters:** None. **Returns:** None.