mods/ENTITIES/mobs_mc/villager.lua

   1 --MCmobs v0.4
   2 --maikerumine
   3 --made for MC like Survival game
   4 --License for code WTFPL and otherwise stated in readmes
   5
   6 --###################
   7 --################### VILLAGER
   8 --###################
   9 -- Summary: Villagers are complex NPCs, their main feature allows players to trade with them.
  10
  11 -- TODO: Particles
  12 -- TODO: 4s Regeneration I after trade unlock
  13 -- TODO: Breeding
  14 -- TODO: Baby villagers
  15 -- TODO: Spawning in villages
  16 -- TODO: Behaviour:
  17 --     TODO: Walk around village, but do not leave it intentionally
  18 --     TODO: Run into house on rain or danger, open doors
  19 --     TODO: Internal inventory, pick up items, trade with other villagers
  20 --     TODO: Farm stuff
  21
  22 local S = minetest.get_translator("mobs_mc")
  23 local N = function(s) return s end
  24 local F = minetest.formspec_escape
  25
  26 -- playername-indexed table containing the previously used tradenum
  27 local player_tradenum = {}
  28 -- playername-indexed table containing the objectref of trader, if trading formspec is open
  29 local player_trading_with = {}
  30
  31 local DEFAULT_WALK_CHANCE = 33 -- chance to walk in percent, if no player nearby
  32 local PLAYER_SCAN_INTERVAL = 5 -- every X seconds, villager looks for players nearby
  33 local PLAYER_SCAN_RADIUS = 4 -- scan radius for looking for nearby players
  34
  35 --[=======[ TRADING ]=======]
  36
  37 -- LIST OF VILLAGER PROFESSIONS AND TRADES
  38
  39 -- TECHNICAL RESTRICTIONS (FIXME):
  40 -- * You can't use a clock as requested item
  41 -- * You can't use a compass as requested item if its stack size > 1
  42 -- * You can't use a compass in the second requested slot
  43 -- This is a problem in the mcl_compass and mcl_clock mods,
  44 -- these items should be implemented as single items, then everything
  45 -- will be much easier.
  46
  47 local COMPASS = "mcl_compass:compass"
  48 if minetest.registered_aliases[COMPASS] then
  49         COMPASS = minetest.registered_aliases[COMPASS]
  50 end
  51
  52 local E1 = { "mcl_core:emerald", 1, 1 } -- one emerald
  53
  54 -- Special trades for v6 only
  55 -- NOTE: These symbols MUST only be added at the end of a tier
  56 local TRADE_V6_RED_SANDSTONE, TRADE_V6_DARK_OAK_SAPLING, TRADE_V6_ACACIA_SAPLING, TRADE_V6_BIRCH_SAPLING
  57 if minetest.get_mapgen_setting("mg_name") == "v6" then
  58         TRADE_V6_RED_SANDSTONE = { E1, { "mcl_core:redsandstone", 12, 16 } }
  59         TRADE_V6_DARK_OAK_SAPLING = { { "mcl_core:emerald", 6, 9 }, { "mcl_core:darksapling", 1, 1 } }
  60         TRADE_V6_ACACIA_SAPLING = { { "mcl_core:emerald", 14, 17 }, { "mcl_core:acaciasapling", 1, 1 } }
  61         TRADE_V6_BIRCH_SAPLING = { { "mcl_core:emerald", 8, 11 }, { "mcl_core:birchsapling", 1, 1 } }
  62 end
  63
  64 local professions = {
  65         farmer = {
  66                 name = N("Farmer"),
  67                 texture = "mobs_mc_villager_farmer.png",
  68                 trades = {
  69                         {
  70                         { { "mcl_farming:wheat_item", 18, 22, }, E1 },
  71                         { { "mcl_farming:potato_item", 15, 19, }, E1 },
  72                         { { "mcl_farming:carrot_item", 15, 19, }, E1 },
  73                         { E1, { "mcl_farming:bread", 2, 4 } },
  74                         },
  75
  76                         {
  77                         { { "mcl_farming:pumpkin_face", 8, 13 }, E1 },
  78                         { E1, { "mcl_farming:pumpkin_pie", 2, 3} },
  79                         },
  80
  81                         {
  82                         { { "mcl_farming:melon", 7, 12 }, E1 },
  83                         { E1, { "mcl_core:apple", 5, 7 }, },
  84                         },
  85
  86                         {
  87                         { E1, { "mcl_farming:cookie", 6, 10 } },
  88                         { E1, { "mcl_cake:cake", 1, 1 } },
  89                         TRADE_V6_BIRCH_SAPLING,
  90                         TRADE_V6_DARK_OAK_SAPLING,
  91                         TRADE_V6_ACACIA_SAPLING,
  92                         },
  93                 }
  94         },
  95         fisherman = {
  96                 name = N("Fisherman"),
  97                 texture = "mobs_mc_villager_farmer.png",
  98                 trades = {
  99                         {
 100                         { { "mcl_fishing:fish_raw", 6, 6, "mcl_core:emerald", 1, 1 }, { "mcl_fishing:fish_cooked", 6, 6 } },
 101                         { { "mcl_mobitems:string", 15, 20 }, E1 },
 102                         -- TODO: replace with enchanted fishing rod
 103                         { { "mcl_core:emerald", 3, 11 }, { "mcl_fishing:fishing_rod", 1, 1} },
 104                         },
 105                 },
 106         },
 107         fletcher = {
 108                 name = N("Fletcher"),
 109                 texture = "mobs_mc_villager_farmer.png",
 110                 trades = {
 111                         {
 112                         { { "mcl_mobitems:string", 15, 20 }, E1 },
 113                         { E1, { "mcl_bows:arrow", 8, 12 } },
 114                         },
 115
 116                         {
 117                         { { "mcl_core:gravel", 10, 10, "mcl_core:emerald", 1, 1 }, { "mcl_core:flint", 6, 10 } },
 118                         { { "mcl_core:emerald", 2, 3 }, { "mcl_bows:bow", 1, 1 } },
 119                         },
 120                 }
 121         },
 122         shepherd ={
 123                 name = N("Shepherd"),
 124                 texture = "mobs_mc_villager_farmer.png",
 125                 trades = {
 126                         {
 127                         { { "mcl_wool:white", 16, 22 }, E1 },
 128                         { { "mcl_core:emerald", 3, 4 }, { "mcl_tools:shears", 1, 1 } },
 129                         },
 130
 131                         {
 132                         { { "mcl_core:emerald", 1, 2 }, { "mcl_wool:white", 1, 1 } },
 133                         { { "mcl_core:emerald", 1, 2 }, { "mcl_wool:grey", 1, 1 } },
 134                         { { "mcl_core:emerald", 1, 2 }, { "mcl_wool:silver", 1, 1 } },
 135                         { { "mcl_core:emerald", 1, 2 }, { "mcl_wool:black", 1, 1 } },
 136                         { { "mcl_core:emerald", 1, 2 }, { "mcl_wool:yellow", 1, 1 } },
 137                         { { "mcl_core:emerald", 1, 2 }, { "mcl_wool:orange", 1, 1 } },
 138                         { { "mcl_core:emerald", 1, 2 }, { "mcl_wool:red", 1, 1 } },
 139                         { { "mcl_core:emerald", 1, 2 }, { "mcl_wool:magenta", 1, 1 } },
 140                         { { "mcl_core:emerald", 1, 2 }, { "mcl_wool:purple", 1, 1 } },
 141                         { { "mcl_core:emerald", 1, 2 }, { "mcl_wool:blue", 1, 1 } },
 142                         { { "mcl_core:emerald", 1, 2 }, { "mcl_wool:cyan", 1, 1 } },
 143                         { { "mcl_core:emerald", 1, 2 }, { "mcl_wool:lime", 1, 1 } },
 144                         { { "mcl_core:emerald", 1, 2 }, { "mcl_wool:green", 1, 1 } },
 145                         { { "mcl_core:emerald", 1, 2 }, { "mcl_wool:pink", 1, 1 } },
 146                         { { "mcl_core:emerald", 1, 2 }, { "mcl_wool:light_blue", 1, 1 } },
 147                         { { "mcl_core:emerald", 1, 2 }, { "mcl_wool:brown", 1, 1 } },
 148                         },
 149                 },
 150         },
 151         librarian = {
 152                 name = N("Librarian"),
 153                 texture = "mobs_mc_villager_librarian.png",
 154                 trades = {
 155                         {
 156                         { { "mcl_core:paper", 24, 36 }, E1 },
 157                         -- TODO: enchanted book
 158                         { { "mcl_books:book", 8, 10 }, E1 },
 159                         { { "mcl_core:emerald", 10, 12 }, { "mcl_compass:compass", 1 ,1 }},
 160                         { { "mcl_core:emerald", 3, 4 }, { "mcl_books:bookshelf", 1 ,1 }},
 161                         },
 162
 163                         {
 164                         { { "mcl_books:written_book", 2, 2 }, E1 },
 165                         { { "mcl_core:emerald", 10, 12 }, { "mcl_clock:clock", 1, 1 } },
 166                         { E1, { "mcl_core:glass", 3, 5 } },
 167                         },
 168
 169                         {
 170                         { E1, { "mcl_core:glass", 3, 5 } },
 171                         },
 172
 173                         -- TODO: 2 enchanted book tiers
 174
 175                         {
 176                         { { "mcl_core:emerald", 20, 22 }, { "mcl_mobs:nametag", 1, 1 } },
 177                         }
 178                 },
 179         },
 180         cartographer = {
 181                 name = N("Cartographer"),
 182                 texture = "mobs_mc_villager_librarian.png",
 183                 trades = {
 184                         {
 185                         { { "mcl_core:paper", 24, 36 }, E1 },
 186                         },
 187
 188                         {
 189                         -- subject to special checks
 190                         { { "mcl_compass:compass", 1, 1 }, E1 },
 191                         },
 192
 193                         {
 194                         -- TODO: replace with empty map
 195                         { { "mcl_core:emerald", 7, 11}, { "mcl_maps:filled_map", 1, 1 } },
 196                         },
 197
 198                         -- TODO: special maps
 199                 },
 200         },
 201         armorer = {
 202                 name = N("Armorer"),
 203                 texture = "mobs_mc_villager_smith.png",
 204                 trades = {
 205                         {
 206                         { { "mcl_core:coal_lump", 16, 24 }, E1 },
 207                         { { "mcl_core:emerald", 4, 6 }, { "mcl_armor:helmet_iron", 1, 1 } },
 208                         },
 209
 210                         {
 211                         { { "mcl_core:iron_ingot", 7, 9 }, E1 },
 212                         { { "mcl_core:emerald", 10, 14 }, { "mcl_armor:chestplate_iron", 1, 1 } },
 213                         },
 214
 215                         {
 216                         { { "mcl_core:diamond", 3, 4 }, E1 },
 217                         -- TODO: enchant
 218                         { { "mcl_core:emerald", 16, 19 }, { "mcl_armor:chestplate_diamond", 1, 1 } },
 219                         },
 220
 221                         {
 222                         { { "mcl_core:emerald", 5, 7 }, { "mcl_armor:boots_chain", 1, 1 } },
 223                         { { "mcl_core:emerald", 9, 11 }, { "mcl_armor:leggings_chain", 1, 1 } },
 224                         { { "mcl_core:emerald", 5, 7 }, { "mcl_armor:helmet_chain", 1, 1 } },
 225                         { { "mcl_core:emerald", 11, 15 }, { "mcl_armor:chestplate_chain", 1, 1 } },
 226                         },
 227                 },
 228         },
 229         leatherworker = {
 230                 name = N("Leatherworker"),
 231                 texture = "mobs_mc_villager_butcher.png",
 232                 trades = {
 233                         {
 234                         { { "mcl_mobitems:leather", 9, 12 }, E1 },
 235                         { { "mcl_core:emerald", 2, 4 }, { "mcl_armor:leggings_leather", 2, 4 } },
 236                         },
 237
 238                         {
 239                         -- TODO: enchant
 240                         { { "mcl_core:emerald", 7, 12 }, { "mcl_armor:chestplate_leather", 1, 1 } },
 241                         },
 242
 243                         {
 244                         { { "mcl_core:emerald", 8, 10 }, { "mcl_mobitems:saddle", 1, 1 } },
 245                         },
 246                 },
 247         },
 248         butcher = {
 249                 name = N("Butcher"),
 250                 texture = "mobs_mc_villager_butcher.png",
 251                 trades = {
 252                         {
 253                         { { "mcl_mobitems:beef", 14, 18 }, E1 },
 254                         { { "mcl_mobitems:chicken", 14, 18 }, E1 },
 255                         },
 256
 257                         {
 258                         { { "mcl_core:coal_lump", 16, 24 }, E1 },
 259                         { E1, { "mcl_mobitems:cooked_beef", 5, 7 } },
 260                         { E1, { "mcl_mobitems:cooked_chicken", 6, 8 } },
 261                         },
 262                 },
 263         },
 264         weapon_smith = {
 265                 name = N("Weapon Smith"),
 266                 texture = "mobs_mc_villager_smith.png",
 267                 trades = {
 268                         {
 269                         { { "mcl_core:coal_lump", 16, 24 }, E1 },
 270                         { { "mcl_core:emerald", 6, 8 }, { "mcl_tools:axe_iron", 1, 1 } },
 271                         },
 272
 273                         {
 274                         { { "mcl_core:iron_ingot", 7, 9 }, E1 },
 275                         -- TODO: enchant
 276                         { { "mcl_core:emerald", 9, 10 }, { "mcl_tools:sword_iron", 1, 1 } },
 277                         },
 278
 279                         {
 280                         { { "mcl_core:diamond", 3, 4 }, E1 },
 281                         -- TODO: enchant
 282                         { { "mcl_core:emerald", 12, 15 }, { "mcl_tools:sword_diamond", 1, 1 } },
 283                         -- TODO: enchant
 284                         { { "mcl_core:emerald", 9, 12 }, { "mcl_tools:axe_diamond", 1, 1 } },
 285                         },
 286                 },
 287         },
 288         tool_smith = {
 289                 name = N("Tool Smith"),
 290                 texture = "mobs_mc_villager_smith.png",
 291                 trades = {
 292                         {
 293                         { { "mcl_core:coal_lump", 16, 24 }, E1 },
 294                         -- TODO: enchant
 295                         { { "mcl_core:emerald", 5, 7 }, { "mcl_tools:shovel_iron", 1, 1 } },
 296                         },
 297
 298                         {
 299                         { { "mcl_core:iron_ingot", 7, 9 }, E1 },
 300                         -- TODO: enchant
 301                         { { "mcl_core:emerald", 9, 11 }, { "mcl_tools:pick_iron", 1, 1 } },
 302                         },
 303
 304                         {
 305                         { { "mcl_core:diamond", 3, 4 }, E1 },
 306                         -- TODO: enchant
 307                         { { "mcl_core:emerald", 12, 15 }, { "mcl_tools:pick_diamond", 1, 1 } },
 308                         },
 309                 },
 310         },
 311         cleric = {
 312                 name = N("Cleric"),
 313                 texture = "mobs_mc_villager_priest.png",
 314                 trades = {
 315                         {
 316                         { { "mcl_mobitems:rotten_flesh", 36, 40 }, E1 },
 317                         { { "mcl_core:gold_ingot", 8, 10 }, E1 },
 318                         },
 319
 320                         {
 321                         { E1, { "mesecons:redstone", 1, 4  } },
 322                         { E1, { "mcl_dye:blue", 1, 2 } },
 323                         },
 324
 325                         {
 326                         { E1, { "mcl_nether:glowstone", 1, 3 } },
 327                         { { "mcl_core:emerald", 4, 7 }, { "mcl_throwing:ender_pearl", 1, 1 } },
 328                         TRADE_V6_RED_SANDSTONE,
 329                         },
 330
 331                         -- TODO: Bottle 'o enchanting
 332                 },
 333         },
 334         nitwit = {
 335                 name = N("Nitwit"),
 336                 texture = "mobs_mc_villager.png",
 337                 -- No trades for nitwit
 338                 trades = nil,
 339         }
 340 }
 341
 342 local profession_names = {}
 343 for id, _ in pairs(professions) do
 344         table.insert(profession_names, id)
 345 end
 346
 347 local stand_still = function(self)
 348         self.walk_chance = 0
 349         self.jump = false
 350 end
 351
 352 local update_max_tradenum = function(self)
 353         if not self._trades then
 354                 return
 355         end
 356         local trades = minetest.deserialize(self._trades)
 357         for t=1, #trades do
 358                 local trade = trades[t]
 359                 if trade.tier > self._max_trade_tier then
 360                         self._max_tradenum = t - 1
 361                         return
 362                 end
 363         end
 364         self._max_tradenum = #trades
 365 end
 366
 367 local init_trader_vars = function(self)
 368         if not self._profession then
 369                 -- Select random profession from all professions with matching clothing
 370                 local texture = self.base_texture[1]
 371                 local matches = {}
 372                 for prof_id, prof in pairs(professions) do
 373                         if texture == prof.texture then
 374                                 table.insert(matches, prof_id)
 375                         end
 376                 end
 377                 local p = math.random(1, #matches)
 378                 self._profession = matches[p]
 379         end
 380         if not self._max_trade_tier then
 381                 self._max_trade_tier = 1
 382         end
 383         if not self._locked_trades then
 384                 self._locked_trades = 0
 385         end
 386         if not self._trading_players then
 387                 self._trading_players = {}
 388         end
 389 end
 390
 391 local init_trades = function(self, inv)
 392         local profession = professions[self._profession]
 393         local trade_tiers = profession.trades
 394         if trade_tiers == nil then
 395                 -- Empty trades
 396                 self._trades = false
 397                 return
 398         end
 399
 400         local max_tier = #trade_tiers
 401         local trades = {}
 402         for tiernum=1, max_tier do
 403                 local tier = trade_tiers[tiernum]
 404                 for tradenum=1, #tier do
 405                         local trade = tier[tradenum]
 406                         local wanted1_item = trade[1][1]
 407                         local wanted1_count = math.random(trade[1][2], trade[1][3])
 408                         local offered_item = trade[2][1]
 409                         local offered_count = math.random(trade[2][2], trade[2][3])
 410
 411                         local wanted = { wanted1_item .. " " ..wanted1_count }
 412                         if trade[1][4] then
 413                                 local wanted2_item = trade[1][4]
 414                                 local wanted2_count = math.random(trade[1][5], trade[1][6])
 415                                 table.insert(wanted, wanted2_item .. " " ..wanted2_count)
 416                         end
 417
 418                         table.insert(trades, {
 419                                 wanted = wanted,
 420                                 offered = offered_item .. " " .. offered_count,
 421                                 tier = tiernum, -- tier of this trade
 422                                 traded_once = false, -- true if trade was traded at least once
 423                                 trade_counter = 0, -- how often the this trade was mate after the last time it got unlocked
 424                                 locked = false, -- if this trade is locked. Locked trades can't be used
 425                         })
 426                 end
 427         end
 428         self._trades = minetest.serialize(trades)
 429 end
 430
 431 local set_trade = function(trader, player, inv, concrete_tradenum)
 432         local trades = minetest.deserialize(trader._trades)
 433         if not trades then
 434                 init_trades(trader)
 435                 trades = minetest.deserialize(trader._trades)
 436                 if not trades then
 437                         minetest.log("error", "[mobs_mc] Failed to select villager trade!")
 438                         return
 439                 end
 440         end
 441         local name = player:get_player_name()
 442
 443         -- Stop tradenum from advancing into locked tiers or out-of-range areas
 444         if concrete_tradenum > trader._max_tradenum then
 445                 concrete_tradenum = trader._max_tradenum
 446         elseif concrete_tradenum < 1 then
 447                 concrete_tradenum = 1
 448         end
 449         player_tradenum[name] = concrete_tradenum
 450         local trade = trades[concrete_tradenum]
 451         inv:set_stack("wanted", 1, ItemStack(trade.wanted[1]))
 452         inv:set_stack("offered", 1, ItemStack(trade.offered))
 453         if trade.wanted[2] then
 454                 local wanted2 = ItemStack(trade.wanted[2])
 455                 inv:set_stack("wanted", 2, wanted2)
 456         else
 457                 inv:set_stack("wanted", 2, "")
 458         end
 459
 460 end
 461
 462 local function show_trade_formspec(playername, trader, tradenum)
 463         if not trader._trades then
 464                 return
 465         end
 466         if not tradenum then
 467                 tradenum = 1
 468         end
 469         local trades = minetest.deserialize(trader._trades)
 470         local trade = trades[tradenum]
 471         local profession = professions[trader._profession].name
 472         local disabled_img = ""
 473         if trade.locked then
 474                 disabled_img = "image[4.3,2.52;1,1;mobs_mc_trading_formspec_disabled.png]"..
 475                         "image[4.3,1.1;1,1;mobs_mc_trading_formspec_disabled.png]"
 476         end
 477         local tradeinv_name = "mobs_mc:trade_"..playername
 478         local tradeinv = F("detached:"..tradeinv_name)
 479
 480         local b_prev, b_next = "", ""
 481         if #trades > 1 then
 482                 if tradenum > 1 then
 483                         b_prev = "button[1,1;0.5,1;prev_trade;<]"
 484                 end
 485                 if tradenum < trader._max_tradenum then
 486                         b_next = "button[7.26,1;0.5,1;next_trade;>]"
 487                 end
 488         end
 489
 490         local inv = minetest.get_inventory({type="detached", name="mobs_mc:trade_"..playername})
 491         local wanted1 = inv:get_stack("wanted", 1)
 492         local wanted2 = inv:get_stack("wanted", 2)
 493         local offered = inv:get_stack("offered", 1)
 494
 495         local w2_formspec = ""
 496         if not wanted2:is_empty() then
 497                 w2_formspec = "item_image[3,1;1,1;"..wanted2:to_string().."]"
 498                 .."tooltip[3,1;0.8,0.8;"..F(wanted2:get_description()).."]"
 499         end
 500
 501         local formspec =
 502         "size[9,8.75]"
 503         .."background[-0.19,-0.25;9.41,9.49;mobs_mc_trading_formspec_bg.png]"
 504         ..disabled_img
 505         .."label[4,0;"..F(minetest.colorize("#313131", S(profession))).."]"
 506         .."list[current_player;main;0,4.5;9,3;9]"
 507         .."list[current_player;main;0,7.74;9,1;]"
 508         ..b_prev..b_next
 509         .."["..tradeinv..";wanted;2,1;2,1;]"
 510         .."item_image[2,1;1,1;"..wanted1:to_string().."]"
 511         .."tooltip[2,1;0.8,0.8;"..F(wanted1:get_description()).."]"
 512         ..w2_formspec
 513         .."item_image[5.76,1;1,1;"..offered:to_string().."]"
 514         .."tooltip[5.76,1;0.8,0.8;"..F(offered:get_description()).."]"
 515         .."list["..tradeinv..";input;2,2.5;2,1;]"
 516         .."list["..tradeinv..";output;5.76,2.55;1,1;]"
 517         .."listring["..tradeinv..";output]"
 518         .."listring[current_player;main]"
 519         .."listring["..tradeinv..";input]"
 520         .."listring[current_player;main]"
 521         minetest.sound_play("mobs_mc_villager_trade", {to_player = playername})
 522         minetest.show_formspec(playername, tradeinv_name, formspec)
 523 end
 524
 525 local update_offer = function(inv, player, sound)
 526         local name = player:get_player_name()
 527         local trader = player_trading_with[name]
 528         local tradenum = player_tradenum[name]
 529         if not trader or not tradenum then
 530                 return false
 531         end
 532         local trades = minetest.deserialize(trader._trades)
 533         if not trades then
 534                 return false
 535         end
 536         local trade = trades[tradenum]
 537         if not trade then
 538                 return false
 539         end
 540         local wanted1, wanted2 = inv:get_stack("wanted", 1), inv:get_stack("wanted", 2)
 541         local input1, input2 = inv:get_stack("input", 1), inv:get_stack("input", 2)
 542
 543         -- BEGIN OF SPECIAL HANDLING OF COMPASS
 544         -- These 2 functions are a complicated check to check if the input contains a
 545         -- special item which we cannot check directly against their name, like
 546         -- compass.
 547         -- TODO: Remove these check functions when compass and clock are implemented
 548         -- as single items.
 549         local check_special = function(special_item, group, wanted1, wanted2, input1, input2)
 550                 if minetest.registered_aliases[special_item] then
 551                         special_item = minetest.registered_aliases[special_item]
 552                 end
 553                 if wanted1:get_name() == special_item then
 554                         local check_input = function(input, wanted, group)
 555                                 return minetest.get_item_group(input:get_name(), group) ~= 0 and input:get_count() >= wanted:get_count()
 556                         end
 557                         if check_input(input1, wanted1, group) then
 558                                 return true
 559                         elseif check_input(input2, wanted1, group) then
 560                                 return true
 561                         else
 562                                 return false
 563                         end
 564                 end
 565                 return false
 566         end
 567         -- Apply above function to all items which we consider special.
 568         -- This function succeeds if ANY item check succeeds.
 569         local check_specials = function(wanted1, wanted2, input1, input2)
 570                 return check_special(COMPASS, "compass", wanted1, wanted2, input1, input2)
 571         end
 572         -- END OF SPECIAL HANDLING OF COMPASS
 573
 574         if (
 575                         ((inv:contains_item("input", wanted1) and
 576                         (wanted2:is_empty() or inv:contains_item("input", wanted2))) or
 577                         -- BEGIN OF SPECIAL HANDLING OF COMPASS
 578                         check_specials(wanted1, wanted2, input1, input2)) and
 579                         -- END OF SPECIAL HANDLING OF COMPASS
 580                         (trade.locked == false)) then
 581                 inv:set_stack("output", 1, inv:get_stack("offered", 1))
 582                 if sound then
 583                         minetest.sound_play("mobs_mc_villager_accept", {to_player = name})
 584                 end
 585                 return true
 586         else
 587                 inv:set_stack("output", 1, ItemStack(""))
 588                 if sound then
 589                         minetest.sound_play("mobs_mc_villager_deny", {to_player = name})
 590                 end
 591                 return false
 592         end
 593 end
 594
 595 -- Returns a single itemstack in the given inventory to the player's main inventory, or drop it when there's no space left
 596 local function return_item(itemstack, dropper, pos, inv_p)
 597         if dropper:is_player() then
 598                 -- Return to main inventory
 599                 if inv_p:room_for_item("main", itemstack) then
 600                         inv_p:add_item("main", itemstack)
 601                 else
 602                         -- Drop item on the ground
 603                         local v = dropper:get_look_dir()
 604                         local p = {x=pos.x, y=pos.y+1.2, z=pos.z}
 605                         p.x = p.x+(math.random(1,3)*0.2)
 606                         p.z = p.z+(math.random(1,3)*0.2)
 607                         local obj = minetest.add_item(p, itemstack)
 608                         if obj then
 609                                 v.x = v.x*4
 610                                 v.y = v.y*4 + 2
 611                                 v.z = v.z*4
 612                                 obj:set_velocity(v)
 613                                 obj:get_luaentity()._insta_collect = false
 614                         end
 615                 end
 616         else
 617                 -- Fallback for unexpected cases
 618                 minetest.add_item(pos, itemstack)
 619         end
 620         return itemstack
 621 end
 622
 623 local return_fields = function(player)
 624         local name = player:get_player_name()
 625         local inv_t = minetest.get_inventory({type="detached", name = "mobs_mc:trade_"..name})
 626         local inv_p = player:get_inventory()
 627         for i=1, inv_t:get_size("input") do
 628                 local stack = inv_t:get_stack("input", i)
 629                 return_item(stack, player, player:get_pos(), inv_p)
 630                 stack:clear()
 631                 inv_t:set_stack("input", i, stack)
 632         end
 633         inv_t:set_stack("output", 1, "")
 634 end
 635
 636 minetest.register_on_player_receive_fields(function(player, formname, fields)
 637         if string.sub(formname, 1, 14) == "mobs_mc:trade_" then
 638                 local name = player:get_player_name()
 639                 if fields.quit then
 640                         -- Get input items back
 641                         return_fields(player)
 642                         -- Reset internal "trading with" state
 643                         local trader = player_trading_with[name]
 644                         if trader then
 645                                 trader._trading_players[name] = nil
 646                         end
 647                         player_trading_with[name] = nil
 648                 elseif fields.next_trade or fields.prev_trade then
 649                         local trader = player_trading_with[name]
 650                         if not trader or not trader.object:get_luaentity() then
 651                                 return
 652                         end
 653                         local trades = trader._trades
 654                         if not trades then
 655                                 return
 656                         end
 657                         local dir = 1
 658                         if fields.prev_trade then
 659                                 dir = -1
 660                         end
 661                         local tradenum = player_tradenum[name] + dir
 662                         local inv = minetest.get_inventory({type="detached", name="mobs_mc:trade_"..name})
 663                         set_trade(trader, player, inv, tradenum)
 664                         update_offer(inv, player, false)
 665                         show_trade_formspec(name, trader, player_tradenum[name])
 666                 end
 667         end
 668 end)
 669
 670 minetest.register_on_leaveplayer(function(player)
 671         local name = player:get_player_name()
 672         return_fields(player)
 673         player_tradenum[name] = nil
 674         local trader = player_trading_with[name]
 675         if trader then
 676                 trader._trading_players[name] = nil
 677         end
 678         player_trading_with[name] = nil
 679
 680 end)
 681
 682 -- Return true if player is trading with villager, and the villager entity exists
 683 local trader_exists = function(playername)
 684         local trader = player_trading_with[playername]
 685         return trader ~= nil and trader.object:get_luaentity() ~= nil
 686 end
 687
 688 local trade_inventory = {
 689         allow_take = function(inv, listname, index, stack, player)
 690                 if listname == "input" then
 691                         return stack:get_count()
 692                 elseif listname == "output" then
 693                         if not trader_exists(player:get_player_name()) then
 694                                 return 0
 695                         end
 696                         -- Only allow taking full stack
 697                         local count = stack:get_count()
 698                         if count == inv:get_stack(listname, index):get_count() then
 699                                 -- Also update output stack again.
 700                                 -- If input has double the wanted items, the
 701                                 -- output will stay because there will be still
 702                                 -- enough items in input after the trade
 703                                 local wanted1 = inv:get_stack("wanted", 1)
 704                                 local wanted2 = inv:get_stack("wanted", 2)
 705                                 local input1 = inv:get_stack("input", 1)
 706                                 local input2 = inv:get_stack("input", 2)
 707                                 wanted1:set_count(wanted1:get_count()*2)
 708                                 wanted2:set_count(wanted2:get_count()*2)
 709                                 -- BEGIN OF SPECIAL HANDLING FOR COMPASS
 710                                 local special_checks = function(wanted1, input1, input2)
 711                                         if wanted1:get_name() == COMPASS then
 712                                                 local compasses = 0
 713                                                 if (minetest.get_item_group(input1:get_name(), "compass") ~= 0) then
 714                                                         compasses = compasses + input1:get_count()
 715                                                 end
 716                                                 if (minetest.get_item_group(input2:get_name(), "compass") ~= 0) then
 717                                                         compasses = compasses + input2:get_count()
 718                                                 end
 719                                                 return compasses >= wanted1:get_count()
 720                                         end
 721                                         return false
 722                                 end
 723                                 -- END OF SPECIAL HANDLING FOR COMPASS
 724                                 if (inv:contains_item("input", wanted1) and
 725                                         (wanted2:is_empty() or inv:contains_item("input", wanted2)))
 726                                         -- BEGIN OF SPECIAL HANDLING FOR COMPASS
 727                                         or special_checks(wanted1, input1, input2) then
 728                                         -- END OF SPECIAL HANDLING FOR COMPASS
 729                                         return -1
 730                                 else
 731                                         -- If less than double the wanted items,
 732                                         -- remove items from output (final trade,
 733                                         -- input runs empty)
 734                                         return count
 735                                 end
 736                         else
 737                                 return 0
 738                         end
 739                 else
 740                         return 0
 741                 end
 742         end,
 743         allow_move = function(inv, from_list, from_index, to_list, to_index, count, player)
 744                 if from_list == "input" and to_list == "input" then
 745                         return count
 746                 elseif from_list == "output" and to_list == "input" then
 747                         if not trader_exists(player:get_player_name()) then
 748                                 return 0
 749                         end
 750                         local move_stack = inv:get_stack(from_list, from_index)
 751                         if inv:get_stack(to_list, to_index):item_fits(move_stack) then
 752                                 return count
 753                         end
 754                 end
 755                 return 0
 756         end,
 757         allow_put = function(inv, listname, index, stack, player)
 758                 if listname == "input" then
 759                         if not trader_exists(player:get_player_name()) then
 760                                 return 0
 761                         else
 762                                 return stack:get_count()
 763                         end
 764                 else
 765                         return 0
 766                 end
 767         end,
 768         on_put = function(inv, listname, index, stack, player)
 769                 update_offer(inv, player, true)
 770         end,
 771         on_move = function(inv, from_list, from_index, to_list, to_index, count, player)
 772                 if from_list == "output" and to_list == "input" then
 773                         inv:remove_item("input", inv:get_stack("wanted", 1))
 774                         local wanted2 = inv:get_stack("wanted", 2)
 775                         if not wanted2:is_empty() then
 776                                 inv:remove_item("input", inv:get_stack("wanted", 2))
 777                         end
 778                         minetest.sound_play("mobs_mc_villager_accept", {to_player = player:get_player_name()})
 779                 end
 780                 update_offer(inv, player, true)
 781         end,
 782         on_take = function(inv, listname, index, stack, player)
 783                 local accept
 784                 local name = player:get_player_name()
 785                 if listname == "output" then
 786                         local wanted1 = inv:get_stack("wanted", 1)
 787                         inv:remove_item("input", wanted1)
 788                         local wanted2 = inv:get_stack("wanted", 2)
 789                         if not wanted2:is_empty() then
 790                                 inv:remove_item("input", inv:get_stack("wanted", 2))
 791                         end
 792                         -- BEGIN OF SPECIAL HANDLING FOR COMPASS
 793                         if wanted1:get_name() == COMPASS then
 794                                 for n=1, 2 do
 795                                         local input = inv:get_stack("input", n)
 796                                         if minetest.get_item_group(input:get_name(), "compass") ~= 0 then
 797                                                 input:set_count(input:get_count() - wanted1:get_count())
 798                                                 inv:set_stack("input", n, input)
 799                                                 break
 800                                         end
 801                                 end
 802                         end
 803                         -- END OF SPECIAL HANDLING FOR COMPASS
 804                         local trader = player_trading_with[name]
 805                         local tradenum = player_tradenum[name]
 806                         local trades
 807                         if trader and trader._trades then
 808                                 trades = minetest.deserialize(trader._trades)
 809                         end
 810                         if trades then
 811                                 local trade = trades[tradenum]
 812                                 local unlock_stuff = false
 813                                 if not trade.traded_once then
 814                                         -- Unlock all the things if something was traded
 815                                         -- for the first time ever
 816                                         unlock_stuff = true
 817                                         trade.traded_once = true
 818                                 elseif trade.trade_counter == 0 and math.random(1,5) == 1 then
 819                                         -- Otherwise, 20% chance to unlock if used freshly reset trade
 820                                         unlock_stuff = true
 821                                 end
 822                                 local update_formspec = false
 823                                 if unlock_stuff then
 824                                         -- First-time trade unlock all trades and unlock next trade tier
 825                                         if trade.tier + 1 > trader._max_trade_tier then
 826                                                 trader._max_trade_tier = trader._max_trade_tier + 1
 827                                                 update_max_tradenum(trader)
 828                                                 update_formspec = true
 829                                         end
 830                                         for t=1, #trades do
 831                                                 trades[t].locked = false
 832                                                 trades[t].trade_counter = 0
 833                                         end
 834                                         trader._locked_trades = 0
 835                                         -- Also heal trader for unlocking stuff
 836                                         -- TODO: Replace by Regeneration I
 837                                         trader.health = math.min(trader.hp_max, trader.health + 4)
 838                                 end
 839                                 trade.trade_counter = trade.trade_counter + 1
 840                                 -- Semi-randomly lock trade for repeated trade (not if there's only 1 trade)
 841                                 if trader._max_tradenum > 1 then
 842                                         if trade.trade_counter >= 12 then
 843                                                 trade.locked = true
 844                                         elseif trade.trade_counter >= 2 then
 845                                                 local r = math.random(1, math.random(4, 10))
 846                                                 if r == 1 then
 847                                                         trade.locked = true
 848                                                 end
 849                                         end
 850                                 end
 851
 852                                 if trade.locked then
 853                                         inv:set_stack("output", 1, "")
 854                                         update_formspec = true
 855                                         trader._locked_trades = trader._locked_trades + 1
 856                                         -- Check if we managed to lock ALL available trades. Rare but possible.
 857                                         if trader._locked_trades >= trader._max_tradenum then
 858                                                 -- Emergency unlock! Unlock all other trades except the current one
 859                                                 for t=1, #trades do
 860                                                         if t ~= tradenum then
 861                                                                 trades[t].locked = false
 862                                                                 trades[t].trade_counter = 0
 863                                                         end
 864                                                 end
 865                                                 trader._locked_trades = 1
 866                                                 -- Also heal trader for unlocking stuff
 867                                                 -- TODO: Replace by Regeneration I
 868                                                 trader.health = math.min(trader.hp_max, trader.health + 4)
 869                                         end
 870                                 end
 871                                 trader._trades = minetest.serialize(trades)
 872                                 if update_formspec then
 873                                         show_trade_formspec(name, trader, tradenum)
 874                                 end
 875                         else
 876                                 minetest.log("error", "[mobs_mc] Player took item from trader output but player_trading_with or player_tradenum is nil!")
 877                         end
 878
 879                         accept = true
 880                 elseif listname == "input" then
 881                         update_offer(inv, player, false)
 882                 end
 883                 if accept then
 884                         minetest.sound_play("mobs_mc_villager_accept", {to_player = name})
 885                 else
 886                         minetest.sound_play("mobs_mc_villager_deny", {to_player = name})
 887                 end
 888         end,
 889 }
 890
 891 minetest.register_on_joinplayer(function(player)
 892         local name = player:get_player_name()
 893         player_tradenum[name] = 1
 894         player_trading_with[name] = nil
 895
 896         -- Create or get player-specific trading inventory
 897         local inv = minetest.get_inventory({type="detached", name="mobs_mc:trade_"..name})
 898         if not inv then
 899                 inv = minetest.create_detached_inventory("mobs_mc:trade_"..name, trade_inventory, name)
 900         end
 901         inv:set_size("input", 2)
 902         inv:set_size("output", 1)
 903         inv:set_size("wanted", 2)
 904         inv:set_size("offered", 1)
 905 end)
 906
 907 --[=======[ MOB REGISTRATION AND SPAWNING ]=======]
 908
 909 mobs:register_mob("mobs_mc:villager", {
 910         type = "npc",
 911         hp_min = 20,
 912         hp_max = 20,
 913         collisionbox = {-0.3, -0.01, -0.3, 0.3, 1.94, 0.3},
 914         visual = "mesh",
 915         mesh = "mobs_mc_villager.b3d",
 916         textures = {
 917         {
 918                 "mobs_mc_villager.png",
 919                 "mobs_mc_villager.png", --hat
 920         },
 921         {
 922                 "mobs_mc_villager_farmer.png",
 923                 "mobs_mc_villager_farmer.png", --hat
 924         },
 925         {
 926                 "mobs_mc_villager_priest.png",
 927                 "mobs_mc_villager_priest.png", --hat
 928         },
 929         {
 930                 "mobs_mc_villager_librarian.png",
 931                 "mobs_mc_villager_librarian.png", --hat
 932         },
 933         {
 934                 "mobs_mc_villager_butcher.png",
 935                 "mobs_mc_villager_butcher.png", --hat
 936         },
 937         {
 938                 "mobs_mc_villager_smith.png",
 939                 "mobs_mc_villager_smith.png", --hat
 940         },
 941         },
 942         visual_size = {x=3, y=3},
 943         makes_footstep_sound = true,
 944         walk_velocity = 1.2,
 945         run_velocity = 2.4,
 946         drops = {},
 947         -- TODO: sounds
 948         animation = {
 949                 stand_speed = 25,
 950                 stand_start = 40,
 951                 stand_end = 59,
 952                 walk_speed = 25,
 953                 walk_start = 0,
 954                 walk_end = 40,
 955                 run_speed = 25,
 956                 run_start = 0,
 957                 run_end = 40,
 958                 die_speed = 15,
 959                 die_start = 210,
 960                 die_end = 220,
 961                 die_loop = false,
 962         },
 963         view_range = 16,
 964         fear_height = 4,
 965         jump = true,
 966         walk_chance = DEFAULT_WALK_CHANCE,
 967         on_rightclick = function(self, clicker)
 968                 -- Initiate trading
 969                 local name = clicker:get_player_name()
 970                 self._trading_players[name] = true
 971
 972                 init_trader_vars(self)
 973                 if self._trades == nil then
 974                         init_trades(self)
 975                 end
 976                 update_max_tradenum(self)
 977                 if self._trades == false then
 978                         -- Villager has no trades, rightclick is a no-op
 979                         return
 980                 end
 981
 982                 player_trading_with[name] = self
 983
 984                 local inv = minetest.get_inventory({type="detached", name="mobs_mc:trade_"..name})
 985
 986                 set_trade(self, clicker, inv, 1)
 987
 988                 show_trade_formspec(name, self)
 989
 990                 -- Behaviour stuff:
 991                 -- Make villager look at player and stand still
 992                 local selfpos = self.object:get_pos()
 993                 local clickerpos = clicker:get_pos()
 994                 local dir = vector.direction(selfpos, clickerpos)
 995                 self.object:set_yaw(minetest.dir_to_yaw(dir))
 996                 stand_still(self)
 997         end,
 998
 999         _player_scan_timer = 0,
1000         _trading_players = {}, -- list of playernames currently trading with villager (open formspec)
1001         do_custom = function(self, dtime)
1002                 -- Stand still if player is nearby.
1003                 if not self._player_scan_timer then
1004                         self._player_scan_timer = 0
1005                 end
1006                 self._player_scan_timer = self._player_scan_timer + dtime
1007                 -- Check infrequently to keep CPU load low
1008                 if self._player_scan_timer > PLAYER_SCAN_INTERVAL then
1009                         self._player_scan_timer = 0
1010                         local selfpos = self.object:get_pos()
1011                         local objects = minetest.get_objects_inside_radius(selfpos, PLAYER_SCAN_RADIUS)
1012                         local has_player = false
1013                         for o, obj in pairs(objects) do
1014                                 if obj:is_player() then
1015                                         has_player = true
1016                                         break
1017                                 end
1018                         end
1019                         if has_player then
1020                                 minetest.log("verbose", "[mobs_mc] Player near villager found!")
1021                                 stand_still(self)
1022                         else
1023                                 minetest.log("verbose", "[mobs_mc] No player near villager found!")
1024                                 self.walk_chance = DEFAULT_WALK_CHANCE
1025                                 self.jump = true
1026                         end
1027                 end
1028         end,
1029
1030         on_spawn = function(self)
1031                 init_trader_vars(self)
1032         end,
1033         on_die = function(self, pos)
1034                 -- Close open trade formspecs and give input back to players
1035                 local trading_players = self._trading_players
1036                 for name, _ in pairs(trading_players) do
1037                         minetest.close_formspec(name, "mobs_mc:trade_"..name)
1038                         local player = minetest.get_player_by_name(name)
1039                         if player then
1040                                 return_fields(player)
1041                         end
1042                 end
1043         end,
1044 })
1045
1046
1047
1048 mobs:spawn_specific("mobs_mc:villager", mobs_mc.spawn.village, {"air"}, 0, minetest.LIGHT_MAX+1, 30, 8000, 4, mobs_mc.spawn_height.water+1, mobs_mc.spawn_height.overworld_max)
1049
1050 -- spawn eggs
1051 mobs:register_egg("mobs_mc:villager", S("Villager"), "mobs_mc_spawn_icon_villager.png", 0)
1052
1053 if minetest.settings:get_bool("log_mods") then
1054         minetest.log("action", "MC mobs loaded")
1055 end