* FEATURE: spell name instead of words

Author: jprzimba

config.lua.dist

@@ -426,7 +426,6 @@ allowChangeOutfit = true
 freePremium = false
 kickIdlePlayerAfterMinutes = 15
 maxMessageBuffer = 4
-emoteSpells = false
 allowWalkthrough = true
 coinPacketSize = 25
 coinImagesURL = "http://127.0.0.1/images/store/"
@@ -465,6 +464,10 @@ combatChainSkillFormulaDistance = 0.9
 combatChainSkillFormulaMissile = 0.9
 combatChainSkillFormulaWandsAndRods = 1.0
 
+-- Spells
+emoteSpells = false
+spellNameInsteadOfWords = false
+
 -- Global server Save
 -- NOTE: globalServerSaveNotifyDuration in minutes
 globalServerSaveNotifyMessage = true

data/libs/systems/features.lua

@@ -2,6 +2,7 @@ Features = {
 	AutoLoot = "autoloot",
 	ChainSystem = "chainSystem",
 	EmoteSpells = "emoteSpells",
+	SpellNameInsteadOfWords = "spellNameInsteadOfWords",
 }
 
 local function validateFeature(feature)

data/scripts/talkactions/player/emote_spell.lua

@@ -13,7 +13,7 @@ function emoteSpell.onSay(player, words, param)
 
 	if not table.contains(validValues, param) then
 		local validValuesStr = table.concat(validValues, "/")
-		player:sendTextMessage(MESSAGE_EVENT_ADVANCE, "Invalid param specified. Usage: !emote [" .. validValuesStr .. "]")
+		player:sendTextMessage(MESSAGE_FAILURE, "Invalid param specified. Usage: !emote [" .. validValuesStr .. "]")
 		return true
 	end
 

data/scripts/talkactions/player/spell_name_instead_words.lua

@@ -0,0 +1,32 @@
+local featrue = TalkAction("!spellwords")
+
+local validValues = {
+	"on",
+	"off",
+}
+
+function featrue.onSay(player, words, param)
+	if not configManager.getBoolean(configKeys.EMOTE_SPELLS) then
+		player:sendTextMessage(MESSAGE_FAILURE, "Spell name instead of words have been disabled by the administrator.")
+		return true
+	end
+
+	if not table.contains(validValues, param) then
+		local validValuesStr = table.concat(validValues, "/")
+		player:sendTextMessage(MESSAGE_FAILURE, "Invalid param specified. Usage: !spellwords [" .. validValuesStr .. "]")
+		return true
+	end
+
+	if param == "on" then
+		player:setFeature(Features.SpellNameInsteadOfWords, 1)
+		player:sendTextMessage(MESSAGE_LOOK, "You have activated spell name instead of words.")
+	elseif param == "off" then
+		player:setFeature(Features.SpellNameInsteadOfWords, 0)
+		player:sendTextMessage(MESSAGE_LOOK, "You have deactivated spell name instead of words.")
+	end
+	return true
+end
+
+featrue:separator(" ")
+featrue:groupType("normal")
+featrue:register()

markdowns/CHANGELOG.md

@@ -9,13 +9,14 @@
 - New protocol 14.05 assets. ([Tryller](https://github.com/jprzimba))
 - Optimized the `onPlayerSellAllLoot` code to prevent prolonged freezes. ([Tryller](https://github.com/jprzimba))
 - Add new configurable featurees in `config.lua`:  `chainSystemVipOnly`, `fieldOwnershipDuration`, `bedsOnlyPremium`, `loginProtectionPeriod`, `chainSystemModifyMagic`. ([Tryller](https://github.com/jprzimba))
-- Added a new command for players: `!randomoutfit`. ([Tryller](https://github.com/jprzimba))
+- Added a new commands for players: `!randomoutfit`, `!spellwords`. ([Tryller](https://github.com/jprzimba))
 - Moved emote spells to `kv` instead of `storage`. ([Tryller](https://github.com/jprzimba))
 
 ## Added files
 
 - Add all files in data/migrations
 - data/scripts/talkactions/player/randomoutfit.lua
+- data/scripts/talkactions/player/spell_name_instead_words.lua
 - data/scripts/creaturescripts/player/swimming.lua
 - data-global/scripts/creaturescripts/customs/water_houses.lua
 

src/config/config_enums.hpp

@@ -350,4 +350,5 @@ enum ConfigKey_t : uint16_t {
 	FIELD_OWNERSHIP,
 	BEDS_ONLY_PREMIUM,
 	LOGIN_PROTECTION,
+	SPELL_NAME_INSTEAD_WORDS,
 };

src/config/configmanager.cpp

@@ -171,6 +171,7 @@ bool ConfigManager::load() {
 	loadBoolConfig(L, HALF_LOSS_MAGIC, "halfLossMagicLevel", true);
 	loadBoolConfig(L, CHAIN_SYSTEM_VIP_ONLY, "chainSystemVipOnly", false);
 	loadBoolConfig(L, BEDS_ONLY_PREMIUM, "bedsOnlyPremium", true);
+	loadBoolConfig(L, SPELL_NAME_INSTEAD_WORDS, "spellNameInsteadOfWords", false);
 
 	loadFloatConfig(L, BESTIARY_RATE_CHARM_SHOP_PRICE, "bestiaryRateCharmShopPrice", 1.0);
 	loadFloatConfig(L, COMBAT_CHAIN_SKILL_FORMULA_AXE, "combatChainSkillFormulaAxe", 0.9);

src/creatures/combat/spells.cpp

@@ -99,7 +99,12 @@ TalkActionResult_t Spells::playerSaySpell(const std::shared_ptr<Player> &player,
 	}
 
 	if (instantSpell->playerCastInstant(player, param)) {
-		words = instantSpell->getWords();
+		if (!player->checkSpellNameInsteadOfWords()) {
+			words = instantSpell->getWords();
+		}
+		else {
+			words = instantSpell->getName();
+		}
 
 		if (instantSpell->getHasParam() && !param.empty()) {
 			words += " \"" + param + "\"";

src/creatures/players/player.cpp

@@ -5020,6 +5020,24 @@ bool Player::checkEmoteSpells() const {
 	return false;
 }
 
+bool Player::checkSpellNameInsteadOfWords() const {
+	if (!g_configManager().getBoolean(SPELL_NAME_INSTEAD_WORDS)) {
+		return false;
+	}
+
+	auto featureKV = kv()->scoped("features")->get("spellNameInsteadOfWords");
+	if (featureKV.has_value()) {
+		auto value = featureKV->getNumber();
+		if (value == 1) {
+			return true;
+		} else if (value == 0) {
+			return false;
+		}
+	}
+
+	return false;
+}
+
 QuickLootFilter_t Player::getQuickLootFilter() const {
 	return quickLootFilter;
 }

src/creatures/players/player.hpp

@@ -1212,6 +1212,7 @@ class Player final : public Creature, public Cylinder, public Bankable {
 	bool checkAutoLoot(bool isBoss) const;
 	bool checkChainSystem() const;
 	bool checkEmoteSpells() const;
+	bool checkSpellNameInsteadOfWords() const;
 
 	QuickLootFilter_t getQuickLootFilter() const;