lua_api.txt 229 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235
  1. Minetest Lua Modding API Reference
  2. ==================================
  3. * More information at <http://www.minetest.net/>
  4. * Developer Wiki: <http://dev.minetest.net/>
  5. Introduction
  6. ------------
  7. Content and functionality can be added to Minetest using Lua scripting
  8. in run-time loaded mods.
  9. A mod is a self-contained bunch of scripts, textures and other related
  10. things, which is loaded by and interfaces with Minetest.
  11. Mods are contained and ran solely on the server side. Definitions and media
  12. files are automatically transferred to the client.
  13. If you see a deficiency in the API, feel free to attempt to add the
  14. functionality in the engine and API, and to document it here.
  15. Programming in Lua
  16. ------------------
  17. If you have any difficulty in understanding this, please read
  18. [Programming in Lua](http://www.lua.org/pil/).
  19. Startup
  20. -------
  21. Mods are loaded during server startup from the mod load paths by running
  22. the `init.lua` scripts in a shared environment.
  23. Paths
  24. -----
  25. * `RUN_IN_PLACE=1` (Windows release, local build)
  26. * `$path_user`:
  27. * Linux: `<build directory>`
  28. * Windows: `<build directory>`
  29. * `$path_share`
  30. * Linux: `<build directory>`
  31. * Windows: `<build directory>`
  32. * `RUN_IN_PLACE=0`: (Linux release)
  33. * `$path_share`
  34. * Linux: `/usr/share/minetest`
  35. * Windows: `<install directory>/minetest-0.4.x`
  36. * `$path_user`:
  37. * Linux: `$HOME/.minetest`
  38. * Windows: `C:/users/<user>/AppData/minetest` (maybe)
  39. Games
  40. -----
  41. Games are looked up from:
  42. * `$path_share/games/gameid/`
  43. * `$path_user/games/gameid/`
  44. where `gameid` is unique to each game.
  45. The game directory contains the file `game.conf`, which contains these fields:
  46. name = <Human-readable full name of the game>
  47. e.g.
  48. name = Minetest
  49. The game directory can contain the file minetest.conf, which will be used
  50. to set default settings when running the particular game.
  51. It can also contain a settingtypes.txt in the same format as the one in builtin.
  52. This settingtypes.txt will be parsed by the menu and the settings will be displayed
  53. in the "Games" category in the settings tab.
  54. ### Menu images
  55. Games can provide custom main menu images. They are put inside a `menu` directory
  56. inside the game directory.
  57. The images are named `$identifier.png`, where `$identifier` is
  58. one of `overlay,background,footer,header`.
  59. If you want to specify multiple images for one identifier, add additional images named
  60. like `$identifier.$n.png`, with an ascending number $n starting with 1, and a random
  61. image will be chosen from the provided ones.
  62. Mod load path
  63. -------------
  64. Generic:
  65. * `$path_share/games/gameid/mods/`
  66. * `$path_share/mods/`
  67. * `$path_user/games/gameid/mods/`
  68. * `$path_user/mods/` (User-installed mods)
  69. * `$worldpath/worldmods/`
  70. In a run-in-place version (e.g. the distributed windows version):
  71. * `minetest-0.4.x/games/gameid/mods/`
  72. * `minetest-0.4.x/mods/` (User-installed mods)
  73. * `minetest-0.4.x/worlds/worldname/worldmods/`
  74. On an installed version on Linux:
  75. * `/usr/share/minetest/games/gameid/mods/`
  76. * `$HOME/.minetest/mods/` (User-installed mods)
  77. * `$HOME/.minetest/worlds/worldname/worldmods`
  78. Mod load path for world-specific games
  79. --------------------------------------
  80. It is possible to include a game in a world; in this case, no mods or
  81. games are loaded or checked from anywhere else.
  82. This is useful for e.g. adventure worlds.
  83. This happens if the following directory exists:
  84. $world/game/
  85. Mods should be then be placed in:
  86. $world/game/mods/
  87. Modpack support
  88. ----------------
  89. Mods can be put in a subdirectory, if the parent directory, which otherwise
  90. should be a mod, contains a file named `modpack.txt`. This file shall be
  91. empty, except for lines starting with `#`, which are comments.
  92. Mod directory structure
  93. ------------------------
  94. mods
  95. |-- modname
  96. | |-- depends.txt
  97. | |-- screenshot.png
  98. | |-- description.txt
  99. | |-- settingtypes.txt
  100. | |-- init.lua
  101. | |-- models
  102. | |-- textures
  103. | | |-- modname_stuff.png
  104. | | `-- modname_something_else.png
  105. | |-- sounds
  106. | |-- media
  107. | |-- locale
  108. | `-- <custom data>
  109. `-- another
  110. ### modname
  111. The location of this directory can be fetched by using
  112. `minetest.get_modpath(modname)`.
  113. ### `depends.txt`
  114. List of mods that have to be loaded before loading this mod.
  115. A single line contains a single modname.
  116. Optional dependencies can be defined by appending a question mark
  117. to a single modname. This means that if the specified mod
  118. is missing, it does not prevent this mod from being loaded.
  119. ### `screenshot.png`
  120. A screenshot shown in the mod manager within the main menu. It should
  121. have an aspect ratio of 3:2 and a minimum size of 300×200 pixels.
  122. ### `description.txt`
  123. A file containing a description to be shown in the Mods tab of the mainmenu.
  124. ### `settingtypes.txt`
  125. A file in the same format as the one in builtin. It will be parsed by the
  126. settings menu and the settings will be displayed in the "Mods" category.
  127. ### `init.lua`
  128. The main Lua script. Running this script should register everything it
  129. wants to register. Subsequent execution depends on minetest calling the
  130. registered callbacks.
  131. `minetest.settings` can be used to read custom or existing settings at load
  132. time, if necessary. (See `Settings`)
  133. ### `models`
  134. Models for entities or meshnodes.
  135. ### `textures`, `sounds`, `media`
  136. Media files (textures, sounds, whatever) that will be transferred to the
  137. client and will be available for use by the mod.
  138. ### `locale`
  139. Translation files for the clients. (See `Translations`)
  140. Naming convention for registered textual names
  141. ----------------------------------------------
  142. Registered names should generally be in this format:
  143. `modname:<whatever>`
  144. `<whatever>` can have these characters:
  145. a-zA-Z0-9_
  146. This is to prevent conflicting names from corrupting maps and is
  147. enforced by the mod loader.
  148. ### Example
  149. In the mod `experimental`, there is the ideal item/node/entity name `tnt`.
  150. So the name should be `experimental:tnt`.
  151. Enforcement can be overridden by prefixing the name with `:`. This can
  152. be used for overriding the registrations of some other mod.
  153. Example: Any mod can redefine `experimental:tnt` by using the name
  154. :experimental:tnt
  155. when registering it.
  156. (also that mod is required to have `experimental` as a dependency)
  157. The `:` prefix can also be used for maintaining backwards compatibility.
  158. Aliases
  159. -------
  160. Aliases can be added by using `minetest.register_alias(name, convert_to)` or
  161. `minetest.register_alias_force(name, convert_to)`.
  162. This converts anything called `name` to `convert_to`.
  163. The only difference between `minetest.register_alias` and
  164. `minetest.register_alias_force` is that if an item called `name` exists,
  165. `minetest.register_alias` will do nothing while
  166. `minetest.register_alias_force` will unregister it.
  167. This can be used for maintaining backwards compatibility.
  168. This can also set quick access names for things, e.g. if
  169. you have an item called `epiclylongmodname:stuff`, you could do
  170. minetest.register_alias("stuff", "epiclylongmodname:stuff")
  171. and be able to use `/giveme stuff`.
  172. Mapgen aliases
  173. --------------
  174. In a game, a certain number of these must be set to tell core mapgens which
  175. of the game's nodes are to be used by the core mapgens. For example:
  176. minetest.register_alias("mapgen_stone", "default:stone")
  177. ### Aliases needed for all mapgens except Mapgen v6
  178. Base terrain:
  179. "mapgen_stone"
  180. "mapgen_water_source"
  181. "mapgen_river_water_source"
  182. Caves:
  183. "mapgen_lava_source"
  184. Dungeons:
  185. Only needed for registered biomes where 'node_stone' is stone:
  186. "mapgen_cobble"
  187. "mapgen_stair_cobble"
  188. "mapgen_mossycobble"
  189. Only needed for registered biomes where 'node_stone' is desert stone:
  190. "mapgen_desert_stone"
  191. "mapgen_stair_desert_stone"
  192. Only needed for registered biomes where 'node_stone' is sandstone:
  193. "mapgen_sandstone"
  194. "mapgen_sandstonebrick"
  195. "mapgen_stair_sandstone_block"
  196. ### Aliases needed for Mapgen v6
  197. Terrain and biomes:
  198. "mapgen_stone"
  199. "mapgen_water_source"
  200. "mapgen_lava_source"
  201. "mapgen_dirt"
  202. "mapgen_dirt_with_grass"
  203. "mapgen_sand"
  204. "mapgen_gravel"
  205. "mapgen_desert_stone"
  206. "mapgen_desert_sand"
  207. "mapgen_dirt_with_snow"
  208. "mapgen_snowblock"
  209. "mapgen_snow"
  210. "mapgen_ice"
  211. Flora:
  212. "mapgen_tree"
  213. "mapgen_leaves"
  214. "mapgen_apple"
  215. "mapgen_jungletree"
  216. "mapgen_jungleleaves"
  217. "mapgen_junglegrass"
  218. "mapgen_pine_tree"
  219. "mapgen_pine_needles"
  220. Dungeons:
  221. "mapgen_cobble"
  222. "mapgen_stair_cobble"
  223. "mapgen_mossycobble"
  224. "mapgen_stair_desert_stone"
  225. Textures
  226. --------
  227. Mods should generally prefix their textures with `modname_`, e.g. given
  228. the mod name `foomod`, a texture could be called:
  229. foomod_foothing.png
  230. Textures are referred to by their complete name, or alternatively by
  231. stripping out the file extension:
  232. * e.g. `foomod_foothing.png`
  233. * e.g. `foomod_foothing`
  234. Texture modifiers
  235. -----------------
  236. There are various texture modifiers that can be used
  237. to generate textures on-the-fly.
  238. ### Texture overlaying
  239. Textures can be overlaid by putting a `^` between them.
  240. Example:
  241. default_dirt.png^default_grass_side.png
  242. `default_grass_side.png` is overlaid over `default_dirt.png`.
  243. The texture with the lower resolution will be automatically upscaled to
  244. the higher resolution texture.
  245. ### Texture grouping
  246. Textures can be grouped together by enclosing them in `(` and `)`.
  247. Example: `cobble.png^(thing1.png^thing2.png)`
  248. A texture for `thing1.png^thing2.png` is created and the resulting
  249. texture is overlaid on top of `cobble.png`.
  250. ### Escaping
  251. Modifiers that accept texture names (e.g. `[combine`) accept escaping to allow
  252. passing complex texture names as arguments. Escaping is done with backslash and
  253. is required for `^` and `:`.
  254. Example: `cobble.png^[lowpart:50:color.png\^[mask\:trans.png`
  255. The lower 50 percent of `color.png^[mask:trans.png` are overlaid
  256. on top of `cobble.png`.
  257. ### Advanced texture modifiers
  258. #### Crack
  259. * `[crack:<n>:<p>`
  260. * `[cracko:<n>:<p>`
  261. * `[crack:<t>:<n>:<p>`
  262. * `[cracko:<t>:<n>:<p>`
  263. Parameters:
  264. * `<t>` = tile count (in each direction)
  265. * `<n>` = animation frame count
  266. * `<p>` = current animation frame
  267. Draw a step of the crack animation on the texture.
  268. `crack` draws it normally, while `cracko` lays it over, keeping transparent pixels intact.
  269. Example:
  270. default_cobble.png^[crack:10:1
  271. #### `[combine:<w>x<h>:<x1>,<y1>=<file1>:<x2>,<y2>=<file2>:...`
  272. * `<w>` = width
  273. * `<h>` = height
  274. * `<x>` = x position
  275. * `<y>` = y position
  276. * `<file>` = texture to combine
  277. Creates a texture of size `<w>` times `<h>` and blits the listed files to their
  278. specified coordinates.
  279. Example:
  280. [combine:16x32:0,0=default_cobble.png:0,16=default_wood.png
  281. #### `[resize:<w>x<h>`
  282. Resizes the texture to the given dimensions.
  283. Example:
  284. default_sandstone.png^[resize:16x16
  285. #### `[opacity:<r>`
  286. Makes the base image transparent according to the given ratio.
  287. `r` must be between 0 and 255.
  288. 0 means totally transparent. 255 means totally opaque.
  289. Example:
  290. default_sandstone.png^[opacity:127
  291. #### `[invert:<mode>`
  292. Inverts the given channels of the base image.
  293. Mode may contain the characters "r", "g", "b", "a".
  294. Only the channels that are mentioned in the mode string will be inverted.
  295. Example:
  296. default_apple.png^[invert:rgb
  297. #### `[brighten`
  298. Brightens the texture.
  299. Example:
  300. tnt_tnt_side.png^[brighten
  301. #### `[noalpha`
  302. Makes the texture completely opaque.
  303. Example:
  304. default_leaves.png^[noalpha
  305. #### `[makealpha:<r>,<g>,<b>`
  306. Convert one color to transparency.
  307. Example:
  308. default_cobble.png^[makealpha:128,128,128
  309. #### `[transform<t>`
  310. * `<t>` = transformation(s) to apply
  311. Rotates and/or flips the image.
  312. `<t>` can be a number (between 0 and 7) or a transform name.
  313. Rotations are counter-clockwise.
  314. 0 I identity
  315. 1 R90 rotate by 90 degrees
  316. 2 R180 rotate by 180 degrees
  317. 3 R270 rotate by 270 degrees
  318. 4 FX flip X
  319. 5 FXR90 flip X then rotate by 90 degrees
  320. 6 FY flip Y
  321. 7 FYR90 flip Y then rotate by 90 degrees
  322. Example:
  323. default_stone.png^[transformFXR90
  324. #### `[inventorycube{<top>{<left>{<right>`
  325. Escaping does not apply here and `^` is replaced by `&` in texture names instead.
  326. Create an inventory cube texture using the side textures.
  327. Example:
  328. [inventorycube{grass.png{dirt.png&grass_side.png{dirt.png&grass_side.png
  329. Creates an inventorycube with `grass.png`, `dirt.png^grass_side.png` and
  330. `dirt.png^grass_side.png` textures
  331. #### `[lowpart:<percent>:<file>`
  332. Blit the lower `<percent>`% part of `<file>` on the texture.
  333. Example:
  334. base.png^[lowpart:25:overlay.png
  335. #### `[verticalframe:<t>:<n>`
  336. * `<t>` = animation frame count
  337. * `<n>` = current animation frame
  338. Crops the texture to a frame of a vertical animation.
  339. Example:
  340. default_torch_animated.png^[verticalframe:16:8
  341. #### `[mask:<file>`
  342. Apply a mask to the base image.
  343. The mask is applied using binary AND.
  344. #### `[sheet:<w>x<h>:<x>,<y>`
  345. Retrieves a tile at position x,y from the base image
  346. which it assumes to be a tilesheet with dimensions w,h.
  347. #### `[colorize:<color>:<ratio>`
  348. Colorize the textures with the given color.
  349. `<color>` is specified as a `ColorString`.
  350. `<ratio>` is an int ranging from 0 to 255 or the word "`alpha`". If
  351. it is an int, then it specifies how far to interpolate between the
  352. colors where 0 is only the texture color and 255 is only `<color>`. If
  353. omitted, the alpha of `<color>` will be used as the ratio. If it is
  354. the word "`alpha`", then each texture pixel will contain the RGB of
  355. `<color>` and the alpha of `<color>` multiplied by the alpha of the
  356. texture pixel.
  357. #### `[multiply:<color>`
  358. Multiplies texture colors with the given color.
  359. `<color>` is specified as a `ColorString`.
  360. Result is more like what you'd expect if you put a color on top of another
  361. color. Meaning white surfaces get a lot of your new color while black parts don't
  362. change very much.
  363. Hardware coloring
  364. -----------------
  365. The goal of hardware coloring is to simplify the creation of
  366. colorful nodes. If your textures use the same pattern, and they only
  367. differ in their color (like colored wool blocks), you can use hardware
  368. coloring instead of creating and managing many texture files.
  369. All of these methods use color multiplication (so a white-black texture
  370. with red coloring will result in red-black color).
  371. ### Static coloring
  372. This method is useful if you wish to create nodes/items with
  373. the same texture, in different colors, each in a new node/item definition.
  374. #### Global color
  375. When you register an item or node, set its `color` field (which accepts a
  376. `ColorSpec`) to the desired color.
  377. An `ItemStack`s static color can be overwritten by the `color` metadata
  378. field. If you set that field to a `ColorString`, that color will be used.
  379. #### Tile color
  380. Each tile may have an individual static color, which overwrites every
  381. other coloring methods. To disable the coloring of a face,
  382. set its color to white (because multiplying with white does nothing).
  383. You can set the `color` property of the tiles in the node's definition
  384. if the tile is in table format.
  385. ### Palettes
  386. For nodes and items which can have many colors, a palette is more
  387. suitable. A palette is a texture, which can contain up to 256 pixels.
  388. Each pixel is one possible color for the node/item.
  389. You can register one node/item, which can have up to 256 colors.
  390. #### Palette indexing
  391. When using palettes, you always provide a pixel index for the given
  392. node or `ItemStack`. The palette is read from left to right and from
  393. top to bottom. If the palette has less than 256 pixels, then it is
  394. stretched to contain exactly 256 pixels (after arranging the pixels
  395. to one line). The indexing starts from 0.
  396. Examples:
  397. * 16x16 palette, index = 0: the top left corner
  398. * 16x16 palette, index = 4: the fifth pixel in the first row
  399. * 16x16 palette, index = 16: the pixel below the top left corner
  400. * 16x16 palette, index = 255: the bottom right corner
  401. * 2 (width)x4 (height) palette, index=31: the top left corner.
  402. The palette has 8 pixels, so each pixel is stretched to 32 pixels,
  403. to ensure the total 256 pixels.
  404. * 2x4 palette, index=32: the top right corner
  405. * 2x4 palette, index=63: the top right corner
  406. * 2x4 palette, index=64: the pixel below the top left corner
  407. #### Using palettes with items
  408. When registering an item, set the item definition's `palette` field to
  409. a texture. You can also use texture modifiers.
  410. The `ItemStack`'s color depends on the `palette_index` field of the
  411. stack's metadata. `palette_index` is an integer, which specifies the
  412. index of the pixel to use.
  413. #### Linking palettes with nodes
  414. When registering a node, set the item definition's `palette` field to
  415. a texture. You can also use texture modifiers.
  416. The node's color depends on its `param2`, so you also must set an
  417. appropriate `drawtype`:
  418. * `drawtype = "color"` for nodes which use their full `param2` for
  419. palette indexing. These nodes can have 256 different colors.
  420. The palette should contain 256 pixels.
  421. * `drawtype = "colorwallmounted"` for nodes which use the first
  422. five bits (most significant) of `param2` for palette indexing.
  423. The remaining three bits are describing rotation, as in `wallmounted`
  424. draw type. Division by 8 yields the palette index (without stretching the
  425. palette). These nodes can have 32 different colors, and the palette
  426. should contain 32 pixels.
  427. Examples:
  428. * `param2 = 17` is 2 * 8 + 1, so the rotation is 1 and the third (= 2 + 1)
  429. pixel will be picked from the palette.
  430. * `param2 = 35` is 4 * 8 + 3, so the rotation is 3 and the fifth (= 4 + 1)
  431. pixel will be picked from the palette.
  432. * `drawtype = "colorfacedir"` for nodes which use the first
  433. three bits of `param2` for palette indexing. The remaining
  434. five bits are describing rotation, as in `facedir` draw type.
  435. Division by 32 yields the palette index (without stretching the
  436. palette). These nodes can have 8 different colors, and the
  437. palette should contain 8 pixels.
  438. Examples:
  439. * `param2 = 17` is 0 * 32 + 17, so the rotation is 17 and the
  440. first (= 0 + 1) pixel will be picked from the palette.
  441. * `param2 = 35` is 1 * 32 + 3, so the rotation is 3 and the
  442. second (= 1 + 1) pixel will be picked from the palette.
  443. To colorize a node on the map, set its `param2` value (according
  444. to the node's draw type).
  445. ### Conversion between nodes in the inventory and the on the map
  446. Static coloring is the same for both cases, there is no need
  447. for conversion.
  448. If the `ItemStack`'s metadata contains the `color` field, it will be
  449. lost on placement, because nodes on the map can only use palettes.
  450. If the `ItemStack`'s metadata contains the `palette_index` field, it is
  451. automatically transferred between node and item forms by the engine,
  452. when a player digs or places a colored node.
  453. You can disable this feature by setting the `drop` field of the node
  454. to itself (without metadata).
  455. To transfer the color to a special drop, you need a drop table.
  456. Example:
  457. minetest.register_node("mod:stone", {
  458. description = "Stone",
  459. tiles = {"default_stone.png"},
  460. paramtype2 = "color",
  461. palette = "palette.png",
  462. drop = {
  463. items = {
  464. -- assume that mod:cobblestone also has the same palette
  465. {items = {"mod:cobblestone"}, inherit_color = true },
  466. }
  467. }
  468. })
  469. ### Colored items in craft recipes
  470. Craft recipes only support item strings, but fortunately item strings
  471. can also contain metadata. Example craft recipe registration:
  472. minetest.register_craft({
  473. output = minetest.itemstring_with_palette("wool:block", 3),
  474. type = "shapeless",
  475. recipe = {
  476. "wool:block",
  477. "dye:red",
  478. },
  479. })
  480. To set the `color` field, you can use `minetest.itemstring_with_color`.
  481. Metadata field filtering in the `recipe` field are not supported yet,
  482. so the craft output is independent of the color of the ingredients.
  483. Soft texture overlay
  484. --------------------
  485. Sometimes hardware coloring is not enough, because it affects the
  486. whole tile. Soft texture overlays were added to Minetest to allow
  487. the dynamic coloring of only specific parts of the node's texture.
  488. For example a grass block may have colored grass, while keeping the
  489. dirt brown.
  490. These overlays are 'soft', because unlike texture modifiers, the layers
  491. are not merged in the memory, but they are simply drawn on top of each
  492. other. This allows different hardware coloring, but also means that
  493. tiles with overlays are drawn slower. Using too much overlays might
  494. cause FPS loss.
  495. For inventory and wield images you can specify overlays which
  496. hardware coloring does not modify. You have to set `inventory_overlay`
  497. and `wield_overlay` fields to an image name.
  498. To define a node overlay, simply set the `overlay_tiles` field of the node
  499. definition. These tiles are defined in the same way as plain tiles:
  500. they can have a texture name, color etc.
  501. To skip one face, set that overlay tile to an empty string.
  502. Example (colored grass block):
  503. minetest.register_node("default:dirt_with_grass", {
  504. description = "Dirt with Grass",
  505. -- Regular tiles, as usual
  506. -- The dirt tile disables palette coloring
  507. tiles = {{name = "default_grass.png"},
  508. {name = "default_dirt.png", color = "white"}},
  509. -- Overlay tiles: define them in the same style
  510. -- The top and bottom tile does not have overlay
  511. overlay_tiles = {"", "",
  512. {name = "default_grass_side.png", tileable_vertical = false}},
  513. -- Global color, used in inventory
  514. color = "green",
  515. -- Palette in the world
  516. paramtype2 = "color",
  517. palette = "default_foilage.png",
  518. })
  519. Sounds
  520. ------
  521. Only Ogg Vorbis files are supported.
  522. For positional playing of sounds, only single-channel (mono) files are
  523. supported. Otherwise OpenAL will play them non-positionally.
  524. Mods should generally prefix their sounds with `modname_`, e.g. given
  525. the mod name "`foomod`", a sound could be called:
  526. foomod_foosound.ogg
  527. Sounds are referred to by their name with a dot, a single digit and the
  528. file extension stripped out. When a sound is played, the actual sound file
  529. is chosen randomly from the matching sounds.
  530. When playing the sound `foomod_foosound`, the sound is chosen randomly
  531. from the available ones of the following files:
  532. * `foomod_foosound.ogg`
  533. * `foomod_foosound.0.ogg`
  534. * `foomod_foosound.1.ogg`
  535. * (...)
  536. * `foomod_foosound.9.ogg`
  537. Examples of sound parameter tables:
  538. -- Play locationless on all clients
  539. {
  540. gain = 1.0, -- default
  541. fade = 0.0, -- default, change to a value > 0 to fade the sound in
  542. pitch = 1.0, -- default
  543. }
  544. -- Play locationless to one player
  545. {
  546. to_player = name,
  547. gain = 1.0, -- default
  548. fade = 0.0, -- default, change to a value > 0 to fade the sound in
  549. pitch = 1.0, -- default
  550. }
  551. -- Play locationless to one player, looped
  552. {
  553. to_player = name,
  554. gain = 1.0, -- default
  555. loop = true,
  556. }
  557. -- Play in a location
  558. {
  559. pos = {x = 1, y = 2, z = 3},
  560. gain = 1.0, -- default
  561. max_hear_distance = 32, -- default, uses an euclidean metric
  562. }
  563. -- Play connected to an object, looped
  564. {
  565. object = <an ObjectRef>,
  566. gain = 1.0, -- default
  567. max_hear_distance = 32, -- default, uses an euclidean metric
  568. loop = true,
  569. }
  570. Looped sounds must either be connected to an object or played locationless to
  571. one player using `to_player = name,`
  572. ### `SimpleSoundSpec`
  573. * e.g. `""`
  574. * e.g. `"default_place_node"`
  575. * e.g. `{}`
  576. * e.g. `{name = "default_place_node"}`
  577. * e.g. `{name = "default_place_node", gain = 1.0}`
  578. * e.g. `{name = "default_place_node", gain = 1.0, pitch = 1.0}`
  579. Registered definitions of stuff
  580. -------------------------------
  581. Anything added using certain `minetest.register_*` functions get added to
  582. the global `minetest.registered_*` tables.
  583. * `minetest.register_entity(name, prototype table)`
  584. * added to `minetest.registered_entities[name]`
  585. * `minetest.register_node(name, node definition)`
  586. * added to `minetest.registered_items[name]`
  587. * added to `minetest.registered_nodes[name]`
  588. * `minetest.register_tool(name, item definition)`
  589. * added to `minetest.registered_items[name]`
  590. * `minetest.register_craftitem(name, item definition)`
  591. * added to `minetest.registered_items[name]`
  592. * `minetest.unregister_item(name)`
  593. * Unregisters the item name from engine, and deletes the entry with key
  594. * `name` from `minetest.registered_items` and from the associated item
  595. * table according to its nature: `minetest.registered_nodes[]` etc
  596. * `minetest.register_biome(biome definition)`
  597. * returns an integer uniquely identifying the registered biome
  598. * added to `minetest.registered_biome` with the key of `biome.name`
  599. * if `biome.name` is nil, the key is the returned ID
  600. * `minetest.unregister_biome(name)`
  601. * Unregisters the biome name from engine, and deletes the entry with key
  602. * `name` from `minetest.registered_biome`
  603. * `minetest.register_ore(ore definition)`
  604. * returns an integer uniquely identifying the registered ore
  605. * added to `minetest.registered_ores` with the key of `ore.name`
  606. * if `ore.name` is nil, the key is the returned ID
  607. * `minetest.register_decoration(decoration definition)`
  608. * returns an integer uniquely identifying the registered decoration
  609. * added to `minetest.registered_decorations` with the key of `decoration.name`
  610. * if `decoration.name` is nil, the key is the returned ID
  611. * `minetest.register_schematic(schematic definition)`
  612. * returns an integer uniquely identifying the registered schematic
  613. * added to `minetest.registered_schematic` with the key of `schematic.name`
  614. * if `schematic.name` is nil, the key is the returned ID
  615. * if the schematic is loaded from a file, schematic.name is set to the filename
  616. * if the function is called when loading the mod, and schematic.name is a relative
  617. path, then the current mod path will be prepended to the schematic filename
  618. * `minetest.clear_registered_biomes()`
  619. * clears all biomes currently registered
  620. * `minetest.clear_registered_ores()`
  621. * clears all ores currently registered
  622. * `minetest.clear_registered_decorations()`
  623. * clears all decorations currently registered
  624. * `minetest.clear_registered_schematics()`
  625. * clears all schematics currently registered
  626. Note that in some cases you will stumble upon things that are not contained
  627. in these tables (e.g. when a mod has been removed). Always check for
  628. existence before trying to access the fields.
  629. Example: If you want to check the drawtype of a node, you could do:
  630. local function get_nodedef_field(nodename, fieldname)
  631. if not minetest.registered_nodes[nodename] then
  632. return nil
  633. end
  634. return minetest.registered_nodes[nodename][fieldname]
  635. end
  636. local drawtype = get_nodedef_field(nodename, "drawtype")
  637. Example: `minetest.get_item_group(name, group)` has been implemented as:
  638. function minetest.get_item_group(name, group)
  639. if not minetest.registered_items[name] or not
  640. minetest.registered_items[name].groups[group] then
  641. return 0
  642. end
  643. return minetest.registered_items[name].groups[group]
  644. end
  645. Nodes
  646. -----
  647. Nodes are the bulk data of the world: cubes and other things that take the
  648. space of a cube. Huge amounts of them are handled efficiently, but they
  649. are quite static.
  650. The definition of a node is stored and can be accessed by name in
  651. minetest.registered_nodes[node.name]
  652. See "Registered definitions of stuff".
  653. Nodes are passed by value between Lua and the engine.
  654. They are represented by a table:
  655. {name="name", param1=num, param2=num}
  656. `param1` and `param2` are 8-bit integers ranging from 0 to 255. The engine uses
  657. them for certain automated functions. If you don't use these functions, you can
  658. use them to store arbitrary values.
  659. The functions of `param1` and `param2` are determined by certain fields in the
  660. node definition:
  661. `param1` is reserved for the engine when `paramtype != "none"`:
  662. paramtype = "light"
  663. ^ The value stores light with and without sun in its upper and lower 4 bits
  664. respectively. Allows light to propagate from or through the node with
  665. light value falling by 1 per node. This is essential for a light source
  666. node to spread its light.
  667. `param2` is reserved for the engine when any of these are used:
  668. liquidtype == "flowing"
  669. ^ The level and some flags of the liquid is stored in param2
  670. drawtype == "flowingliquid"
  671. ^ The drawn liquid level is read from param2
  672. drawtype == "torchlike"
  673. drawtype == "signlike"
  674. paramtype2 == "wallmounted"
  675. ^ The rotation of the node is stored in param2. You can make this value
  676. by using minetest.dir_to_wallmounted().
  677. paramtype2 == "facedir"
  678. ^ The rotation of the node is stored in param2. Furnaces and chests are
  679. rotated this way. Can be made by using minetest.dir_to_facedir().
  680. Values range 0 - 23
  681. facedir / 4 = axis direction:
  682. 0 = y+ 1 = z+ 2 = z- 3 = x+ 4 = x- 5 = y-
  683. facedir modulo 4 = rotation around that axis
  684. paramtype2 == "leveled"
  685. ^ Only valid for "nodebox" with 'type = "leveled"', and "plantlike_rooted".
  686. Leveled nodebox:
  687. The level of the top face of the nodebox is stored in param2.
  688. The other faces are defined by 'fixed = {}' like 'type = "fixed"' nodeboxes.
  689. The nodebox height is (param2 / 64) nodes.
  690. The maximum accepted value of param2 is 127.
  691. Rooted plantlike:
  692. The height of the 'plantlike' section is stored in param2.
  693. The height is (param2 / 16) nodes.
  694. paramtype2 == "degrotate"
  695. ^ The rotation of this node is stored in param2. Plants are rotated this way.
  696. Values range 0 - 179. The value stored in param2 is multiplied by two to
  697. get the actual rotation of the node.
  698. paramtype2 == "meshoptions"
  699. ^ Only valid for "plantlike". The value of param2 becomes a bitfield which can
  700. be used to change how the client draws plantlike nodes. Bits 0, 1 and 2 form
  701. a mesh selector. Currently the following meshes are choosable:
  702. 0 = a "x" shaped plant (ordinary plant)
  703. 1 = a "+" shaped plant (just rotated 45 degrees)
  704. 2 = a "*" shaped plant with 3 faces instead of 2
  705. 3 = a "#" shaped plant with 4 faces instead of 2
  706. 4 = a "#" shaped plant with 4 faces that lean outwards
  707. 5-7 are unused and reserved for future meshes.
  708. Bits 3 through 7 are optional flags that can be combined and give these
  709. effects:
  710. bit 3 (0x08) - Makes the plant slightly vary placement horizontally
  711. bit 4 (0x10) - Makes the plant mesh 1.4x larger
  712. bit 5 (0x20) - Moves each face randomly a small bit down (1/8 max)
  713. bits 6-7 are reserved for future use.
  714. paramtype2 == "color"
  715. ^ `param2` tells which color is picked from the palette.
  716. The palette should have 256 pixels.
  717. paramtype2 == "colorfacedir"
  718. ^ Same as `facedir`, but with colors.
  719. The first three bits of `param2` tells which color
  720. is picked from the palette.
  721. The palette should have 8 pixels.
  722. paramtype2 == "colorwallmounted"
  723. ^ Same as `wallmounted`, but with colors.
  724. The first five bits of `param2` tells which color
  725. is picked from the palette.
  726. The palette should have 32 pixels.
  727. paramtype2 == "glasslikeliquidlevel"
  728. ^ Only valid for "glasslike_framed" or "glasslike_framed_optional" drawtypes.
  729. param2 values 0-63 define 64 levels of internal liquid, 0 being empty and
  730. 63 being full.
  731. Liquid texture is defined using `special_tiles = {"modname_tilename.png"},`
  732. Nodes can also contain extra data. See "Node Metadata".
  733. Node drawtypes
  734. --------------
  735. There are a bunch of different looking node types.
  736. Look for examples in `games/minimal` or `games/minetest_game`.
  737. * `normal`
  738. * `airlike`
  739. * `liquid`
  740. * `flowingliquid`
  741. * `glasslike`
  742. * `glasslike_framed`
  743. * `glasslike_framed_optional`
  744. * `allfaces`
  745. * `allfaces_optional`
  746. * `torchlike`
  747. * `signlike`
  748. * `plantlike`
  749. * `firelike`
  750. * `fencelike`
  751. * `raillike`
  752. * `nodebox` -- See below
  753. * `mesh` -- Use models for nodes, see below
  754. * `plantlike_rooted` -- See below
  755. `*_optional` drawtypes need less rendering time if deactivated (always client side).
  756. Node boxes
  757. ----------
  758. Node selection boxes are defined using "node boxes"
  759. The `nodebox` node drawtype allows defining nodes consisting of an arbitrary
  760. number of boxes. It allows defining stuff like stairs and slabs.
  761. A nodebox is defined as any of:
  762. {
  763. -- A normal cube; the default in most things
  764. type = "regular"
  765. }
  766. {
  767. -- A fixed box (or boxes) (facedir param2 is used, if applicable)
  768. type = "fixed",
  769. fixed = box OR {box1, box2, ...}
  770. }
  771. {
  772. -- A variable height box (or boxes) with the top face position defined by
  773. -- the node parameter 'leveled = ', or if 'paramtype2 == "leveled"' by
  774. -- param2.
  775. -- Other faces are defined by 'fixed = {}' as with 'type = "fixed"'.
  776. type = "leveled",
  777. fixed = box OR {box1, box2, ...}
  778. }
  779. {
  780. -- A box like the selection box for torches
  781. -- (wallmounted param2 is used, if applicable)
  782. type = "wallmounted",
  783. wall_top = box,
  784. wall_bottom = box,
  785. wall_side = box
  786. }
  787. {
  788. -- A node that has optional boxes depending on neighbouring nodes'
  789. -- presence and type. See also `connects_to`.
  790. type = "connected",
  791. fixed = box OR {box1, box2, ...}
  792. connect_top = box OR {box1, box2, ...}
  793. connect_bottom = box OR {box1, box2, ...}
  794. connect_front = box OR {box1, box2, ...}
  795. connect_left = box OR {box1, box2, ...}
  796. connect_back = box OR {box1, box2, ...}
  797. connect_right = box OR {box1, box2, ...}
  798. }
  799. A `box` is defined as:
  800. {x1, y1, z1, x2, y2, z2}
  801. A box of a regular node would look like:
  802. {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
  803. Meshes
  804. ------
  805. If drawtype `mesh` is used, tiles should hold model materials textures.
  806. Only static meshes are implemented.
  807. For supported model formats see Irrlicht engine documentation.
  808. Rooted plantlike drawtype
  809. -------------------------
  810. The `plantlike_rooted` drawtype was developed to enable underwater plants
  811. without air bubbles around the plants.
  812. It consists of a base cube at the co-ordinates of the node (the seabed /
  813. lakebed / riverbed node) plus a 'plantlike' extension above with a height
  814. defined by param2 (maximum height 16 nodes). This extension visually passes
  815. through any nodes above the base cube without affecting them.
  816. The node is dug by digging the base cube.
  817. The base cube texture tiles are defined as normal, the plantlike extension
  818. uses the defined 'special tile', for example:
  819. `special_tiles = {{name = "default_papyrus.png", tileable_vertical = true}},`
  820. Noise Parameters
  821. ----------------
  822. Noise Parameters, or commonly called "`NoiseParams`", define the properties of
  823. perlin noise.
  824. ### `offset`
  825. Offset that the noise is translated by (i.e. added) after calculation.
  826. ### `scale`
  827. Factor that the noise is scaled by (i.e. multiplied) after calculation.
  828. ### `spread`
  829. Vector containing values by which each coordinate is divided by before calculation.
  830. Higher spread values result in larger noise features.
  831. A value of `{x=250, y=250, z=250}` is common.
  832. ### `seed`
  833. Random seed for the noise. Add the world seed to a seed offset for world-unique noise.
  834. In the case of `minetest.get_perlin()`, this value has the world seed automatically added.
  835. ### `octaves`
  836. Number of times the noise gradient is accumulated into the noise.
  837. Increase this number to increase the amount of detail in the resulting noise.
  838. A value of `6` is common.
  839. ### `persistence`
  840. Factor by which the effect of the noise gradient function changes with each successive octave.
  841. Values less than `1` make the details of successive octaves' noise diminish, while values
  842. greater than `1` make successive octaves stronger.
  843. A value of `0.6` is common.
  844. ### `lacunarity`
  845. Factor by which the noise feature sizes change with each successive octave.
  846. A value of `2.0` is common.
  847. ### `flags`
  848. Leave this field unset for no special handling.
  849. Currently supported are `defaults`, `eased` and `absvalue`.
  850. #### `defaults`
  851. Specify this if you would like to keep auto-selection of eased/not-eased while specifying
  852. some other flags.
  853. #### `eased`
  854. Maps noise gradient values onto a quintic S-curve before performing interpolation.
  855. This results in smooth, rolling noise. Disable this (`noeased`) for sharp-looking noise.
  856. If no flags are specified (or defaults is), 2D noise is eased and 3D noise is not eased.
  857. #### `absvalue`
  858. Accumulates the absolute value of each noise gradient result.
  859. Noise parameters format example for 2D or 3D perlin noise or perlin noise maps:
  860. np_terrain = {
  861. offset = 0,
  862. scale = 1,
  863. spread = {x=500, y=500, z=500},
  864. seed = 571347,
  865. octaves = 5,
  866. persist = 0.63,
  867. lacunarity = 2.0,
  868. flags = "defaults, absvalue"
  869. }
  870. ^ A single noise parameter table can be used to get 2D or 3D noise,
  871. when getting 2D noise spread.z is ignored.
  872. Ore types
  873. ---------
  874. These tell in what manner the ore is generated.
  875. All default ores are of the uniformly-distributed scatter type.
  876. ### `scatter`
  877. Randomly chooses a location and generates a cluster of ore.
  878. If `noise_params` is specified, the ore will be placed if the 3D perlin noise at
  879. that point is greater than the `noise_threshold`, giving the ability to create
  880. a non-equal distribution of ore.
  881. ### `sheet`
  882. Creates a sheet of ore in a blob shape according to the 2D perlin noise
  883. described by `noise_params` and `noise_threshold`. This is essentially an
  884. improved version of the so-called "stratus" ore seen in some unofficial mods.
  885. This sheet consists of vertical columns of uniform randomly distributed height,
  886. varying between the inclusive range `column_height_min` and `column_height_max`.
  887. If `column_height_min` is not specified, this parameter defaults to 1.
  888. If `column_height_max` is not specified, this parameter defaults to `clust_size`
  889. for reverse compatibility. New code should prefer `column_height_max`.
  890. The `column_midpoint_factor` parameter controls the position of the column at which
  891. ore emanates from. If 1, columns grow upward. If 0, columns grow downward. If 0.5,
  892. columns grow equally starting from each direction. `column_midpoint_factor` is a
  893. decimal number ranging in value from 0 to 1. If this parameter is not specified,
  894. the default is 0.5.
  895. The ore parameters `clust_scarcity` and `clust_num_ores` are ignored for this ore type.
  896. ### `puff`
  897. Creates a sheet of ore in a cloud-like puff shape.
  898. As with the `sheet` ore type, the size and shape of puffs are described by
  899. `noise_params` and `noise_threshold` and are placed at random vertical positions
  900. within the currently generated chunk.
  901. The vertical top and bottom displacement of each puff are determined by the noise
  902. parameters `np_puff_top` and `np_puff_bottom`, respectively.
  903. ### `blob`
  904. Creates a deformed sphere of ore according to 3d perlin noise described by
  905. `noise_params`. The maximum size of the blob is `clust_size`, and
  906. `clust_scarcity` has the same meaning as with the `scatter` type.
  907. ### `vein`
  908. Creates veins of ore varying in density by according to the intersection of two
  909. instances of 3d perlin noise with different seeds, both described by
  910. `noise_params`.
  911. `random_factor` varies the influence random chance has on placement of an ore
  912. inside the vein, which is `1` by default. Note that modifying this parameter may
  913. require adjusting `noise_threshold`.
  914. The parameters `clust_scarcity`, `clust_num_ores`, and `clust_size` are ignored
  915. by this ore type.
  916. This ore type is difficult to control since it is sensitive to small changes.
  917. The following is a decent set of parameters to work from:
  918. noise_params = {
  919. offset = 0,
  920. scale = 3,
  921. spread = {x=200, y=200, z=200},
  922. seed = 5390,
  923. octaves = 4,
  924. persist = 0.5,
  925. flags = "eased",
  926. },
  927. noise_threshold = 1.6
  928. **WARNING**: Use this ore type *very* sparingly since it is ~200x more
  929. computationally expensive than any other ore.
  930. ### `stratum`
  931. Creates a single undulating ore stratum that is continuous across mapchunk
  932. borders and horizontally spans the world.
  933. The 2D perlin noise described by `noise_params` defines the Y co-ordinate of the
  934. stratum midpoint. The 2D perlin noise described by `np_stratum_thickness`
  935. defines the stratum's vertical thickness (in units of nodes). Due to being
  936. continuous across mapchunk borders the stratum's vertical thickness is
  937. unlimited.
  938. If the noise parameter `noise_params` is omitted the ore will occur from y_min
  939. to y_max in a simple horizontal stratum.
  940. A parameter `stratum_thickness` can be provided instead of the noise parameter
  941. `np_stratum_thickness`, to create a constant thickness.
  942. Leaving out one or both noise parameters makes the ore generation less intensive,
  943. useful when adding multiple strata.
  944. `y_min` and `y_max` define the limits of the ore generation and for performance
  945. reasons should be set as close together as possible but without clipping the
  946. stratum's Y variation.
  947. Each node in the stratum has a 1-in-`clust_scarcity` chance of being ore, so a
  948. solid-ore stratum would require a `clust_scarcity` of 1.
  949. The parameters `clust_num_ores`, `clust_size`, `noise_threshold` and
  950. `random_factor` are ignored by this ore type.
  951. Ore attributes
  952. --------------
  953. See section "Flag Specifier Format".
  954. Currently supported flags:
  955. `puff_cliffs`, `puff_additive_composition`.
  956. ### `puff_cliffs`
  957. If set, puff ore generation will not taper down large differences in displacement
  958. when approaching the edge of a puff. This flag has no effect for ore types other
  959. than `puff`.
  960. ### `puff_additive_composition`
  961. By default, when noise described by `np_puff_top` or `np_puff_bottom` results in a
  962. negative displacement, the sub-column at that point is not generated. With this
  963. attribute set, puff ore generation will instead generate the absolute difference in
  964. noise displacement values. This flag has no effect for ore types other than `puff`.
  965. Decoration types
  966. ----------------
  967. The varying types of decorations that can be placed.
  968. ### `simple`
  969. Creates a 1 times `H` times 1 column of a specified node (or a random node from
  970. a list, if a decoration list is specified). Can specify a certain node it must
  971. spawn next to, such as water or lava, for example. Can also generate a
  972. decoration of random height between a specified lower and upper bound.
  973. This type of decoration is intended for placement of grass, flowers, cacti,
  974. papyri, waterlilies and so on.
  975. ### `schematic`
  976. Copies a box of `MapNodes` from a specified schematic file (or raw description).
  977. Can specify a probability of a node randomly appearing when placed.
  978. This decoration type is intended to be used for multi-node sized discrete
  979. structures, such as trees, cave spikes, rocks, and so on.
  980. Schematic specifier
  981. --------------------
  982. A schematic specifier identifies a schematic by either a filename to a
  983. Minetest Schematic file (`.mts`) or through raw data supplied through Lua,
  984. in the form of a table. This table specifies the following fields:
  985. * The `size` field is a 3D vector containing the dimensions of the provided schematic. (required)
  986. * The `yslice_prob` field is a table of {ypos, prob} which sets the `ypos`th vertical slice
  987. of the schematic to have a `prob / 256 * 100` chance of occurring. (default: 255)
  988. * The `data` field is a flat table of MapNode tables making up the schematic,
  989. in the order of `[z [y [x]]]`. (required)
  990. Each MapNode table contains:
  991. * `name`: the name of the map node to place (required)
  992. * `prob` (alias `param1`): the probability of this node being placed (default: 255)
  993. * `param2`: the raw param2 value of the node being placed onto the map (default: 0)
  994. * `force_place`: boolean representing if the node should forcibly overwrite any
  995. previous contents (default: false)
  996. About probability values:
  997. * A probability value of `0` or `1` means that node will never appear (0% chance).
  998. * A probability value of `254` or `255` means the node will always appear (100% chance).
  999. * If the probability value `p` is greater than `1`, then there is a
  1000. `(p / 256 * 100)` percent chance that node will appear when the schematic is
  1001. placed on the map.
  1002. Schematic attributes
  1003. --------------------
  1004. See section "Flag Specifier Format".
  1005. Currently supported flags: `place_center_x`, `place_center_y`, `place_center_z`,
  1006. `force_placement`.
  1007. * `place_center_x`: Placement of this decoration is centered along the X axis.
  1008. * `place_center_y`: Placement of this decoration is centered along the Y axis.
  1009. * `place_center_z`: Placement of this decoration is centered along the Z axis.
  1010. * `force_placement`: Schematic nodes other than "ignore" will replace existing nodes.
  1011. HUD element types
  1012. -----------------
  1013. The position field is used for all element types.
  1014. To account for differing resolutions, the position coordinates are the percentage
  1015. of the screen, ranging in value from `0` to `1`.
  1016. The name field is not yet used, but should contain a description of what the
  1017. HUD element represents. The direction field is the direction in which something
  1018. is drawn.
  1019. `0` draws from left to right, `1` draws from right to left, `2` draws from
  1020. top to bottom, and `3` draws from bottom to top.
  1021. The `alignment` field specifies how the item will be aligned. It ranges from `-1` to `1`,
  1022. with `0` being the center, `-1` is moved to the left/up, and `1` is to the right/down.
  1023. Fractional values can be used.
  1024. The `offset` field specifies a pixel offset from the position. Contrary to position,
  1025. the offset is not scaled to screen size. This allows for some precisely-positioned
  1026. items in the HUD.
  1027. **Note**: `offset` _will_ adapt to screen DPI as well as user defined scaling factor!
  1028. Below are the specific uses for fields in each type; fields not listed for that type are ignored.
  1029. **Note**: Future revisions to the HUD API may be incompatible; the HUD API is still
  1030. in the experimental stages.
  1031. ### `image`
  1032. Displays an image on the HUD.
  1033. * `scale`: The scale of the image, with 1 being the original texture size.
  1034. Only the X coordinate scale is used (positive values).
  1035. Negative values represent that percentage of the screen it
  1036. should take; e.g. `x=-100` means 100% (width).
  1037. * `text`: The name of the texture that is displayed.
  1038. * `alignment`: The alignment of the image.
  1039. * `offset`: offset in pixels from position.
  1040. ### `text`
  1041. Displays text on the HUD.
  1042. * `scale`: Defines the bounding rectangle of the text.
  1043. A value such as `{x=100, y=100}` should work.
  1044. * `text`: The text to be displayed in the HUD element.
  1045. * `number`: An integer containing the RGB value of the color used to draw the text.
  1046. Specify `0xFFFFFF` for white text, `0xFF0000` for red, and so on.
  1047. * `alignment`: The alignment of the text.
  1048. * `offset`: offset in pixels from position.
  1049. ### `statbar`
  1050. Displays a horizontal bar made up of half-images.
  1051. * `text`: The name of the texture that is used.
  1052. * `number`: The number of half-textures that are displayed.
  1053. If odd, will end with a vertically center-split texture.
  1054. * `direction`
  1055. * `offset`: offset in pixels from position.
  1056. * `size`: If used, will force full-image size to this value (override texture pack image size)
  1057. ### `inventory`
  1058. * `text`: The name of the inventory list to be displayed.
  1059. * `number`: Number of items in the inventory to be displayed.
  1060. * `item`: Position of item that is selected.
  1061. * `direction`
  1062. * `offset`: offset in pixels from position.
  1063. ### `waypoint`
  1064. Displays distance to selected world position.
  1065. * `name`: The name of the waypoint.
  1066. * `text`: Distance suffix. Can be blank.
  1067. * `number:` An integer containing the RGB value of the color used to draw the text.
  1068. * `world_pos`: World position of the waypoint.
  1069. Representations of simple things
  1070. --------------------------------
  1071. ### Position/vector
  1072. {x=num, y=num, z=num}
  1073. For helper functions see "Vector helpers".
  1074. ### `pointed_thing`
  1075. * `{type="nothing"}`
  1076. * `{type="node", under=pos, above=pos}`
  1077. * `{type="object", ref=ObjectRef}`
  1078. Flag Specifier Format
  1079. ---------------------
  1080. Flags using the standardized flag specifier format can be specified in either of
  1081. two ways, by string or table.
  1082. The string format is a comma-delimited set of flag names; whitespace and
  1083. unrecognized flag fields are ignored. Specifying a flag in the string sets the
  1084. flag, and specifying a flag prefixed by the string `"no"` explicitly
  1085. clears the flag from whatever the default may be.
  1086. In addition to the standard string flag format, the schematic flags field can
  1087. also be a table of flag names to boolean values representing whether or not the
  1088. flag is set. Additionally, if a field with the flag name prefixed with `"no"`
  1089. is present, mapped to a boolean of any value, the specified flag is unset.
  1090. E.g. A flag field of value
  1091. {place_center_x = true, place_center_y=false, place_center_z=true}
  1092. is equivalent to
  1093. {place_center_x = true, noplace_center_y=true, place_center_z=true}
  1094. which is equivalent to
  1095. "place_center_x, noplace_center_y, place_center_z"
  1096. or even
  1097. "place_center_x, place_center_z"
  1098. since, by default, no schematic attributes are set.
  1099. Items
  1100. -----
  1101. ### Item types
  1102. There are three kinds of items: nodes, tools and craftitems.
  1103. * Node (`register_node`): A node from the world.
  1104. * Tool (`register_tool`): A tool/weapon that can dig and damage
  1105. things according to `tool_capabilities`.
  1106. * Craftitem (`register_craftitem`): A miscellaneous item.
  1107. ### Amount and wear
  1108. All item stacks have an amount between 0 to 65535. It is 1 by
  1109. default. Tool item stacks can not have an amount greater than 1.
  1110. Tools use a wear (=damage) value ranging from 0 to 65535. The
  1111. value 0 is the default and used is for unworn tools. The values
  1112. 1 to 65535 are used for worn tools, where a higher value stands for
  1113. a higher wear. Non-tools always have a wear value of 0.
  1114. ### Item formats
  1115. Items and item stacks can exist in three formats: Serializes, table format
  1116. and `ItemStack`.
  1117. #### Serialized
  1118. This is called "stackstring" or "itemstring". It is a simple string with
  1119. 1-3 components: the full item identifier, an optional amount and an optional
  1120. wear value. Syntax:
  1121. <identifier> [<amount>[ <wear>]]
  1122. Examples:
  1123. * `'default:apple'`: 1 apple
  1124. * `'default:dirt 5'`: 5 dirt
  1125. * `'default:pick_stone'`: a new stone pickaxe
  1126. * `'default:pick_wood 1 21323'`: a wooden pickaxe, ca. 1/3 worn out
  1127. #### Table format
  1128. Examples:
  1129. 5 dirt nodes:
  1130. {name="default:dirt", count=5, wear=0, metadata=""}
  1131. A wooden pick about 1/3 worn out:
  1132. {name="default:pick_wood", count=1, wear=21323, metadata=""}
  1133. An apple:
  1134. {name="default:apple", count=1, wear=0, metadata=""}
  1135. #### `ItemStack`
  1136. A native C++ format with many helper methods. Useful for converting
  1137. between formats. See the Class reference section for details.
  1138. When an item must be passed to a function, it can usually be in any of
  1139. these formats.
  1140. Groups
  1141. ------
  1142. In a number of places, there is a group table. Groups define the
  1143. properties of a thing (item, node, armor of entity, capabilities of
  1144. tool) in such a way that the engine and other mods can can interact with
  1145. the thing without actually knowing what the thing is.
  1146. ### Usage
  1147. Groups are stored in a table, having the group names with keys and the
  1148. group ratings as values. For example:
  1149. groups = {crumbly=3, soil=1}
  1150. -- ^ Default dirt
  1151. groups = {crumbly=2, soil=1, level=2, outerspace=1}
  1152. -- ^ A more special dirt-kind of thing
  1153. Groups always have a rating associated with them. If there is no
  1154. useful meaning for a rating for an enabled group, it shall be `1`.
  1155. When not defined, the rating of a group defaults to `0`. Thus when you
  1156. read groups, you must interpret `nil` and `0` as the same value, `0`.
  1157. You can read the rating of a group for an item or a node by using
  1158. minetest.get_item_group(itemname, groupname)
  1159. ### Groups of items
  1160. Groups of items can define what kind of an item it is (e.g. wool).
  1161. ### Groups of nodes
  1162. In addition to the general item things, groups are used to define whether
  1163. a node is destroyable and how long it takes to destroy by a tool.
  1164. ### Groups of entities
  1165. For entities, groups are, as of now, used only for calculating damage.
  1166. The rating is the percentage of damage caused by tools with this damage group.
  1167. See "Entity damage mechanism".
  1168. object.get_armor_groups() --> a group-rating table (e.g. {fleshy=100})
  1169. object.set_armor_groups({fleshy=30, cracky=80})
  1170. ### Groups of tools
  1171. Groups in tools define which groups of nodes and entities they are
  1172. effective towards.
  1173. ### Groups in crafting recipes
  1174. An example: Make meat soup from any meat, any water and any bowl:
  1175. {
  1176. output = 'food:meat_soup_raw',
  1177. recipe = {
  1178. {'group:meat'},
  1179. {'group:water'},
  1180. {'group:bowl'},
  1181. },
  1182. -- preserve = {'group:bowl'}, -- Not implemented yet (TODO)
  1183. }
  1184. Another example: Make red wool from white wool and red dye:
  1185. {
  1186. type = 'shapeless',
  1187. output = 'wool:red',
  1188. recipe = {'wool:white', 'group:dye,basecolor_red'},
  1189. }
  1190. ### Special groups
  1191. * `immortal`: Disables the group damage system for an entity
  1192. * `punch_operable`: For entities; disables the regular damage mechanism for
  1193. players punching it by hand or a non-tool item, so that it can do something
  1194. else than take damage.
  1195. * `level`: Can be used to give an additional sense of progression in the game.
  1196. * A larger level will cause e.g. a weapon of a lower level make much less
  1197. damage, and get worn out much faster, or not be able to get drops
  1198. from destroyed nodes.
  1199. * `0` is something that is directly accessible at the start of gameplay
  1200. * There is no upper limit
  1201. * `dig_immediate`: (player can always pick up node without reducing tool wear)
  1202. * `2`: the node always gets the digging time 0.5 seconds (rail, sign)
  1203. * `3`: the node always gets the digging time 0 seconds (torch)
  1204. * `disable_jump`: Player (and possibly other things) cannot jump from node
  1205. * `fall_damage_add_percent`: damage speed = `speed * (1 + value/100)`
  1206. * `bouncy`: value is bounce speed in percent
  1207. * `falling_node`: if there is no walkable block under the node it will fall
  1208. * `attached_node`: if the node under it is not a walkable block the node will be
  1209. dropped as an item. If the node is wallmounted the wallmounted direction is
  1210. checked.
  1211. * `soil`: saplings will grow on nodes in this group
  1212. * `connect_to_raillike`: makes nodes of raillike drawtype with same group value
  1213. connect to each other
  1214. * `slippery`: Players and items will slide on the node.
  1215. Slipperiness rises steadily with `slippery` value, starting at 1.
  1216. ### Known damage and digging time defining groups
  1217. * `crumbly`: dirt, sand
  1218. * `cracky`: tough but crackable stuff like stone.
  1219. * `snappy`: something that can be cut using fine tools; e.g. leaves, small
  1220. plants, wire, sheets of metal
  1221. * `choppy`: something that can be cut using force; e.g. trees, wooden planks
  1222. * `fleshy`: Living things like animals and the player. This could imply
  1223. some blood effects when hitting.
  1224. * `explody`: Especially prone to explosions
  1225. * `oddly_breakable_by_hand`:
  1226. Can be added to nodes that shouldn't logically be breakable by the
  1227. hand but are. Somewhat similar to `dig_immediate`, but times are more
  1228. like `{[1]=3.50,[2]=2.00,[3]=0.70}` and this does not override the
  1229. speed of a tool if the tool can dig at a faster speed than this
  1230. suggests for the hand.
  1231. ### Examples of custom groups
  1232. Item groups are often used for defining, well, _groups of items_.
  1233. * `meat`: any meat-kind of a thing (rating might define the size or healing
  1234. ability or be irrelevant -- it is not defined as of yet)
  1235. * `eatable`: anything that can be eaten. Rating might define HP gain in half
  1236. hearts.
  1237. * `flammable`: can be set on fire. Rating might define the intensity of the
  1238. fire, affecting e.g. the speed of the spreading of an open fire.
  1239. * `wool`: any wool (any origin, any color)
  1240. * `metal`: any metal
  1241. * `weapon`: any weapon
  1242. * `heavy`: anything considerably heavy
  1243. ### Digging time calculation specifics
  1244. Groups such as `crumbly`, `cracky` and `snappy` are used for this
  1245. purpose. Rating is `1`, `2` or `3`. A higher rating for such a group implies
  1246. faster digging time.
  1247. The `level` group is used to limit the toughness of nodes a tool can dig
  1248. and to scale the digging times / damage to a greater extent.
  1249. **Please do understand this**, otherwise you cannot use the system to it's
  1250. full potential.
  1251. Tools define their properties by a list of parameters for groups. They
  1252. cannot dig other groups; thus it is important to use a standard bunch of
  1253. groups to enable interaction with tools.
  1254. #### Tools definition
  1255. Tools define:
  1256. * Full punch interval
  1257. * Maximum drop level
  1258. * For an arbitrary list of groups:
  1259. * Uses (until the tool breaks)
  1260. * Maximum level (usually `0`, `1`, `2` or `3`)
  1261. * Digging times
  1262. * Damage groups
  1263. #### Full punch interval
  1264. When used as a weapon, the tool will do full damage if this time is spent
  1265. between punches. If e.g. half the time is spent, the tool will do half
  1266. damage.
  1267. #### Maximum drop level
  1268. Suggests the maximum level of node, when dug with the tool, that will drop
  1269. it's useful item. (e.g. iron ore to drop a lump of iron).
  1270. This is not automated; it is the responsibility of the node definition
  1271. to implement this.
  1272. #### Uses
  1273. Determines how many uses the tool has when it is used for digging a node,
  1274. of this group, of the maximum level. For lower leveled nodes, the use count
  1275. is multiplied by `3^leveldiff`.
  1276. * `uses=10, leveldiff=0`: actual uses: 10
  1277. * `uses=10, leveldiff=1`: actual uses: 30
  1278. * `uses=10, leveldiff=2`: actual uses: 90
  1279. #### Maximum level
  1280. Tells what is the maximum level of a node of this group that the tool will
  1281. be able to dig.
  1282. #### Digging times
  1283. List of digging times for different ratings of the group, for nodes of the
  1284. maximum level.
  1285. For example, as a Lua table, `times={2=2.00, 3=0.70}`. This would
  1286. result in the tool to be able to dig nodes that have a rating of `2` or `3`
  1287. for this group, and unable to dig the rating `1`, which is the toughest.
  1288. Unless there is a matching group that enables digging otherwise.
  1289. If the result digging time is 0, a delay of 0.15 seconds is added between
  1290. digging nodes; If the player releases LMB after digging, this delay is set to 0,
  1291. i.e. players can more quickly click the nodes away instead of holding LMB.
  1292. #### Damage groups
  1293. List of damage for groups of entities. See "Entity damage mechanism".
  1294. #### Example definition of the capabilities of a tool
  1295. tool_capabilities = {
  1296. full_punch_interval=1.5,
  1297. max_drop_level=1,
  1298. groupcaps={
  1299. crumbly={maxlevel=2, uses=20, times={[1]=1.60, [2]=1.20, [3]=0.80}}
  1300. }
  1301. damage_groups = {fleshy=2},
  1302. }
  1303. This makes the tool be able to dig nodes that fulfil both of these:
  1304. * Have the `crumbly` group
  1305. * Have a `level` group less or equal to `2`
  1306. Table of resulting digging times:
  1307. crumbly 0 1 2 3 4 <- level
  1308. -> 0 - - - - -
  1309. 1 0.80 1.60 1.60 - -
  1310. 2 0.60 1.20 1.20 - -
  1311. 3 0.40 0.80 0.80 - -
  1312. level diff: 2 1 0 -1 -2
  1313. Table of resulting tool uses:
  1314. -> 0 - - - - -
  1315. 1 180 60 20 - -
  1316. 2 180 60 20 - -
  1317. 3 180 60 20 - -
  1318. **Notes**:
  1319. * At `crumbly==0`, the node is not diggable.
  1320. * At `crumbly==3`, the level difference digging time divider kicks in and makes
  1321. easy nodes to be quickly breakable.
  1322. * At `level > 2`, the node is not diggable, because it's `level > maxlevel`
  1323. Entity damage mechanism
  1324. -----------------------
  1325. Damage calculation:
  1326. damage = 0
  1327. foreach group in cap.damage_groups:
  1328. damage += cap.damage_groups[group] * limit(actual_interval /
  1329. cap.full_punch_interval, 0.0, 1.0)
  1330. * (object.armor_groups[group] / 100.0)
  1331. -- Where object.armor_groups[group] is 0 for inexistent values
  1332. return damage
  1333. Client predicts damage based on damage groups. Because of this, it is able to
  1334. give an immediate response when an entity is damaged or dies; the response is
  1335. pre-defined somehow (e.g. by defining a sprite animation) (not implemented;
  1336. TODO).
  1337. Currently a smoke puff will appear when an entity dies.
  1338. The group `immortal` completely disables normal damage.
  1339. Entities can define a special armor group, which is `punch_operable`. This
  1340. group disables the regular damage mechanism for players punching it by hand or
  1341. a non-tool item, so that it can do something else than take damage.
  1342. On the Lua side, every punch calls:
  1343. entity:on_punch(puncher, time_from_last_punch, tool_capabilities, direction, damage)
  1344. This should never be called directly, because damage is usually not handled by
  1345. the entity itself.
  1346. * `puncher` is the object performing the punch. Can be `nil`. Should never be
  1347. accessed unless absolutely required, to encourage interoperability.
  1348. * `time_from_last_punch` is time from last punch (by `puncher`) or `nil`.
  1349. * `tool_capabilities` can be `nil`.
  1350. * `direction` is a unit vector, pointing from the source of the punch to
  1351. the punched object.
  1352. * `damage` damage that will be done to entity
  1353. Return value of this function will determine if damage is done by this function
  1354. (retval true) or shall be done by engine (retval false)
  1355. To punch an entity/object in Lua, call:
  1356. object:punch(puncher, time_from_last_punch, tool_capabilities, direction)
  1357. * Return value is tool wear.
  1358. * Parameters are equal to the above callback.
  1359. * If `direction` equals `nil` and `puncher` does not equal `nil`,
  1360. `direction` will be automatically filled in based on the location of `puncher`.
  1361. Node Metadata
  1362. -------------
  1363. The instance of a node in the world normally only contains the three values
  1364. mentioned in "Nodes". However, it is possible to insert extra data into a
  1365. node. It is called "node metadata"; See `NodeMetaRef`.
  1366. Node metadata contains two things:
  1367. * A key-value store
  1368. * An inventory
  1369. Some of the values in the key-value store are handled specially:
  1370. * `formspec`: Defines a right-click inventory menu. See "Formspec".
  1371. * `infotext`: Text shown on the screen when the node is pointed at
  1372. Example stuff:
  1373. local meta = minetest.get_meta(pos)
  1374. meta:set_string("formspec",
  1375. "size[8,9]"..
  1376. "list[context;main;0,0;8,4;]"..
  1377. "list[current_player;main;0,5;8,4;]")
  1378. meta:set_string("infotext", "Chest");
  1379. local inv = meta:get_inventory()
  1380. inv:set_size("main", 8*4)
  1381. print(dump(meta:to_table()))
  1382. meta:from_table({
  1383. inventory = {
  1384. main = {[1] = "default:dirt", [2] = "", [3] = "", [4] = "",
  1385. [5] = "", [6] = "", [7] = "", [8] = "", [9] = "",
  1386. [10] = "", [11] = "", [12] = "", [13] = "",
  1387. [14] = "default:cobble", [15] = "", [16] = "", [17] = "",
  1388. [18] = "", [19] = "", [20] = "default:cobble", [21] = "",
  1389. [22] = "", [23] = "", [24] = "", [25] = "", [26] = "",
  1390. [27] = "", [28] = "", [29] = "", [30] = "", [31] = "",
  1391. [32] = ""}
  1392. },
  1393. fields = {
  1394. formspec = "size[8,9]list[context;main;0,0;8,4;]list[current_player;main;0,5;8,4;]",
  1395. infotext = "Chest"
  1396. }
  1397. })
  1398. Item Metadata
  1399. -------------
  1400. Item stacks can store metadata too. See `ItemStackMetaRef`.
  1401. Item metadata only contains a key-value store.
  1402. Some of the values in the key-value store are handled specially:
  1403. * `description`: Set the item stack's description. Defaults to `idef.description`
  1404. * `color`: A `ColorString`, which sets the stack's color.
  1405. * `palette_index`: If the item has a palette, this is used to get the
  1406. current color from the palette.
  1407. Example stuff:
  1408. local meta = stack:get_meta()
  1409. meta:set_string("key", "value")
  1410. print(dump(meta:to_table()))
  1411. Formspec
  1412. --------
  1413. Formspec defines a menu. Currently not much else than inventories are
  1414. supported. It is a string, with a somewhat strange format.
  1415. Spaces and newlines can be inserted between the blocks, as is used in the
  1416. examples.
  1417. ### Examples
  1418. #### Chest
  1419. size[8,9]
  1420. list[context;main;0,0;8,4;]
  1421. list[current_player;main;0,5;8,4;]
  1422. #### Furnace
  1423. size[8,9]
  1424. list[context;fuel;2,3;1,1;]
  1425. list[context;src;2,1;1,1;]
  1426. list[context;dst;5,1;2,2;]
  1427. list[current_player;main;0,5;8,4;]
  1428. #### Minecraft-like player inventory
  1429. size[8,7.5]
  1430. image[1,0.6;1,2;player.png]
  1431. list[current_player;main;0,3.5;8,4;]
  1432. list[current_player;craft;3,0;3,3;]
  1433. list[current_player;craftpreview;7,1;1,1;]
  1434. ### Elements
  1435. #### `size[<W>,<H>,<fixed_size>]`
  1436. * Define the size of the menu in inventory slots
  1437. * `fixed_size`: `true`/`false` (optional)
  1438. * deprecated: `invsize[<W>,<H>;]`
  1439. #### `position[<X>,<Y>]`
  1440. * Define the position of the formspec
  1441. * A value between 0.0 and 1.0 represents a position inside the screen
  1442. * The default value is the center of the screen (0.5, 0.5)
  1443. #### `anchor[<X>,<Y>]`
  1444. * Define the anchor of the formspec
  1445. * A value between 0.0 and 1.0 represents an anchor inside the formspec
  1446. * The default value is the center of the formspec (0.5, 0.5)
  1447. #### `container[<X>,<Y>]`
  1448. * Start of a container block, moves all physical elements in the container by (X, Y)
  1449. * Must have matching `container_end`
  1450. * Containers can be nested, in which case the offsets are added
  1451. (child containers are relative to parent containers)
  1452. #### `container_end[]`
  1453. * End of a container, following elements are no longer relative to this container
  1454. #### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;]`
  1455. * Show an inventory list
  1456. #### `list[<inventory location>;<list name>;<X>,<Y>;<W>,<H>;<starting item index>]`
  1457. * Show an inventory list
  1458. #### `listring[<inventory location>;<list name>]`
  1459. * Allows to create a ring of inventory lists
  1460. * Shift-clicking on items in one element of the ring
  1461. will send them to the next inventory list inside the ring
  1462. * The first occurrence of an element inside the ring will
  1463. determine the inventory where items will be sent to
  1464. #### `listring[]`
  1465. * Shorthand for doing `listring[<inventory location>;<list name>]`
  1466. for the last two inventory lists added by list[...]
  1467. #### `listcolors[<slot_bg_normal>;<slot_bg_hover>]`
  1468. * Sets background color of slots as `ColorString`
  1469. * Sets background color of slots on mouse hovering
  1470. #### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>]`
  1471. * Sets background color of slots as `ColorString`
  1472. * Sets background color of slots on mouse hovering
  1473. * Sets color of slots border
  1474. #### `listcolors[<slot_bg_normal>;<slot_bg_hover>;<slot_border>;<tooltip_bgcolor>;<tooltip_fontcolor>]`
  1475. * Sets background color of slots as `ColorString`
  1476. * Sets background color of slots on mouse hovering
  1477. * Sets color of slots border
  1478. * Sets default background color of tooltips
  1479. * Sets default font color of tooltips
  1480. #### `tooltip[<gui_element_name>;<tooltip_text>;<bgcolor>;<fontcolor>]`
  1481. * Adds tooltip for an element
  1482. * `<bgcolor>` tooltip background color as `ColorString` (optional)
  1483. * `<fontcolor>` tooltip font color as `ColorString` (optional)
  1484. #### `image[<X>,<Y>;<W>,<H>;<texture name>]`
  1485. * Show an image
  1486. * Position and size units are inventory slots
  1487. #### `item_image[<X>,<Y>;<W>,<H>;<item name>]`
  1488. * Show an inventory image of registered item/node
  1489. * Position and size units are inventory slots
  1490. #### `bgcolor[<color>;<fullscreen>]`
  1491. * Sets background color of formspec as `ColorString`
  1492. * If `true`, the background color is drawn fullscreen (does not effect the size of the formspec)
  1493. #### `background[<X>,<Y>;<W>,<H>;<texture name>]`
  1494. * Use a background. Inventory rectangles are not drawn then.
  1495. * Position and size units are inventory slots
  1496. * Example for formspec 8x4 in 16x resolution: image shall be sized
  1497. 8 times 16px times 4 times 16px.
  1498. #### `background[<X>,<Y>;<W>,<H>;<texture name>;<auto_clip>]`
  1499. * Use a background. Inventory rectangles are not drawn then.
  1500. * Position and size units are inventory slots
  1501. * Example for formspec 8x4 in 16x resolution:
  1502. image shall be sized 8 times 16px times 4 times 16px
  1503. * If `true` the background is clipped to formspec size
  1504. (`x` and `y` are used as offset values, `w` and `h` are ignored)
  1505. #### `pwdfield[<X>,<Y>;<W>,<H>;<name>;<label>]`
  1506. * Textual password style field; will be sent to server when a button is clicked
  1507. * When enter is pressed in field, fields.key_enter_field will be sent with the name
  1508. of this field.
  1509. * `x` and `y` position the field relative to the top left of the menu
  1510. * `w` and `h` are the size of the field
  1511. * Fields are a set height, but will be vertically centred on `h`
  1512. * Position and size units are inventory slots
  1513. * `name` is the name of the field as returned in fields to `on_receive_fields`
  1514. * `label`, if not blank, will be text printed on the top left above the field
  1515. * See field_close_on_enter to stop enter closing the formspec
  1516. #### `field[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
  1517. * Textual field; will be sent to server when a button is clicked
  1518. * When enter is pressed in field, `fields.key_enter_field` will be sent with the name
  1519. of this field.
  1520. * `x` and `y` position the field relative to the top left of the menu
  1521. * `w` and `h` are the size of the field
  1522. * Fields are a set height, but will be vertically centred on `h`
  1523. * Position and size units are inventory slots
  1524. * `name` is the name of the field as returned in fields to `on_receive_fields`
  1525. * `label`, if not blank, will be text printed on the top left above the field
  1526. * `default` is the default value of the field
  1527. * `default` may contain variable references such as `${text}'` which
  1528. will fill the value from the metadata value `text`
  1529. * **Note**: no extra text or more than a single variable is supported ATM.
  1530. * See `field_close_on_enter` to stop enter closing the formspec
  1531. #### `field[<name>;<label>;<default>]`
  1532. * As above, but without position/size units
  1533. * When enter is pressed in field, `fields.key_enter_field` will be sent with the name
  1534. of this field.
  1535. * Special field for creating simple forms, such as sign text input
  1536. * Must be used without a `size[]` element
  1537. * A "Proceed" button will be added automatically
  1538. * See `field_close_on_enter` to stop enter closing the formspec
  1539. #### `field_close_on_enter[<name>;<close_on_enter>]`
  1540. * <name> is the name of the field
  1541. * if <close_on_enter> is false, pressing enter in the field will submit the form but not close it
  1542. * defaults to true when not specified (ie: no tag for a field)
  1543. #### `textarea[<X>,<Y>;<W>,<H>;<name>;<label>;<default>]`
  1544. * Same as fields above, but with multi-line input
  1545. * if the text overflows a vertical scrollbar is added
  1546. * if the name is empty the textarea is readonly. The label is not displayed then
  1547. #### `label[<X>,<Y>;<label>]`
  1548. * `x` and `y` work as per field
  1549. * `label` is the text on the label
  1550. * Position and size units are inventory slots
  1551. #### `vertlabel[<X>,<Y>;<label>]`
  1552. * Textual label drawn vertically
  1553. * `x` and `y` work as per field
  1554. * `label` is the text on the label
  1555. * Position and size units are inventory slots
  1556. #### `button[<X>,<Y>;<W>,<H>;<name>;<label>]`
  1557. * Clickable button. When clicked, fields will be sent.
  1558. * `x`, `y` and `name` work as per field
  1559. * `w` and `h` are the size of the button
  1560. * Fixed button height. It will be vertically centred on `h`
  1561. * `label` is the text on the button
  1562. * Position and size units are inventory slots
  1563. #### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
  1564. * `x`, `y`, `w`, `h`, and `name` work as per button
  1565. * `texture name` is the filename of an image
  1566. * Position and size units are inventory slots
  1567. #### `image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>;<noclip>;<drawborder>;<pressed texture name>]`
  1568. * `x`, `y`, `w`, `h`, and `name` work as per button
  1569. * `texture name` is the filename of an image
  1570. * Position and size units are inventory slots
  1571. * `noclip=true` means the image button doesn't need to be within specified formsize
  1572. * `drawborder`: draw button border or not
  1573. * `pressed texture name` is the filename of an image on pressed state
  1574. #### `item_image_button[<X>,<Y>;<W>,<H>;<item name>;<name>;<label>]`
  1575. * `x`, `y`, `w`, `h`, `name` and `label` work as per button
  1576. * `item name` is the registered name of an item/node,
  1577. tooltip will be made out of its description
  1578. to override it use tooltip element
  1579. * Position and size units are inventory slots
  1580. #### `button_exit[<X>,<Y>;<W>,<H>;<name>;<label>]`
  1581. * When clicked, fields will be sent and the form will quit.
  1582. #### `image_button_exit[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]`
  1583. * When clicked, fields will be sent and the form will quit.
  1584. #### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>]`
  1585. * Scrollable item list showing arbitrary text elements
  1586. * `x` and `y` position the itemlist relative to the top left of the menu
  1587. * `w` and `h` are the size of the itemlist
  1588. * `name` fieldname sent to server on doubleclick value is current selected element
  1589. * `listelements` can be prepended by #color in hexadecimal format RRGGBB (only),
  1590. * if you want a listelement to start with "#" write "##".
  1591. #### `textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>;<selected idx>;<transparent>]`
  1592. * Scrollable itemlist showing arbitrary text elements
  1593. * `x` and `y` position the item list relative to the top left of the menu
  1594. * `w` and `h` are the size of the item list
  1595. * `name` fieldname sent to server on doubleclick value is current selected element
  1596. * `listelements` can be prepended by #RRGGBB (only) in hexadecimal format
  1597. * if you want a listelement to start with "#" write "##"
  1598. * Index to be selected within textlist
  1599. * `true`/`false`: draw transparent background
  1600. * See also `minetest.explode_textlist_event` (main menu: `engine.explode_textlist_event`)
  1601. #### `tabheader[<X>,<Y>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]`
  1602. * Show a tab**header** at specific position (ignores formsize)
  1603. * `x` and `y` position the itemlist relative to the top left of the menu
  1604. * `name` fieldname data is transferred to Lua
  1605. * `caption 1`...: name shown on top of tab
  1606. * `current_tab`: index of selected tab 1...
  1607. * `transparent` (optional): show transparent
  1608. * `draw_border` (optional): draw border
  1609. #### `box[<X>,<Y>;<W>,<H>;<color>]`
  1610. * Simple colored semitransparent box
  1611. * `x` and `y` position the box relative to the top left of the menu
  1612. * `w` and `h` are the size of box
  1613. * `color` is color specified as a `ColorString`
  1614. #### `dropdown[<X>,<Y>;<W>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>]`
  1615. * Show a dropdown field
  1616. * **Important note**: There are two different operation modes:
  1617. 1. handle directly on change (only changed dropdown is submitted)
  1618. 2. read the value on pressing a button (all dropdown values are available)
  1619. * `x` and `y` position of dropdown
  1620. * Width of dropdown
  1621. * Fieldname data is transferred to Lua
  1622. * Items to be shown in dropdown
  1623. * Index of currently selected dropdown item
  1624. #### `checkbox[<X>,<Y>;<name>;<label>;<selected>]`
  1625. * Show a checkbox
  1626. * `x` and `y`: position of checkbox
  1627. * `name` fieldname data is transferred to Lua
  1628. * `label` to be shown left of checkbox
  1629. * `selected` (optional): `true`/`false`
  1630. #### `scrollbar[<X>,<Y>;<W>,<H>;<orientation>;<name>;<value>]`
  1631. * Show a scrollbar
  1632. * There are two ways to use it:
  1633. 1. handle the changed event (only changed scrollbar is available)
  1634. 2. read the value on pressing a button (all scrollbars are available)
  1635. * `x` and `y`: position of trackbar
  1636. * `w` and `h`: width and height
  1637. * `orientation`: `vertical`/`horizontal`
  1638. * Fieldname data is transferred to Lua
  1639. * Value this trackbar is set to (`0`-`1000`)
  1640. * See also `minetest.explode_scrollbar_event` (main menu: `engine.explode_scrollbar_event`)
  1641. #### `table[<X>,<Y>;<W>,<H>;<name>;<cell 1>,<cell 2>,...,<cell n>;<selected idx>]`
  1642. * Show scrollable table using options defined by the previous `tableoptions[]`
  1643. * Displays cells as defined by the previous `tablecolumns[]`
  1644. * `x` and `y`: position the itemlist relative to the top left of the menu
  1645. * `w` and `h` are the size of the itemlist
  1646. * `name`: fieldname sent to server on row select or doubleclick
  1647. * `cell 1`...`cell n`: cell contents given in row-major order
  1648. * `selected idx`: index of row to be selected within table (first row = `1`)
  1649. * See also `minetest.explode_table_event` (main menu: `engine.explode_table_event`)
  1650. #### `tableoptions[<opt 1>;<opt 2>;...]`
  1651. * Sets options for `table[]`
  1652. * `color=#RRGGBB`
  1653. * default text color (`ColorString`), defaults to `#FFFFFF`
  1654. * `background=#RRGGBB`
  1655. * table background color (`ColorString`), defaults to `#000000`
  1656. * `border=<true/false>`
  1657. * should the table be drawn with a border? (default: `true`)
  1658. * `highlight=#RRGGBB`
  1659. * highlight background color (`ColorString`), defaults to `#466432`
  1660. * `highlight_text=#RRGGBB`
  1661. * highlight text color (`ColorString`), defaults to `#FFFFFF`
  1662. * `opendepth=<value>`
  1663. * all subtrees up to `depth < value` are open (default value = `0`)
  1664. * only useful when there is a column of type "tree"
  1665. #### `tablecolumns[<type 1>,<opt 1a>,<opt 1b>,...;<type 2>,<opt 2a>,<opt 2b>;...]`
  1666. * Sets columns for `table[]`
  1667. * Types: `text`, `image`, `color`, `indent`, `tree`
  1668. * `text`: show cell contents as text
  1669. * `image`: cell contents are an image index, use column options to define images
  1670. * `color`: cell contents are a ColorString and define color of following cell
  1671. * `indent`: cell contents are a number and define indentation of following cell
  1672. * `tree`: same as indent, but user can open and close subtrees (treeview-like)
  1673. * Column options:
  1674. * `align=<value>`
  1675. * for `text` and `image`: content alignment within cells.
  1676. Available values: `left` (default), `center`, `right`, `inline`
  1677. * `width=<value>`
  1678. * for `text` and `image`: minimum width in em (default: `0`)
  1679. * for `indent` and `tree`: indent width in em (default: `1.5`)
  1680. * `padding=<value>`: padding left of the column, in em (default `0.5`).
  1681. Exception: defaults to 0 for indent columns
  1682. * `tooltip=<value>`: tooltip text (default: empty)
  1683. * `image` column options:
  1684. * `0=<value>` sets image for image index 0
  1685. * `1=<value>` sets image for image index 1
  1686. * `2=<value>` sets image for image index 2
  1687. * and so on; defined indices need not be contiguous empty or
  1688. non-numeric cells are treated as `0`.
  1689. * `color` column options:
  1690. * `span=<value>`: number of following columns to affect (default: infinite)
  1691. **Note**: do _not_ use a element name starting with `key_`; those names are reserved to
  1692. pass key press events to formspec!
  1693. Inventory locations
  1694. -------------------
  1695. * `"context"`: Selected node metadata (deprecated: `"current_name"`)
  1696. * `"current_player"`: Player to whom the menu is shown
  1697. * `"player:<name>"`: Any player
  1698. * `"nodemeta:<X>,<Y>,<Z>"`: Any node metadata
  1699. * `"detached:<name>"`: A detached inventory
  1700. Player Inventory lists
  1701. ----------------------
  1702. * `main`: list containing the default inventory
  1703. * `craft`: list containing the craft input
  1704. * `craftpreview`: list containing the craft output
  1705. * `hand`: list containing an override for the empty hand
  1706. `ColorString`
  1707. -------------
  1708. `#RGB` defines a color in hexadecimal format.
  1709. `#RGBA` defines a color in hexadecimal format and alpha channel.
  1710. `#RRGGBB` defines a color in hexadecimal format.
  1711. `#RRGGBBAA` defines a color in hexadecimal format and alpha channel.
  1712. Named colors are also supported and are equivalent to
  1713. [CSS Color Module Level 4](http://dev.w3.org/csswg/css-color/#named-colors).
  1714. To specify the value of the alpha channel, append `#AA` to the end of the color name
  1715. (e.g. `colorname#08`). For named colors the hexadecimal string representing the alpha
  1716. value must (always) be two hexadecimal digits.
  1717. `ColorSpec`
  1718. -----------
  1719. A ColorSpec specifies a 32-bit color. It can be written in either:
  1720. table form, each element ranging from 0..255 (a, if absent, defaults to 255):
  1721. `colorspec = {a=255, r=0, g=255, b=0}`
  1722. numerical form, the raw integer value of an ARGB8 quad:
  1723. `colorspec = 0xFF00FF00`
  1724. or string form, a ColorString (defined above):
  1725. `colorspec = "green"`
  1726. Escape sequences
  1727. ----------------
  1728. Most text can contain escape sequences, that can for example color the text.
  1729. There are a few exceptions: tab headers, dropdowns and vertical labels can't.
  1730. The following functions provide escape sequences:
  1731. * `minetest.get_color_escape_sequence(color)`:
  1732. * `color` is a ColorString
  1733. * The escape sequence sets the text color to `color`
  1734. * `minetest.colorize(color, message)`:
  1735. * Equivalent to:
  1736. `minetest.get_color_escape_sequence(color) ..
  1737. message ..
  1738. minetest.get_color_escape_sequence("#ffffff")`
  1739. * `minetest.get_background_escape_sequence(color)`
  1740. * `color` is a ColorString
  1741. * The escape sequence sets the background of the whole text element to
  1742. `color`. Only defined for item descriptions and tooltips.
  1743. * `minetest.strip_foreground_colors(str)`
  1744. * Removes foreground colors added by `get_color_escape_sequence`.
  1745. * `minetest.strip_background_colors(str)`
  1746. * Removes background colors added by `get_background_escape_sequence`.
  1747. * `minetest.strip_colors(str)`
  1748. * Removes all color escape sequences.
  1749. Spatial Vectors
  1750. ---------------
  1751. * `vector.new(a[, b, c])`: returns a vector:
  1752. * A copy of `a` if `a` is a vector.
  1753. * `{x = a, y = b, z = c}`, if all `a, b, c` are defined
  1754. * `vector.direction(p1, p2)`: returns a vector
  1755. * `vector.distance(p1, p2)`: returns a number
  1756. * `vector.length(v)`: returns a number
  1757. * `vector.normalize(v)`: returns a vector
  1758. * `vector.floor(v)`: returns a vector, each dimension rounded down
  1759. * `vector.round(v)`: returns a vector, each dimension rounded to nearest int
  1760. * `vector.apply(v, func)`: returns a vector
  1761. * `vector.equals(v1, v2)`: returns a boolean
  1762. * `vector.sort(v1, v2)`: returns minp, maxp vectors of the cuboid defined by v1 and v2
  1763. For the following functions `x` can be either a vector or a number:
  1764. * `vector.add(v, x)`: returns a vector
  1765. * `vector.subtract(v, x)`: returns a vector
  1766. * `vector.multiply(v, x)`: returns a scaled vector or Schur product
  1767. * `vector.divide(v, x)`: returns a scaled vector or Schur quotient
  1768. Helper functions
  1769. ----------------
  1770. * `dump2(obj, name, dumped)`: returns a string which makes `obj` human readable,
  1771. handles reference loops
  1772. * `obj`: arbitrary variable
  1773. * `name`: string, default: `"_"`
  1774. * `dumped`: table, default: `{}`
  1775. * `dump(obj, dumped)`: returns a string which makes `obj` human readable
  1776. * `obj`: arbitrary variable
  1777. * `dumped`: table, default: `{}`
  1778. * `math.hypot(x, y)`
  1779. * Get the hypotenuse of a triangle with legs x and y.
  1780. Useful for distance calculation.
  1781. * `math.sign(x, tolerance)`: returns `-1`, `0` or `1`
  1782. * Get the sign of a number.
  1783. * tolerance: number, default: `0.0`
  1784. * If the absolute value of `x` is within the `tolerance` or `x` is NaN,
  1785. `0` is returned.
  1786. * `string.split(str, separator, include_empty, max_splits, sep_is_pattern)`
  1787. * `separator`: string, default: `","`
  1788. * `include_empty`: boolean, default: `false`
  1789. * `max_splits`: number, if it's positive, splits aren't limited,
  1790. default: `-1`
  1791. * `sep_is_pattern`: boolean, it specifies whether separator is a plain
  1792. string or a pattern (regex), default: `false`
  1793. * e.g. `"a,b":split","` returns `{"a","b"}`
  1794. * `string:trim()`: returns the string whithout whitespace pre- and suffixes
  1795. * e.g. `"\n \t\tfoo bar\t ":trim()` returns `"foo bar"`
  1796. * `minetest.wrap_text(str, limit, as_table)`: returns a string or table
  1797. * Adds newlines to the string to keep it within the specified character
  1798. limit
  1799. * Note that the returned lines may be longer than the limit since it only
  1800. splits at word borders.
  1801. * `limit`: number, maximal amount of characters in one line
  1802. * `as_table`: boolean, if set to true, a table of lines instead of a string
  1803. is returned, default: `false`
  1804. * `minetest.pos_to_string(pos, decimal_places)`: returns string `"(X,Y,Z)"`
  1805. * `pos`: table {x=X, y=Y, z=Z}
  1806. * Converts the position `pos` to a human-readable, printable string
  1807. * `decimal_places`: number, if specified, the x, y and z values of
  1808. the position are rounded to the given decimal place.
  1809. * `minetest.string_to_pos(string)`: returns a position or `nil`
  1810. * Same but in reverse.
  1811. * If the string can't be parsed to a position, nothing is returned.
  1812. * `minetest.string_to_area("(X1, Y1, Z1) (X2, Y2, Z2)")`: returns two positions
  1813. * Converts a string representing an area box into two positions
  1814. * `minetest.formspec_escape(string)`: returns a string
  1815. * escapes the characters "[", "]", "\", "," and ";", which can not be used in formspecs
  1816. * `minetest.is_yes(arg)`
  1817. * returns true if passed 'y', 'yes', 'true' or a number that isn't zero.
  1818. * `minetest.get_us_time()`
  1819. * returns time with microsecond precision. May not return wall time.
  1820. * `table.copy(table)`: returns a table
  1821. * returns a deep copy of `table`
  1822. * `minetest.pointed_thing_to_face_pos(placer, pointed_thing)`: returns a position
  1823. * returns the exact position on the surface of a pointed node
  1824. Translations
  1825. ------------
  1826. Texts can be translated client-side with the help of `minetest.translate` and translation files.
  1827. ### Translating a string
  1828. Two functions are provided to translate strings: `minetest.translate` and `minetest.get_translator`.
  1829. * `minetest.get_translator(textdomain)` is a simple wrapper around `minetest.translate`, and
  1830. `minetest.get_translator(textdomain)(str, ...)` is equivalent to `minetest.translate(textdomain, str, ...)`.
  1831. It is intended to be used in the following way, so that it avoids verbose repetitions of `minetest.translate`:
  1832. local S = minetest.get_translator(textdomain)
  1833. S(str, ...)
  1834. As an extra commodity, if `textdomain` is nil, it is assumed to be "" instead.
  1835. * `minetest.translate(textdomain, str, ...)` translates the string `str` with the given `textdomain`
  1836. for disambiguation. The textdomain must match the textdomain specified in the translation file in order
  1837. to get the string translated. This can be used so that a string is translated differently in different contexts.
  1838. It is advised to use the name of the mod as textdomain whenever possible, to avoid clashes with other mods.
  1839. This function must be given a number of arguments equal to the number of arguments the translated string expects.
  1840. Arguments are literal strings -- they will not be translated, so if you want them to be, they need to come as
  1841. outputs of `minetest.translate` as well.
  1842. For instance, suppose we want to translate "@1 Wool" with "@1" being replaced by the translation of "Red".
  1843. We can do the following:
  1844. local S = minetest.get_translator()
  1845. S("@1 Wool", S("Red"))
  1846. This will be displayed as "Red Wool" on old clients and on clients that do not have localization enabled.
  1847. However, if we have for instance a translation file named `wool.fr.tr` containing the following:
  1848. @1 Wool=Laine @1
  1849. Red=Rouge
  1850. this will be displayed as "Laine Rouge" on clients with a French locale.
  1851. ### Operations on translated strings
  1852. The output of `minetest.translate` is a string, with escape sequences adding additional information to that string
  1853. so that it can be translated on the different clients. In particular, you can't expect operations like string.length
  1854. to work on them like you would expect them to, or string.gsub to work in the expected manner. However, string
  1855. concatenation will still work as expected (note that you should only use this for things like formspecs; do not
  1856. translate sentences by breaking them into parts; arguments should be used instead), and operations such as
  1857. `minetest.colorize` which are only concatenation under the hood as well.
  1858. ### Translation file format
  1859. A translation file has the suffix `.[lang].tr`, where `[lang]` is the language it corresponds to.
  1860. The file should be a text file, with the following format:
  1861. * Lines beginning with `# textdomain:` (the space is significant) can be used to specify the text
  1862. domain of all following translations in the file.
  1863. * All other empty lines or lines beginning with `#` are ignored.
  1864. * Other lines should be in the format `original=translated`. Both `original` and `translated` can
  1865. contain escape sequences beginning with `@` to insert arguments, literal `@`, `=` or newline
  1866. (See ### Escapes below). There must be no extraneous whitespace around the `=` or at the beginning
  1867. or the end of the line.
  1868. ### Escapes
  1869. Strings that need to be translated can contain several escapes, preceded by `@`.
  1870. * `@@` acts as a literal `@`.
  1871. * `@n`, where `n` is a digit between 1 and 9, is an argument for the translated string that will be inlined
  1872. when translation. Due to how translations are implemented, the original translation string **must** have
  1873. its arguments in increasing order, without gaps or repetitions, starting from 1.
  1874. * `@=` acts as a literal `=`. It is not required in strings given to `minetest.translate`, but is in translation
  1875. files to avoid begin confused with the `=` separating the original from the translation.
  1876. * `@\n` (where the `\n` is a literal newline) acts as a literal newline. As with `@=`, this escape is not required
  1877. in strings given to `minetest.translate`, but is in translation files.
  1878. * `@n` acts as a literal newline as well.
  1879. `minetest` namespace reference
  1880. ------------------------------
  1881. ### Utilities
  1882. * `minetest.get_current_modname()`: returns the currently loading mod's name, when we are loading a mod
  1883. * `minetest.get_modpath(modname)`: returns e.g. `"/home/user/.minetest/usermods/modname"`
  1884. * Useful for loading additional `.lua` modules or static data from mod
  1885. * `minetest.get_modnames()`: returns a list of installed mods
  1886. * Return a list of installed mods, sorted alphabetically
  1887. * `minetest.get_worldpath()`: returns e.g. `"/home/user/.minetest/world"`
  1888. * Useful for storing custom data
  1889. * `minetest.is_singleplayer()`
  1890. * `minetest.features`: Table containing API feature flags
  1891. {
  1892. glasslike_framed = true,
  1893. nodebox_as_selectionbox = true,
  1894. chat_send_player_param3 = true,
  1895. get_all_craft_recipes_works = true,
  1896. use_texture_alpha = true,
  1897. -- ^ The transparency channel of textures can be used optionally
  1898. no_legacy_abms = true,
  1899. -- ^ Tree and grass ABMs are no longer done from C++
  1900. texture_names_parens = true,
  1901. -- ^ Texture grouping is possible using parentheses
  1902. area_store_custom_ids = true,
  1903. -- ^ Unique Area ID for AreaStore:insert_area
  1904. add_entity_with_staticdata = true,
  1905. -- ^ add_entity supports passing initial staticdata to on_activate
  1906. no_chat_message_prediction = true,
  1907. -- ^ Chat messages are no longer predicted
  1908. }
  1909. * `minetest.has_feature(arg)`: returns `boolean, missing_features`
  1910. * `arg`: string or table in format `{foo=true, bar=true}`
  1911. * `missing_features`: `{foo=true, bar=true}`
  1912. * `minetest.get_player_information(player_name)`:
  1913. * Returns a table containing information about a player. Example return value:
  1914. {
  1915. address = "127.0.0.1", -- IP address of client
  1916. ip_version = 4, -- IPv4 / IPv6
  1917. min_rtt = 0.01, -- minimum round trip time
  1918. max_rtt = 0.2, -- maximum round trip time
  1919. avg_rtt = 0.02, -- average round trip time
  1920. min_jitter = 0.01, -- minimum packet time jitter
  1921. max_jitter = 0.5, -- maximum packet time jitter
  1922. avg_jitter = 0.03, -- average packet time jitter
  1923. connection_uptime = 200, -- seconds since client connected
  1924. protocol_version = 32, -- protocol version used by client
  1925. -- following information is available on debug build only!!!
  1926. -- DO NOT USE IN MODS
  1927. --ser_vers = 26, -- serialization version used by client
  1928. --major = 0, -- major version number
  1929. --minor = 4, -- minor version number
  1930. --patch = 10, -- patch version number
  1931. --vers_string = "0.4.9-git", -- full version string
  1932. --state = "Active" -- current client state
  1933. }
  1934. * `minetest.mkdir(path)`: returns success.
  1935. * Creates a directory specified by `path`, creating parent directories
  1936. if they don't exist.
  1937. * `minetest.get_dir_list(path, [is_dir])`: returns list of entry names
  1938. * is_dir is one of:
  1939. * nil: return all entries,
  1940. * true: return only subdirectory names, or
  1941. * false: return only file names.
  1942. * `minetest.safe_file_write(path, content)`: returns boolean indicating success
  1943. * Replaces contents of file at path with new contents in a safe (atomic) way.
  1944. Use this instead of below code when writing e.g. database files:
  1945. `local f = io.open(path, "wb"); f:write(content); f:close()`
  1946. * `minetest.get_version()`: returns a table containing components of the
  1947. engine version. Components:
  1948. * `project`: Name of the project, eg, "Minetest"
  1949. * `string`: Simple version, eg, "1.2.3-dev"
  1950. * `hash`: Full git version (only set if available), eg, "1.2.3-dev-01234567-dirty"
  1951. Use this for informational purposes only. The information in the returned
  1952. table does not represent the capabilities of the engine, nor is it
  1953. reliable or verifiable. Compatible forks will have a different name and
  1954. version entirely. To check for the presence of engine features, test
  1955. whether the functions exported by the wanted features exist. For example:
  1956. `if minetest.check_for_falling then ... end`.
  1957. * `minetest.sha1(data, [raw])`: returns the sha1 hash of data
  1958. * `data`: string of data to hash
  1959. * `raw`: return raw bytes instead of hex digits, default: false
  1960. ### Logging
  1961. * `minetest.debug(...)`
  1962. * Equivalent to `minetest.log(table.concat({...}, "\t"))`
  1963. * `minetest.log([level,] text)`
  1964. * `level` is one of `"none"`, `"error"`, `"warning"`, `"action"`,
  1965. `"info"`, or `"verbose"`. Default is `"none"`.
  1966. ### Registration functions
  1967. Call these functions only at load time!
  1968. * `minetest.register_entity(name, prototype table)`
  1969. * `minetest.register_abm(abm definition)`
  1970. * `minetest.register_lbm(lbm definition)`
  1971. * `minetest.register_node(name, node definition)`
  1972. * `minetest.register_tool(name, item definition)`
  1973. * `minetest.register_craftitem(name, item definition)`
  1974. * `minetest.unregister_item(name)`
  1975. * `minetest.register_alias(name, convert_to)`
  1976. * Also use this to set the 'mapgen aliases' needed in a game for the core
  1977. * mapgens. See 'Mapgen aliases' section above.
  1978. * `minetest.register_alias_force(name, convert_to)`
  1979. * `minetest.register_craft(recipe)`
  1980. * Check recipe table syntax for different types below.
  1981. * `minetest.clear_craft(recipe)`
  1982. * Will erase existing craft based either on output item or on input recipe.
  1983. * Specify either output or input only. If you specify both, input will be ignored. For input use the same recipe table
  1984. syntax as for `minetest.register_craft(recipe)`. For output specify only the item, without a quantity.
  1985. * If no erase candidate could be found, Lua exception will be thrown.
  1986. * **Warning**! The type field ("shaped","cooking" or any other) will be ignored if the recipe
  1987. contains output. Erasing is then done independently from the crafting method.
  1988. * `minetest.register_ore(ore definition)`
  1989. * `minetest.register_biome(biome definition)`
  1990. * `minetest.register_decoration(decoration definition)`
  1991. * `minetest.override_item(name, redefinition)`
  1992. * Overrides fields of an item registered with register_node/tool/craftitem.
  1993. * Note: Item must already be defined, (opt)depend on the mod defining it.
  1994. * Example: `minetest.override_item("default:mese", {light_source=LIGHT_MAX})`
  1995. * `minetest.clear_registered_ores()`
  1996. * `minetest.clear_registered_biomes()`
  1997. * `minetest.clear_registered_decorations()`
  1998. ### Global callback registration functions
  1999. Call these functions only at load time!
  2000. * `minetest.register_globalstep(func(dtime))`
  2001. * Called every server step, usually interval of 0.1s
  2002. * `minetest.register_on_shutdown(func())`
  2003. * Called before server shutdown
  2004. * **Warning**: If the server terminates abnormally (i.e. crashes), the registered
  2005. callbacks **will likely not be run**. Data should be saved at
  2006. semi-frequent intervals as well as on server shutdown.
  2007. * `minetest.register_on_placenode(func(pos, newnode, placer, oldnode, itemstack, pointed_thing))`
  2008. * Called when a node has been placed
  2009. * If return `true` no item is taken from `itemstack`
  2010. * `placer` may be any valid ObjectRef or nil.
  2011. * **Not recommended**; use `on_construct` or `after_place_node` in node definition
  2012. whenever possible
  2013. * `minetest.register_on_dignode(func(pos, oldnode, digger))`
  2014. * Called when a node has been dug.
  2015. * **Not recommended**; Use `on_destruct` or `after_dig_node` in node definition
  2016. whenever possible
  2017. * `minetest.register_on_punchnode(func(pos, node, puncher, pointed_thing))`
  2018. * Called when a node is punched
  2019. * `minetest.register_on_generated(func(minp, maxp, blockseed))`
  2020. * Called after generating a piece of world. Modifying nodes inside the area
  2021. is a bit faster than usually.
  2022. * `minetest.register_on_newplayer(func(ObjectRef))`
  2023. * Called after a new player has been created
  2024. * `minetest.register_on_dieplayer(func(ObjectRef))`
  2025. * Called when a player dies
  2026. * `minetest.register_on_punchplayer(func(player, hitter, time_from_last_punch, tool_capabilities, dir, damage))`
  2027. * Called when a player is punched
  2028. * `player` - ObjectRef - Player that was punched
  2029. * `hitter` - ObjectRef - Player that hit
  2030. * `time_from_last_punch`: Meant for disallowing spamming of clicks (can be nil)
  2031. * `tool_capabilities`: capability table of used tool (can be nil)
  2032. * `dir`: unit vector of direction of punch. Always defined. Points from
  2033. the puncher to the punched.
  2034. * `damage` - number that represents the damage calculated by the engine
  2035. * should return `true` to prevent the default damage mechanism
  2036. * `minetest.register_on_player_hpchange(func(player, hp_change), modifier)`
  2037. * Called when the player gets damaged or healed
  2038. * `player`: ObjectRef of the player
  2039. * `hp_change`: the amount of change. Negative when it is damage.
  2040. * `modifier`: when true, the function should return the actual `hp_change`.
  2041. Note: modifiers only get a temporary hp_change that can be modified by later modifiers.
  2042. modifiers can return true as a second argument to stop the execution of further functions.
  2043. Non-modifiers receive the final hp change calculated by the modifiers.
  2044. * `minetest.register_on_respawnplayer(func(ObjectRef))`
  2045. * Called when player is to be respawned
  2046. * Called _before_ repositioning of player occurs
  2047. * return true in func to disable regular player placement
  2048. * `minetest.register_on_prejoinplayer(func(name, ip))`
  2049. * Called before a player joins the game
  2050. * If it returns a string, the player is disconnected with that string as reason
  2051. * `minetest.register_on_joinplayer(func(ObjectRef))`
  2052. * Called when a player joins the game
  2053. * `minetest.register_on_leaveplayer(func(ObjectRef, timed_out))`
  2054. * Called when a player leaves the game
  2055. * `timed_out`: True for timeout, false for other reasons.
  2056. * `minetest.register_on_cheat(func(ObjectRef, cheat))`
  2057. * Called when a player cheats
  2058. * `cheat`: `{type=<cheat_type>}`, where `<cheat_type>` is one of:
  2059. * `moved_too_fast`
  2060. * `interacted_too_far`
  2061. * `interacted_while_dead`
  2062. * `finished_unknown_dig`
  2063. * `dug_unbreakable`
  2064. * `dug_too_fast`
  2065. * `minetest.register_on_chat_message(func(name, message))`
  2066. * Called always when a player says something
  2067. * Return `true` to mark the message as handled, which means that it will not be sent to other players
  2068. * `minetest.register_on_player_receive_fields(func(player, formname, fields))`
  2069. * Called when a button is pressed in player's inventory form
  2070. * Newest functions are called first
  2071. * If function returns `true`, remaining functions are not called
  2072. * `minetest.register_on_craft(func(itemstack, player, old_craft_grid, craft_inv))`
  2073. * Called when `player` crafts something
  2074. * `itemstack` is the output
  2075. * `old_craft_grid` contains the recipe (Note: the one in the inventory is cleared)
  2076. * `craft_inv` is the inventory with the crafting grid
  2077. * Return either an `ItemStack`, to replace the output, or `nil`, to not modify it
  2078. * `minetest.register_craft_predict(func(itemstack, player, old_craft_grid, craft_inv))`
  2079. * The same as before, except that it is called before the player crafts, to make
  2080. craft prediction, and it should not change anything.
  2081. * `minetest.register_on_protection_violation(func(pos, name))`
  2082. * Called by `builtin` and mods when a player violates protection at a position
  2083. (eg, digs a node or punches a protected entity).
  2084. * The registered functions can be called using `minetest.record_protection_violation`
  2085. * The provided function should check that the position is protected by the mod
  2086. calling this function before it prints a message, if it does, to allow for
  2087. multiple protection mods.
  2088. * `minetest.register_on_item_eat(func(hp_change, replace_with_item, itemstack, user, pointed_thing))`
  2089. * Called when an item is eaten, by `minetest.item_eat`
  2090. * Return `true` or `itemstack` to cancel the default item eat response (i.e.: hp increase)
  2091. * `minetest.register_on_priv_grant(function(name, granter, priv))`
  2092. * Called when `granter` grants the priv `priv` to `name`.
  2093. * Note that the callback will be called twice if it's done by a player, once with granter being the player name,
  2094. and again with granter being nil.
  2095. * `minetest.register_on_priv_revoke(function(name, revoker, priv))`
  2096. * Called when `revoker` revokes the priv `priv` from `name`.
  2097. * Note that the callback will be called twice if it's done by a player, once with revoker being the player name,
  2098. and again with revoker being nil.
  2099. * `minetest.register_can_bypass_userlimit(function(name, ip))`
  2100. * Called when `name` user connects with `ip`.
  2101. * Return `true` to by pass the player limit
  2102. * `minetest.register_on_modchannel_message(func(channel_name, sender, message))`
  2103. * Called when an incoming mod channel message is received
  2104. * You should have joined some channels to receive events.
  2105. * If message comes from a server mod, `sender` field is an empty string.
  2106. ### Other registration functions
  2107. * `minetest.register_chatcommand(cmd, chatcommand definition)`
  2108. * Adds definition to `minetest.registered_chatcommands`
  2109. * `minetest.override_chatcommand(name, redefinition)`
  2110. * Overrides fields of a chatcommand registered with `register_chatcommand`.
  2111. * `minetest.unregister_chatcommand(name)`
  2112. * Unregisters a chatcommands registered with `register_chatcommand`.
  2113. * `minetest.register_privilege(name, definition)`
  2114. * `definition`: `"description text"`
  2115. * `definition`: `{ description = "description text", give_to_singleplayer = boolean}`
  2116. the default of `give_to_singleplayer` is true
  2117. * To allow players with `basic_privs` to grant, see `basic_privs` minetest.conf setting.
  2118. * `on_grant(name, granter_name)`: Called when given to player `name` by `granter_name`.
  2119. `granter_name` will be nil if the priv was granted by a mod.
  2120. * `on_revoke(name, revoker_name)`: Called when taken from player `name` by `revoker_name`.
  2121. `revoker_name` will be nil if the priv was revoked by a mod
  2122. * Note that the above two callbacks will be called twice if a player is responsible -
  2123. once with the player name, and then with a nil player name.
  2124. * Return true in the above callbacks to stop register_on_priv_grant or revoke being called.
  2125. * `minetest.register_authentication_handler(authentication handler definition)`
  2126. * Registers an auth handler that overrides the builtin one
  2127. * This function can be called by a single mod once only.
  2128. ### Setting-related
  2129. * `minetest.settings`: Settings object containing all of the settings from the
  2130. main config file (`minetest.conf`).
  2131. * `minetest.setting_get_pos(name)`: Loads a setting from the main settings and
  2132. parses it as a position (in the format `(1,2,3)`). Returns a position or nil.
  2133. ### Authentication
  2134. * `minetest.string_to_privs(str)`: returns `{priv1=true,...}`
  2135. * `minetest.privs_to_string(privs)`: returns `"priv1,priv2,..."`
  2136. * Convert between two privilege representations
  2137. * `minetest.get_player_privs(name) -> {priv1=true,...}`
  2138. * `minetest.check_player_privs(player_or_name, ...)`: returns `bool, missing_privs`
  2139. * A quickhand for checking privileges.
  2140. * `player_or_name`: Either a Player object or the name of a player.
  2141. * `...` is either a list of strings, e.g. `"priva", "privb"` or
  2142. a table, e.g. `{ priva = true, privb = true }`.
  2143. * `minetest.check_password_entry(name, entry, password)`
  2144. * Returns true if the "password entry" for a player with name matches given
  2145. password, false otherwise.
  2146. * The "password entry" is the password representation generated by the engine
  2147. as returned as part of a `get_auth()` call on the auth handler.
  2148. * Only use this function for making it possible to log in via password from
  2149. external protocols such as IRC, other uses are frowned upon.
  2150. * `minetest.get_password_hash(name, raw_password)`
  2151. * Convert a name-password pair to a password hash that Minetest can use.
  2152. * The returned value alone is not a good basis for password checks based
  2153. on comparing the password hash in the database with the password hash
  2154. from the function, with an externally provided password, as the hash
  2155. in the db might use the new SRP verifier format.
  2156. * For this purpose, use `minetest.check_password_entry` instead.
  2157. * `minetest.get_player_ip(name)`: returns an IP address string for the player `name`
  2158. * The player needs to be online for this to be successful.
  2159. * `minetest.get_auth_handler()`: Return the currently active auth handler
  2160. * See the `Authentication handler definition`
  2161. * Use this to e.g. get the authentication data for a player:
  2162. `local auth_data = minetest.get_auth_handler().get_auth(playername)`
  2163. * `minetest.notify_authentication_modified(name)`
  2164. * Must be called by the authentication handler for privilege changes.
  2165. * `name`: string; if omitted, all auth data should be considered modified
  2166. * `minetest.set_player_password(name, password_hash)`: Set password hash of player `name`
  2167. * `minetest.set_player_privs(name, {priv1=true,...})`: Set privileges of player `name`
  2168. * `minetest.auth_reload()`
  2169. * See `reload()` in authentication handler definition
  2170. `minetest.set_player_password`, `minetest_set_player_privs`, `minetest_get_player_privs`
  2171. and `minetest.auth_reload` call the authentication handler.
  2172. ### Chat
  2173. * `minetest.chat_send_all(text)`
  2174. * `minetest.chat_send_player(name, text)`
  2175. ### Environment access
  2176. * `minetest.set_node(pos, node)`
  2177. * `minetest.add_node(pos, node): alias to `minetest.set_node`
  2178. * Set node at position `pos`
  2179. * `node`: table `{name=string, param1=number, param2=number}`
  2180. * If param1 or param2 is omitted, it's set to `0`.
  2181. * e.g. `minetest.set_node({x=0, y=10, z=0}, {name="default:wood"})`
  2182. * `minetest.swap_node(pos, node)`
  2183. * Set node at position, but don't remove metadata
  2184. * `minetest.remove_node(pos)`
  2185. * By default it does the same as `minetest.set_node(pos, {name="air"})`
  2186. * `minetest.get_node(pos)`
  2187. * Returns the node at the given position as table in the format
  2188. `{name="node_name", param1=0, param2=0}`, returns `{name="ignore", param1=0, param2=0}`
  2189. for unloaded areas.
  2190. * `minetest.get_node_or_nil(pos)`
  2191. * Same as `get_node` but returns `nil` for unloaded areas.
  2192. * `minetest.get_node_light(pos, timeofday)`
  2193. * Gets the light value at the given position. Note that the light value
  2194. "inside" the node at the given position is returned, so you usually want
  2195. to get the light value of a neighbor.
  2196. * `pos`: The position where to measure the light.
  2197. * `timeofday`: `nil` for current time, `0` for night, `0.5` for day
  2198. * Returns a number between `0` and `15` or `nil`
  2199. * `minetest.place_node(pos, node)`
  2200. * Place node with the same effects that a player would cause
  2201. * `minetest.dig_node(pos)`
  2202. * Dig node with the same effects that a player would cause
  2203. * Returns `true` if successful, `false` on failure (e.g. protected location)
  2204. * `minetest.punch_node(pos)`
  2205. * Punch node with the same effects that a player would cause
  2206. * `minetest.spawn_falling_node(pos)`
  2207. * Change node into falling node
  2208. * Returns `true` if successful, `false` on failure
  2209. * `minetest.find_nodes_with_meta(pos1, pos2)`
  2210. * Get a table of positions of nodes that have metadata within a region {pos1, pos2}
  2211. * `minetest.get_meta(pos)`
  2212. * Get a `NodeMetaRef` at that position
  2213. * `minetest.get_node_timer(pos)`
  2214. * Get `NodeTimerRef`
  2215. * `minetest.add_entity(pos, name, [staticdata])`: Spawn Lua-defined entity at position
  2216. * Returns `ObjectRef`, or `nil` if failed
  2217. * `minetest.add_item(pos, item)`: Spawn item
  2218. * Returns `ObjectRef`, or `nil` if failed
  2219. * `minetest.get_player_by_name(name)`: Get an `ObjectRef` to a player
  2220. * `minetest.get_objects_inside_radius(pos, radius)`: returns a list of ObjectRefs
  2221. * `radius`: using an euclidean metric
  2222. * `minetest.set_timeofday(val)`
  2223. * `val` is between `0` and `1`; `0` for midnight, `0.5` for midday
  2224. * `minetest.get_timeofday()`
  2225. * `minetest.get_gametime()`: returns the time, in seconds, since the world was created
  2226. * `minetest.get_day_count()`: returns number days elapsed since world was created,
  2227. * accounting for time changes.
  2228. * `minetest.find_node_near(pos, radius, nodenames, [search_center])`: returns pos or `nil`
  2229. * `radius`: using a maximum metric
  2230. * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
  2231. * `search_center` is an optional boolean (default: `false`)
  2232. If true `pos` is also checked for the nodes
  2233. * `minetest.find_nodes_in_area(pos1, pos2, nodenames)`: returns a list of positions
  2234. * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
  2235. * First return value: Table with all node positions
  2236. * Second return value: Table with the count of each node with the node name as index
  2237. * `minetest.find_nodes_in_area_under_air(pos1, pos2, nodenames)`: returns a list of positions
  2238. * `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
  2239. * Return value: Table with all node positions with a node air above
  2240. * `minetest.get_perlin(noiseparams)`
  2241. * `minetest.get_perlin(seeddiff, octaves, persistence, scale)`
  2242. * Return world-specific perlin noise (`int(worldseed)+seeddiff`)
  2243. * `minetest.get_voxel_manip([pos1, pos2])`
  2244. * Return voxel manipulator object.
  2245. * Loads the manipulator from the map if positions are passed.
  2246. * `minetest.set_gen_notify(flags, {deco_ids})`
  2247. * Set the types of on-generate notifications that should be collected
  2248. * `flags` is a flag field with the available flags: `dungeon`, `temple`, `cave_begin`,
  2249. `cave_end`, `large_cave_begin`, `large_cave_end`, `decoration`
  2250. * The second parameter is a list of IDS of decorations which notification is requested for
  2251. * `get_gen_notify()`: returns a flagstring and a table with the `deco_id`s
  2252. * `minetest.get_mapgen_object(objectname)`
  2253. * Return requested mapgen object if available (see "Mapgen objects")
  2254. * `minetest.get_biome_id(biome_name)`
  2255. * Returns the biome id, as used in the biomemap Mapgen object, for a
  2256. given biome_name string.
  2257. * `minetest.get_mapgen_params()` Returns mapgen parameters, a table containing
  2258. `mgname`, `seed`, `chunksize`, `water_level`, and `flags`.
  2259. * Deprecated: use `minetest.get_mapgen_setting(name)` instead
  2260. * `minetest.set_mapgen_params(MapgenParams)`
  2261. * Deprecated: use `minetest.set_mapgen_setting(name, value, override)` instead
  2262. * Set map generation parameters
  2263. * Function cannot be called after the registration period; only initialization
  2264. and `on_mapgen_init`
  2265. * Takes a table as an argument with the fields `mgname`, `seed`, `water_level`,
  2266. and `flags`.
  2267. * Leave field unset to leave that parameter unchanged
  2268. * `flags` contains a comma-delimited string of flags to set,
  2269. or if the prefix `"no"` is attached, clears instead.
  2270. * `flags` is in the same format and has the same options as `mg_flags` in `minetest.conf`
  2271. * `minetest.get_mapgen_setting(name)`
  2272. * Gets the *active* mapgen setting (or nil if none exists) in string format with the following
  2273. order of precedence:
  2274. 1) Settings loaded from map_meta.txt or overrides set during mod execution
  2275. 2) Settings set by mods without a metafile override
  2276. 3) Settings explicitly set in the user config file, minetest.conf
  2277. 4) Settings set as the user config default
  2278. * `minetest.get_mapgen_setting_noiseparams(name)`
  2279. * Same as above, but returns the value as a NoiseParams table if the setting `name` exists
  2280. and is a valid NoiseParams
  2281. * `minetest.set_mapgen_setting(name, value, [override_meta])`
  2282. * Sets a mapgen param to `value`, and will take effect if the corresponding mapgen setting
  2283. is not already present in map_meta.txt.
  2284. * `override_meta` is an optional boolean (default: `false`). If this is set to true,
  2285. the setting will become the active setting regardless of the map metafile contents.
  2286. * Note: to set the seed, use `"seed"`, not `"fixed_map_seed"`
  2287. * `minetest.set_mapgen_setting_noiseparams(name, value, [override_meta])`
  2288. * Same as above, except value is a NoiseParams table.
  2289. * `minetest.set_noiseparams(name, noiseparams, set_default)`
  2290. * Sets the noiseparams setting of `name` to the noiseparams table specified in `noiseparams`.
  2291. * `set_default` is an optional boolean (default: `true`) that specifies whether the setting
  2292. should be applied to the default config or current active config
  2293. * `minetest.get_noiseparams(name)`: returns a table of the noiseparams for name
  2294. * `minetest.generate_ores(vm, pos1, pos2)`
  2295. * Generate all registered ores within the VoxelManip `vm` and in the area from `pos1` to `pos2`.
  2296. * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
  2297. * `minetest.generate_decorations(vm, pos1, pos2)`
  2298. * Generate all registered decorations within the VoxelManip `vm` and in the area from `pos1` to `pos2`.
  2299. * `pos1` and `pos2` are optional and default to mapchunk minp and maxp.
  2300. * `minetest.clear_objects([options])`
  2301. * Clear all objects in the environment
  2302. * Takes an optional table as an argument with the field `mode`.
  2303. * mode = `"full"`: Load and go through every mapblock, clearing objects (default).
  2304. * mode = `"quick"`: Clear objects immediately in loaded mapblocks;
  2305. clear objects in unloaded mapblocks only when the mapblocks are next activated.
  2306. * `minetest.emerge_area(pos1, pos2, [callback], [param])`
  2307. * Queue all blocks in the area from `pos1` to `pos2`, inclusive, to be asynchronously
  2308. * fetched from memory, loaded from disk, or if inexistent, generates them.
  2309. * If `callback` is a valid Lua function, this will be called for each block emerged.
  2310. * The function signature of callback is:
  2311. * `function EmergeAreaCallback(blockpos, action, calls_remaining, param)`
  2312. * - `blockpos` is the *block* coordinates of the block that had been emerged
  2313. * - `action` could be one of the following constant values:
  2314. * `minetest.EMERGE_CANCELLED`, `minetest.EMERGE_ERRORED`, `minetest.EMERGE_FROM_MEMORY`,
  2315. * `minetest.EMERGE_FROM_DISK`, `minetest.EMERGE_GENERATED`
  2316. * - `calls_remaining` is the number of callbacks to be expected after this one
  2317. * - `param` is the user-defined parameter passed to emerge_area (or nil if the
  2318. * parameter was absent)
  2319. * `minetest.delete_area(pos1, pos2)`
  2320. * delete all mapblocks in the area from pos1 to pos2, inclusive
  2321. * `minetest.line_of_sight(pos1, pos2, stepsize)`: returns `boolean, pos`
  2322. * Check if there is a direct line of sight between `pos1` and `pos2`
  2323. * Returns the position of the blocking node when `false`
  2324. * `pos1`: First position
  2325. * `pos2`: Second position
  2326. * `stepsize`: smaller gives more accurate results but requires more computing
  2327. time. Default is `1`.
  2328. * `minetest.raycast(pos1, pos2, objects, liquids)`: returns `Raycast`
  2329. * Creates a `Raycast` object.
  2330. * `pos1`: start of the ray
  2331. * `pos2`: end of the ray
  2332. * `objects` : if false, only nodes will be returned. Default is `true`.
  2333. * `liquids' : if false, liquid nodes won't be returned. Default is `false`.
  2334. * `minetest.find_path(pos1,pos2,searchdistance,max_jump,max_drop,algorithm)`
  2335. * returns table containing path
  2336. * returns a table of 3D points representing a path from `pos1` to `pos2` or `nil`
  2337. * `pos1`: start position
  2338. * `pos2`: end position
  2339. * `searchdistance`: number of blocks to search in each direction using a maximum metric
  2340. * `max_jump`: maximum height difference to consider walkable
  2341. * `max_drop`: maximum height difference to consider droppable
  2342. * `algorithm`: One of `"A*_noprefetch"` (default), `"A*"`, `"Dijkstra"`
  2343. * `minetest.spawn_tree (pos, {treedef})`
  2344. * spawns L-system tree at given `pos` with definition in `treedef` table
  2345. * `minetest.transforming_liquid_add(pos)`
  2346. * add node to liquid update queue
  2347. * `minetest.get_node_max_level(pos)`
  2348. * get max available level for leveled node
  2349. * `minetest.get_node_level(pos)`
  2350. * get level of leveled node (water, snow)
  2351. * `minetest.set_node_level(pos, level)`
  2352. * set level of leveled node, default `level` equals `1`
  2353. * if `totallevel > maxlevel`, returns rest (`total-max`).
  2354. * `minetest.add_node_level(pos, level)`
  2355. * increase level of leveled node by level, default `level` equals `1`
  2356. * if `totallevel > maxlevel`, returns rest (`total-max`)
  2357. * can be negative for decreasing
  2358. * `minetest.fix_light(pos1, pos2)`: returns `true`/`false`
  2359. * resets the light in a cuboid-shaped part of
  2360. the map and removes lighting bugs.
  2361. * Loads the area if it is not loaded.
  2362. * `pos1` is the corner of the cuboid with the least coordinates
  2363. (in node coordinates), inclusive.
  2364. * `pos2` is the opposite corner of the cuboid, inclusive.
  2365. * The actual updated cuboid might be larger than the specified one,
  2366. because only whole map blocks can be updated.
  2367. The actual updated area consists of those map blocks that intersect
  2368. with the given cuboid.
  2369. * However, the neighborhood of the updated area might change
  2370. as well, as light can spread out of the cuboid, also light
  2371. might be removed.
  2372. * returns `false` if the area is not fully generated,
  2373. `true` otherwise
  2374. * `minetest.check_single_for_falling(pos)`
  2375. * causes an unsupported `group:falling_node` node to fall and causes an
  2376. unattached `group:attached_node` node to fall.
  2377. * does not spread these updates to neighbours.
  2378. * `minetest.check_for_falling(pos)`
  2379. * causes an unsupported `group:falling_node` node to fall and causes an
  2380. unattached `group:attached_node` node to fall.
  2381. * spread these updates to neighbours and can cause a cascade
  2382. of nodes to fall.
  2383. ### Mod channels
  2384. You can find mod channels communication scheme in `docs/mod_channels.png`.
  2385. * `minetest.mod_channel_join(channel_name)`
  2386. * Server joins channel `channel_name`, and creates it if necessary. You
  2387. should listen from incoming messages with `minetest.register_on_modchannel_message`
  2388. call to receive incoming messages
  2389. ### Inventory
  2390. `minetest.get_inventory(location)`: returns an `InvRef`
  2391. * `location` = e.g.
  2392. * `{type="player", name="celeron55"}`
  2393. * `{type="node", pos={x=, y=, z=}}`
  2394. * `{type="detached", name="creative"}`
  2395. * `minetest.create_detached_inventory(name, callbacks, [player_name])`: returns an `InvRef`
  2396. * callbacks: See "Detached inventory callbacks"
  2397. * `player_name`: Make detached inventory available to one player exclusively,
  2398. by default they will be sent to every player (even if not used).
  2399. Note that this parameter is mostly just a workaround and will be removed in future releases.
  2400. * Creates a detached inventory. If it already exists, it is cleared.
  2401. * `minetest.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)`:
  2402. returns left over ItemStack
  2403. * See `minetest.item_eat` and `minetest.register_on_item_eat`
  2404. ### Formspec
  2405. * `minetest.show_formspec(playername, formname, formspec)`
  2406. * `playername`: name of player to show formspec
  2407. * `formname`: name passed to `on_player_receive_fields` callbacks.
  2408. It should follow the `"modname:<whatever>"` naming convention
  2409. * `formspec`: formspec to display
  2410. * `minetest.close_formspec(playername, formname)`
  2411. * `playername`: name of player to close formspec
  2412. * `formname`: has to exactly match the one given in `show_formspec`, or the formspec will
  2413. not close.
  2414. * calling `show_formspec(playername, formname, "")` is equal to this expression
  2415. * to close a formspec regardless of the formname, call
  2416. `minetest.close_formspec(playername, "")`. **USE THIS ONLY WHEN ABSOLUTELY NECESSARY!**
  2417. * `minetest.formspec_escape(string)`: returns a string
  2418. * escapes the characters "[", "]", "\", "," and ";", which can not be used in formspecs
  2419. * `minetest.explode_table_event(string)`: returns a table
  2420. * returns e.g. `{type="CHG", row=1, column=2}`
  2421. * `type` is one of:
  2422. * `"INV"`: no row selected)
  2423. * `"CHG"`: selected)
  2424. * `"DCL"`: double-click
  2425. * `minetest.explode_textlist_event(string)`: returns a table
  2426. * returns e.g. `{type="CHG", index=1}`
  2427. * `type` is one of:
  2428. * `"INV"`: no row selected)
  2429. * `"CHG"`: selected)
  2430. * `"DCL"`: double-click
  2431. * `minetest.explode_scrollbar_event(string)`: returns a table
  2432. * returns e.g. `{type="CHG", value=500}`
  2433. * `type` is one of:
  2434. * `"INV"`: something failed
  2435. * `"CHG"`: has been changed
  2436. * `"VAL"`: not changed
  2437. ### Item handling
  2438. * `minetest.inventorycube(img1, img2, img3)`
  2439. * Returns a string for making an image of a cube (useful as an item image)
  2440. * `minetest.get_pointed_thing_position(pointed_thing, above)`
  2441. * Get position of a `pointed_thing` (that you can get from somewhere)
  2442. * `minetest.dir_to_facedir(dir, is6d)`
  2443. * Convert a vector to a facedir value, used in `param2` for `paramtype2="facedir"`;
  2444. * passing something non-`nil`/`false` for the optional second parameter causes it to
  2445. take the y component into account
  2446. * `minetest.facedir_to_dir(facedir)`
  2447. * Convert a facedir back into a vector aimed directly out the "back" of a node
  2448. * `minetest.dir_to_wallmounted(dir)`
  2449. * Convert a vector to a wallmounted value, used for `paramtype2="wallmounted"`
  2450. * `minetest.wallmounted_to_dir(wallmounted)`
  2451. * Convert a wallmounted value back into a vector aimed directly out the "back" of a node
  2452. * `minetest.dir_to_yaw(dir)`
  2453. * Convert a vector into a yaw (angle)
  2454. * `minetest.yaw_to_dir(yaw)`
  2455. * Convert yaw (angle) to a vector
  2456. * `minetest.is_colored_paramtype(ptype)`
  2457. * Returns a boolean. Returns `true` if the given `paramtype2` contains color
  2458. information (`color`, `colorwallmounted` or `colorfacedir`).
  2459. * `minetest.strip_param2_color(param2, paramtype2)`
  2460. * Removes everything but the color information from the
  2461. given `param2` value.
  2462. * Returns `nil` if the given `paramtype2` does not contain color information
  2463. * `minetest.get_node_drops(nodename, toolname)`
  2464. * Returns list of item names.
  2465. * **Note**: This will be removed or modified in a future version.
  2466. * `minetest.get_craft_result(input)`: returns `output, decremented_input`
  2467. * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
  2468. * `input.width` = for example `3`
  2469. * `input.items` = for example
  2470. `{ stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9 }`
  2471. * `output.item` = `ItemStack`, if unsuccessful: empty `ItemStack`
  2472. * `output.time` = a number, if unsuccessful: `0`
  2473. * `output.replacements` = list of `ItemStack`s that couldn't be placed in
  2474. `decremented_input.items`
  2475. * `decremented_input` = like `input`
  2476. * `minetest.get_craft_recipe(output)`: returns input
  2477. * returns last registered recipe for output item (node)
  2478. * `output` is a node or item type such as `"default:torch"`
  2479. * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
  2480. * `input.width` = for example `3`
  2481. * `input.items` = for example
  2482. `{ stack1, stack2, stack3, stack4, stack 5, stack 6, stack 7, stack 8, stack 9 }`
  2483. * `input.items` = `nil` if no recipe found
  2484. * `minetest.get_all_craft_recipes(query item)`: returns a table or `nil`
  2485. * returns indexed table with all registered recipes for query item (node)
  2486. or `nil` if no recipe was found
  2487. * recipe entry table:
  2488. {
  2489. method = 'normal' or 'cooking' or 'fuel'
  2490. width = 0-3, 0 means shapeless recipe
  2491. items = indexed [1-9] table with recipe items
  2492. output = string with item name and quantity
  2493. }
  2494. * Example query for `"default:gold_ingot"` will return table:
  2495. {
  2496. [1]={method = "cooking", width = 3, output = "default:gold_ingot",
  2497. items = {1 = "default:gold_lump"}},
  2498. [2]={method = "normal", width = 1, output = "default:gold_ingot 9",
  2499. items = {1 = "default:goldblock"}}
  2500. }
  2501. * `minetest.handle_node_drops(pos, drops, digger)`
  2502. * `drops`: list of itemstrings
  2503. * Handles drops from nodes after digging: Default action is to put them into
  2504. digger's inventory
  2505. * Can be overridden to get different functionality (e.g. dropping items on
  2506. ground)
  2507. * `minetest.itemstring_with_palette(item, palette_index)`: returns an item string
  2508. * Creates an item string which contains palette index information
  2509. for hardware colorization. You can use the returned string
  2510. as an output in a craft recipe.
  2511. * `item`: the item stack which becomes colored. Can be in string,
  2512. table and native form.
  2513. * `palette_index`: this index is added to the item stack
  2514. * `minetest.itemstring_with_color(item, colorstring)`: returns an item string
  2515. * Creates an item string which contains static color information
  2516. for hardware colorization. Use this method if you wish to colorize
  2517. an item that does not own a palette. You can use the returned string
  2518. as an output in a craft recipe.
  2519. * `item`: the item stack which becomes colored. Can be in string,
  2520. table and native form.
  2521. * `colorstring`: the new color of the item stack
  2522. ### Rollback
  2523. * `minetest.rollback_get_node_actions(pos, range, seconds, limit)`:
  2524. returns `{{actor, pos, time, oldnode, newnode}, ...}`
  2525. * Find who has done something to a node, or near a node
  2526. * `actor`: `"player:<name>"`, also `"liquid"`.
  2527. * `minetest.rollback_revert_actions_by(actor, seconds)`: returns `boolean, log_messages`
  2528. * Revert latest actions of someone
  2529. * `actor`: `"player:<name>"`, also `"liquid"`.
  2530. ### Defaults for the `on_*` item definition functions
  2531. These functions return the leftover itemstack.
  2532. * `minetest.item_place_node(itemstack, placer, pointed_thing, param2)`
  2533. * Place item as a node
  2534. * `param2` overrides `facedir` and wallmounted `param2`
  2535. * returns `itemstack, success`
  2536. * `minetest.item_place_object(itemstack, placer, pointed_thing)`
  2537. * Place item as-is
  2538. * `minetest.item_place(itemstack, placer, pointed_thing, param2)`
  2539. * Use one of the above based on what the item is.
  2540. * Calls `on_rightclick` of `pointed_thing.under` if defined instead
  2541. * **Note**: is not called when wielded item overrides `on_place`
  2542. * `param2` overrides `facedir` and wallmounted `param2`
  2543. * returns `itemstack, success`
  2544. * `minetest.item_drop(itemstack, dropper, pos)`
  2545. * Drop the item
  2546. * `minetest.item_eat(hp_change, replace_with_item)`
  2547. * Eat the item.
  2548. * `replace_with_item` is the itemstring which is added to the inventory.
  2549. If the player is eating a stack, then replace_with_item goes to a
  2550. different spot. Can be `nil`
  2551. * See `minetest.do_item_eat`
  2552. ### Defaults for the `on_punch` and `on_dig` node definition callbacks
  2553. * `minetest.node_punch(pos, node, puncher, pointed_thing)`
  2554. * Calls functions registered by `minetest.register_on_punchnode()`
  2555. * `minetest.node_dig(pos, node, digger)`
  2556. * Checks if node can be dug, puts item into inventory, removes node
  2557. * Calls functions registered by `minetest.registered_on_dignodes()`
  2558. ### Sounds
  2559. * `minetest.sound_play(spec, parameters)`: returns a handle
  2560. * `spec` is a `SimpleSoundSpec`
  2561. * `parameters` is a sound parameter table
  2562. * `minetest.sound_stop(handle)`
  2563. * `minetest.sound_fade(handle, step, gain)`
  2564. * `handle` is a handle returned by `minetest.sound_play`
  2565. * `step` determines how fast a sound will fade.
  2566. Negative step will lower the sound volume, positive step will increase the sound volume
  2567. * `gain` the target gain for the fade.
  2568. ### Timing
  2569. * `minetest.after(time, func, ...)`
  2570. * Call the function `func` after `time` seconds, may be fractional
  2571. * Optional: Variable number of arguments that are passed to `func`
  2572. ### Server
  2573. * `minetest.request_shutdown([message],[reconnect],[delay])`: request for server shutdown. Will display `message` to clients,
  2574. `reconnect` == true displays a reconnect button,
  2575. `delay` adds an optional delay (in seconds) before shutdown
  2576. negative delay cancels the current active shutdown
  2577. zero delay triggers an immediate shutdown.
  2578. * `minetest.cancel_shutdown_requests()`: cancel current delayed shutdown
  2579. * `minetest.get_server_status()`: returns server status string
  2580. * `minetest.get_server_uptime()`: returns the server uptime in seconds
  2581. * `minetest.remove_player(name)`: remove player from database (if he is not connected).
  2582. * Does not remove player authentication data, minetest.player_exists will continue to return true.
  2583. * Returns a code (0: successful, 1: no such player, 2: player is connected)
  2584. ### Bans
  2585. * `minetest.get_ban_list()`: returns the ban list (same as `minetest.get_ban_description("")`)
  2586. * `minetest.get_ban_description(ip_or_name)`: returns ban description (string)
  2587. * `minetest.ban_player(name)`: ban a player
  2588. * `minetest.unban_player_or_ip(name)`: unban player or IP address
  2589. * `minetest.kick_player(name, [reason])`: disconnect a player with a optional reason
  2590. ### Particles
  2591. * `minetest.add_particle(particle definition)`
  2592. * Deprecated: `minetest.add_particle(pos, velocity, acceleration, expirationtime,
  2593. size, collisiondetection, texture, playername)`
  2594. * `minetest.add_particlespawner(particlespawner definition)`
  2595. * Add a `ParticleSpawner`, an object that spawns an amount of particles over `time` seconds
  2596. * Returns an `id`, and -1 if adding didn't succeed
  2597. * `Deprecated: minetest.add_particlespawner(amount, time,
  2598. minpos, maxpos,
  2599. minvel, maxvel,
  2600. minacc, maxacc,
  2601. minexptime, maxexptime,
  2602. minsize, maxsize,
  2603. collisiondetection, texture, playername)`
  2604. * `minetest.delete_particlespawner(id, player)`
  2605. * Delete `ParticleSpawner` with `id` (return value from `minetest.add_particlespawner`)
  2606. * If playername is specified, only deletes on the player's client,
  2607. * otherwise on all clients
  2608. ### Schematics
  2609. * `minetest.create_schematic(p1, p2, probability_list, filename, slice_prob_list)`
  2610. * Create a schematic from the volume of map specified by the box formed by p1 and p2.
  2611. * Apply the specified probability and per-node force-place to the specified nodes
  2612. according to the `probability_list`.
  2613. * `probability_list` is an array of tables containing two fields, `pos` and `prob`.
  2614. * `pos` is the 3D vector specifying the absolute coordinates of the
  2615. node being modified,
  2616. * `prob` is an integer value from `0` to `255` that encodes probability and
  2617. per-node force-place. Probability has levels 0-127, then 128 is added to
  2618. encode per-node force-place.
  2619. For probability stated as 0-255, divide by 2 and round down to get values
  2620. 0-127, then add 128 to apply per-node force-place.
  2621. * If there are two or more entries with the same pos value, the
  2622. last entry is used.
  2623. * If `pos` is not inside the box formed by `p1` and `p2`, it is ignored.
  2624. * If `probability_list` equals `nil`, no probabilities are applied.
  2625. * Apply the specified probability to the specified horizontal slices according to the
  2626. `slice_prob_list`.
  2627. * `slice_prob_list` is an array of tables containing two fields, `ypos` and `prob`.
  2628. * `ypos` indicates the y position of the slice with a probability applied,
  2629. the lowest slice being `ypos = 0`.
  2630. * If slice probability list equals `nil`, no slice probabilities are applied.
  2631. * Saves schematic in the Minetest Schematic format to filename.
  2632. * `minetest.place_schematic(pos, schematic, rotation, replacements, force_placement)`
  2633. * Place the schematic specified by schematic (see: Schematic specifier) at `pos`.
  2634. * `rotation` can equal `"0"`, `"90"`, `"180"`, `"270"`, or `"random"`.
  2635. * If the `rotation` parameter is omitted, the schematic is not rotated.
  2636. * `replacements` = `{["old_name"] = "convert_to", ...}`
  2637. * `force_placement` is a boolean indicating whether nodes other than `air` and
  2638. `ignore` are replaced by the schematic
  2639. * Returns nil if the schematic could not be loaded.
  2640. * `minetest.place_schematic_on_vmanip(vmanip, pos, schematic, rotation, replacement, force_placement)`:
  2641. * This function is analogous to minetest.place_schematic, but places a schematic onto the
  2642. specified VoxelManip object `vmanip` instead of the whole map.
  2643. * Returns false if any part of the schematic was cut-off due to the VoxelManip not
  2644. containing the full area required, and true if the whole schematic was able to fit.
  2645. * Returns nil if the schematic could not be loaded.
  2646. * After execution, any external copies of the VoxelManip contents are invalidated.
  2647. * `minetest.serialize_schematic(schematic, format, options)`
  2648. * Return the serialized schematic specified by schematic (see: Schematic specifier)
  2649. * in the `format` of either "mts" or "lua".
  2650. * "mts" - a string containing the binary MTS data used in the MTS file format
  2651. * "lua" - a string containing Lua code representing the schematic in table format
  2652. * `options` is a table containing the following optional parameters:
  2653. * If `lua_use_comments` is true and `format` is "lua", the Lua code generated will have (X, Z)
  2654. * position comments for every X row generated in the schematic data for easier reading.
  2655. * If `lua_num_indent_spaces` is a nonzero number and `format` is "lua", the Lua code generated
  2656. * will use that number of spaces as indentation instead of a tab character.
  2657. ### HTTP Requests:
  2658. * `minetest.request_http_api()`:
  2659. * returns `HTTPApiTable` containing http functions if the calling mod has been granted
  2660. access by being listed in the `secure.http_mods` or `secure.trusted_mods` setting,
  2661. otherwise returns `nil`.
  2662. * The returned table contains the functions `fetch`, `fetch_async` and `fetch_async_get`
  2663. described below.
  2664. * Only works at init time and must be called from the mod's main scope (not from a function).
  2665. * Function only exists if minetest server was built with cURL support.
  2666. * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED TABLE, STORE IT IN
  2667. A LOCAL VARIABLE!**
  2668. * `HTTPApiTable.fetch(HTTPRequest req, callback)`
  2669. * Performs given request asynchronously and calls callback upon completion
  2670. * callback: `function(HTTPRequestResult res)`
  2671. * Use this HTTP function if you are unsure, the others are for advanced use.
  2672. * `HTTPApiTable.fetch_async(HTTPRequest req)`: returns handle
  2673. * Performs given request asynchronously and returns handle for `HTTPApiTable.fetch_async_get`
  2674. * `HTTPApiTable.fetch_async_get(handle)`: returns HTTPRequestResult
  2675. * Return response data for given asynchronous HTTP request
  2676. ### Storage API:
  2677. * `minetest.get_mod_storage()`:
  2678. * returns reference to mod private `StorageRef`
  2679. * must be called during mod load time
  2680. ### Misc.
  2681. * `minetest.get_connected_players()`: returns list of `ObjectRefs`
  2682. * `minetest.player_exists(name)`: boolean, whether player exists (regardless of online status)
  2683. * `minetest.hud_replace_builtin(name, hud_definition)`
  2684. * Replaces definition of a builtin hud element
  2685. * `name`: `"breath"` or `"health"`
  2686. * `hud_definition`: definition to replace builtin definition
  2687. * `minetest.send_join_message(player_name)`
  2688. * This function can be overridden by mods to change the join message.
  2689. * `minetest.send_leave_message(player_name, timed_out)`
  2690. * This function can be overridden by mods to change the leave message.
  2691. * `minetest.hash_node_position(pos)`: returns an 48-bit integer
  2692. * `pos`: table {x=number, y=number, z=number},
  2693. * Gives a unique hash number for a node position (16+16+16=48bit)
  2694. * `minetest.get_position_from_hash(hash)`: returns a position
  2695. * Inverse transform of `minetest.hash_node_position`
  2696. * `minetest.get_item_group(name, group)`: returns a rating
  2697. * Get rating of a group of an item. (`0` means: not in group)
  2698. * `minetest.get_node_group(name, group)`: returns a rating
  2699. * Deprecated: An alias for the former.
  2700. * `minetest.raillike_group(name)`: returns a rating
  2701. * Returns rating of the connect_to_raillike group corresponding to name
  2702. * If name is not yet the name of a connect_to_raillike group, a new group id
  2703. * is created, with that name
  2704. * `minetest.get_content_id(name)`: returns an integer
  2705. * Gets the internal content ID of `name`
  2706. * `minetest.get_name_from_content_id(content_id)`: returns a string
  2707. * Gets the name of the content with that content ID
  2708. * `minetest.parse_json(string[, nullvalue])`: returns something
  2709. * Convert a string containing JSON data into the Lua equivalent
  2710. * `nullvalue`: returned in place of the JSON null; defaults to `nil`
  2711. * On success returns a table, a string, a number, a boolean or `nullvalue`
  2712. * On failure outputs an error message and returns `nil`
  2713. * Example: `parse_json("[10, {\"a\":false}]")`, returns `{10, {a = false}}`
  2714. * `minetest.write_json(data[, styled])`: returns a string or `nil` and an error message
  2715. * Convert a Lua table into a JSON string
  2716. * styled: Outputs in a human-readable format if this is set, defaults to false
  2717. * Unserializable things like functions and userdata will cause an error.
  2718. * **Warning**: JSON is more strict than the Lua table format.
  2719. 1. You can only use strings and positive integers of at least one as keys.
  2720. 2. You can not mix string and integer keys.
  2721. This is due to the fact that JSON has two distinct array and object values.
  2722. * Example: `write_json({10, {a = false}})`, returns `"[10, {\"a\": false}]"`
  2723. * `minetest.serialize(table)`: returns a string
  2724. * Convert a table containing tables, strings, numbers, booleans and `nil`s
  2725. into string form readable by `minetest.deserialize`
  2726. * Example: `serialize({foo='bar'})`, returns `'return { ["foo"] = "bar" }'`
  2727. * `minetest.deserialize(string)`: returns a table
  2728. * Convert a string returned by `minetest.deserialize` into a table
  2729. * `string` is loaded in an empty sandbox environment.
  2730. * Will load functions, but they cannot access the global environment.
  2731. * Example: `deserialize('return { ["foo"] = "bar" }')`, returns `{foo='bar'}`
  2732. * Example: `deserialize('print("foo")')`, returns `nil` (function call fails)
  2733. * `error:[string "print("foo")"]:1: attempt to call global 'print' (a nil value)`
  2734. * `minetest.compress(data, method, ...)`: returns `compressed_data`
  2735. * Compress a string of data.
  2736. * `method` is a string identifying the compression method to be used.
  2737. * Supported compression methods:
  2738. * Deflate (zlib): `"deflate"`
  2739. * `...` indicates method-specific arguments. Currently defined arguments are:
  2740. * Deflate: `level` - Compression level, `0`-`9` or `nil`.
  2741. * `minetest.decompress(compressed_data, method, ...)`: returns data
  2742. * Decompress a string of data (using ZLib).
  2743. * See documentation on `minetest.compress()` for supported compression methods.
  2744. * currently supported.
  2745. * `...` indicates method-specific arguments. Currently, no methods use this.
  2746. * `minetest.rgba(red, green, blue[, alpha])`: returns a string
  2747. * Each argument is a 8 Bit unsigned integer
  2748. * Returns the ColorString from rgb or rgba values
  2749. * Example: `minetest.rgba(10, 20, 30, 40)`, returns `"#0A141E28"`
  2750. * `minetest.encode_base64(string)`: returns string encoded in base64
  2751. * Encodes a string in base64.
  2752. * `minetest.decode_base64(string)`: returns string
  2753. * Decodes a string encoded in base64.
  2754. * `minetest.is_protected(pos, name)`: returns boolean
  2755. * Returns true, if player `name` shouldn't be abled to dig at `pos` or do other
  2756. actions, definable by mods, due to some mod-defined ownership-like concept.
  2757. Returns false or nil, if the player is allowed to do such actions.
  2758. * `name` will be "" for non-players or unknown players.
  2759. * This function should be overridden by protection mods and should be used to
  2760. check if a player can interact at a position.
  2761. * This function should call the old version of itself if the position is not
  2762. protected by the mod.
  2763. * Example:
  2764. local old_is_protected = minetest.is_protected
  2765. function minetest.is_protected(pos, name)
  2766. if mymod:position_protected_from(pos, name) then
  2767. return true
  2768. end
  2769. return old_is_protected(pos, name)
  2770. end
  2771. * `minetest.record_protection_violation(pos, name)`
  2772. * This function calls functions registered with
  2773. `minetest.register_on_protection_violation`.
  2774. * `minetest.rotate_and_place(itemstack, placer, pointed_thing, infinitestacks, orient_flags)`
  2775. * Attempt to predict the desired orientation of the facedir-capable node
  2776. defined by `itemstack`, and place it accordingly (on-wall, on the floor, or
  2777. hanging from the ceiling). Stacks are handled normally if the `infinitestacks`
  2778. field is false or omitted (else, the itemstack is not changed). `orient_flags`
  2779. is an optional table containing extra tweaks to the placement code:
  2780. * `invert_wall`: if `true`, place wall-orientation on the ground and ground-
  2781. orientation on the wall.
  2782. * `force_wall` : if `true`, always place the node in wall orientation.
  2783. * `force_ceiling`: if `true`, always place on the ceiling.
  2784. * `force_floor`: if `true`, always place the node on the floor.
  2785. * `force_facedir`: if `true`, forcefully reset the facedir to north when placing on
  2786. the floor or ceiling
  2787. * The first four options are mutually-exclusive; the last in the list takes
  2788. precedence over the first.
  2789. * `minetest.rotate_node(itemstack, placer, pointed_thing)`
  2790. * calls `rotate_and_place()` with infinitestacks set according to the state of
  2791. the creative mode setting, and checks for "sneak" to set the `invert_wall`
  2792. parameter.
  2793. * `minetest.forceload_block(pos[, transient])`
  2794. * forceloads the position `pos`.
  2795. * returns `true` if area could be forceloaded
  2796. * If `transient` is `false` or absent, the forceload will be persistent
  2797. (saved between server runs). If `true`, the forceload will be transient
  2798. (not saved between server runs).
  2799. * `minetest.forceload_free_block(pos[, transient])`
  2800. * stops forceloading the position `pos`
  2801. * If `transient` is `false` or absent, frees a persistent forceload.
  2802. If `true`, frees a transient forceload.
  2803. * `minetest.request_insecure_environment()`: returns an environment containing
  2804. insecure functions if the calling mod has been listed as trusted in the
  2805. `secure.trusted_mods` setting or security is disabled, otherwise returns `nil`.
  2806. * Only works at init time and must be called from the mod's main scope (not from a function).
  2807. * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED ENVIRONMENT, STORE IT IN
  2808. A LOCAL VARIABLE!**
  2809. * `minetest.global_exists(name)`
  2810. * Checks if a global variable has been set, without triggering a warning.
  2811. ### Global objects
  2812. * `minetest.env`: `EnvRef` of the server environment and world.
  2813. * Any function in the minetest namespace can be called using the syntax
  2814. `minetest.env:somefunction(somearguments)`
  2815. instead of `minetest.somefunction(somearguments)`
  2816. * Deprecated, but support is not to be dropped soon
  2817. ### Global tables
  2818. * `minetest.registered_items`
  2819. * Map of registered items, indexed by name
  2820. * `minetest.registered_nodes`
  2821. * Map of registered node definitions, indexed by name
  2822. * `minetest.registered_craftitems`
  2823. * Map of registered craft item definitions, indexed by name
  2824. * `minetest.registered_tools`
  2825. * Map of registered tool definitions, indexed by name
  2826. * `minetest.registered_entities`
  2827. * Map of registered entity prototypes, indexed by name
  2828. * `minetest.object_refs`
  2829. * Map of object references, indexed by active object id
  2830. * `minetest.luaentities`
  2831. * Map of Lua entities, indexed by active object id
  2832. * `minetest.registered_chatcommands`
  2833. * Map of registered chat command definitions, indexed by name
  2834. * `minetest.registered_ores`
  2835. * List of registered ore definitions.
  2836. * `minetest.registered_biomes`
  2837. * List of registered biome definitions.
  2838. * `minetest.registered_decorations`
  2839. * List of registered decoration definitions.
  2840. Class reference
  2841. ---------------
  2842. ### ModChannel
  2843. An interface to use mod channels on client and server
  2844. #### Methods
  2845. * `leave()`: leave the mod channel.
  2846. * Server leaves channel `channel_name`.
  2847. * No more incoming or outgoing messages can be sent to this channel from server mods.
  2848. * This invalidate all future object usage
  2849. * Ensure your set mod_channel to nil after that to free Lua resources
  2850. * `is_writeable()`: returns true if channel is writeable and mod can send over it.
  2851. * `send_all(message)`: Send `message` though the mod channel.
  2852. * If mod channel is not writeable or invalid, message will be dropped.
  2853. * Message size is limited to 65535 characters by protocol.
  2854. ### `MetaDataRef`
  2855. See `StorageRef`, `NodeMetaRef` and `ItemStackMetaRef`.
  2856. #### Methods
  2857. * `set_string(name, value)`
  2858. * `get_string(name)`
  2859. * `set_int(name, value)`
  2860. * `get_int(name)`
  2861. * `set_float(name, value)`
  2862. * `get_float(name)`
  2863. * `to_table()`: returns `nil` or a table with keys:
  2864. * `fields`: key-value storage
  2865. * `inventory`: `{list1 = {}, ...}}` (NodeMetaRef only)
  2866. * `from_table(nil or {})`
  2867. * Any non-table value will clear the metadata
  2868. * See "Node Metadata" for an example
  2869. * returns `true` on success
  2870. * `equals(other)`
  2871. * returns `true` if this metadata has the same key-value pairs as `other`
  2872. ### `NodeMetaRef`
  2873. Node metadata: reference extra data and functionality stored in a node.
  2874. Can be obtained via `minetest.get_meta(pos)`.
  2875. #### Methods
  2876. * All methods in MetaDataRef
  2877. * `get_inventory()`: returns `InvRef`
  2878. * `mark_as_private(name or {name1, name2, ...})`: Mark specific vars as private
  2879. This will prevent them from being sent to the client. Note that the "private"
  2880. status will only be remembered if an associated key-value pair exists, meaning
  2881. it's best to call this when initializing all other meta (e.g. `on_construct`).
  2882. ### `ItemStackMetaRef`
  2883. ItemStack metadata: reference extra data and functionality stored in a stack.
  2884. Can be obtained via `item:get_meta()`.
  2885. #### Methods
  2886. * All methods in MetaDataRef
  2887. * `set_tool_capabilities([tool_capabilities])`
  2888. * overrides the item's tool capabilities
  2889. * a nil value will clear the override data and restore the original behavior
  2890. ### `StorageRef`
  2891. Mod metadata: per mod metadata, saved automatically.
  2892. Can be obtained via `minetest.get_mod_storage()` during load time.
  2893. #### Methods
  2894. * All methods in MetaDataRef
  2895. ### `NodeTimerRef`
  2896. Node Timers: a high resolution persistent per-node timer.
  2897. Can be gotten via `minetest.get_node_timer(pos)`.
  2898. #### Methods
  2899. * `set(timeout,elapsed)`
  2900. * set a timer's state
  2901. * `timeout` is in seconds, and supports fractional values (0.1 etc)
  2902. * `elapsed` is in seconds, and supports fractional values (0.1 etc)
  2903. * will trigger the node's `on_timer` function after `(timeout - elapsed)` seconds
  2904. * `start(timeout)`
  2905. * start a timer
  2906. * equivalent to `set(timeout,0)`
  2907. * `stop()`
  2908. * stops the timer
  2909. * `get_timeout()`: returns current timeout in seconds
  2910. * if `timeout` equals `0`, timer is inactive
  2911. * `get_elapsed()`: returns current elapsed time in seconds
  2912. * the node's `on_timer` function will be called after `(timeout - elapsed)` seconds
  2913. * `is_started()`: returns boolean state of timer
  2914. * returns `true` if timer is started, otherwise `false`
  2915. ### `ObjectRef`
  2916. Moving things in the game are generally these.
  2917. This is basically a reference to a C++ `ServerActiveObject`
  2918. #### Methods
  2919. * `remove()`: remove object (after returning from Lua)
  2920. * Note: Doesn't work on players, use `minetest.kick_player` instead
  2921. * `get_pos()`: returns `{x=num, y=num, z=num}`
  2922. * `set_pos(pos)`; `pos`=`{x=num, y=num, z=num}`
  2923. * `move_to(pos, continuous=false)`: interpolated move
  2924. * `punch(puncher, time_from_last_punch, tool_capabilities, direction)`
  2925. * `puncher` = another `ObjectRef`,
  2926. * `time_from_last_punch` = time since last punch action of the puncher
  2927. * `direction`: can be `nil`
  2928. * `right_click(clicker)`; `clicker` is another `ObjectRef`
  2929. * `get_hp()`: returns number of hitpoints (2 * number of hearts)
  2930. * `set_hp(hp)`: set number of hitpoints (2 * number of hearts)
  2931. * `get_inventory()`: returns an `InvRef`
  2932. * `get_wield_list()`: returns the name of the inventory list the wielded item is in
  2933. * `get_wield_index()`: returns the index of the wielded item
  2934. * `get_wielded_item()`: returns an `ItemStack`
  2935. * `set_wielded_item(item)`: replaces the wielded item, returns `true` if successful
  2936. * `set_armor_groups({group1=rating, group2=rating, ...})`
  2937. * `get_armor_groups()`: returns a table with the armor group ratings
  2938. * `set_animation(frame_range, frame_speed, frame_blend, frame_loop)`
  2939. * `frame_range`: table {x=num, y=num}, default: `{x=1, y=1}`
  2940. * `frame_speed`: number, default: `15.0`
  2941. * `frame_blend`: number, default: `0.0`
  2942. * `frame_loop`: boolean, default: `true`
  2943. * `get_animation()`: returns `range`, `frame_speed`, `frame_blend` and `frame_loop`
  2944. * `set_animation_frame_speed(frame_speed)`
  2945. * `frame_speed`: number, default: `15.0`
  2946. * `set_attach(parent, bone, position, rotation)`
  2947. * `bone`: string
  2948. * `position`: `{x=num, y=num, z=num}` (relative)
  2949. * `rotation`: `{x=num, y=num, z=num}` = Rotation on each axis, in degrees
  2950. * `get_attach()`: returns parent, bone, position, rotation or nil if it isn't attached
  2951. * `set_detach()`
  2952. * `set_bone_position(bone, position, rotation)`
  2953. * `bone`: string
  2954. * `position`: `{x=num, y=num, z=num}` (relative)
  2955. * `rotation`: `{x=num, y=num, z=num}`
  2956. * `get_bone_position(bone)`: returns position and rotation of the bone
  2957. * `set_properties(object property table)`
  2958. * `get_properties()`: returns object property table
  2959. * `is_player()`: returns true for players, false otherwise
  2960. * `get_nametag_attributes()`
  2961. * returns a table with the attributes of the nametag of an object
  2962. * {
  2963. color = {a=0..255, r=0..255, g=0..255, b=0..255},
  2964. text = "",
  2965. }
  2966. * `set_nametag_attributes(attributes)`
  2967. * sets the attributes of the nametag of an object
  2968. * `attributes`:
  2969. {
  2970. color = ColorSpec,
  2971. text = "My Nametag",
  2972. }
  2973. ##### LuaEntitySAO-only (no-op for other objects)
  2974. * `set_velocity(vel)`
  2975. * `vel` is a vector, e.g. `{x=0.0, y=2.3, z=1.0}`
  2976. * `get_velocity()`: returns the velocity, a vector
  2977. * `set_acceleration(acc)`
  2978. * `acc` is a vector
  2979. * `get_acceleration()`: returns the acceleration, a vector
  2980. * `set_yaw(radians)`
  2981. * `get_yaw()`: returns number in radians
  2982. * `set_texture_mod(mod)`
  2983. * `get_texture_mod()` returns current texture modifier
  2984. * `set_sprite(p, num_frames, framelength, select_horiz_by_yawpitch)`
  2985. * Select sprite from spritesheet with optional animation and Dungeon Master
  2986. style texture selection based on yaw relative to camera
  2987. * `p`: {x=number, y=number}, the coordinate of the first frame
  2988. (x: column, y: row), default: `{x=0, y=0}`
  2989. * `num_frames`: number, default: `1`
  2990. * `framelength`: number, default: `0.2`
  2991. * `select_horiz_by_yawpitch`: boolean, this was once used for the Dungeon
  2992. Master mob, default: `false`
  2993. * `get_entity_name()` (**Deprecated**: Will be removed in a future version)
  2994. * `get_luaentity()`
  2995. ##### Player-only (no-op for other objects)
  2996. * `get_player_name()`: returns `""` if is not a player
  2997. * `get_player_velocity()`: returns `nil` if is not a player, otherwise a
  2998. table {x, y, z} representing the player's instantaneous velocity in nodes/s
  2999. * `get_look_dir()`: get camera direction as a unit vector
  3000. * `get_look_vertical()`: pitch in radians
  3001. * Angle ranges between -pi/2 and pi/2, which are straight up and down respectively.
  3002. * `get_look_horizontal()`: yaw in radians
  3003. * Angle is counter-clockwise from the +z direction.
  3004. * `set_look_vertical(radians)`: sets look pitch
  3005. * radians - Angle from looking forward, where positive is downwards.
  3006. * `set_look_horizontal(radians)`: sets look yaw
  3007. * radians - Angle from the +z direction, where positive is counter-clockwise.
  3008. * `get_look_pitch()`: pitch in radians - Deprecated as broken. Use `get_look_vertical`.
  3009. * Angle ranges between -pi/2 and pi/2, which are straight down and up respectively.
  3010. * `get_look_yaw()`: yaw in radians - Deprecated as broken. Use `get_look_horizontal`.
  3011. * Angle is counter-clockwise from the +x direction.
  3012. * `set_look_pitch(radians)`: sets look pitch - Deprecated. Use `set_look_vertical`.
  3013. * `set_look_yaw(radians)`: sets look yaw - Deprecated. Use `set_look_horizontal`.
  3014. * `get_breath()`: returns players breath
  3015. * `set_breath(value)`: sets players breath
  3016. * values:
  3017. * `0`: player is drowning
  3018. * max: bubbles bar is not shown
  3019. * See Object Properties for more information
  3020. * `set_attribute(attribute, value)`:
  3021. * Sets an extra attribute with value on player.
  3022. * `value` must be a string, or a number which will be converted to a string.
  3023. * If `value` is `nil`, remove attribute from player.
  3024. * `get_attribute(attribute)`:
  3025. * Returns value (a string) for extra attribute.
  3026. * Returns `nil` if no attribute found.
  3027. * `set_inventory_formspec(formspec)`
  3028. * Redefine player's inventory form
  3029. * Should usually be called in `on_joinplayer`
  3030. * `get_inventory_formspec()`: returns a formspec string
  3031. * `get_player_control()`: returns table with player pressed keys
  3032. * The table consists of fields with boolean value representing the pressed
  3033. keys, the fields are jump, right, left, LMB, RMB, sneak, aux1, down and up
  3034. * example: `{jump=false, right=true, left=false, LMB=false, RMB=false,
  3035. sneak=true, aux1=false, down=false, up=false}`
  3036. * `get_player_control_bits()`: returns integer with bit packed player pressed keys
  3037. * bit nr/meaning: 0/up, 1/down, 2/left, 3/right, 4/jump, 5/aux1, 6/sneak,
  3038. 7/LMB, 8/RMB
  3039. * `set_physics_override(override_table)`
  3040. * `override_table` is a table with the following fields:
  3041. * `speed`: multiplier to default walking speed value (default: `1`)
  3042. * `jump`: multiplier to default jump value (default: `1`)
  3043. * `gravity`: multiplier to default gravity value (default: `1`)
  3044. * `sneak`: whether player can sneak (default: `true`)
  3045. * `sneak_glitch`: whether player can use the new move code replications
  3046. of the old sneak side-effects: sneak ladders and 2 node sneak jump
  3047. (default: `false`)
  3048. * `new_move`: use new move/sneak code. When `false` the exact old code
  3049. is used for the specific old sneak behaviour (default: `true`)
  3050. * `get_physics_override()`: returns the table given to `set_physics_override`
  3051. * `hud_add(hud definition)`: add a HUD element described by HUD def, returns ID
  3052. number on success
  3053. * `hud_remove(id)`: remove the HUD element of the specified id
  3054. * `hud_change(id, stat, value)`: change a value of a previously added HUD element
  3055. * element `stat` values: `position`, `name`, `scale`, `text`, `number`, `item`, `dir`
  3056. * `hud_get(id)`: gets the HUD element definition structure of the specified ID
  3057. * `hud_set_flags(flags)`: sets specified HUD flags to `true`/`false`
  3058. * `flags`: (is visible) `hotbar`, `healthbar`, `crosshair`, `wielditem`, `breathbar`,
  3059. `minimap`, `minimap_radar`
  3060. * pass a table containing a `true`/`false` value of each flag to be set or unset
  3061. * if a flag equals `nil`, the flag is not modified
  3062. * note that setting `minimap` modifies the client's permission to view the minimap -
  3063. * the client may locally elect to not view the minimap
  3064. * minimap `radar` is only usable when `minimap` is true
  3065. * `hud_get_flags()`: returns a table containing status of hud flags
  3066. * returns `{hotbar=true, healthbar=true, crosshair=true, wielditem=true,
  3067. breathbar=true, minimap=true, minimap_radar=true}`
  3068. * `hud_set_hotbar_itemcount(count)`: sets number of items in builtin hotbar
  3069. * `count`: number of items, must be between `1` and `23`
  3070. * `hud_get_hotbar_itemcount`: returns number of visible items
  3071. * `hud_set_hotbar_image(texturename)`
  3072. * sets background image for hotbar
  3073. * `hud_get_hotbar_image`: returns texturename
  3074. * `hud_set_hotbar_selected_image(texturename)`
  3075. * sets image for selected item of hotbar
  3076. * `hud_get_hotbar_selected_image`: returns texturename
  3077. * `set_sky(bgcolor, type, {texture names}, clouds)`
  3078. * `bgcolor`: ColorSpec, defaults to white
  3079. * `type`: Available types:
  3080. * `"regular"`: Uses 0 textures, `bgcolor` ignored
  3081. * `"skybox"`: Uses 6 textures, `bgcolor` used
  3082. * `"plain"`: Uses 0 textures, `bgcolor` used
  3083. * `clouds`: Boolean for whether clouds appear in front of `"skybox"` or
  3084. `"plain"` custom skyboxes (default: `true`)
  3085. * `get_sky()`: returns bgcolor, type, table of textures, clouds
  3086. * `set_clouds(parameters)`: set cloud parameters
  3087. * `parameters` is a table with the following optional fields:
  3088. * `density`: from `0` (no clouds) to `1` (full clouds) (default `0.4`)
  3089. * `color`: basic cloud color with alpha channel, ColorSpec (default `#fff0f0e5`)
  3090. * `ambient`: cloud color lower bound, use for a "glow at night" effect.
  3091. ColorSpec (alpha ignored, default `#000000`)
  3092. * `height`: cloud height, i.e. y of cloud base (default per conf, usually `120`)
  3093. * `thickness`: cloud thickness in nodes (default `16`)
  3094. * `speed`: 2D cloud speed + direction in nodes per second (default `{x=0, z=-2}`)
  3095. * `get_clouds()`: returns a table with the current cloud parameters as in `set_clouds`
  3096. * `override_day_night_ratio(ratio or nil)`
  3097. * `0`...`1`: Overrides day-night ratio, controlling sunlight to a specific amount
  3098. * `nil`: Disables override, defaulting to sunlight based on day-night cycle
  3099. * `get_day_night_ratio()`: returns the ratio or nil if it isn't overridden
  3100. * `set_local_animation(stand/idle, walk, dig, walk+dig, frame_speed=frame_speed)`:
  3101. set animation for player model in third person view
  3102. set_local_animation({x=0, y=79}, -- < stand/idle animation key frames
  3103. {x=168, y=187}, -- < walk animation key frames
  3104. {x=189, y=198}, -- < dig animation key frames
  3105. {x=200, y=219}, -- < walk+dig animation key frames
  3106. frame_speed=30): -- < animation frame speed
  3107. * `get_local_animation()`: returns stand, walk, dig, dig+walk tables and `frame_speed`
  3108. * `set_eye_offset({x=0,y=0,z=0},{x=0,y=0,z=0})`: defines offset value for camera per player
  3109. * in first person view
  3110. * in third person view (max. values `{x=-10/10,y=-10,15,z=-5/5}`)
  3111. * `get_eye_offset()`: returns `offset_first` and `offset_third`
  3112. ### `InvRef`
  3113. An `InvRef` is a reference to an inventory.
  3114. #### Methods
  3115. * `is_empty(listname)`: return `true` if list is empty
  3116. * `get_size(listname)`: get size of a list
  3117. * `set_size(listname, size)`: set size of a list
  3118. * returns `false` on error (e.g. invalid `listname` or `size`)
  3119. * `get_width(listname)`: get width of a list
  3120. * `set_width(listname, width)`: set width of list; currently used for crafting
  3121. * `get_stack(listname, i)`: get a copy of stack index `i` in list
  3122. * `set_stack(listname, i, stack)`: copy `stack` to index `i` in list
  3123. * `get_list(listname)`: return full list
  3124. * `set_list(listname, list)`: set full list (size will not change)
  3125. * `get_lists()`: returns list of inventory lists
  3126. * `set_lists(lists)`: sets inventory lists (size will not change)
  3127. * `add_item(listname, stack)`: add item somewhere in list, returns leftover `ItemStack`
  3128. * `room_for_item(listname, stack):` returns `true` if the stack of items
  3129. can be fully added to the list
  3130. * `contains_item(listname, stack, [match_meta])`: returns `true` if
  3131. the stack of items can be fully taken from the list.
  3132. If `match_meta` is false, only the items' names are compared (default: `false`).
  3133. * `remove_item(listname, stack)`: take as many items as specified from the list,
  3134. returns the items that were actually removed (as an `ItemStack`) -- note that
  3135. any item metadata is ignored, so attempting to remove a specific unique
  3136. item this way will likely remove the wrong one -- to do that use `set_stack`
  3137. with an empty `ItemStack`
  3138. * `get_location()`: returns a location compatible to `minetest.get_inventory(location)`
  3139. * returns `{type="undefined"}` in case location is not known
  3140. ### `AreaStore`
  3141. A fast access data structure to store areas, and find areas near a given position or area.
  3142. Every area has a `data` string attribute to store additional information.
  3143. You can create an empty `AreaStore` by calling `AreaStore()`, or `AreaStore(type_name)`.
  3144. If you chose the parameter-less constructor, a fast implementation will be automatically
  3145. chosen for you.
  3146. #### Methods
  3147. * `get_area(id, include_borders, include_data)`: returns the area with the id `id`.
  3148. (optional) Boolean values `include_borders` and `include_data` control what's copied.
  3149. Returns nil if specified area id does not exist.
  3150. * `get_areas_for_pos(pos, include_borders, include_data)`: returns all areas that contain
  3151. the position `pos`. (optional) Boolean values `include_borders` and `include_data` control
  3152. what's copied.
  3153. * `get_areas_in_area(edge1, edge2, accept_overlap, include_borders, include_data)`:
  3154. returns all areas that contain all nodes inside the area specified by `edge1` and `edge2` (inclusive).
  3155. If `accept_overlap` is true, also areas are returned that have nodes in common with the specified area.
  3156. (optional) Boolean values `include_borders` and `include_data` control what's copied.
  3157. * `insert_area(edge1, edge2, data, [id])`: inserts an area into the store. Returns the new area's ID,
  3158. or nil if the insertion failed. The (inclusive) positions `edge1` and `edge2` describe the area.
  3159. `data` is a string stored with the area. If passed, `id` will be used as the internal area ID,
  3160. it must be a unique number between 0 and 2^32-2. If you use the `id` parameter you must always use it,
  3161. or insertions are likely to fail due to conflicts.
  3162. * `reserve(count)`: reserves resources for at most `count` many contained areas.
  3163. Only needed for efficiency, and only some implementations profit.
  3164. * `remove_area(id)`: removes the area with the given id from the store, returns success.
  3165. * `set_cache_params(params)`: sets params for the included prefiltering cache.
  3166. Calling invalidates the cache, so that its elements have to be newly generated.
  3167. * `params`:
  3168. {
  3169. enabled = boolean, -- whether to enable, default true
  3170. block_radius = number, -- the radius (in nodes) of the areas the cache generates
  3171. prefiltered lists for, minimum 16, default 64
  3172. limit = number, -- the cache's size, minimum 20, default 1000
  3173. }
  3174. * `to_string()`: Experimental. Returns area store serialized as a (binary) string.
  3175. * `to_file(filename)`: Experimental. Like `to_string()`, but writes the data to a file.
  3176. * `from_string(str)`: Experimental. Deserializes string and loads it into the AreaStore.
  3177. Returns success and, optionally, an error message.
  3178. * `from_file(filename)`: Experimental. Like `from_string()`, but reads the data from a file.
  3179. ### `ItemStack`
  3180. An `ItemStack` is a stack of items.
  3181. It can be created via `ItemStack(x)`, where x is an `ItemStack`,
  3182. an itemstring, a table or `nil`.
  3183. #### Methods
  3184. * `is_empty()`: returns `true` if stack is empty.
  3185. * `get_name()`: returns item name (e.g. `"default:stone"`).
  3186. * `set_name(item_name)`: returns a boolean indicating whether the item was cleared
  3187. * `get_count()`: Returns number of items on the stack.
  3188. * `set_count(count)`: returns a boolean indicating whether the item was cleared
  3189. * `count`: number, unsigned 16 bit integer
  3190. * `get_wear()`: returns tool wear (`0`-`65535`), `0` for non-tools.
  3191. * `set_wear(wear)`: returns boolean indicating whether item was cleared
  3192. * `wear`: number, unsigned 16 bit integer
  3193. * `get_meta()`: returns ItemStackMetaRef. See section for more details
  3194. * `get_metadata()`: (DEPRECATED) Returns metadata (a string attached to an item stack).
  3195. * `set_metadata(metadata)`: (DEPRECATED) Returns true.
  3196. * `clear()`: removes all items from the stack, making it empty.
  3197. * `replace(item)`: replace the contents of this stack.
  3198. * `item` can also be an itemstring or table.
  3199. * `to_string()`: returns the stack in itemstring form.
  3200. * `to_table()`: returns the stack in Lua table form.
  3201. * `get_stack_max()`: returns the maximum size of the stack (depends on the item).
  3202. * `get_free_space()`: returns `get_stack_max() - get_count()`.
  3203. * `is_known()`: returns `true` if the item name refers to a defined item type.
  3204. * `get_definition()`: returns the item definition table.
  3205. * `get_tool_capabilities()`: returns the digging properties of the item,
  3206. or those of the hand if none are defined for this item type
  3207. * `add_wear(amount)`
  3208. * Increases wear by `amount` if the item is a tool
  3209. * `amount`: number, integer
  3210. * `add_item(item)`: returns leftover `ItemStack`
  3211. * Put some item or stack onto this stack
  3212. * `item_fits(item)`: returns `true` if item or stack can be fully added to
  3213. this one.
  3214. * `take_item(n)`: returns taken `ItemStack`
  3215. * Take (and remove) up to `n` items from this stack
  3216. * `n`: number, default: `1`
  3217. * `peek_item(n)`: returns taken `ItemStack`
  3218. * Copy (don't remove) up to `n` items from this stack
  3219. * `n`: number, default: `1`
  3220. ### `PseudoRandom`
  3221. A 16-bit pseudorandom number generator.
  3222. Uses a well-known LCG algorithm introduced by K&R.
  3223. It can be created via `PseudoRandom(seed)`.
  3224. #### Methods
  3225. * `next()`: return next integer random number [`0`...`32767`]
  3226. * `next(min, max)`: return next integer random number [`min`...`max`]
  3227. * `((max - min) == 32767) or ((max-min) <= 6553))` must be true
  3228. due to the simple implementation making bad distribution otherwise.
  3229. ### `PcgRandom`
  3230. A 32-bit pseudorandom number generator.
  3231. Uses PCG32, an algorithm of the permuted congruential generator family, offering very strong randomness.
  3232. It can be created via `PcgRandom(seed)` or `PcgRandom(seed, sequence)`.
  3233. #### Methods
  3234. * `next()`: return next integer random number [`-2147483648`...`2147483647`]
  3235. * `next(min, max)`: return next integer random number [`min`...`max`]
  3236. * `rand_normal_dist(min, max, num_trials=6)`: return normally distributed random number [`min`...`max`]
  3237. * This is only a rough approximation of a normal distribution with:
  3238. * `mean = (max - min) / 2`, and
  3239. * `variance = (((max - min + 1) ^ 2) - 1) / (12 * num_trials)`
  3240. * Increasing `num_trials` improves accuracy of the approximation
  3241. ### `SecureRandom`
  3242. Interface for the operating system's crypto-secure PRNG.
  3243. It can be created via `SecureRandom()`. The constructor returns nil if a secure random device cannot be
  3244. be found on the system.
  3245. #### Methods
  3246. * `next_bytes([count])`: return next `count` (default 1, capped at 2048) many random bytes, as a string.
  3247. ### `PerlinNoise`
  3248. A perlin noise generator.
  3249. It can be created via `PerlinNoise(seed, octaves, persistence, scale)`
  3250. or `PerlinNoise(noiseparams)`.
  3251. Alternatively with `minetest.get_perlin(seeddiff, octaves, persistence, scale)`
  3252. or `minetest.get_perlin(noiseparams)`.
  3253. #### Methods
  3254. * `get2d(pos)`: returns 2D noise value at `pos={x=,y=}`
  3255. * `get3d(pos)`: returns 3D noise value at `pos={x=,y=,z=}`
  3256. ### `PerlinNoiseMap`
  3257. A fast, bulk perlin noise generator.
  3258. It can be created via `PerlinNoiseMap(noiseparams, size)` or
  3259. `minetest.get_perlin_map(noiseparams, size)`.
  3260. Format of `size` is `{x=dimx, y=dimy, z=dimz}`. The `z` component is omitted
  3261. for 2D noise, and it must be must be larger than 1 for 3D noise (otherwise
  3262. `nil` is returned).
  3263. For each of the functions with an optional `buffer` parameter: If `buffer` is not
  3264. nil, this table will be used to store the result instead of creating a new table.
  3265. #### Methods
  3266. * `get2dMap(pos)`: returns a `<size.x>` times `<size.y>` 2D array of 2D noise
  3267. with values starting at `pos={x=,y=}`
  3268. * `get3dMap(pos)`: returns a `<size.x>` times `<size.y>` times `<size.z>` 3D array
  3269. of 3D noise with values starting at `pos={x=,y=,z=}`
  3270. * `get2dMap_flat(pos, buffer)`: returns a flat `<size.x * size.y>` element array of 2D noise
  3271. with values starting at `pos={x=,y=}`
  3272. * `get3dMap_flat(pos, buffer)`: Same as `get2dMap_flat`, but 3D noise
  3273. * `calc2dMap(pos)`: Calculates the 2d noise map starting at `pos`. The result is stored internally.
  3274. * `calc3dMap(pos)`: Calculates the 3d noise map starting at `pos`. The result is stored internally.
  3275. * `getMapSlice(slice_offset, slice_size, buffer)`: In the form of an array, returns a slice of the
  3276. most recently computed noise results. The result slice begins at coordinates `slice_offset` and
  3277. takes a chunk of `slice_size`.
  3278. E.g. to grab a 2-slice high horizontal 2d plane of noise starting at buffer offset y = 20:
  3279. `noisevals = noise:getMapSlice({y=20}, {y=2})`
  3280. It is important to note that `slice_offset` offset coordinates begin at 1, and are relative to
  3281. the starting position of the most recently calculated noise.
  3282. To grab a single vertical column of noise starting at map coordinates x = 1023, y=1000, z = 1000:
  3283. `noise:calc3dMap({x=1000, y=1000, z=1000})`
  3284. `noisevals = noise:getMapSlice({x=24, z=1}, {x=1, z=1})`
  3285. ### `VoxelManip`
  3286. #### About VoxelManip
  3287. VoxelManip is a scripting interface to the internal 'Map Voxel Manipulator' facility. The purpose of
  3288. this object is for fast, low-level, bulk access to reading and writing Map content. As such, setting
  3289. map nodes through VoxelManip will lack many of the higher level features and concepts you may be used
  3290. to with other methods of setting nodes. For example, nodes will not have their construction and
  3291. destruction callbacks run, and no rollback information is logged.
  3292. It is important to note that VoxelManip is designed for speed, and *not* ease of use or flexibility.
  3293. If your mod requires a map manipulation facility that will handle 100% of all edge cases, or the use
  3294. of high level node placement features, perhaps `minetest.set_node()` is better suited for the job.
  3295. In addition, VoxelManip might not be faster, or could even be slower, for your specific use case.
  3296. VoxelManip is most effective when setting very large areas of map at once - for example, if only
  3297. setting a 5x5x5 node area, a `minetest.set_node()` loop may be more optimal. Always profile code
  3298. using both methods of map manipulation to determine which is most appropriate for your usage.
  3299. #### Using VoxelManip
  3300. A VoxelManip object can be created any time using either:
  3301. `VoxelManip([p1, p2])`, or `minetest.get_voxel_manip([p1, p2])`.
  3302. If the optional position parameters are present for either of these routines, the specified region
  3303. will be pre-loaded into the VoxelManip object on creation. Otherwise, the area of map you wish to
  3304. manipulate must first be loaded into the VoxelManip object using `VoxelManip:read_from_map()`.
  3305. Note that `VoxelManip:read_from_map()` returns two position vectors. The region formed by these
  3306. positions indicate the minimum and maximum (respectively) positions of the area actually loaded in
  3307. the VoxelManip, which may be larger than the area requested. For convenience, the loaded area
  3308. coordinates can also be queried any time after loading map data with `VoxelManip:get_emerged_area()`.
  3309. Now that the VoxelManip object is populated with map data, your mod can fetch a copy of this data
  3310. using either of two methods. `VoxelManip:get_node_at()`, which retrieves an individual node in a
  3311. MapNode formatted table at the position requested is the simplest method to use, but also the slowest.
  3312. Nodes in a VoxelManip object may also be read in bulk to a flat array table using:
  3313. `VoxelManip:get_data()` for node content (in Content ID form, see section 'Content IDs'),
  3314. `VoxelManip:get_light_data()` for node light levels, and
  3315. `VoxelManip:get_param2_data()` for the node type-dependent "param2" values.
  3316. See section 'Flat array format' for more details.
  3317. It is very important to understand that the tables returned by any of the above three functions
  3318. represent a snapshot of the VoxelManip's internal state at the time of the call. This copy of the
  3319. data will *not* magically update itself if another function modifies the internal VoxelManip state.
  3320. Any functions that modify a VoxelManip's contents work on the VoxelManip's internal state unless
  3321. otherwise explicitly stated.
  3322. Once the bulk data has been edited to your liking, the internal VoxelManip state can be set using:
  3323. `VoxelManip:set_data()` for node content (in Content ID form, see section 'Content IDs'),
  3324. `VoxelManip:set_light_data()` for node light levels, and
  3325. `VoxelManip:set_param2_data()` for the node type-dependent `param2` values.
  3326. The parameter to each of the above three functions can use any table at all in the same flat array
  3327. format as produced by `get_data()` et al. and is *not required* to be a table retrieved from `get_data()`.
  3328. Once the internal VoxelManip state has been modified to your liking, the changes can be committed back
  3329. to the map by calling `VoxelManip:write_to_map()`.
  3330. ##### Flat array format
  3331. Let
  3332. `Nx = p2.X - p1.X + 1`,
  3333. `Ny = p2.Y - p1.Y + 1`, and
  3334. `Nz = p2.Z - p1.Z + 1`.
  3335. Then, for a loaded region of p1..p2, this array ranges from `1` up to and including the value of
  3336. the expression `Nx * Ny * Nz`.
  3337. Positions offset from p1 are present in the array with the format of:
  3338. ```
  3339. [
  3340. (0, 0, 0), (1, 0, 0), (2, 0, 0), ... (Nx, 0, 0),
  3341. (0, 1, 0), (1, 1, 0), (2, 1, 0), ... (Nx, 1, 0),
  3342. ...
  3343. (0, Ny, 0), (1, Ny, 0), (2, Ny, 0), ... (Nx, Ny, 0),
  3344. (0, 0, 1), (1, 0, 1), (2, 0, 1), ... (Nx, 0, 1),
  3345. ...
  3346. (0, Ny, 2), (1, Ny, 2), (2, Ny, 2), ... (Nx, Ny, 2),
  3347. ...
  3348. (0, Ny, Nz), (1, Ny, Nz), (2, Ny, Nz), ... (Nx, Ny, Nz)
  3349. ]
  3350. ```
  3351. and the array index for a position p contained completely in p1..p2 is:
  3352. `(p.Z - p1.Z) * Ny * Nx + (p.Y - p1.Y) * Nx + (p.X - p1.X) + 1`
  3353. Note that this is the same "flat 3D array" format as `PerlinNoiseMap:get3dMap_flat()`.
  3354. VoxelArea objects (see section 'VoxelArea') can be used to simplify calculation of the index
  3355. for a single point in a flat VoxelManip array.
  3356. ##### Content IDs
  3357. A Content ID is a unique integer identifier for a specific node type. These IDs are used by VoxelManip
  3358. in place of the node name string for `VoxelManip:get_data()` and `VoxelManip:set_data()`. You can use
  3359. `minetest.get_content_id()` to look up the Content ID for the specified node name, and
  3360. `minetest.get_name_from_content_id()` to look up the node name string for a given Content ID.
  3361. After registration of a node, its Content ID will remain the same throughout execution of the mod.
  3362. Note that the node being queried needs to have already been been registered.
  3363. The following builtin node types have their Content IDs defined as constants:
  3364. * `minetest.CONTENT_UNKNOWN`: ID for "unknown" nodes
  3365. * `minetest.CONTENT_AIR`: ID for "air" nodes
  3366. * `minetest.CONTENT_IGNORE`: ID for "ignore" nodes
  3367. ##### Mapgen VoxelManip objects
  3368. Inside of `on_generated()` callbacks, it is possible to retrieve the same VoxelManip object used by the
  3369. core's Map Generator (commonly abbreviated Mapgen). Most of the rules previously described still apply
  3370. but with a few differences:
  3371. * The Mapgen VoxelManip object is retrieved using: `minetest.get_mapgen_object("voxelmanip")`
  3372. * This VoxelManip object already has the region of map just generated loaded into it; it's not necessary
  3373. to call `VoxelManip:read_from_map()` before using a Mapgen VoxelManip.
  3374. * The `on_generated()` callbacks of some mods may place individual nodes in the generated area using
  3375. non-VoxelManip map modification methods. Because the same Mapgen VoxelManip object is passed through
  3376. each `on_generated()` callback, it becomes necessary for the Mapgen VoxelManip object to maintain
  3377. consistency with the current map state. For this reason, calling any of the following functions:
  3378. `minetest.add_node()`, `minetest.set_node()`, or `minetest.swap_node()`
  3379. will also update the Mapgen VoxelManip object's internal state active on the current thread.
  3380. * After modifying the Mapgen VoxelManip object's internal buffer, it may be necessary to update lighting
  3381. information using either: `VoxelManip:calc_lighting()` or `VoxelManip:set_lighting()`.
  3382. ##### Other API functions operating on a VoxelManip
  3383. If any VoxelManip contents were set to a liquid node, `VoxelManip:update_liquids()` must be called
  3384. for these liquid nodes to begin flowing. It is recommended to call this function only after having
  3385. written all buffered data back to the VoxelManip object, save for special situations where the modder
  3386. desires to only have certain liquid nodes begin flowing.
  3387. The functions `minetest.generate_ores()` and `minetest.generate_decorations()` will generate all
  3388. registered decorations and ores throughout the full area inside of the specified VoxelManip object.
  3389. `minetest.place_schematic_on_vmanip()` is otherwise identical to `minetest.place_schematic()`,
  3390. except instead of placing the specified schematic directly on the map at the specified position, it
  3391. will place the schematic inside of the VoxelManip.
  3392. ##### Notes
  3393. * Attempting to read data from a VoxelManip object before map is read will result in a zero-length
  3394. array table for `VoxelManip:get_data()`, and an "ignore" node at any position for
  3395. `VoxelManip:get_node_at()`.
  3396. * If either a region of map has not yet been generated or is out-of-bounds of the map, that region is
  3397. filled with "ignore" nodes.
  3398. * Other mods, or the core itself, could possibly modify the area of map currently loaded into a VoxelManip
  3399. object. With the exception of Mapgen VoxelManips (see above section), the internal buffers are not
  3400. updated. For this reason, it is strongly encouraged to complete the usage of a particular VoxelManip
  3401. object in the same callback it had been created.
  3402. * If a VoxelManip object will be used often, such as in an `on_generated()` callback, consider passing
  3403. a file-scoped table as the optional parameter to `VoxelManip:get_data()`, which serves as a static
  3404. buffer the function can use to write map data to instead of returning a new table each call. This
  3405. greatly enhances performance by avoiding unnecessary memory allocations.
  3406. #### Methods
  3407. * `read_from_map(p1, p2)`: Loads a chunk of map into the VoxelManip object containing
  3408. the region formed by `p1` and `p2`.
  3409. * returns actual emerged `pmin`, actual emerged `pmax`
  3410. * `write_to_map([light])`: Writes the data loaded from the `VoxelManip` back to the map.
  3411. * **important**: data must be set using `VoxelManip:set_data()` before calling this
  3412. * if `light` is true, then lighting is automatically recalculated.
  3413. The default value is true.
  3414. If `light` is false, no light calculations happen, and you should correct
  3415. all modified blocks with `minetest.fix_light()` as soon as possible.
  3416. Keep in mind that modifying the map where light is incorrect can cause
  3417. more lighting bugs.
  3418. * `get_node_at(pos)`: Returns a `MapNode` table of the node currently loaded in
  3419. the `VoxelManip` at that position
  3420. * `set_node_at(pos, node)`: Sets a specific `MapNode` in the `VoxelManip` at that position
  3421. * `get_data([buffer])`: Retrieves the node content data loaded into the `VoxelManip` object
  3422. * returns raw node data in the form of an array of node content IDs
  3423. * if the param `buffer` is present, this table will be used to store the result instead
  3424. * `set_data(data)`: Sets the data contents of the `VoxelManip` object
  3425. * `update_map()`: Does nothing, kept for compatibility.
  3426. * `set_lighting(light, [p1, p2])`: Set the lighting within the `VoxelManip` to a uniform value
  3427. * `light` is a table, `{day=<0...15>, night=<0...15>}`
  3428. * To be used only by a `VoxelManip` object from `minetest.get_mapgen_object`
  3429. * (`p1`, `p2`) is the area in which lighting is set;
  3430. defaults to the whole area if left out
  3431. * `get_light_data()`: Gets the light data read into the `VoxelManip` object
  3432. * Returns an array (indices 1 to volume) of integers ranging from `0` to `255`
  3433. * Each value is the bitwise combination of day and night light values (`0` to `15` each)
  3434. * `light = day + (night * 16)`
  3435. * `set_light_data(light_data)`: Sets the `param1` (light) contents of each node
  3436. in the `VoxelManip`
  3437. * expects lighting data in the same format that `get_light_data()` returns
  3438. * `get_param2_data([buffer])`: Gets the raw `param2` data read into the `VoxelManip` object
  3439. * Returns an array (indices 1 to volume) of integers ranging from `0` to `255`
  3440. * If the param `buffer` is present, this table will be used to store the result instead
  3441. * `set_param2_data(param2_data)`: Sets the `param2` contents of each node in the `VoxelManip`
  3442. * `calc_lighting([p1, p2], [propagate_shadow])`: Calculate lighting within the `VoxelManip`
  3443. * To be used only by a `VoxelManip` object from `minetest.get_mapgen_object`
  3444. * (`p1`, `p2`) is the area in which lighting is set; defaults to the whole area
  3445. if left out or nil
  3446. * `propagate_shadow` is an optional boolean deciding whether shadows in a generated
  3447. mapchunk above are propagated down into the mapchunk; defaults to `true` if left out
  3448. * `update_liquids()`: Update liquid flow
  3449. * `was_modified()`: Returns `true` or `false` if the data in the voxel manipulator
  3450. had been modified since the last read from map, due to a call to
  3451. `minetest.set_data()` on the loaded area elsewhere
  3452. * `get_emerged_area()`: Returns actual emerged minimum and maximum positions.
  3453. ### `VoxelArea`
  3454. A helper class for voxel areas.
  3455. It can be created via `VoxelArea:new{MinEdge=pmin, MaxEdge=pmax}`.
  3456. The coordinates are *inclusive*, like most other things in Minetest.
  3457. #### Methods
  3458. * `getExtent()`: returns a 3D vector containing the size of the area formed by
  3459. `MinEdge` and `MaxEdge`
  3460. * `getVolume()`: returns the volume of the area formed by `MinEdge` and `MaxEdge`
  3461. * `index(x, y, z)`: returns the index of an absolute position in a flat array starting at `1`
  3462. * useful for things like `VoxelManip`, raw Schematic specifiers,
  3463. `PerlinNoiseMap:get2d`/`3dMap`, and so on
  3464. * `indexp(p)`: same as above, except takes a vector
  3465. * `position(i)`: returns the absolute position vector corresponding to index `i`
  3466. * `contains(x, y, z)`: check if (`x`,`y`,`z`) is inside area formed by `MinEdge` and `MaxEdge`
  3467. * `containsp(p)`: same as above, except takes a vector
  3468. * `containsi(i)`: same as above, except takes an index `i`
  3469. * `iter(minx, miny, minz, maxx, maxy, maxz)`: returns an iterator that returns indices
  3470. * from (`minx`,`miny`,`minz`) to (`maxx`,`maxy`,`maxz`) in the order of `[z [y [x]]]`
  3471. * `iterp(minp, maxp)`: same as above, except takes a vector
  3472. ### `Settings`
  3473. An interface to read config files in the format of `minetest.conf`.
  3474. It can be created via `Settings(filename)`.
  3475. #### Methods
  3476. * `get(key)`: returns a value
  3477. * `get_bool(key)`: returns a boolean
  3478. * `get_np_group(key)`: returns a NoiseParams table
  3479. * `set(key, value)`
  3480. * Setting names can't contain whitespace or any of `="{}#`.
  3481. * Setting values can't contain the sequence `\n"""`.
  3482. * Setting names starting with "secure." can't be set on the main settings object (`minetest.settings`).
  3483. * `set_bool(key, value)`
  3484. * See documentation for set() above.
  3485. * `set_np_group(key, value)`
  3486. * `value` is a NoiseParams table.
  3487. * Also, see documentation for set() above.
  3488. * `remove(key)`: returns a boolean (`true` for success)
  3489. * `get_names()`: returns `{key1,...}`
  3490. * `write()`: returns a boolean (`true` for success)
  3491. * Writes changes to file.
  3492. * `to_table()`: returns `{[key1]=value1,...}`
  3493. ### `Raycast`
  3494. A raycast on the map. It works with selection boxes.
  3495. Can be used as an iterator in a for loop.
  3496. The map is loaded as the ray advances. If the
  3497. map is modified after the `Raycast` is created,
  3498. the changes may or may not have an effect on
  3499. the object.
  3500. It can be created via `Raycast(pos1, pos2, objects, liquids)` or
  3501. `minetest.raycast(pos1, pos2, objects, liquids)` where:
  3502. * `pos1`: start of the ray
  3503. * `pos2`: end of the ray
  3504. * `objects` : if false, only nodes will be returned. Default is true.
  3505. * `liquids' : if false, liquid nodes won't be returned. Default is false.
  3506. #### Methods
  3507. * `next()`: returns a `pointed_thing`
  3508. * Returns the next thing pointed by the ray or nil.
  3509. Mapgen objects
  3510. --------------
  3511. A mapgen object is a construct used in map generation. Mapgen objects can be used
  3512. by an `on_generate` callback to speed up operations by avoiding unnecessary
  3513. recalculations; these can be retrieved using the `minetest.get_mapgen_object()`
  3514. function. If the requested Mapgen object is unavailable, or `get_mapgen_object()`
  3515. was called outside of an `on_generate()` callback, `nil` is returned.
  3516. The following Mapgen objects are currently available:
  3517. ### `voxelmanip`
  3518. This returns three values; the `VoxelManip` object to be used, minimum and maximum
  3519. emerged position, in that order. All mapgens support this object.
  3520. ### `heightmap`
  3521. Returns an array containing the y coordinates of the ground levels of nodes in
  3522. the most recently generated chunk by the current mapgen.
  3523. ### `biomemap`
  3524. Returns an array containing the biome IDs of nodes in the most recently
  3525. generated chunk by the current mapgen.
  3526. ### `heatmap`
  3527. Returns an array containing the temperature values of nodes in the most
  3528. recently generated chunk by the current mapgen.
  3529. ### `humiditymap`
  3530. Returns an array containing the humidity values of nodes in the most recently
  3531. generated chunk by the current mapgen.
  3532. ### `gennotify`
  3533. Returns a table mapping requested generation notification types to arrays of
  3534. positions at which the corresponding generated structures are located at within
  3535. the current chunk. To set the capture of positions of interest to be recorded
  3536. on generate, use `minetest.set_gen_notify()`.
  3537. Possible fields of the table returned are:
  3538. * `dungeon`
  3539. * `temple`
  3540. * `cave_begin`
  3541. * `cave_end`
  3542. * `large_cave_begin`
  3543. * `large_cave_end`
  3544. * `decoration`
  3545. Decorations have a key in the format of `"decoration#id"`, where `id` is the
  3546. numeric unique decoration ID.
  3547. Registered entities
  3548. -------------------
  3549. * Functions receive a "luaentity" as `self`:
  3550. * It has the member `.name`, which is the registered name `("mod:thing")`
  3551. * It has the member `.object`, which is an `ObjectRef` pointing to the object
  3552. * The original prototype stuff is visible directly via a metatable
  3553. * Callbacks:
  3554. * `on_activate(self, staticdata, dtime_s)`
  3555. * Called when the object is instantiated.
  3556. * `dtime_s` is the time passed since the object was unloaded, which can
  3557. be used for updating the entity state.
  3558. * `on_step(self, dtime)`
  3559. * Called on every server tick, after movement and collision processing.
  3560. `dtime` is usually 0.1 seconds, as per the `dedicated_server_step` setting
  3561. `in minetest.conf`.
  3562. * `on_punch(self, puncher, time_from_last_punch, tool_capabilities, dir)`
  3563. * Called when somebody punches the object.
  3564. * Note that you probably want to handle most punches using the
  3565. automatic armor group system.
  3566. * `puncher`: an `ObjectRef` (can be `nil`)
  3567. * `time_from_last_punch`: Meant for disallowing spamming of clicks (can be `nil`)
  3568. * `tool_capabilities`: capability table of used tool (can be `nil`)
  3569. * `dir`: unit vector of direction of punch. Always defined. Points from
  3570. the puncher to the punched.
  3571. * `on_death(self, killer)`
  3572. * Called when the object dies.
  3573. * `killer`: an `ObjectRef` (can be `nil`)
  3574. * `on_rightclick(self, clicker)`
  3575. * `get_staticdata(self)`
  3576. * Should return a string that will be passed to `on_activate` when
  3577. the object is instantiated the next time.
  3578. L-system trees
  3579. --------------
  3580. **Warning**
  3581. L-system generation currently creates lighting bugs in the form of mapblock-sized shadows.
  3582. Often these bugs appear as subtle shadows in water.
  3583. ### Tree definition
  3584. treedef={
  3585. axiom, --string initial tree axiom
  3586. rules_a, --string rules set A
  3587. rules_b, --string rules set B
  3588. rules_c, --string rules set C
  3589. rules_d, --string rules set D
  3590. trunk, --string trunk node name
  3591. leaves, --string leaves node name
  3592. leaves2, --string secondary leaves node name
  3593. leaves2_chance,--num chance (0-100) to replace leaves with leaves2
  3594. angle, --num angle in deg
  3595. iterations, --num max # of iterations, usually 2 -5
  3596. random_level, --num factor to lower nr of iterations, usually 0 - 3
  3597. trunk_type, --string single/double/crossed) type of trunk: 1 node,
  3598. -- 2x2 nodes or 3x3 in cross shape
  3599. thin_branches, --boolean true -> use thin (1 node) branches
  3600. fruit, --string fruit node name
  3601. fruit_chance, --num chance (0-100) to replace leaves with fruit node
  3602. seed, --num random seed; if no seed is provided, the engine will create one
  3603. }
  3604. ### Key for Special L-System Symbols used in Axioms
  3605. * `G`: move forward one unit with the pen up
  3606. * `F`: move forward one unit with the pen down drawing trunks and branches
  3607. * `f`: move forward one unit with the pen down drawing leaves (100% chance)
  3608. * `T`: move forward one unit with the pen down drawing trunks only
  3609. * `R`: move forward one unit with the pen down placing fruit
  3610. * `A`: replace with rules set A
  3611. * `B`: replace with rules set B
  3612. * `C`: replace with rules set C
  3613. * `D`: replace with rules set D
  3614. * `a`: replace with rules set A, chance 90%
  3615. * `b`: replace with rules set B, chance 80%
  3616. * `c`: replace with rules set C, chance 70%
  3617. * `d`: replace with rules set D, chance 60%
  3618. * `+`: yaw the turtle right by `angle` parameter
  3619. * `-`: yaw the turtle left by `angle` parameter
  3620. * `&`: pitch the turtle down by `angle` parameter
  3621. * `^`: pitch the turtle up by `angle` parameter
  3622. * `/`: roll the turtle to the right by `angle` parameter
  3623. * `*`: roll the turtle to the left by `angle` parameter
  3624. * `[`: save in stack current state info
  3625. * `]`: recover from stack state info
  3626. ### Example
  3627. Spawn a small apple tree:
  3628. pos = {x=230,y=20,z=4}
  3629. apple_tree={
  3630. axiom="FFFFFAFFBF",
  3631. rules_a="[&&&FFFFF&&FFFF][&&&++++FFFFF&&FFFF][&&&----FFFFF&&FFFF]",
  3632. rules_b="[&&&++FFFFF&&FFFF][&&&--FFFFF&&FFFF][&&&------FFFFF&&FFFF]",
  3633. trunk="default:tree",
  3634. leaves="default:leaves",
  3635. angle=30,
  3636. iterations=2,
  3637. random_level=0,
  3638. trunk_type="single",
  3639. thin_branches=true,
  3640. fruit_chance=10,
  3641. fruit="default:apple"
  3642. }
  3643. minetest.spawn_tree(pos,apple_tree)
  3644. Definition tables
  3645. -----------------
  3646. ### Object Properties
  3647. {
  3648. hp_max = 1,
  3649. -- ^ For players: Defaults to `minetest.PLAYER_MAX_HP_DEFAULT`
  3650. breath_max = 0,
  3651. -- ^ For players only. Defaults to `minetest.PLAYER_MAX_BREATH_DEFAULT`
  3652. can_zoom = true,
  3653. -- ^ For players only. Enables the zoom feature. Defaults to true
  3654. eye_height = 1.625,
  3655. -- ^ For players only. Camera height above feet position in nodes. Defaults to 1.625
  3656. physical = true,
  3657. collide_with_objects = true, -- collide with other objects if physical = true
  3658. weight = 5,
  3659. collisionbox = {-0.5, 0.0, -0.5, 0.5, 1.0, 0.5},
  3660. selectionbox = {-0.5, 0.0, -0.5, 0.5, 1.0, 0.5},
  3661. -- ^ Default, uses collision box dimensions when not set
  3662. pointable = true, -- overrides selection box when false
  3663. visual = "cube" / "sprite" / "upright_sprite" / "mesh" / "wielditem",
  3664. visual_size = {x = 1, y = 1},
  3665. mesh = "model",
  3666. textures = {}, -- number of required textures depends on visual
  3667. colors = {}, -- number of required colors depends on visual
  3668. spritediv = {x = 1, y = 1},
  3669. initial_sprite_basepos = {x = 0, y = 0},
  3670. is_visible = true,
  3671. makes_footstep_sound = false,
  3672. automatic_rotate = false,
  3673. stepheight = 0,
  3674. automatic_face_movement_dir = 0.0,
  3675. -- ^ Automatically set yaw to movement direction, offset in degrees,
  3676. -- 'false' to disable.
  3677. automatic_face_movement_max_rotation_per_sec = -1,
  3678. -- ^ Limit automatic rotation to this value in degrees per second,
  3679. -- value < 0 no limit.
  3680. backface_culling = true, -- false to disable backface_culling for model
  3681. glow = 0,
  3682. -- ^ Add this much extra lighting when calculating texture color.
  3683. -- Value < 0 disables light's effect on texture color.
  3684. -- For faking self-lighting, UI style entities, or programmatic coloring in mods.
  3685. nametag = "", -- by default empty, for players their name is shown if empty
  3686. nametag_color = <color>, -- sets color of nametag as ColorSpec
  3687. infotext = "", -- by default empty, text to be shown when pointed at object
  3688. static_save = true,
  3689. -- ^ If false, never save this object statically. It will simply be deleted when the
  3690. -- block gets unloaded.
  3691. -- The get_staticdata() callback is never called then.
  3692. -- Defaults to 'true'
  3693. }
  3694. ### Entity definition (`register_entity`)
  3695. {
  3696. -- Deprecated: Everything in object properties is read directly from here
  3697. initial_properties = --[[<initial object properties>]],
  3698. on_activate = function(self, staticdata, dtime_s),
  3699. on_step = function(self, dtime),
  3700. on_punch = function(self, puncher, time_from_last_punch, tool_capabilities, dir),
  3701. on_rightclick = function(self, clicker),
  3702. get_staticdata = function(self),
  3703. -- ^ Called sometimes; the string returned is passed to on_activate when
  3704. -- the entity is re-activated from static state
  3705. -- Also you can define arbitrary member variables here (see item definition for
  3706. -- more info)
  3707. _custom_field = whatever,
  3708. }
  3709. ### ABM (ActiveBlockModifier) definition (`register_abm`)
  3710. {
  3711. label = "Lava cooling",
  3712. -- ^ Descriptive label for profiling purposes (optional).
  3713. -- Definitions with identical labels will be listed as one.
  3714. -- In the following two fields, also group:groupname will work.
  3715. nodenames = {"default:lava_source"},
  3716. neighbors = {"default:water_source", "default:water_flowing"}, -- Any of these --[[
  3717. ^ If left out or empty, any neighbor will do ]]
  3718. interval = 1.0, -- Operation interval in seconds
  3719. chance = 1, -- Chance of trigger per-node per-interval is 1.0 / this
  3720. catch_up = true, -- If true, catch-up behaviour is enabled --[[
  3721. ^ The chance value is temporarily reduced when returning to
  3722. an area to simulate time lost by the area being unattended.
  3723. ^ Note chance value can often be reduced to 1 ]]
  3724. action = func(pos, node, active_object_count, active_object_count_wider),
  3725. }
  3726. ### LBM (LoadingBlockModifier) definition (`register_lbm`)
  3727. {
  3728. label = "Upgrade legacy doors",
  3729. -- ^ Descriptive label for profiling purposes (optional).
  3730. -- Definitions with identical labels will be listed as one.
  3731. name = "modname:replace_legacy_door",
  3732. nodenames = {"default:lava_source"},
  3733. -- ^ List of node names to trigger the LBM on.
  3734. -- Also non-registered nodes will work.
  3735. -- Groups (as of group:groupname) will work as well.
  3736. run_at_every_load = false,
  3737. -- ^ Whether to run the LBM's action every time a block gets loaded,
  3738. -- and not just for blocks that were saved last time before LBMs were
  3739. -- introduced to the world.
  3740. action = func(pos, node),
  3741. }
  3742. ### Item definition (`register_node`, `register_craftitem`, `register_tool`)
  3743. {
  3744. description = "Steel Axe",
  3745. groups = {}, -- key = name, value = rating; rating = 1..3.
  3746. if rating not applicable, use 1.
  3747. e.g. {wool = 1, fluffy = 3}
  3748. {soil = 2, outerspace = 1, crumbly = 1}
  3749. {bendy = 2, snappy = 1},
  3750. {hard = 1, metal = 1, spikes = 1}
  3751. inventory_image = "default_tool_steelaxe.png",
  3752. inventory_overlay = "overlay.png", -- an overlay which does not get colorized
  3753. wield_image = "",
  3754. wield_overlay = "",
  3755. palette = "",
  3756. --[[
  3757. ^ An image file containing the palette of a node.
  3758. ^ You can set the currently used color as the
  3759. ^ "palette_index" field of the item stack metadata.
  3760. ^ The palette is always stretched to fit indices
  3761. ^ between 0 and 255, to ensure compatibility with
  3762. ^ "colorfacedir" and "colorwallmounted" nodes.
  3763. ]]
  3764. color = "0xFFFFFFFF",
  3765. --[[
  3766. ^ The color of the item. The palette overrides this.
  3767. ]]
  3768. wield_scale = {x = 1, y = 1, z = 1},
  3769. stack_max = 99,
  3770. range = 4.0,
  3771. liquids_pointable = false,
  3772. tool_capabilities = {
  3773. full_punch_interval = 1.0,
  3774. max_drop_level = 0,
  3775. groupcaps = {
  3776. -- For example:
  3777. choppy = {times = {[1] = 2.50, [2] = 1.40, [3] = 1.00}, uses = 20, maxlevel = 2},
  3778. },
  3779. damage_groups = {groupname = damage},
  3780. },
  3781. node_placement_prediction = nil,
  3782. --[[
  3783. ^ If nil and item is node, prediction is made automatically
  3784. ^ If nil and item is not a node, no prediction is made
  3785. ^ If "" and item is anything, no prediction is made
  3786. ^ Otherwise should be name of node which the client immediately places
  3787. on ground when the player places the item. Server will always update
  3788. actual result to client in a short moment.
  3789. ]]
  3790. node_dig_prediction = "air",
  3791. --[[
  3792. ^ if "", no prediction is made
  3793. ^ if "air", node is removed
  3794. ^ Otherwise should be name of node which the client immediately places
  3795. upon digging. Server will always update actual result shortly.
  3796. ]]
  3797. sound = {
  3798. breaks = "default_tool_break", -- tools only
  3799. place = --[[<SimpleSoundSpec>]],
  3800. },
  3801. on_place = func(itemstack, placer, pointed_thing),
  3802. --[[
  3803. ^ Shall place item and return the leftover itemstack
  3804. ^ The placer may be any ObjectRef or nil.
  3805. ^ default: minetest.item_place ]]
  3806. on_secondary_use = func(itemstack, user, pointed_thing),
  3807. --[[
  3808. ^ Same as on_place but called when pointing at nothing.
  3809. ^ The user may be any ObjectRef or nil.
  3810. ^ pointed_thing : always { type = "nothing" }
  3811. ]]
  3812. on_drop = func(itemstack, dropper, pos),
  3813. --[[
  3814. ^ Shall drop item and return the leftover itemstack
  3815. ^ The dropper may be any ObjectRef or nil.
  3816. ^ default: minetest.item_drop ]]
  3817. on_use = func(itemstack, user, pointed_thing),
  3818. --[[
  3819. ^ default: nil
  3820. ^ Function must return either nil if no item shall be removed from
  3821. inventory, or an itemstack to replace the original itemstack.
  3822. e.g. itemstack:take_item(); return itemstack
  3823. ^ Otherwise, the function is free to do what it wants.
  3824. ^ The user may be any ObjectRef or nil.
  3825. ^ The default functions handle regular use cases.
  3826. ]]
  3827. after_use = func(itemstack, user, node, digparams),
  3828. --[[
  3829. ^ default: nil
  3830. ^ If defined, should return an itemstack and will be called instead of
  3831. wearing out the tool. If returns nil, does nothing.
  3832. If after_use doesn't exist, it is the same as:
  3833. function(itemstack, user, node, digparams)
  3834. itemstack:add_wear(digparams.wear)
  3835. return itemstack
  3836. end
  3837. ^ The user may be any ObjectRef or nil.
  3838. ]]
  3839. _custom_field = whatever,
  3840. --[[
  3841. ^ Add your own custom fields. By convention, all custom field names
  3842. should start with `_` to avoid naming collisions with future engine
  3843. usage.
  3844. ]]
  3845. }
  3846. ### Tile definition
  3847. * `"image.png"`
  3848. * `{name="image.png", animation={Tile Animation definition}}`
  3849. * `{name="image.png", backface_culling=bool, tileable_vertical=bool,
  3850. tileable_horizontal=bool, align_style="node"/"world"/"user", scale=int}`
  3851. * backface culling enabled by default for most nodes
  3852. * tileable flags are info for shaders, how they should treat texture
  3853. when displacement mapping is used
  3854. Directions are from the point of view of the tile texture,
  3855. not the node it's on
  3856. * align style determines whether the texture will be rotated with the node
  3857. or kept aligned with its surroundings. "user" means that client
  3858. setting will be used, similar to `glasslike_framed_optional`.
  3859. Note: supported by solid nodes and nodeboxes only.
  3860. * scale is used to make texture span several (exactly `scale`) nodes,
  3861. instead of just one, in each direction. Works for world-aligned
  3862. textures only.
  3863. Note that as the effect is applied on per-mapblock basis, `16` should
  3864. be equally divisible by `scale` or you may get wrong results.
  3865. * `{name="image.png", color=ColorSpec}`
  3866. * the texture's color will be multiplied with this color.
  3867. * the tile's color overrides the owning node's color in all cases.
  3868. * deprecated, yet still supported field names:
  3869. * `image` (name)
  3870. ### Tile animation definition
  3871. {
  3872. type = "vertical_frames",
  3873. aspect_w = 16,
  3874. -- ^ specify width of a frame in pixels
  3875. aspect_h = 16,
  3876. -- ^ specify height of a frame in pixels
  3877. length = 3.0,
  3878. -- ^ specify full loop length
  3879. }
  3880. {
  3881. type = "sheet_2d",
  3882. frames_w = 5,
  3883. -- ^ specify width in number of frames
  3884. frames_h = 3,
  3885. -- ^ specify height in number of frames
  3886. frame_length = 0.5,
  3887. -- ^ specify length of a single frame
  3888. }
  3889. ### Node definition (`register_node`)
  3890. {
  3891. -- <all fields allowed in item definitions>,
  3892. drawtype = "normal", -- See "Node drawtypes"
  3893. visual_scale = 1.0, --[[
  3894. ^ Supported for drawtypes "plantlike", "signlike", "torchlike",
  3895. ^ "firelike", "mesh".
  3896. ^ For plantlike and firelike, the image will start at the bottom of the
  3897. ^ node, for the other drawtypes the image will be centered on the node.
  3898. ^ Note that positioning for "torchlike" may still change. ]]
  3899. tiles = {tile definition 1, def2, def3, def4, def5, def6}, --[[
  3900. ^ Textures of node; +Y, -Y, +X, -X, +Z, -Z (old field name: tile_images)
  3901. ^ List can be shortened to needed length ]]
  3902. overlay_tiles = {tile definition 1, def2, def3, def4, def5, def6}, --[[
  3903. ^ Same as `tiles`, but these textures are drawn on top of the
  3904. ^ base tiles. You can use this to colorize only specific parts of
  3905. ^ your texture. If the texture name is an empty string, that
  3906. ^ overlay is not drawn. Since such tiles are drawn twice, it
  3907. ^ is not recommended to use overlays on very common nodes. ]]
  3908. special_tiles = {tile definition 1, Tile definition 2}, --[[
  3909. ^ Special textures of node; used rarely (old field name: special_materials)
  3910. ^ List can be shortened to needed length ]]
  3911. color = ColorSpec, --[[
  3912. ^ The node's original color will be multiplied with this color.
  3913. ^ If the node has a palette, then this setting only has an effect
  3914. ^ in the inventory and on the wield item. ]]
  3915. use_texture_alpha = false, -- Use texture's alpha channel
  3916. palette = "palette.png", --[[
  3917. ^ The node's `param2` is used to select a pixel from the image
  3918. ^ (pixels are arranged from left to right and from top to bottom).
  3919. ^ The node's color will be multiplied with the selected pixel's
  3920. ^ color. Tiles can override this behavior.
  3921. ^ Only when `paramtype2` supports palettes. ]]
  3922. post_effect_color = "green#0F", -- If player is inside node, see "ColorSpec"
  3923. paramtype = "none", -- See "Nodes" --[[
  3924. ^ paramtype = "light" allows light to propagate from or through the node with light value
  3925. ^ falling by 1 per node. This line is essential for a light source node to spread its light. ]]
  3926. paramtype2 = "none", -- See "Nodes"
  3927. place_param2 = nil, -- Force value for param2 when player places node
  3928. is_ground_content = true, -- If false, the cave generator will not carve through this
  3929. sunlight_propagates = false, -- If true, sunlight will go infinitely through this
  3930. walkable = true, -- If true, objects collide with node
  3931. pointable = true, -- If true, can be pointed at
  3932. diggable = true, -- If false, can never be dug
  3933. climbable = false, -- If true, can be climbed on (ladder)
  3934. buildable_to = false, -- If true, placed nodes can replace this node
  3935. floodable = false, --[[
  3936. ^ If true, liquids flow into and replace this node.
  3937. ^ Warning: making a liquid node 'floodable' does not work and may cause problems. ]]
  3938. liquidtype = "none", -- "none"/"source"/"flowing"
  3939. liquid_alternative_flowing = "", -- Flowing version of source liquid
  3940. liquid_alternative_source = "", -- Source version of flowing liquid
  3941. liquid_viscosity = 0, -- Higher viscosity = slower flow (max. 7)
  3942. liquid_renewable = true, --[[
  3943. ^ If true, a new liquid source can be created by placing two or more sources nearby ]]
  3944. leveled = 16, --[[
  3945. ^ Only valid for "nodebox" drawtype with 'type = "leveled"'.
  3946. ^ Allows defining the nodebox height without using param2.
  3947. ^ The nodebox height is 'leveled' / 64 nodes.
  3948. ^ The maximum value of 'leveled' is 127. ]]
  3949. liquid_range = 8, -- number of flowing nodes around source (max. 8)
  3950. drowning = 0, -- Player will take this amount of damage if no bubbles are left
  3951. light_source = 0, --[[
  3952. ^ Amount of light emitted by node.
  3953. ^ To set the maximum (currently 14), use the value 'minetest.LIGHT_MAX'.
  3954. ^ A value outside the range 0 to minetest.LIGHT_MAX causes undefined behavior.]]
  3955. damage_per_second = 0, -- If player is inside node, this damage is caused
  3956. node_box = {type="regular"}, -- See "Node boxes"
  3957. connects_to = nodenames, --[[
  3958. * Used for nodebox nodes with the type == "connected"
  3959. * Specifies to what neighboring nodes connections will be drawn
  3960. * e.g. `{"group:fence", "default:wood"}` or `"default:stone"` ]]
  3961. connect_sides = { "top", "bottom", "front", "left", "back", "right" }, --[[
  3962. ^ Tells connected nodebox nodes to connect only to these sides of this node. ]]
  3963. mesh = "model",
  3964. selection_box = {type="regular"}, -- See "Node boxes" --[[
  3965. ^ If drawtype "nodebox" is used and selection_box is nil, then node_box is used. ]]
  3966. legacy_facedir_simple = false, -- Support maps made in and before January 2012
  3967. legacy_wallmounted = false, -- Support maps made in and before January 2012
  3968. waving = 0, --[[ valid for mesh, nodebox, plantlike, allfaces_optional nodes
  3969. ^ 1 - wave node like plants (top of node moves, bottom is fixed)
  3970. ^ 2 - wave node like leaves (whole node moves side-to-side synchronously)
  3971. ^ caveats: not all models will properly wave
  3972. ^ plantlike drawtype nodes can only wave like plants
  3973. ^ allfaces_optional drawtype nodes can only wave like leaves --]]
  3974. sounds = {
  3975. footstep = <SimpleSoundSpec>,
  3976. dig = <SimpleSoundSpec>, -- "__group" = group-based sound (default)
  3977. dug = <SimpleSoundSpec>,
  3978. place = <SimpleSoundSpec>,
  3979. place_failed = <SimpleSoundSpec>,
  3980. },
  3981. drop = "", -- Name of dropped node when dug. Default is the node itself.
  3982. -- Alternatively:
  3983. drop = {
  3984. max_items = 1, -- Maximum number of items to drop.
  3985. items = { -- Choose max_items randomly from this list.
  3986. {
  3987. items = {"foo:bar", "baz:frob"}, -- Items to drop.
  3988. rarity = 1, -- Probability of dropping is 1 / rarity.
  3989. inherit_color = true, -- To inherit palette color from the node
  3990. },
  3991. },
  3992. },
  3993. on_construct = func(pos), --[[
  3994. ^ Node constructor; called after adding node
  3995. ^ Can set up metadata and stuff like that
  3996. ^ Not called for bulk node placement (i.e. schematics and VoxelManip)
  3997. ^ default: nil ]]
  3998. on_destruct = func(pos), --[[
  3999. ^ Node destructor; called before removing node
  4000. ^ Not called for bulk node placement (i.e. schematics and VoxelManip)
  4001. ^ default: nil ]]
  4002. after_destruct = func(pos, oldnode), --[[
  4003. ^ Node destructor; called after removing node
  4004. ^ Not called for bulk node placement (i.e. schematics and VoxelManip)
  4005. ^ default: nil ]]
  4006. on_flood = func(pos, oldnode, newnode), --[[
  4007. ^ Called when a liquid (newnode) is about to flood oldnode, if
  4008. ^ it has `floodable = true` in the nodedef. Not called for bulk
  4009. ^ node placement (i.e. schematics and VoxelManip) or air nodes. If
  4010. ^ return true the node is not flooded, but on_flood callback will
  4011. ^ most likely be called over and over again every liquid update
  4012. ^ interval. Default: nil.
  4013. ^ Warning: making a liquid node 'floodable' does not work and may cause problems. ]]
  4014. after_place_node = func(pos, placer, itemstack, pointed_thing) --[[
  4015. ^ Called after constructing node when node was placed using
  4016. minetest.item_place_node / minetest.place_node
  4017. ^ If return true no item is taken from itemstack
  4018. ^ `placer` may be any valid ObjectRef or nil
  4019. ^ default: nil ]]
  4020. after_dig_node = func(pos, oldnode, oldmetadata, digger), --[[
  4021. ^ oldmetadata is in table format
  4022. ^ Called after destructing node when node was dug using
  4023. minetest.node_dig / minetest.dig_node
  4024. ^ default: nil ]]
  4025. can_dig = function(pos, [player]) --[[
  4026. ^ returns true if node can be dug, or false if not
  4027. ^ default: nil ]]
  4028. on_punch = func(pos, node, puncher, pointed_thing), --[[
  4029. ^ default: minetest.node_punch
  4030. ^ By default: Calls minetest.register_on_punchnode callbacks ]]
  4031. on_rightclick = func(pos, node, clicker, itemstack, pointed_thing), --[[
  4032. ^ default: nil
  4033. ^ itemstack will hold clicker's wielded item
  4034. ^ Shall return the leftover itemstack
  4035. ^ Note: pointed_thing can be nil, if a mod calls this function
  4036. This function does not get triggered by clients <=0.4.16 if the
  4037. "formspec" node metadata field is set ]]
  4038. on_dig = func(pos, node, digger), --[[
  4039. ^ default: minetest.node_dig
  4040. ^ By default: checks privileges, wears out tool and removes node ]]
  4041. on_timer = function(pos,elapsed), --[[
  4042. ^ default: nil
  4043. ^ called by NodeTimers, see minetest.get_node_timer and NodeTimerRef
  4044. ^ elapsed is the total time passed since the timer was started
  4045. ^ return true to run the timer for another cycle with the same timeout value ]]
  4046. on_receive_fields = func(pos, formname, fields, sender), --[[
  4047. ^ fields = {name1 = value1, name2 = value2, ...}
  4048. ^ Called when an UI form (e.g. sign text input) returns data
  4049. ^ default: nil ]]
  4050. allow_metadata_inventory_move = func(pos, from_list, from_index,
  4051. to_list, to_index, count, player), --[[
  4052. ^ Called when a player wants to move items inside the inventory
  4053. ^ Return value: number of items allowed to move ]]
  4054. allow_metadata_inventory_put = func(pos, listname, index, stack, player), --[[
  4055. ^ Called when a player wants to put something into the inventory
  4056. ^ Return value: number of items allowed to put
  4057. ^ Return value: -1: Allow and don't modify item count in inventory ]]
  4058. allow_metadata_inventory_take = func(pos, listname, index, stack, player), --[[
  4059. ^ Called when a player wants to take something out of the inventory
  4060. ^ Return value: number of items allowed to take
  4061. ^ Return value: -1: Allow and don't modify item count in inventory ]]
  4062. on_metadata_inventory_move = func(pos, from_list, from_index,
  4063. to_list, to_index, count, player),
  4064. on_metadata_inventory_put = func(pos, listname, index, stack, player),
  4065. on_metadata_inventory_take = func(pos, listname, index, stack, player), --[[
  4066. ^ Called after the actual action has happened, according to what was allowed.
  4067. ^ No return value ]]
  4068. on_blast = func(pos, intensity), --[[
  4069. ^ intensity: 1.0 = mid range of regular TNT
  4070. ^ If defined, called when an explosion touches the node, instead of
  4071. removing the node ]]
  4072. }
  4073. ### Recipe for `register_craft` (shaped)
  4074. {
  4075. output = 'default:pick_stone',
  4076. recipe = {
  4077. {'default:cobble', 'default:cobble', 'default:cobble'},
  4078. {'', 'default:stick', ''},
  4079. {'', 'default:stick', ''}, -- Also groups; e.g. 'group:crumbly'
  4080. },
  4081. replacements = --[[<optional list of item pairs,
  4082. replace one input item with another item on crafting>]]
  4083. }
  4084. ### Recipe for `register_craft` (shapeless)
  4085. {
  4086. type = "shapeless",
  4087. output = 'mushrooms:mushroom_stew',
  4088. recipe = {
  4089. "mushrooms:bowl",
  4090. "mushrooms:mushroom_brown",
  4091. "mushrooms:mushroom_red",
  4092. },
  4093. replacements = --[[<optional list of item pairs,
  4094. replace one input item with another item on crafting>]]
  4095. }
  4096. ### Recipe for `register_craft` (tool repair)
  4097. {
  4098. type = "toolrepair",
  4099. additional_wear = -0.02,
  4100. }
  4101. ### Recipe for `register_craft` (cooking)
  4102. {
  4103. type = "cooking",
  4104. output = "default:glass",
  4105. recipe = "default:sand",
  4106. cooktime = 3,
  4107. }
  4108. ### Recipe for `register_craft` (furnace fuel)
  4109. {
  4110. type = "fuel",
  4111. recipe = "default:leaves",
  4112. burntime = 1,
  4113. }
  4114. ### Ore definition (`register_ore`)
  4115. See 'Ore types' section above for essential information.
  4116. {
  4117. ore_type = "scatter",
  4118. ore = "default:stone_with_coal",
  4119. ore_param2 = 3,
  4120. -- ^ Facedir rotation. Default is 0 (unchanged rotation)
  4121. wherein = "default:stone",
  4122. -- ^ a list of nodenames is supported too
  4123. clust_scarcity = 8 * 8 * 8,
  4124. -- ^ Ore has a 1 out of clust_scarcity chance of spawning in a node
  4125. -- ^ If the desired average distance between ores is 'd', set this to d * d * d.
  4126. clust_num_ores = 8,
  4127. -- ^ Number of ores in a cluster
  4128. clust_size = 3,
  4129. -- ^ Size of the bounding box of the cluster
  4130. -- ^ In this example, there is a 3 * 3 * 3 cluster where 8 out of the 27 nodes
  4131. -- ^ are coal ore.
  4132. y_min = -31000,
  4133. y_max = 64,
  4134. -- ^ Lower and upper limits for ore.
  4135. flags = "",
  4136. -- ^ Attributes for this ore generation, see 'Ore attributes' section above.
  4137. noise_threshold = 0.5,
  4138. -- ^ If noise is above this threshold, ore is placed. Not needed for a
  4139. -- ^ uniform distribution.
  4140. noise_params = {
  4141. offset = 0,
  4142. scale = 1,
  4143. spread = {x = 100, y = 100, z = 100},
  4144. seed = 23,
  4145. octaves = 3,
  4146. persist = 0.7
  4147. },
  4148. -- ^ NoiseParams structure describing one of the perlin noises used for ore
  4149. -- ^ distribution.
  4150. -- ^ Needed by "sheet", "puff", "blob" and "vein" ores.
  4151. -- ^ Omit from "scatter" ore for a uniform ore distribution.
  4152. -- ^ Omit from "stratum ore for a simple horizontal strata from y_min to y_max.
  4153. biomes = {"desert", "rainforest"}
  4154. -- ^ List of biomes in which this decoration occurs.
  4155. -- ^ Occurs in all biomes if this is omitted, and ignored if the Mapgen being
  4156. -- ^ used does not support biomes.
  4157. -- ^ Can be a list of (or a single) biome names, IDs, or definitions.
  4158. column_height_min = 1,
  4159. column_height_max = 16,
  4160. column_midpoint_factor = 0.5,
  4161. -- ^ See 'Ore types' section above.
  4162. -- ^ The above 3 parameters are only valid for "sheet" ore.
  4163. np_puff_top = {
  4164. offset = 4,
  4165. scale = 2,
  4166. spread = {x = 100, y = 100, z = 100},
  4167. seed = 47,
  4168. octaves = 3,
  4169. persist = 0.7
  4170. },
  4171. np_puff_bottom = {
  4172. offset = 4,
  4173. scale = 2,
  4174. spread = {x = 100, y = 100, z = 100},
  4175. seed = 11,
  4176. octaves = 3,
  4177. persist = 0.7
  4178. },
  4179. -- ^ See 'Ore types' section above.
  4180. -- ^ The above 2 parameters are only valid for "puff" ore.
  4181. random_factor = 1.0,
  4182. -- ^ See 'Ore types' section above.
  4183. -- ^ Only valid for "vein" ore.
  4184. np_stratum_thickness = {
  4185. offset = 8,
  4186. scale = 4,
  4187. spread = {x = 100, y = 100, z = 100},
  4188. seed = 17,
  4189. octaves = 3,
  4190. persist = 0.7
  4191. },
  4192. stratum_thickness = 8,
  4193. -- ^ See 'Ore types' section above.
  4194. -- ^ The above 2 parameters are only valid for "stratum" ore.
  4195. }
  4196. ### Biome definition (`register_biome`)
  4197. {
  4198. name = "tundra",
  4199. node_dust = "default:snow",
  4200. -- ^ Node dropped onto upper surface after all else is generated.
  4201. node_top = "default:dirt_with_snow",
  4202. depth_top = 1,
  4203. -- ^ Node forming surface layer of biome and thickness of this layer.
  4204. node_filler = "default:permafrost",
  4205. depth_filler = 3,
  4206. -- ^ Node forming lower layer of biome and thickness of this layer.
  4207. node_stone = "default:bluestone",
  4208. -- ^ Node that replaces all stone nodes between roughly y_min and y_max.
  4209. node_water_top = "default:ice",
  4210. depth_water_top = 10,
  4211. -- ^ Node forming a surface layer in seawater with the defined thickness.
  4212. node_water = "",
  4213. -- ^ Node that replaces all seawater nodes not in the defined surface layer.
  4214. node_river_water = "default:ice",
  4215. -- ^ Node that replaces river water in mapgens that use default:river_water.
  4216. node_riverbed = "default:gravel",
  4217. depth_riverbed = 2,
  4218. -- ^ Node placed under river water and thickness of this layer.
  4219. y_min = 1,
  4220. y_max = 31000,
  4221. -- ^ Lower and upper limits for biome.
  4222. heat_point = 0,
  4223. humidity_point = 50,
  4224. -- ^ Characteristic average temperature and humidity for the biome.
  4225. -- ^ These values create 'biome points' on a voronoi diagram that has heat
  4226. -- ^ and humidity as axes. The resulting voronoi cells determine which
  4227. -- ^ heat/humidity points belong to which biome, and therefore determine
  4228. -- ^ the area and location of each biome in the world.
  4229. -- ^ The biome points need to be carefully and evenly spaced on the voronoi
  4230. -- ^ diagram to result in roughly equal size biomes.
  4231. -- ^ Heat and humidity have average values of 50, vary mostly between
  4232. -- ^ 0 and 100 but also often exceed these values.
  4233. -- ^ Heat is not in degrees Celsius, both values are abstract.
  4234. }
  4235. ### Decoration definition (`register_decoration`)
  4236. {
  4237. deco_type = "simple", -- See "Decoration types"
  4238. place_on = "default:dirt_with_grass",
  4239. -- ^ Node (or list of nodes) that the decoration can be placed on
  4240. sidelen = 8,
  4241. -- ^ Size of divisions made in the chunk being generated.
  4242. -- ^ If the chunk size is not evenly divisible by sidelen, sidelen is made equal to the chunk size.
  4243. fill_ratio = 0.02,
  4244. -- ^ Ratio of the area to be uniformly filled by the decoration.
  4245. -- ^ Used only if noise_params is not specified.
  4246. noise_params = {offset=0, scale=.45, spread={x=100, y=100, z=100}, seed=354, octaves=3, persist=0.7},
  4247. -- ^ NoiseParams structure describing the perlin noise used for decoration distribution.
  4248. -- ^ The result of this is multiplied by the 2d area of the division being decorated.
  4249. biomes = {"Oceanside", "Hills", "Plains"},
  4250. -- ^ List of biomes in which this decoration occurs. Occurs in all biomes if this is omitted,
  4251. -- ^ and ignored if the Mapgen being used does not support biomes.
  4252. -- ^ Can be a list of (or a single) biome names, IDs, or definitions.
  4253. y_min = -31000
  4254. y_max = 31000
  4255. -- ^ Lower and upper limits for decoration.
  4256. -- ^ These parameters refer to the Y co-ordinate of the 'place_on' node.
  4257. spawn_by = "default:water",
  4258. -- ^ Node (or list of nodes) that the decoration only spawns next to.
  4259. -- ^ Checks two horizontal planes of neighbouring nodes (including diagonal neighbours),
  4260. -- ^ one plane level with the 'place_on' node and a plane one node above that.
  4261. num_spawn_by = 1,
  4262. -- ^ Number of spawn_by nodes that must be surrounding the decoration position to occur.
  4263. -- ^ If absent or -1, decorations occur next to any nodes.
  4264. flags = "liquid_surface, force_placement, all_floors, all_ceilings",
  4265. -- ^ Flags for all decoration types.
  4266. -- ^ "liquid_surface": Instead of placement on the highest solid surface
  4267. -- ^ in a mapchunk column, placement is on the highest liquid surface.
  4268. -- ^ Placement is disabled if solid nodes are found above the liquid
  4269. -- ^ surface.
  4270. -- ^ "force_placement": Nodes other than "air" and "ignore" are replaced
  4271. -- ^ by the decoration.
  4272. -- ^ "all_floors", "all_ceilings": Instead of placement on the highest
  4273. -- ^ surface in a mapchunk the decoration is placed on all floor and/or
  4274. -- ^ ceiling surfaces, for example in caves.
  4275. -- ^ Ceiling decorations act as an inversion of floor decorations so the
  4276. -- ^ effect of 'place_offset_y' is inverted.
  4277. -- ^ If a single decoration registration has both flags the floor and
  4278. -- ^ ceiling decorations will be aligned vertically and may sometimes
  4279. -- ^ meet to form a column.
  4280. ----- Simple-type parameters
  4281. decoration = "default:grass",
  4282. -- ^ The node name used as the decoration.
  4283. -- ^ If instead a list of strings, a randomly selected node from the list is placed as the decoration.
  4284. height = 1,
  4285. -- ^ Decoration height in nodes.
  4286. -- ^ If height_max is not 0, this is the lower limit of a randomly selected height.
  4287. height_max = 0,
  4288. -- ^ Upper limit of the randomly selected height.
  4289. -- ^ If absent, the parameter 'height' is used as a constant.
  4290. param2 = 0,
  4291. -- ^ Param2 value of decoration nodes.
  4292. -- ^ If param2_max is not 0, this is the lower limit of a randomly selected param2.
  4293. param2_max = 0,
  4294. -- ^ Upper limit of the randomly selected param2.
  4295. -- ^ If absent, the parameter 'param2' is used as a constant.
  4296. place_offset_y = 0,
  4297. -- ^ Y offset of the decoration base node relative to the standard base
  4298. -- ^ node position.
  4299. -- ^ Can be positive or negative. Default is 0.
  4300. -- ^ Effect is inverted for "all_ceilings" decorations.
  4301. -- ^ Ignored by 'y_min', 'y_max' and 'spawn_by' checks, which always refer
  4302. -- ^ to the 'place_on' node.
  4303. ----- Schematic-type parameters
  4304. schematic = "foobar.mts",
  4305. -- ^ If schematic is a string, it is the filepath relative to the current working directory of the
  4306. -- ^ specified Minetest schematic file.
  4307. -- ^ - OR -, could be the ID of a previously registered schematic
  4308. -- ^ - OR -, could instead be a table containing two mandatory fields, size and data,
  4309. -- ^ and an optional table yslice_prob:
  4310. schematic = {
  4311. size = {x=4, y=6, z=4},
  4312. data = {
  4313. {name="default:cobble", param1=255, param2=0},
  4314. {name="default:dirt_with_grass", param1=255, param2=0},
  4315. {name="ignore", param1=255, param2=0},
  4316. {name="air", param1=255, param2=0},
  4317. ...
  4318. },
  4319. yslice_prob = {
  4320. {ypos=2, prob=128},
  4321. {ypos=5, prob=64},
  4322. ...
  4323. },
  4324. },
  4325. -- ^ See 'Schematic specifier' for details.
  4326. replacements = {["oldname"] = "convert_to", ...},
  4327. flags = "place_center_x, place_center_y, place_center_z",
  4328. -- ^ Flags for schematic decorations. See 'Schematic attributes'.
  4329. rotation = "90" -- rotate schematic 90 degrees on placement
  4330. -- ^ Rotation can be "0", "90", "180", "270", or "random".
  4331. place_offset_y = 0,
  4332. -- ^ If the flag 'place_center_y' is set this parameter is ignored.
  4333. -- ^ Y offset of the schematic base node layer relative to the 'place_on'
  4334. -- ^ node.
  4335. -- ^ Can be positive or negative. Default is 0.
  4336. -- ^ Effect is inverted for "all_ceilings" decorations.
  4337. -- ^ Ignored by 'y_min', 'y_max' and 'spawn_by' checks, which always refer
  4338. -- ^ to the 'place_on' node.
  4339. }
  4340. ### Chat command definition (`register_chatcommand`)
  4341. {
  4342. params = "<name> <privilege>", -- Short parameter description
  4343. description = "Remove privilege from player", -- Full description
  4344. privs = {privs=true}, -- Require the "privs" privilege to run
  4345. func = function(name, param), -- Called when command is run.
  4346. -- Returns boolean success and text output.
  4347. }
  4348. ### Detached inventory callbacks
  4349. {
  4350. allow_move = func(inv, from_list, from_index, to_list, to_index, count, player),
  4351. -- ^ Called when a player wants to move items inside the inventory
  4352. -- ^ Return value: number of items allowed to move
  4353. allow_put = func(inv, listname, index, stack, player),
  4354. -- ^ Called when a player wants to put something into the inventory
  4355. -- ^ Return value: number of items allowed to put
  4356. -- ^ Return value: -1: Allow and don't modify item count in inventory
  4357. allow_take = func(inv, listname, index, stack, player),
  4358. -- ^ Called when a player wants to take something out of the inventory
  4359. -- ^ Return value: number of items allowed to take
  4360. -- ^ Return value: -1: Allow and don't modify item count in inventory
  4361. on_move = func(inv, from_list, from_index, to_list, to_index, count, player),
  4362. on_put = func(inv, listname, index, stack, player),
  4363. on_take = func(inv, listname, index, stack, player),
  4364. -- ^ Called after the actual action has happened, according to what was allowed.
  4365. -- ^ No return value
  4366. }
  4367. ### HUD Definition (`hud_add`, `hud_get`)
  4368. {
  4369. hud_elem_type = "image", -- see HUD element types
  4370. -- ^ type of HUD element, can be either of "image", "text", "statbar", or "inventory"
  4371. position = {x=0.5, y=0.5},
  4372. -- ^ Left corner position of element
  4373. name = "<name>",
  4374. scale = {x=2, y=2},
  4375. text = "<text>",
  4376. number = 2,
  4377. item = 3,
  4378. -- ^ Selected item in inventory. 0 for no item selected.
  4379. direction = 0,
  4380. -- ^ Direction: 0: left-right, 1: right-left, 2: top-bottom, 3: bottom-top
  4381. alignment = {x=0, y=0},
  4382. -- ^ See "HUD Element Types"
  4383. offset = {x=0, y=0},
  4384. -- ^ See "HUD Element Types"
  4385. size = { x=100, y=100 },
  4386. -- ^ Size of element in pixels
  4387. }
  4388. ### Particle definition (`add_particle`)
  4389. {
  4390. pos = {x=0, y=0, z=0},
  4391. velocity = {x=0, y=0, z=0},
  4392. acceleration = {x=0, y=0, z=0},
  4393. -- ^ Spawn particle at pos with velocity and acceleration
  4394. expirationtime = 1,
  4395. -- ^ Disappears after expirationtime seconds
  4396. size = 1,
  4397. collisiondetection = false,
  4398. -- ^ collisiondetection: if true collides with physical objects
  4399. collision_removal = false,
  4400. -- ^ collision_removal: if true then particle is removed when it collides,
  4401. -- ^ requires collisiondetection = true to have any effect
  4402. vertical = false,
  4403. -- ^ vertical: if true faces player using y axis only
  4404. texture = "image.png",
  4405. -- ^ Uses texture (string)
  4406. playername = "singleplayer",
  4407. -- ^ optional, if specified spawns particle only on the player's client
  4408. animation = {Tile Animation definition},
  4409. -- ^ optional, specifies how to animate the particle texture
  4410. glow = 0
  4411. -- ^ optional, specify particle self-luminescence in darkness
  4412. }
  4413. ### `ParticleSpawner` definition (`add_particlespawner`)
  4414. {
  4415. amount = 1,
  4416. time = 1,
  4417. -- ^ If time is 0 has infinite lifespan and spawns the amount on a per-second base
  4418. minpos = {x=0, y=0, z=0},
  4419. maxpos = {x=0, y=0, z=0},
  4420. minvel = {x=0, y=0, z=0},
  4421. maxvel = {x=0, y=0, z=0},
  4422. minacc = {x=0, y=0, z=0},
  4423. maxacc = {x=0, y=0, z=0},
  4424. minexptime = 1,
  4425. maxexptime = 1,
  4426. minsize = 1,
  4427. maxsize = 1,
  4428. -- ^ The particle's properties are random values in between the bounds:
  4429. -- ^ minpos/maxpos, minvel/maxvel (velocity), minacc/maxacc (acceleration),
  4430. -- ^ minsize/maxsize, minexptime/maxexptime (expirationtime)
  4431. collisiondetection = false,
  4432. -- ^ collisiondetection: if true uses collision detection
  4433. collision_removal = false,
  4434. -- ^ collision_removal: if true then particle is removed when it collides,
  4435. -- ^ requires collisiondetection = true to have any effect
  4436. attached = ObjectRef,
  4437. -- ^ attached: if defined, particle positions, velocities and accelerations
  4438. -- ^ are relative to this object's position and yaw.
  4439. vertical = false,
  4440. -- ^ vertical: if true faces player using y axis only
  4441. texture = "image.png",
  4442. -- ^ Uses texture (string)
  4443. playername = "singleplayer"
  4444. -- ^ Playername is optional, if specified spawns particle only on the player's client
  4445. }
  4446. ### `HTTPRequest` definition (`HTTPApiTable.fetch_async`, `HTTPApiTable.fetch_async`)
  4447. {
  4448. url = "http://example.org",
  4449. timeout = 10,
  4450. -- ^ Timeout for connection in seconds. Default is 3 seconds.
  4451. post_data = "Raw POST request data string" OR { field1 = "data1", field2 = "data2" },
  4452. -- ^ Optional, if specified a POST request with post_data is performed.
  4453. -- ^ Accepts both a string and a table. If a table is specified, encodes table
  4454. -- ^ as x-www-form-urlencoded key-value pairs.
  4455. -- ^ If post_data ist not specified, a GET request is performed instead.
  4456. user_agent = "ExampleUserAgent",
  4457. -- ^ Optional, if specified replaces the default minetest user agent with given string
  4458. extra_headers = { "Accept-Language: en-us", "Accept-Charset: utf-8" },
  4459. -- ^ Optional, if specified adds additional headers to the HTTP request. You must make sure
  4460. -- ^ that the header strings follow HTTP specification ("Key: Value").
  4461. multipart = boolean
  4462. -- ^ Optional, if true performs a multipart HTTP request. Default is false.
  4463. }
  4464. ### `HTTPRequestResult` definition (`HTTPApiTable.fetch` callback, `HTTPApiTable.fetch_async_get`)
  4465. {
  4466. completed = true,
  4467. -- ^ If true, the request has finished (either succeeded, failed or timed out)
  4468. succeeded = true,
  4469. -- ^ If true, the request was successful
  4470. timeout = false,
  4471. -- ^ If true, the request timed out
  4472. code = 200,
  4473. -- ^ HTTP status code
  4474. data = "response"
  4475. }
  4476. ### Authentication handler definition
  4477. {
  4478. get_auth = func(name),
  4479. -- ^ Get authentication data for existing player `name` (`nil` if player doesn't exist)
  4480. -- ^ returns following structure `{password=<string>, privileges=<table>, last_login=<number or nil>}`
  4481. create_auth = func(name, password),
  4482. -- ^ Create new auth data for player `name`
  4483. -- ^ Note that `password` is not plain-text but an arbitrary representation decided by the engine
  4484. set_password = func(name, password),
  4485. -- ^ Set password of player `name` to `password`
  4486. Auth data should be created if not present
  4487. set_privileges = func(name, privileges),
  4488. -- ^ Set privileges of player `name`
  4489. -- ^ `privileges` is in table form, auth data should be created if not present
  4490. reload = func(),
  4491. -- ^ Reload authentication data from the storage location
  4492. -- ^ Returns boolean indicating success
  4493. record_login = func(name),
  4494. -- ^ Called when player joins, used for keeping track of last_login
  4495. }