docu_minecraft_paper.php 149 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905
  1. <section id="Event-List">
  2. <table>
  3. <tr>
  4. <th class="command"></th>
  5. <th class="desc">footnote</th>
  6. </tr>
  7. <tr>
  8. <td class="bold">*</td>
  9. <td>writable</td>
  10. </tr>
  11. <tr>
  12. <td class="bold">**</td>
  13. <td>can be null</td>
  14. </tr>
  15. <tr>
  16. <td class="bold">receiver</td>
  17. <td>sender (player / console)<br>"dev" (perm "script.debug" needed)<br>"online"<br>"server"</td>
  18. </tr>
  19. </table>
  20. <table>
  21. <tr>
  22. <th class="command">entity_change_block</th>
  23. <th class="desc">an entity changes a block</th>
  24. </tr>
  25. <tr>
  26. <td class="bold">Variables</td>
  27. <td>entity<br>block<br>change_data as blockdata for the new state<br>*cancel</td>
  28. </tr>
  29. </table>
  30. <table>
  31. <tr>
  32. <th class="command">entity_damage</th>
  33. <th class="desc">an entity gets damage</th>
  34. </tr>
  35. <tr>
  36. <td class="bold">Variables</td>
  37. <td>entity<br>damage_source<br><a href="https://papermc.io/javadocs/paper/1.18/org/bukkit/event/entity/EntityDamageEvent.DamageCause.html" target="_blank">cause</a> as string<br>**damager_block<br>**damager_entity<br>damage<br>raw_damage<br>*cancel</td>
  38. </tr>
  39. </table>
  40. <table>
  41. <tr>
  42. <th class="command">entity_heal</th>
  43. <th class="desc">an entity gets healed</th>
  44. </tr>
  45. <tr>
  46. <td class="bold">Variables</td>
  47. <td>entity<br>*heal<br><a href="https://papermc.io/javadocs/paper/1.18/org/bukkit/event/entity/EntityRegainHealthEvent.RegainReason.html" target="_blank">cause</a> as string<br>*cancel</td>
  48. </tr>
  49. </table>
  50. <table>
  51. <tr>
  52. <th class="command">living_death</th>
  53. <th class="desc">a living_entity dies</th>
  54. </tr>
  55. <tr>
  56. <td class="bold">Variables</td>
  57. <td>living_entity<br>damage_source<br>*drops as list of itemstacks<br>*experience<br>*cancel</td>
  58. </tr>
  59. </table>
  60. <table>
  61. <tr>
  62. <th class="command">block_drop</th>
  63. <th class="desc">a destroyed block drops something</th>
  64. </tr>
  65. <tr>
  66. <td class="bold">Variables</td>
  67. <td>player<br>block<br>*drops as list with ItemEntities</td>
  68. </tr>
  69. </table>
  70. <table>
  71. <tr>
  72. <th class="command">entity_click</th>
  73. <th class="desc">an entity gets right_clicked</th>
  74. </tr>
  75. <tr>
  76. <td class="bold">Variables</td>
  77. <td>player<br>entity<br><a href="https://papermc.io/javadocs/paper/1.18/org/bukkit/inventory/EquipmentSlot.html" target="_blank">hand</a><br>*cancel</td>
  78. </tr>
  79. </table>
  80. </table>
  81. <table>
  82. <tr>
  83. <th class="command">living_spawn</th>
  84. <th class="desc">a living entity spawns</th>
  85. </tr>
  86. <tr>
  87. <td class="bold">Variables</td>
  88. <td>living_entity<br><a href="https://papermc.io/javadocs/paper/1.18/org/bukkit/event/entity/CreatureSpawnEvent.SpawnReason.html" target="_blank">cause</a> as string<br>location<br>*cancel</td>
  89. </tr>
  90. </table>
  91. <table>
  92. <tr>
  93. <th class="command">entity_spawn</th>
  94. <th class="desc">an entity spawns</th>
  95. </tr>
  96. <tr>
  97. <td class="bold">Variables</td>
  98. <td>entity<br>location<br>*cancel</td>
  99. </tr>
  100. </table>
  101. <table>
  102. <tr>
  103. <th class="command">entity_remove</th>
  104. <th class="desc">an entity is removed from a world</th>
  105. </tr>
  106. <tr>
  107. <td class="bold">Variables</td>
  108. <td>entity</td>
  109. </tr>
  110. </table>
  111. <table>
  112. <tr>
  113. <th class="command">living_tame</th>
  114. <th class="desc">a living entity gets tamed</th>
  115. </tr>
  116. <tr>
  117. <td class="bold">Variables</td>
  118. <td>living_entity<br>tamer<br>*cancel</td>
  119. </tr>
  120. </table>
  121. <table>
  122. <tr>
  123. <th class="command">entity_mount</th>
  124. <th class="desc">an entity mounts another entity</th>
  125. </tr>
  126. <tr>
  127. <td class="bold">Variables</td>
  128. <td>entity<br>mount as entity<br>*cancel</td>
  129. </tr>
  130. </table>
  131. <table>
  132. <tr>
  133. <th class="command">player_login</th>
  134. <th class="desc">a player tries to connect to the server</th>
  135. </tr>
  136. <tr>
  137. <td class="bold">Variables</td>
  138. <td>player<br>result</td>
  139. </tr>
  140. </table>
  141. <table>
  142. <tr>
  143. <th class="command">player_join</th>
  144. <th class="desc">a player joins the server</th>
  145. </tr>
  146. <tr>
  147. <td class="bold">Variables</td>
  148. <td>player<br>*message as text</td>
  149. </tr>
  150. <tr>
  151. <td class="bold">Info</td>
  152. <td>message = null means no message</td>
  153. </tr>
  154. </table>
  155. <table>
  156. <tr>
  157. <th class="command">player_quit</th>
  158. <th class="desc">a player leaves the server</th>
  159. </tr>
  160. <tr>
  161. <td class="bold">Variables</td>
  162. <td>player<br>*message as text</td>
  163. </tr>
  164. <tr>
  165. <td class="bold">Info</td>
  166. <td>message = null means no message</td>
  167. </tr>
  168. </table>
  169. <table>
  170. <tr>
  171. <th class="command">player_pre_respawn</th>
  172. <th class="desc">a player will respawn</th>
  173. </tr>
  174. <tr>
  175. <td class="bold">Variables</td>
  176. <td>player</td>
  177. </tr>
  178. <tr>
  179. <td class="bold">Info</td>
  180. <td>devs can set the spawn-location on this event</td>
  181. </tr>
  182. </table>
  183. <table>
  184. <tr>
  185. <th class="command">player_post_respawn</th>
  186. <th class="desc">a player has respawned</th>
  187. </tr>
  188. <tr>
  189. <td class="bold">Variables</td>
  190. <td>player</td>
  191. </tr>
  192. <tr>
  193. <td class="bold">Info</td>
  194. <td>devs can refill the inventory on this event</td>
  195. </tr>
  196. </table>
  197. <table>
  198. <tr>
  199. <th class="command">player_toggle_sneak</th>
  200. <th class="desc">a player toggles sneak</th>
  201. </tr>
  202. <tr>
  203. <td class="bold">Variables</td>
  204. <td>player<br>sneak as boolean<br>*cancel</td>
  205. </tr>
  206. </table>
  207. <table>
  208. <tr>
  209. <th class="command">player_drop</th>
  210. <th class="desc">a player drops an item</th>
  211. </tr>
  212. <tr>
  213. <td class="bold">Variables</td>
  214. <td>player<br>item_entity<br>*cancel</td>
  215. </tr>
  216. </table>
  217. <table>
  218. <tr>
  219. <th class="command">living_pickup</th>
  220. <th class="desc">a living entity picks up an item</th>
  221. </tr>
  222. <tr>
  223. <td class="bold">Variables</td>
  224. <td>living_entity<br>item_entity<br>*cancel</td>
  225. </tr>
  226. </table>
  227. <table>
  228. <tr>
  229. <th class="command">player_move</th>
  230. <th class="desc">a player moves in a before defined area</th>
  231. </tr>
  232. <tr>
  233. <td class="bold">Variables</td>
  234. <td>player<br>id</td>
  235. </tr>
  236. </table>
  237. <table>
  238. <tr>
  239. <th class="command">block_break</th>
  240. <th class="desc">a block is broken</th>
  241. </tr>
  242. <tr>
  243. <td class="bold">Variables</td>
  244. <td>player<br>block<br>*cancel</td>
  245. </tr>
  246. </table>
  247. <table>
  248. <tr>
  249. <th class="command">block_place</th>
  250. <th class="desc">a block is placed</th>
  251. </tr>
  252. <tr>
  253. <td class="bold">Variables</td>
  254. <td>player<br>block<br><a href="https://papermc.io/javadocs/paper/1.18/org/bukkit/inventory/EquipmentSlot.html" target="_blank">hand</a><br>*cancel</td>
  255. </tr>
  256. </table>
  257. <table>
  258. <tr>
  259. <th class="command">block_click</th>
  260. <th class="desc">a block gets clicked</th>
  261. </tr>
  262. <tr>
  263. <td class="bold">Variables</td>
  264. <td>player<br>**block<br><a href="https://papermc.io/javadocs/paper/1.18/org/bukkit/event/block/Action.html" target="_blank">action</a> as string<br><a href="https://papermc.io/javadocs/paper/1.18/org/bukkit/inventory/EquipmentSlot.html" target="_blank">hand</a><br>*cancel</td>
  265. </tr>
  266. </table>
  267. <table>
  268. <tr>
  269. <th class="command">bucket_use</th>
  270. <th class="desc">a bucket is filled / vacated</th>
  271. </tr>
  272. <tr>
  273. <td class="bold">Variables</td>
  274. <td>player<br>block<br>bucket as material<br><a href="https://papermc.io/javadocs/paper/1.18/org/bukkit/inventory/EquipmentSlot.html" target="_blank">hand</a><br>*cancel</td>
  275. </tr>
  276. </table>
  277. <table>
  278. <tr>
  279. <th class="command">inv_click</th>
  280. <th class="desc">a slot in an container gets clicked</th>
  281. </tr>
  282. <tr>
  283. <td class="bold">Variables</td>
  284. <td>player<br>inv<br>**inv_clicked<br>inv_title as text<br>inv_slot as double<br><a href="https://papermc.io/javadocs/paper/1.18/org/bukkit/event/inventory/ClickType.html" target="_blank">click</a> as string<br><a href="https://papermc.io/javadocs/paper/1.18/org/bukkit/event/inventory/InventoryAction.html" target="_blank">action</a> as string<br>*cancel</td>
  285. </tr>
  286. </table>
  287. <table>
  288. <tr>
  289. <th class="command">snuvi_click</th>
  290. <th class="desc">a slot in an custom inventory gets clicked</th>
  291. </tr>
  292. <tr>
  293. <td class="bold">Variables</td>
  294. <td>player<br>inv<br>inv_title as text<br>inv_slot as double<br><a href="https://papermc.io/javadocs/paper/1.18/org/bukkit/event/inventory/ClickType.html" target="_blank">click</a> as string<br><a href="https://papermc.io/javadocs/paper/1.18/org/bukkit/event/inventory/InventoryAction.html" target="_blank">action</a> as string</td>
  295. </tr>
  296. <tr>
  297. <td class="bold">Info</td>
  298. <td>Custom inventories are not script-across.</td>
  299. </tr>
  300. </table>
  301. <table>
  302. <tr>
  303. <th class="command">inv_close</th>
  304. <th class="desc">an inventory gets closed</th>
  305. </tr>
  306. <tr>
  307. <td class="bold">Variables</td>
  308. <td>player<br>inv<br>inv_title as text</td>
  309. </tr>
  310. </table>
  311. <table>
  312. <tr>
  313. <th class="command">item_consume</th>
  314. <th class="desc">an item gets consumed by a player</th>
  315. </tr>
  316. <tr>
  317. <td class="bold">Variables</td>
  318. <td>player<br>item<br>*cancel</td>
  319. </tr>
  320. </table>
  321. <table>
  322. <tr>
  323. <th class="command">pre_craft</th>
  324. <th class="desc">a player crafts an item</th>
  325. </tr>
  326. <tr>
  327. <td class="bold">Variables</td>
  328. <td>players as list with players<br>*item<br>*inv</td>
  329. </tr>
  330. <tr>
  331. <td class="bold">Info</td>
  332. <td>item can be set to null</td>
  333. </tr>
  334. </table>
  335. <table>
  336. <tr>
  337. <th class="command">craft</th>
  338. <th class="desc">a player takes the result item out of craft inventory</th>
  339. </tr>
  340. <tr>
  341. <td class="bold">Variables</td>
  342. <td>player<br>item<br>*cancel</td>
  343. </tr>
  344. </table>
  345. <table>
  346. <tr>
  347. <th class="command">player_change_world</th>
  348. <th class="desc">a player changes the world</th>
  349. </tr>
  350. <tr>
  351. <td class="bold">Variables</td>
  352. <td>player<br>from world as string</td>
  353. </tr>
  354. </table>
  355. <table>
  356. <tr>
  357. <th class="command">player_teleport</th>
  358. <th class="desc">a player teleports</th>
  359. </tr>
  360. <tr>
  361. <td class="bold">Variables</td>
  362. <td>player<br>from as location<br>to as location<br><a href="https://papermc.io/javadocs/paper/1.18/org/bukkit/event/player/PlayerTeleportEvent.TeleportCause.html" target="_blank">cause</a> as string<br>*cancel</td>
  363. </tr>
  364. </table>
  365. <table>
  366. <tr>
  367. <th class="command">fishing</th>
  368. <th class="desc">a player fishes something</th>
  369. </tr>
  370. <tr>
  371. <td class="bold">Variables</td>
  372. <td>player<br>**entity<br>*experience<br>hook as entity<br>*cancel</td>
  373. </tr>
  374. </table>
  375. <table>
  376. <tr>
  377. <th class="command">command</th>
  378. <th class="desc">a player uses a non custom-command</th>
  379. </tr>
  380. <tr>
  381. <td class="bold">Variables</td>
  382. <td>player<br>command as string<br>*cancel</td>
  383. </tr>
  384. </table>
  385. <table>
  386. <tr>
  387. <th class="command">custom_command</th>
  388. <th class="desc">something uses a custom-command</th>
  389. </tr>
  390. <tr>
  391. <td class="bold">Variables</td>
  392. <td>sender<br>command as string<br>args as list<br>string_args as list with strings only</td>
  393. </tr>
  394. <tr>
  395. <td class="bold">Info</td>
  396. <td>sender can be a player, console...<br></td>
  397. </tr>
  398. </table>
  399. <table>
  400. <tr>
  401. <th class="command">chat</th>
  402. <th class="desc">a player writes into chat</th>
  403. </tr>
  404. <tr>
  405. <td class="bold">Variables</td>
  406. <td>player<br>*message as text<br>*cancel</td>
  407. </tr>
  408. <tr>
  409. <td class="bold">Info</td>
  410. <td>This event is fired asynchronous</td>
  411. </tr>
  412. </table>
  413. <table>
  414. <tr>
  415. <th class="command">projectile_hit</th>
  416. <th class="desc">a thrown projectile hits a block or an entity</th>
  417. </tr>
  418. <tr>
  419. <td class="bold">Variables</td>
  420. <td>**shooter<br>projectile<br>**entity_hit<br>**block_hit<br>*cancel</td>
  421. </tr>
  422. </table>
  423. <table>
  424. <tr>
  425. <th class="command">arm_swing</th>
  426. <th class="desc">a player makes an arm_swing (might be a leftclick into air)</th>
  427. </tr>
  428. <tr>
  429. <td class="bold">Variables</td>
  430. <td>player<br><a href="https://papermc.io/javadocs/paper/1.18/org/bukkit/inventory/EquipmentSlot.html" target="_blank">hand</a><br>*cancel</td>
  431. </tr>
  432. </table>
  433. <table>
  434. <tr>
  435. <th class="command">human_damage</th>
  436. <th class="desc">a human gets damage</th>
  437. </tr>
  438. <tr>
  439. <td class="bold">Variables</td>
  440. <td>human<br>damage_source<br>damage<br>*cancel | true</td>
  441. </tr>
  442. </table>
  443. <table>
  444. <tr>
  445. <th class="command">explosion</th>
  446. <th class="desc">explosions are cancelled on default</th>
  447. </tr>
  448. <tr>
  449. <td class="bold">Variables</td>
  450. <td>entity<br>*fire as boolean<br>*radius<br>*cancel | true</td>
  451. </tr>
  452. </table>
  453. <table>
  454. <tr>
  455. <th class="command">missing_command</th>
  456. <th class="desc">a sender uses a non-existing command</th>
  457. </tr>
  458. <tr>
  459. <td class="bold">Variables</td>
  460. <td>sender<br>command</td>
  461. </tr>
  462. </table>
  463. <table>
  464. <tr>
  465. <th class="command">missing_perm</th>
  466. <th class="desc">a sender has no permissions for a used command</th>
  467. </tr>
  468. <tr>
  469. <td class="bold">Variables</td>
  470. <td>sender<br>command</td>
  471. </tr>
  472. </table>
  473. <table>
  474. <tr>
  475. <th class="command">player_data_tick</th>
  476. <th class="desc">thrown if a timer from data.setTimer reached 0</th>
  477. </tr>
  478. <tr>
  479. <td class="bold">Variables</td>
  480. <td>player<br>var</td>
  481. </tr>
  482. </table>
  483. <table>
  484. <tr>
  485. <th class="command">player_elytra_start</th>
  486. <th class="desc">thrown if a player starts using an elytra</th>
  487. </tr>
  488. <tr>
  489. <td class="bold">Variables</td>
  490. <td>player</td>
  491. </tr>
  492. </table>
  493. <table>
  494. <tr>
  495. <th class="command">player_elytra_stop</th>
  496. <th class="desc">thrown if a player stops using an elytra</th>
  497. </tr>
  498. <tr>
  499. <td class="bold">Variables</td>
  500. <td>player</td>
  501. </tr>
  502. </table>
  503. <table>
  504. <tr>
  505. <th class="command">player_item_held</th>
  506. <th class="desc">a player changes their hotbar slot</th>
  507. </tr>
  508. <tr>
  509. <td class="bold">Variables</td>
  510. <td>player<br>from as double<br>to as double<br>*cancel</td>
  511. </tr>
  512. </table>
  513. <table>
  514. <tr>
  515. <th class="command">player_swap_hand_items</th>
  516. <th class="desc">a player swaps their items in their hands</th>
  517. </tr>
  518. <tr>
  519. <td class="bold">Variables</td>
  520. <td>player<br>*cancel</td>
  521. </tr>
  522. </table>
  523. <table>
  524. <tr>
  525. <th class="command">world_load</th>
  526. <th class="desc">a world gets loaded</th>
  527. </tr>
  528. <tr>
  529. <td class="bold">Variables</td>
  530. <td>world</td>
  531. </tr>
  532. </table>
  533. <table>
  534. <tr>
  535. <th class="command">vote</th>
  536. <th class="desc">a vote gets received</th>
  537. </tr>
  538. <tr>
  539. <td class="bold">Variables</td>
  540. <td>from as string<br>name as string<br>ip as string<br>timestamp as double</td>
  541. </tr>
  542. </table>
  543. </section>
  544. <section id="Event">
  545. <table>
  546. <tr>
  547. <th class="command">event.addMoveData</th>
  548. <th class="desc">creates an area for player_move events and returns the id</th>
  549. </tr>
  550. <tr>
  551. <td class="bold">Format</td>
  552. <td>event.addMoveData(location1, location2, cooldown, livingtime, [uuid / string_uuid / player])</td>
  553. </tr>
  554. <tr>
  555. <td class="bold">Arguments</td>
  556. <td>
  557. cooldown: -1 terminated after a single trigger<br>
  558. cooldown: > 0 clock rate in ticks, no termination<br>
  559. livingtime: -1 area lives forever<br>
  560. livingtime: > 0 stays amount of ticks alive<br>
  561. uuid / string_uuid / player: event only triggers for this player
  562. </td>
  563. </tr>
  564. <tr>
  565. <td class="bold">Info</td>
  566. <td>on script termination this area will be removed</td>
  567. </tr>
  568. </table>
  569. <table>
  570. <tr>
  571. <th class="command"event.removeMoveData</th>
  572. <th class="desc">removes an area for player_move events by id</th>
  573. </tr>
  574. <tr>
  575. <td class="bold">Format</td>
  576. <td>event.removeMoveData(id)</td>
  577. </tr>
  578. </table>
  579. </section>
  580. <section id="Ban">
  581. <table>
  582. <tr>
  583. <th class="command">ban.add</th>
  584. <th class="desc">bans a player from the server</th>
  585. </tr>
  586. <tr>
  587. <td class="bold">Format</td>
  588. <td>ban.add(player_name, reason, banner, [end_date])</td>
  589. </tr>
  590. <tr>
  591. <td class="bold">Arguments</td>
  592. <td>
  593. reason as string<br>
  594. banner as string (the person who bans, write what you want)<br>
  595. end_date as calendar object
  596. </td>
  597. </tr>
  598. </table>
  599. <table>
  600. <tr>
  601. <th class="command">ban.remove</th>
  602. <th class="desc">unbans a player from the server</th>
  603. </tr>
  604. <tr>
  605. <td class="bold">Format</td>
  606. <td>ban.remove(player_name)</td>
  607. </tr>
  608. </table>
  609. <table>
  610. <tr>
  611. <th class="command">ban.kick</th>
  612. <th class="desc">kicks a player from the server</th>
  613. </tr>
  614. <tr>
  615. <td class="bold">Format</td>
  616. <td>ban.kick(player, reason)</td>
  617. </tr>
  618. <tr>
  619. <td class="bold">Arguments</td>
  620. <td>reason as text</td>
  621. </tr>
  622. </table>
  623. </section>
  624. <section id="Block">
  625. <table>
  626. <tr>
  627. <th class="command">block.setData</th>
  628. <th class="desc">set a block</th>
  629. </tr>
  630. <tr>
  631. <td class="bold">Format</td>
  632. <td>block.setData(block, blockdata, [boolean | false])</td>
  633. </tr>
  634. <tr>
  635. <td class="bold">Arguments</td>
  636. <td>boolean true places with block update</td>
  637. </tr>
  638. </table>
  639. <table>
  640. <tr>
  641. <th class="command">block.setMaterial</th>
  642. <th class="desc">set a block</th>
  643. </tr>
  644. <tr>
  645. <td class="bold">Format</td>
  646. <td>block.setMaterial(block, <a href="https://papermc.io/javadocs/paper/1.18/org/bukkit/Material.html" target="_blank">material</a>, [boolean | false])</td>
  647. </tr>
  648. <tr>
  649. <td class="bold">Arguments</td>
  650. <td>boolean true places with block update</td>
  651. </tr>
  652. </table>
  653. <table>
  654. <tr>
  655. <th class="command">block.clone</th>
  656. <th class="desc">clone a block to a location</th>
  657. </tr>
  658. <tr>
  659. <td class="bold">Format</td>
  660. <td>block.clone(block, location, [boolean | false])</td>
  661. </tr>
  662. <tr>
  663. <td class="bold">Arguments</td>
  664. <td>boolean true places with block update</td>
  665. </tr>
  666. </table>
  667. <table>
  668. <tr>
  669. <th class="command">block.setSign</th>
  670. <th class="desc">set text on a sign</th>
  671. </tr>
  672. <tr>
  673. <td class="bold">Format</td>
  674. <td>block.setSign(block, row, text)</td>
  675. </tr>
  676. <tr>
  677. <td class="bold">Arguments</td>
  678. <td>row from 0 to 3</td>
  679. </tr>
  680. </table>
  681. <table>
  682. <tr>
  683. <th class="command">block.getSign</th>
  684. <th class="desc">returns the text of a sign from a specific row</th>
  685. </tr>
  686. <tr>
  687. <td class="bold">Format</td>
  688. <td>block.getSign(block, row)</td>
  689. </tr>
  690. <tr>
  691. <td class="bold">Arguments</td>
  692. <td>row from 0 to 3</td>
  693. </tr>
  694. </table>
  695. <table>
  696. <tr>
  697. <th class="command">block.get</th>
  698. <th class="desc">returns a block</th>
  699. </tr>
  700. <tr>
  701. <td class="bold">Format</td>
  702. <td>block.get(location)</td>
  703. </tr>
  704. </table>
  705. <table>
  706. <tr>
  707. <th class="command">block.getData</th>
  708. <th class="desc">returns the blockdata of a block</th>
  709. </tr>
  710. <tr>
  711. <td class="bold">Format</td>
  712. <td>block.getData(block)</td>
  713. </tr>
  714. </table>
  715. <table>
  716. <tr>
  717. <th class="command">block.getInventory</th>
  718. <th class="desc">returns the inventory of a block or null if it is not a container</th>
  719. </tr>
  720. <tr>
  721. <td class="bold">Format</td>
  722. <td>block.getInventory(block)</td>
  723. </tr>
  724. </table>
  725. <table>
  726. <tr>
  727. <th class="command">block.getType</th>
  728. <th class="desc">returns the <a href="https://papermc.io/javadocs/paper/1.18/org/bukkit/Material.html" target="_blank">material</a> of a block</th>
  729. </tr>
  730. <tr>
  731. <td class="bold">Format</td>
  732. <td>block.getType(block)</td>
  733. </tr>
  734. </table>
  735. <table>
  736. <tr>
  737. <th class="command">block.getLocation</th>
  738. <th class="desc">returns the location of a block</th>
  739. </tr>
  740. <tr>
  741. <td class="bold">Format</td>
  742. <td>block.getLocation(block)</td>
  743. </tr>
  744. </table>
  745. <table>
  746. <tr>
  747. <th class="command">block.setOpen</th>
  748. <th class="desc">set the open property for a block</th>
  749. </tr>
  750. <tr>
  751. <td class="bold">Format</td>
  752. <td>block.setOpen(block, boolean)</td>
  753. </tr>
  754. </table>
  755. <table>
  756. <tr>
  757. <th class="command">block.isOpen</th>
  758. <th class="desc">returns true if the block is open</th>
  759. </tr>
  760. <tr>
  761. <td class="bold">Format</td>
  762. <td>block.isOpen(block)</td>
  763. </tr>
  764. </table>
  765. <table>
  766. <tr>
  767. <th class="command">block.getTag</th>
  768. <th class="desc">returns a tag</th>
  769. </tr>
  770. <tr>
  771. <td class="bold">Format</td>
  772. <td>block.getTag(String tag_name)</td>
  773. </tr>
  774. </table>
  775. <table>
  776. <tr>
  777. <th class="command">block.hasTag</th>
  778. <th class="desc">returns true if a block has a tag</th>
  779. </tr>
  780. <tr>
  781. <td class="bold">Format</td>
  782. <td>block.hasTag(block, tag)</td>
  783. </tr>
  784. </table>
  785. <table>
  786. <tr>
  787. <th class="command">block.break</th>
  788. <th class="desc">breaks a block and drops the item</th>
  789. </tr>
  790. <tr>
  791. <td class="bold">Format</td>
  792. <td>block.break(block, [entity])</td>
  793. </tr>
  794. </table>
  795. <table>
  796. <tr>
  797. <th class="command">block.getEntity</th>
  798. <th class="desc">return the tile entity of a block</th>
  799. </tr>
  800. <tr>
  801. <td class="bold">Format</td>
  802. <td>block.getEntity(block)</td>
  803. </tr>
  804. </table>
  805. <table>
  806. <tr>
  807. <th class="command">block.setEntity</th>
  808. <th class="desc">set the tile entity for a block</th>
  809. </tr>
  810. <tr>
  811. <td class="bold">Format</td>
  812. <td>block.setEntity(block, entity)</td>
  813. </tr>
  814. </table>
  815. </section>
  816. <section id="Databank">
  817. <table>
  818. <tr>
  819. <th class="command">databank.prepare</th>
  820. <th class="desc">returns the prepared statement</th>
  821. </tr>
  822. <tr>
  823. <td class="bold">Format</td>
  824. <td>databank.prepare(sql-query, [boolean autoclose | true])</td>
  825. </tr>
  826. </table>
  827. <table>
  828. <tr>
  829. <th class="command">databank.setInt</th>
  830. <th class="desc">sets an int in a statement</th>
  831. </tr>
  832. <tr>
  833. <td class="bold">Format</td>
  834. <td>databank.setInt(statement, index, int)</td>
  835. </tr>
  836. </table>
  837. <table>
  838. <tr>
  839. <th class="command">databank.setDouble</th>
  840. <th class="desc">sets a double in a statement</th>
  841. </tr>
  842. <tr>
  843. <td class="bold">Format</td>
  844. <td>databank.setDouble(statement, index, double)</td>
  845. </tr>
  846. </table>
  847. <table>
  848. <tr>
  849. <th class="command">databank.setLong</th>
  850. <th class="desc">sets a long in a statement</th>
  851. </tr>
  852. <tr>
  853. <td class="bold">Format</td>
  854. <td>databank.setLong(statement, index, long)</td>
  855. </tr>
  856. </table>
  857. <table>
  858. <tr>
  859. <th class="command">databank.setString</th>
  860. <th class="desc">sets a string in a statement</th>
  861. </tr>
  862. <tr>
  863. <td class="bold">Format</td>
  864. <td>databank.setString(statement, index, string)</td>
  865. </tr>
  866. </table>
  867. <table>
  868. <tr>
  869. <th class="command">databank.setBool</th>
  870. <th class="desc">sets a boolean in a statement</th>
  871. </tr>
  872. <tr>
  873. <td class="bold">Format</td>
  874. <td>databank.setBool(statement, index, boolean)</td>
  875. </tr>
  876. </table>
  877. <table>
  878. <tr>
  879. <th class="command">databank.getInt</th>
  880. <th class="desc">returns an int from a result set</th>
  881. </tr>
  882. <tr>
  883. <td class="bold">Format</td>
  884. <td>databank.getInt(result-set, index)</td>
  885. </tr>
  886. </table>
  887. <table>
  888. <tr>
  889. <th class="command">databank.getDouble</th>
  890. <th class="desc">returns a double from a result set</th>
  891. </tr>
  892. <tr>
  893. <td class="bold">Format</td>
  894. <td>databank.getDouble(result-set, index)</td>
  895. </tr>
  896. </table>
  897. <table>
  898. <tr>
  899. <th class="command">databank.getLong</th>
  900. <th class="desc">returns a long from a result set</th>
  901. </tr>
  902. <tr>
  903. <td class="bold">Format</td>
  904. <td>databank.getLong(result-set, index)</td>
  905. </tr>
  906. </table>
  907. <table>
  908. <tr>
  909. <th class="command">databank.getString</th>
  910. <th class="desc">returns a string from a result set</th>
  911. </tr>
  912. <tr>
  913. <td class="bold">Format</td>
  914. <td>databank.getString(result-set, index)</td>
  915. </tr>
  916. </table>
  917. <table>
  918. <tr>
  919. <th class="command">databank.getBool</th>
  920. <th class="desc">returns a boolean from a result set</th>
  921. </tr>
  922. <tr>
  923. <td class="bold">Format</td>
  924. <td>databank.getBool(result-set, index)</td>
  925. </tr>
  926. </table>
  927. <table>
  928. <tr>
  929. <th class="command">databank.execute</th>
  930. <th class="desc">returns a result-set after executing a reading statement</th>
  931. </tr>
  932. <tr>
  933. <td class="bold">Format</td>
  934. <td>databank.execute(statement)</td>
  935. </tr>
  936. </table>
  937. <table>
  938. <tr>
  939. <th class="command">databank.workerExecute</th>
  940. <th class="desc">executes a writing statement</th>
  941. </tr>
  942. <tr>
  943. <td class="bold">Format</td>
  944. <td>databank.workerExecute(statement)</td>
  945. </tr>
  946. </table>
  947. <table>
  948. <tr>
  949. <th class="command">databank.next</th>
  950. <th class="desc">returns true and jumps to the next entry if the result-set has a next entry</th>
  951. </tr>
  952. <tr>
  953. <td class="bold">Format</td>
  954. <td>databank.next(result-set)</td>
  955. </tr>
  956. </table>
  957. <table>
  958. <tr>
  959. <th class="command">databank.close</th>
  960. <th class="desc">manual closing of a result-set</th>
  961. </tr>
  962. <tr>
  963. <td class="bold">Format</td>
  964. <td>databank.close(result-set)</td>
  965. </tr>
  966. </table>
  967. </section>
  968. <section id="Config">
  969. <table>
  970. <tr>
  971. <th class="command">config.saveAsync</th>
  972. <th class="desc">saves a config asynchronous</th>
  973. </tr>
  974. <tr>
  975. <td class="bold">Format</td>
  976. <td>config.saveAsync(config)</td>
  977. </tr>
  978. </table>
  979. </section>
  980. <section id="Gamerule">
  981. <table>
  982. <tr>
  983. <th class="command">gamerule.getKey</th>
  984. <th class="desc">returns a gamerule_key</th>
  985. </tr>
  986. <tr>
  987. <td class="bold">Format</td>
  988. <td>gamerule.getKey(gamerule_string)</td>
  989. </tr>
  990. </table>
  991. <table>
  992. <tr>
  993. <th class="command">gamerule.getValue</th>
  994. <th class="desc">return a gamerule_value from a world</th>
  995. </tr>
  996. <tr>
  997. <td class="bold">Format</td>
  998. <td>gamerule.getValue(world, gamerule_key)</td>
  999. </tr>
  1000. </table>
  1001. <table>
  1002. <tr>
  1003. <th class="command">gamerule.setBool</th>
  1004. <th class="desc">sets a gamerule_value</th>
  1005. </tr>
  1006. <tr>
  1007. <td class="bold">Format</td>
  1008. <td>gamerule.setBool(gamerule_value, boolean)</td>
  1009. </tr>
  1010. </table>
  1011. <table>
  1012. <tr>
  1013. <th class="command">gamerule.setInt</th>
  1014. <th class="desc">sets a gamerule_key</th>
  1015. </tr>
  1016. <tr>
  1017. <td class="bold">Format</td>
  1018. <td>gamerule.setInt(gamerule_key, value)</td>
  1019. </tr>
  1020. </table>
  1021. </table>
  1022. </section>
  1023. <section id="General">
  1024. <table>
  1025. <tr>
  1026. <th class="command">msg</th>
  1027. <th class="desc">sends a message</th>
  1028. </tr>
  1029. <tr>
  1030. <td class="bold">Format</td>
  1031. <td>msg(receiver, text)</td>
  1032. </tr>
  1033. </table>
  1034. <table>
  1035. <tr>
  1036. <th class="command">isPlayer</th>
  1037. <th class="desc">returns true if the argument is a player</th>
  1038. </tr>
  1039. <tr>
  1040. <td class="bold">Format</td>
  1041. <td>isPlayer(anything)</td>
  1042. </tr>
  1043. </table>
  1044. <table>
  1045. <tr>
  1046. <th class="command">isLiving</th>
  1047. <th class="desc">returns true if the argument is a living entity</th>
  1048. </tr>
  1049. <tr>
  1050. <td class="bold">Format</td>
  1051. <td>isLiving(anything)</td>
  1052. </tr>
  1053. </table>
  1054. <table>
  1055. <tr>
  1056. <th class="command">setMOTD</th>
  1057. <th class="desc">sets the message of the day in the server list</th>
  1058. </tr>
  1059. <tr>
  1060. <td class="bold">Format</td>
  1061. <td>setMOTD(string)</td>
  1062. </tr>
  1063. </table>
  1064. </section>
  1065. <section id="Item">
  1066. <table>
  1067. <tr>
  1068. <th class="command">Xitem.drop</th>
  1069. <th class="desc">drops an itemstack at a location</th>
  1070. </tr>
  1071. <tr>
  1072. <td class="bold">Format</td>
  1073. <td>item.drop(location, itemstack)</td>
  1074. </tr>
  1075. </table>
  1076. <table>
  1077. <tr>
  1078. <th class="command">Xitem.get</th>
  1079. <th class="desc">returns an item as object</th>
  1080. </tr>
  1081. <tr>
  1082. <td class="bold">Format</td>
  1083. <td>item.get(itemstack)</td>
  1084. </tr>
  1085. </table>
  1086. <table>
  1087. <tr>
  1088. <th class="command">Xitem.getType</th>
  1089. <th class="desc">returns the type of an itemstack</th>
  1090. </tr>
  1091. <tr>
  1092. <td class="bold">Format</td>
  1093. <td>item.getType(itemstack)</td>
  1094. </tr>
  1095. <tr>
  1096. <td class="bold">Examples</td>
  1097. <td>"minecraft:wool" / "km:artefact"</td>
  1098. </tr>
  1099. </table>
  1100. <table>
  1101. <tr>
  1102. <th class="command">Xitem.getAmount</th>
  1103. <th class="desc">returns the amount of items in an itemstack</th>
  1104. </tr>
  1105. <tr>
  1106. <td class="bold">Format</td>
  1107. <td>item.getAmount(itemstack)</td>
  1108. </tr>
  1109. </table>
  1110. <table>
  1111. <tr>
  1112. <th class="command">Xitem.setAmount</th>
  1113. <th class="desc">sets the amount of items for an itemstack</th>
  1114. </tr>
  1115. <tr>
  1116. <td class="bold">Format</td>
  1117. <td>item.setAmount(itemstack, value)</td>
  1118. </tr>
  1119. </table>
  1120. <table>
  1121. <tr>
  1122. <th class="command">Xitem.getName</th>
  1123. <th class="desc">returns the name of an itemstack</th>
  1124. </tr>
  1125. <tr>
  1126. <td class="bold">Format</td>
  1127. <td>item.getName(itemstack)</td>
  1128. </tr>
  1129. </table>
  1130. <table>
  1131. <tr>
  1132. <th class="command">Xitem.setName</th>
  1133. <th class="desc">sets the name of an itemstack</th>
  1134. </tr>
  1135. <tr>
  1136. <td class="bold">Format</td>
  1137. <td>item.setName(itemstack, name)</td>
  1138. </tr>
  1139. </table>
  1140. <table>
  1141. <tr>
  1142. <th class="command">Xitem.getLore</th>
  1143. <th class="desc">returns a list with all lores of an itemstack</th>
  1144. </tr>
  1145. <tr>
  1146. <td class="bold">Format</td>
  1147. <td>item.getLore(ItemStack)</td>
  1148. </tr>
  1149. </table>
  1150. <table>
  1151. <tr>
  1152. <th class="command">Xitem.setLore</th>
  1153. <th class="desc">sets the lore for an itemstack with the elements in the list</th>
  1154. </tr>
  1155. <tr>
  1156. <td class="bold">Format</td>
  1157. <td>item.setLore(itemstack, List)</td>
  1158. </tr>
  1159. </table>
  1160. <table>
  1161. <tr>
  1162. <th class="command">Xitem.addLore</th>
  1163. <th class="desc">sets the lore for an itemstack for a specific row</th>
  1164. </tr>
  1165. <tr>
  1166. <td class="bold">Format</td>
  1167. <td>item.addLore(itemstack, lore, row)</td>
  1168. </tr>
  1169. </table>
  1170. <table>
  1171. <tr>
  1172. <th class="command">Xitem.addAttribute</th>
  1173. <th class="desc">adds an attribute to an itemstack</th>
  1174. </tr>
  1175. <tr>
  1176. <td class="bold">Format</td>
  1177. <td>item.addAttribute(itemstack, attribute, slot, double, operation)</td>
  1178. </tr>
  1179. <tr>
  1180. <td class="bold">Info</td>
  1181. <td>
  1182. attributes: generic.max_health, generic.follow_range, generic.knockback_resistance, generic.movement_speed, generic.flying_speed, generic.attack_damage, generic.attack_damage, generic.attack_knockback, generic.attack_speed, generic.armor, generic.armor_toughness, generic.luck, zombie.spawn_reinforcements, horse.jump_strength<br>
  1183. slots: mainhand, offhand, head, chest, legs, feet<br>
  1184. operation: 0 (ADDITION), 1 (MULTIPLY_BASE), 2 (MULTIPLY_TOTAL)
  1185. </td>
  1186. </tr>
  1187. </table>
  1188. <table>
  1189. <tr>
  1190. <th class="command">Xitem.clearAttributes</th>
  1191. <th class="desc">removes all custom attributes from an itemstack</th>
  1192. </tr>
  1193. <tr>
  1194. <td class="bold">Format</td>
  1195. <td>item.clearAttributes(itemstack)</td>
  1196. </tr>
  1197. </table>
  1198. <table>
  1199. <tr>
  1200. <th class="command">Xitem.hasAttributes</th>
  1201. <th class="desc">returns true if an itemstack has custom attributes</th>
  1202. </tr>
  1203. <tr>
  1204. <td class="bold">Format</td>
  1205. <td>item.hasAttributes(itemstack)</td>
  1206. </tr>
  1207. </table>
  1208. <table>
  1209. <tr>
  1210. <th class="command">Xitem.addDefaultTags</th>
  1211. <th class="desc">adds the default attributes to an itemstack</th>
  1212. </tr>
  1213. <tr>
  1214. <td class="bold">Format</td>
  1215. <td>item.addDefaultTags(itemstack)</td>
  1216. </tr>
  1217. </table>
  1218. <table>
  1219. <tr>
  1220. <th class="command">Xitem.hide</th>
  1221. <th class="desc">hides something on an itemstack and returns true on success</th>
  1222. </tr>
  1223. <tr>
  1224. <td class="bold">Format</td>
  1225. <td>item.hide(itemstack, name)</td>
  1226. </tr>
  1227. <tr>
  1228. <td class="bold">Info</td>
  1229. <td>name: "enchantments" / "attributes" / "unbreakable" / "destroys" / "placed_on" / "potion_effects"</td>
  1230. </tr>
  1231. </table>
  1232. <table>
  1233. <tr>
  1234. <th class="command">Xitem.addPotion</th>
  1235. <th class="desc">unknown</th>
  1236. </tr>
  1237. <tr>
  1238. <td class="bold">Format</td>
  1239. <td>item.addPotion(itemstack, potion_name, duration, power)</td>
  1240. </tr>
  1241. </table>
  1242. <table>
  1243. <tr>
  1244. <th class="command">Xitem.setCoolDown</th>
  1245. <th class="desc">sets the cooldown for an item-type</th>
  1246. </tr>
  1247. <tr>
  1248. <td class="bold">Format</td>
  1249. <td>item.setCoolDown(player, itemstack, ticks)</td>
  1250. </tr>
  1251. </table>
  1252. <table>
  1253. <tr>
  1254. <th class="command">Xitem.clone</th>
  1255. <th class="desc">returns a copy of an itemstack</th>
  1256. </tr>
  1257. <tr>
  1258. <td class="bold">Format</td>
  1259. <td>item.clone(itemstack)</td>
  1260. </tr>
  1261. </table>
  1262. <table>
  1263. <tr>
  1264. <th class="command">Xitem.getTag</th>
  1265. <th class="desc">returns a tag</th>
  1266. </tr>
  1267. <tr>
  1268. <td class="bold">Format</td>
  1269. <td>item.getTag(String tag_name)</td>
  1270. </tr>
  1271. </table>
  1272. <table>
  1273. <tr>
  1274. <th class="command">Xitem.hasTag</th>
  1275. <th class="desc">returns true if an itemstack has a tag</th>
  1276. </tr>
  1277. <tr>
  1278. <td class="bold">Format</td>
  1279. <td>item.hasTag(tag, itemstack)</td>
  1280. </tr>
  1281. </table>
  1282. <table>
  1283. <tr>
  1284. <th class="command">Xitem.hasName</th>
  1285. <th class="desc">returns true if the itemstack has a modified name</th>
  1286. </tr>
  1287. <tr>
  1288. <td class="bold">Format</td>
  1289. <td>item.hasName(itemstack)</td>
  1290. </tr>
  1291. </table>
  1292. <table>
  1293. <tr>
  1294. <th class="command">Xitem.getFullText</th>
  1295. <th class="desc">returns the full text object</th>
  1296. </tr>
  1297. <tr>
  1298. <td class="bold">Format</td>
  1299. <td>item.getFullText(itemstack)</td>
  1300. </tr>
  1301. </table>
  1302. <table>
  1303. <tr>
  1304. <th class="command">Xitem.isDamageable</th>
  1305. <th class="desc">returns true if the itemstack is damageable</th>
  1306. </tr>
  1307. <tr>
  1308. <td class="bold">Format</td>
  1309. <td>item.isDamageable(itemstack)</td>
  1310. </tr>
  1311. </table>
  1312. <table>
  1313. <tr>
  1314. <th class="command">Xitem.getMaxDamage</th>
  1315. <th class="desc">returns the maximum damage the itemstack can get</th>
  1316. </tr>
  1317. <tr>
  1318. <td class="bold">Format</td>
  1319. <td>item.getMaxDamage(itemstack)</td>
  1320. </tr>
  1321. </table>
  1322. <table>
  1323. <tr>
  1324. <th class="command">Xitem.setDamage</th>
  1325. <th class="desc">sets the damage of the itemstack</th>
  1326. </tr>
  1327. <tr>
  1328. <td class="bold">Format</td>
  1329. <td>item.setDamage(itemstack, amount)</td>
  1330. </tr>
  1331. </table>
  1332. <table>
  1333. <tr>
  1334. <th class="command">Xitem.getDamage</th>
  1335. <th class="desc">returns the damage of an itemstack</th>
  1336. </tr>
  1337. <tr>
  1338. <td class="bold">Format</td>
  1339. <td>item.getDamage(itemstack)</td>
  1340. </tr>
  1341. </table>
  1342. <table>
  1343. <tr>
  1344. <th class="command">Xitem.getMaxAmount</th>
  1345. <th class="desc">returns the maximum amount of stackable items</th>
  1346. </tr>
  1347. <tr>
  1348. <td class="bold">Format</td>
  1349. <td>item.getMaxAmount(itemstack)</td>
  1350. </tr>
  1351. </table>
  1352. <table>
  1353. <tr>
  1354. <th class="command">Xitem.entity.get</th>
  1355. <th class="desc">returns an itemstack from an item-entity</th>
  1356. </tr>
  1357. <tr>
  1358. <td class="bold">Format</td>
  1359. <td>item.entity.get(item-entity)</td>
  1360. </tr>
  1361. </table>
  1362. <table>
  1363. <tr>
  1364. <th class="command">Xitem.entity.set</th>
  1365. <th class="desc">sets an itemstack to an item-entity</th>
  1366. </tr>
  1367. <tr>
  1368. <td class="bold">Format</td>
  1369. <td>item.entity.set(item-entity, itemstack)</td>
  1370. </tr>
  1371. </table>
  1372. <table>
  1373. <tr>
  1374. <th class="command">Xitem.entity.new</th>
  1375. <th class="desc">creates an item-entity from an itemstack and returns the item-entity</th>
  1376. </tr>
  1377. <tr>
  1378. <td class="bold">Format</td>
  1379. <td>item.entity.new(location, itemstack)</td>
  1380. </tr>
  1381. </table>
  1382. <table>
  1383. <tr>
  1384. <th class="command">Xitem.entity.spawn</th>
  1385. <th class="desc">spawns an item-entity</th>
  1386. </tr>
  1387. <tr>
  1388. <td class="bold">Format</td>
  1389. <td>item.entity.spawn(entity)</td>
  1390. </tr>
  1391. </table>
  1392. <table>
  1393. <tr>
  1394. <th class="command">Xitem.entity.setLifespan</th>
  1395. <th class="desc">sets the lifespan of an item-entity</th>
  1396. </tr>
  1397. <tr>
  1398. <td class="bold">Format</td>
  1399. <td>item.entity.setLifespan(item-entity, ticks)</td>
  1400. </tr>
  1401. </table>
  1402. </section>
  1403. <section id="Enchantment">
  1404. <table>
  1405. <tr>
  1406. <th class="command">Xenchantment.get</th>
  1407. <th class="desc">returns an enchantment</th>
  1408. </tr>
  1409. <tr>
  1410. <td class="bold">Format</td>
  1411. <td>enchantment.get(enchantment_string)</td>
  1412. </tr>
  1413. <tr>
  1414. <td class="bold">Arguments</td>
  1415. <td><a href="https://minecraft-de.gamepedia.com/Verzauberung#Verzauberungen" target="_blank">Minecraft Wiki Verzauberungen</a> (ID-Name verwenden)</td>
  1416. </tr>
  1417. </table>
  1418. <table>
  1419. <tr>
  1420. <th class="command">Xenchantment.add</th>
  1421. <th class="desc">adds an enchantment to an itemstack</th>
  1422. </tr>
  1423. <tr>
  1424. <td class="bold">Format</td>
  1425. <td>enchantment.add(enchantment, itemstack, level)</td>
  1426. </tr>
  1427. </table>
  1428. <table>
  1429. <tr>
  1430. <th class="command">Xenchantment.getLevel</th>
  1431. <th class="desc">returns the level of an enchantment an itemstack has</th>
  1432. </tr>
  1433. <tr>
  1434. <td class="bold">Format</td>
  1435. <td>enchantment.getLevel(enchantment, itemstack)</td>
  1436. </tr>
  1437. </table>
  1438. <table>
  1439. <tr>
  1440. <th class="command">Xenchantment.readFromItem</th>
  1441. <th class="desc">returns a map with all enchantments from an item with the level as value</th>
  1442. </tr>
  1443. <tr>
  1444. <td class="bold">Format</td>
  1445. <td>enchantment.readFromItem(itemstack)</td>
  1446. </tr>
  1447. </table>
  1448. <table>
  1449. <tr>
  1450. <th class="command">Xenchantment.writeToItem</th>
  1451. <th class="desc">transfers all enchantments from the map on the itemstack</th>
  1452. </tr>
  1453. <tr>
  1454. <td class="bold">Format</td>
  1455. <td>enchantment.writeToItem(map, itemstack)</td>
  1456. </tr>
  1457. </table>
  1458. </section>
  1459. <section id="Debug">
  1460. <table>
  1461. <tr>
  1462. <th class="command">debug.clear</th>
  1463. <th class="desc">clears all cached debug-messages</th>
  1464. </tr>
  1465. <tr>
  1466. <td class="bold">Format</td>
  1467. <td>debug.clear()</td>
  1468. </tr>
  1469. </table>
  1470. <table>
  1471. <tr>
  1472. <th class="command">debug.getSize</th>
  1473. <th class="desc">returns the amount of all cached debug-messages</th>
  1474. </tr>
  1475. <tr>
  1476. <td class="bold">Format</td>
  1477. <td>debug.getSize()</td>
  1478. </tr>
  1479. </table>
  1480. <table>
  1481. <tr>
  1482. <th class="command">debug.getIndex</th>
  1483. <th class="desc">returns the debug-message from an index</th>
  1484. </tr>
  1485. <tr>
  1486. <td class="bold">Format</td>
  1487. <td>debug.getIndex(index)</td>
  1488. </tr>
  1489. </table>
  1490. <table>
  1491. <tr>
  1492. <th class="command">debug.setConsolePrint</th>
  1493. <th class="desc">true prints snuvi debug-messages on console (not stack traces)</th>
  1494. </tr>
  1495. <tr>
  1496. <td class="bold">Format</td>
  1497. <td>debug.setConsolePrint(boolean)</td>
  1498. </tr>
  1499. </table>
  1500. </section>
  1501. <section id="Error">
  1502. <table>
  1503. <tr>
  1504. <th class="command">error.clear</th>
  1505. <th class="desc">clears all cached errors</th>
  1506. </tr>
  1507. <tr>
  1508. <td class="bold">Format</td>
  1509. <td>error.clear()</td>
  1510. </tr>
  1511. </table>
  1512. <table>
  1513. <tr>
  1514. <th class="command">error.getSize</th>
  1515. <th class="desc">returns the amount of all cached errors</th>
  1516. </tr>
  1517. <tr>
  1518. <td class="bold">Format</td>
  1519. <td>error.getSize()</td>
  1520. </tr>
  1521. </table>
  1522. <table>
  1523. <tr>
  1524. <th class="command">error.getIndex</th>
  1525. <th class="desc">returns the error from an index</th>
  1526. </tr>
  1527. <tr>
  1528. <td class="bold">Format</td>
  1529. <td>error.getIndex(index)</td>
  1530. </tr>
  1531. </table>
  1532. <table>
  1533. <tr>
  1534. <th class="command">error.setConsolePrint</th>
  1535. <th class="desc">true prints snuvi errors on console (not stack traces)</th>
  1536. </tr>
  1537. <tr>
  1538. <td class="bold">Format</td>
  1539. <td>error.setConsolePrint(boolean)</td>
  1540. </tr>
  1541. </table>
  1542. </section>
  1543. <section id="Location">
  1544. <table>
  1545. <tr>
  1546. <th class="command">loc.new</th>
  1547. <th class="desc">creates a location</th>
  1548. </tr>
  1549. <tr>
  1550. <td class="bold">Format</td>
  1551. <td>loc.new(world, x, y, z)<br>loc.new(world, x, y, z, yaw, pitch)</td>
  1552. </tr>
  1553. </table>
  1554. <table>
  1555. <tr>
  1556. <th class="command">loc.getX</th>
  1557. <th class="desc">returns the x coordinate</th>
  1558. </tr>
  1559. <tr>
  1560. <td class="bold">Format</td>
  1561. <td>loc.getX(location)</td>
  1562. </tr>
  1563. </table>
  1564. <table>
  1565. <tr>
  1566. <th class="command">loc.setX</th>
  1567. <th class="desc">sets the x coordinate</th>
  1568. </tr>
  1569. <tr>
  1570. <td class="bold">Format</td>
  1571. <td>loc.setX(location, value)</td>
  1572. </tr>
  1573. </table>
  1574. <table>
  1575. <tr>
  1576. <th class="command">loc.addX</th>
  1577. <th class="desc">adds the value to the x coordinate</th>
  1578. </tr>
  1579. <tr>
  1580. <td class="bold">Format</td>
  1581. <td>loc.addX(location, value)</td>
  1582. </tr>
  1583. </table>
  1584. <table>
  1585. <tr>
  1586. <th class="command">loc.getBlockX</th>
  1587. <th class="desc">returns the x block coordinate</th>
  1588. </tr>
  1589. <tr>
  1590. <td class="bold">Format</td>
  1591. <td>loc.getBlockX(location)</td>
  1592. </tr>
  1593. </table>
  1594. <table>
  1595. <tr>
  1596. <th class="command">loc.getY</th>
  1597. <th class="desc">returns the y coordinate</th>
  1598. </tr>
  1599. <tr>
  1600. <td class="bold">Format</td>
  1601. <td>loc.getY(location)</td>
  1602. </tr>
  1603. </table>
  1604. <table>
  1605. <tr>
  1606. <th class="command">loc.setY</th>
  1607. <th class="desc">sets the y coordinate</th>
  1608. </tr>
  1609. <tr>
  1610. <td class="bold">Format</td>
  1611. <td>loc.setY(location, value)</td>
  1612. </tr>
  1613. </table>
  1614. <table>
  1615. <tr>
  1616. <th class="command">loc.addY</th>
  1617. <th class="desc">adds the value to the y coordinate</th>
  1618. </tr>
  1619. <tr>
  1620. <td class="bold">Format</td>
  1621. <td>loc.addY(location, value)</td>
  1622. </tr>
  1623. </table>
  1624. <table>
  1625. <tr>
  1626. <th class="command">loc.getBlockY</th>
  1627. <th class="desc">returns the y block coordinate</th>
  1628. </tr>
  1629. <tr>
  1630. <td class="bold">Format</td>
  1631. <td>loc.getBlockY(location)</td>
  1632. </tr>
  1633. </table>
  1634. <table>
  1635. <tr>
  1636. <th class="command">loc.getZ</th>
  1637. <th class="desc">returns the z coordinate</th>
  1638. </tr>
  1639. <tr>
  1640. <td class="bold">Format</td>
  1641. <td>loc.getZ(location)</td>
  1642. </tr>
  1643. </table>
  1644. <table>
  1645. <tr>
  1646. <th class="command">loc.setZ</th>
  1647. <th class="desc">sets the z coordinate</th>
  1648. </tr>
  1649. <tr>
  1650. <td class="bold">Format</td>
  1651. <td>loc.setZ(location, value)</td>
  1652. </tr>
  1653. </table>
  1654. <table>
  1655. <tr>
  1656. <th class="command">loc.addZ</th>
  1657. <th class="desc">adds the value to the z coordinate</th>
  1658. </tr>
  1659. <tr>
  1660. <td class="bold">Format</td>
  1661. <td>loc.addZ(location, value)</td>
  1662. </tr>
  1663. </table>
  1664. <table>
  1665. <tr>
  1666. <th class="command">loc.getBlockZ</th>
  1667. <th class="desc">returns the z block coordinate</th>
  1668. </tr>
  1669. <tr>
  1670. <td class="bold">Format</td>
  1671. <td>loc.getBlockZ(location)</td>
  1672. </tr>
  1673. </table>
  1674. <table>
  1675. <tr>
  1676. <th class="command">loc.setYaw</th>
  1677. <th class="desc">sets the yaw of a location</th>
  1678. </tr>
  1679. <tr>
  1680. <td class="bold">Format</td>
  1681. <td>loc.setYaw(location, Yaw)</td>
  1682. </tr>
  1683. </table>
  1684. <table>
  1685. <tr>
  1686. <th class="command">loc.getYaw</th>
  1687. <th class="desc">returns the yaw of a location</th>
  1688. </tr>
  1689. <tr>
  1690. <td class="bold">Format</td>
  1691. <td>loc.getYaw(location)</td>
  1692. </tr>
  1693. </table>
  1694. <table>
  1695. <tr>
  1696. <th class="command">loc.setPitch</th>
  1697. <th class="desc">sets the pitch of a location</th>
  1698. </tr>
  1699. <tr>
  1700. <td class="bold">Format</td>
  1701. <td>loc.setPitch(location, Pitch)</td>
  1702. </tr>
  1703. </table>
  1704. <table>
  1705. <tr>
  1706. <th class="command">loc.getPitch</th>
  1707. <th class="desc">returns the pitch of a location</th>
  1708. </tr>
  1709. <tr>
  1710. <td class="bold">Format</td>
  1711. <td>loc.getPitch(location)</td>
  1712. </tr>
  1713. </table>
  1714. <table>
  1715. <tr>
  1716. <th class="command">loc.getWorld</th>
  1717. <th class="desc">returns the world of a location as object</th>
  1718. </tr>
  1719. <tr>
  1720. <td class="bold">Format</td>
  1721. <td>loc.getWorld(location)</td>
  1722. </tr>
  1723. </table>
  1724. <table>
  1725. <tr>
  1726. <th class="command">loc.distance</th>
  1727. <th class="desc">returns the difference between two locations</th>
  1728. </tr>
  1729. <tr>
  1730. <td class="bold">Format</td>
  1731. <td>loc.distance(location1, location2)</td>
  1732. </tr>
  1733. <tr>
  1734. <td class="bold">Info</td>
  1735. <td>there is an error if the two locations have not the same world</td>
  1736. </tr>
  1737. </table>
  1738. <table>
  1739. <tr>
  1740. <th class="command">loc.isBetween</th>
  1741. <th class="desc">returns true if the location is between two other locations</th>
  1742. </tr>
  1743. <tr>
  1744. <td class="bold">Format</td>
  1745. <td>loc.isBetween(location, location1, location2)</td>
  1746. </tr>
  1747. </table>
  1748. <table>
  1749. <tr>
  1750. <th class="command">loc.mod</th>
  1751. <th class="desc">returns a modified copy of the location</th>
  1752. </tr>
  1753. <tr>
  1754. <td class="bold">Format</td>
  1755. <td>loc.mod(location, x, y, z)</td>
  1756. </tr>
  1757. </table>
  1758. <table>
  1759. <tr>
  1760. <th class="command">loc.add</th>
  1761. <th class="desc">modifies the original location</th>
  1762. </tr>
  1763. <tr>
  1764. <td class="bold">Format</td>
  1765. <td>loc.add(location, x, y, z)</td>
  1766. </tr>
  1767. </table>
  1768. <table>
  1769. <tr>
  1770. <th class="command">loc.set</th>
  1771. <th class="desc">modifies the original location</th>
  1772. </tr>
  1773. <tr>
  1774. <td class="bold">Format</td>
  1775. <td>loc.set(location, x, y, z)</td>
  1776. </tr>
  1777. </table>
  1778. <table>
  1779. <tr>
  1780. <th class="command">loc.sort</th>
  1781. <th class="desc">sort in lowest and highest coordinates</th>
  1782. </tr>
  1783. <tr>
  1784. <td class="bold">Format</td>
  1785. <td>loc.sort(location1, location2)</td>
  1786. </tr>
  1787. </table>
  1788. <table>
  1789. <tr>
  1790. <th class="command">loc.iterator</th>
  1791. <th class="desc">returns the iterator for the area</th>
  1792. </tr>
  1793. <tr>
  1794. <td class="bold">Format</td>
  1795. <td>loc.iterator(world, x1, y1, z1, x2, y2, z2)</td>
  1796. </tr>
  1797. </table>
  1798. <table>
  1799. <tr>
  1800. <th class="command">loc.explode</th>
  1801. <th class="desc">makes an explosion at a location</th>
  1802. </tr>
  1803. <tr>
  1804. <td class="bold">Format</td>
  1805. <td>loc.explode(location, entity, radius, fire_bool, block_damage_bool)</td>
  1806. </tr>
  1807. <tr>
  1808. <td class="bold">Info</td>
  1809. <td>entity can be null</td>
  1810. </tr>
  1811. </table>
  1812. </section>
  1813. <section id="Read">
  1814. <table>
  1815. <tr>
  1816. <th class="command">Xread.spawnMob</th>
  1817. <th class="desc">spawns a mob and returns the entity</th>
  1818. </tr>
  1819. <tr>
  1820. <td class="bold">Format</td>
  1821. <td>read.spawnMob(location, nbt-tag)</td>
  1822. </tr>
  1823. </table>
  1824. <table>
  1825. <tr>
  1826. <th class="command">Xread.player</th>
  1827. <th class="desc">returns the object player</th>
  1828. </tr>
  1829. <tr>
  1830. <td class="bold">Format</td>
  1831. <td>read.player(playername)</td>
  1832. </tr>
  1833. </table>
  1834. <table>
  1835. <tr>
  1836. <th class="command">Xread.item</th>
  1837. <th class="desc">returns an itemstack</th>
  1838. </tr>
  1839. <tr>
  1840. <td class="bold">Format</td>
  1841. <td>
  1842. read.item(nbt-tag)<br>
  1843. read.item(item_type)<br>
  1844. read.item(item_type, item_amount)<br>
  1845. read.item(item_type, item_amount)<br>
  1846. read.item(item_type, item_amount, name)<br>
  1847. read.item(item_type, item_amount, name, lore1, lore2, ...)
  1848. </td>
  1849. </tr>
  1850. <tr>
  1851. <td class="bold">Info</td>
  1852. <td>returns null if the item does not exist</td>
  1853. </tr>
  1854. </table>
  1855. <table>
  1856. <tr>
  1857. <th class="command">Xread.uuid</th>
  1858. <th class="desc">returns a uuid</th>
  1859. </tr>
  1860. <tr>
  1861. <td class="bold">Format</td>
  1862. <td>read.uuid("uuid")</td>
  1863. </tr>
  1864. </table>
  1865. <table>
  1866. <tr>
  1867. <th class="command">Xread.slot</th>
  1868. <th class="desc">returns a slot</th>
  1869. </tr>
  1870. <tr>
  1871. <td class="bold">Format</td>
  1872. <td>read.slot(slot)</td>
  1873. </tr>
  1874. <tr>
  1875. <td class="bold">Info</td>
  1876. <td>slot: "head" / "chest" / "legs" / "feet" / "hand" / "offhand"</td>
  1877. </tr>
  1878. </table>
  1879. </section>
  1880. <section id="String">
  1881. <table>
  1882. <tr>
  1883. <th class="command">string.item</th>
  1884. <th class="desc">returns an nbt-tag from an itemstack as string</th>
  1885. </tr>
  1886. <tr>
  1887. <td class="bold">Format</td>
  1888. <td>string.item(itemstack)</td>
  1889. </tr>
  1890. </table>
  1891. <table>
  1892. <tr>
  1893. <th class="command">string.entity</th>
  1894. <th class="desc">returns a serialized entity</th>
  1895. </tr>
  1896. <tr>
  1897. <td class="bold">Format</td>
  1898. <td>string.entity(entity)</td>
  1899. </tr>
  1900. </table>
  1901. <table>
  1902. <tr>
  1903. <th class="command">string.text</th>
  1904. <th class="desc">returns a text converted to a string</th>
  1905. </tr>
  1906. <tr>
  1907. <td class="bold">Format</td>
  1908. <td>string.text(text)</td>
  1909. </tr>
  1910. </table>
  1911. <table>
  1912. <tr>
  1913. <th class="command">string.blockData</th>
  1914. <th class="desc">returns blockdata converted to a string</th>
  1915. </tr>
  1916. <tr>
  1917. <td class="bold">Format</td>
  1918. <td>string.blockData(blockdata)</td>
  1919. </tr>
  1920. </table>
  1921. <table>
  1922. <tr>
  1923. <th class="command">string.blockEntity</th>
  1924. <th class="desc">returns a blockentity converted to a string</th>
  1925. </tr>
  1926. <tr>
  1927. <td class="bold">Format</td>
  1928. <td>string.blockEntity(blockentity)</td>
  1929. </tr>
  1930. </table>
  1931. </section>
  1932. <section id="Text">
  1933. <table>
  1934. <tr>
  1935. <th class="command">text.new</th>
  1936. <th class="desc">returns a text</th>
  1937. </tr>
  1938. <tr>
  1939. <td class="bold">Format</td>
  1940. <td>text.new(string)</td>
  1941. </tr>
  1942. </table>
  1943. <table>
  1944. <tr>
  1945. <th class="command">text.click</th>
  1946. <th class="desc">returns a clickable text</th>
  1947. </tr>
  1948. <tr>
  1949. <td class="bold">Format</td>
  1950. <td>text.click(show_text, execute_string)</td>
  1951. </tr>
  1952. </table>
  1953. <table>
  1954. <tr>
  1955. <th class="command">text.hover</th>
  1956. <th class="desc">returns a hoverable text</th>
  1957. </tr>
  1958. <tr>
  1959. <td class="bold">Format</td>
  1960. <td>text.hover(show_text, hover_text)</td>
  1961. </tr>
  1962. </table>
  1963. <table>
  1964. <tr>
  1965. <th class="command">text.link</th>
  1966. <th class="desc">returns a clickable text for links</th>
  1967. </tr>
  1968. <tr>
  1969. <td class="bold">Format</td>
  1970. <td>text.link(text, link_string)</td>
  1971. </tr>
  1972. </table>
  1973. <table>
  1974. <tr>
  1975. <th class="command">text.clipBoard</th>
  1976. <th class="desc">returns a clickable text to copy a string into the clipboard</th>
  1977. </tr>
  1978. <tr>
  1979. <td class="bold">Format</td>
  1980. <td>text.clipBoard(text, string)</td>
  1981. </tr>
  1982. </table>
  1983. <table>
  1984. <tr>
  1985. <th class="command">text.merge</th>
  1986. <th class="desc">returns merged texts</th>
  1987. </tr>
  1988. <tr>
  1989. <td class="bold">Format</td>
  1990. <td>text.merge(text, ...)</td>
  1991. </tr>
  1992. </table>
  1993. </section>
  1994. <section id="Plot">
  1995. <table>
  1996. <tr>
  1997. <th class="command">plot.add</th>
  1998. <th class="desc">returns the created plot</th>
  1999. </tr>
  2000. <tr>
  2001. <td class="bold">Format</td>
  2002. <td>plot.add(location1, location2, [plot_id])</td>
  2003. </tr>
  2004. </table>
  2005. <table>
  2006. <tr>
  2007. <th class="command">plot.remove</th>
  2008. <th class="desc">removes a plot from a world</th>
  2009. </tr>
  2010. <tr>
  2011. <td class="bold">Format</td>
  2012. <td>plot.remove(plot, world)</td>
  2013. </tr>
  2014. </table>
  2015. <table>
  2016. <tr>
  2017. <th class="command">plot.getId</th>
  2018. <th class="desc">returns the plot_id</th>
  2019. </tr>
  2020. <tr>
  2021. <td class="bold">Format</td>
  2022. <td>plot.getId(plot)</td>
  2023. </tr>
  2024. </table>
  2025. <table>
  2026. <tr>
  2027. <th class="command">plot.setName</th>
  2028. <th class="desc">sets the name of a plot</th>
  2029. </tr>
  2030. <tr>
  2031. <td class="bold">Format</td>
  2032. <td>plot.setName(plot, name)</td>
  2033. </tr>
  2034. </table>
  2035. <table>
  2036. <tr>
  2037. <th class="command">plot.getName</th>
  2038. <th class="desc">returns the name of a plot</th>
  2039. </tr>
  2040. <tr>
  2041. <td class="bold">Format</td>
  2042. <td>plot.getName(plot)</td>
  2043. </tr>
  2044. </table>
  2045. <table>
  2046. <tr>
  2047. <th class="command">plot.get</th>
  2048. <th class="desc">returns a list with all plots at a location</th>
  2049. </tr>
  2050. <tr>
  2051. <td class="bold">Format</td>
  2052. <td>plot.get(location)</td>
  2053. </tr>
  2054. </table>
  2055. <table>
  2056. <tr>
  2057. <th class="command">plot.getMinX</th>
  2058. <th class="desc">returns the lowest x coordinate of a plot</th>
  2059. </tr>
  2060. <tr>
  2061. <td class="bold">Format</td>
  2062. <td>plot.getMinX(plot)</td>
  2063. </tr>
  2064. </table>
  2065. <table>
  2066. <tr>
  2067. <th class="command">plot.getMinY</th>
  2068. <th class="desc">returns the lowest y coordinate of a plot</th>
  2069. </tr>
  2070. <tr>
  2071. <td class="bold">Format</td>
  2072. <td>plot.getMinY(plot)</td>
  2073. </tr>
  2074. </table>
  2075. <table>
  2076. <tr>
  2077. <th class="command">plot.getMinZ</th>
  2078. <th class="desc">returns the lowest z coordinate of a plot</th>
  2079. </tr>
  2080. <tr>
  2081. <td class="bold">Format</td>
  2082. <td>plot.getMinZ(plot)</td>
  2083. </tr>
  2084. </table>
  2085. <table>
  2086. <tr>
  2087. <th class="command">plot.getMaxX</th>
  2088. <th class="desc">returns the lowest x coordinate of a plot</th>
  2089. </tr>
  2090. <tr>
  2091. <td class="bold">Format</td>
  2092. <td>plot.getMaxX(plot)</td>
  2093. </tr>
  2094. </table>
  2095. <table>
  2096. <tr>
  2097. <th class="command">plot.getMaxY</th>
  2098. <th class="desc">returns the lowest y coordinate of a plot</th>
  2099. </tr>
  2100. <tr>
  2101. <td class="bold">Format</td>
  2102. <td>plot.getMaxY(plot)</td>
  2103. </tr>
  2104. </table>
  2105. <table>
  2106. <tr>
  2107. <th class="command">plot.getMaxZ</th>
  2108. <th class="desc">returns the lowest z coordinate of a plot</th>
  2109. </tr>
  2110. <tr>
  2111. <td class="bold">Format</td>
  2112. <td>plot.getMaxZ(plot)</td>
  2113. </tr>
  2114. </table>
  2115. <table>
  2116. <tr>
  2117. <th class="command">plot.intersecting</th>
  2118. <th class="desc">returns a list with all intersecting plots</th>
  2119. </tr>
  2120. <tr>
  2121. <td class="bold">Format</td>
  2122. <td>plot.intersecting(world, x1, y1, z1, x2, y2, z2)</td>
  2123. </tr>
  2124. </table>
  2125. <table>
  2126. <tr>
  2127. <th class="command">plot.setFlags</th>
  2128. <th class="desc">sets all flags to the boolean</th>
  2129. </tr>
  2130. <tr>
  2131. <td class="bold">Format</td>
  2132. <td>plot.setFlags(plot, flags, boolean)</td>
  2133. </tr>
  2134. </table>
  2135. <table>
  2136. <tr>
  2137. <th class="command">plot.getFlags</th>
  2138. <th class="desc">returns all flags as double</th>
  2139. </tr>
  2140. <tr>
  2141. <td class="bold">Format</td>
  2142. <td>plot.getFlags(plot)</td>
  2143. </tr>
  2144. </table>
  2145. <table>
  2146. <tr>
  2147. <th class="command">plot.hasFlags</th>
  2148. <th class="desc">returns true if all flags existing</th>
  2149. </tr>
  2150. <tr>
  2151. <td class="bold">Format</td>
  2152. <td>plot.hasFlags(plot, flags)</td>
  2153. </tr>
  2154. </table>
  2155. <table>
  2156. <tr>
  2157. <th class="command">plot.getOwners</th>
  2158. <th class="desc">returns a list with all owners as uuid</th>
  2159. </tr>
  2160. <tr>
  2161. <td class="bold">Format</td>
  2162. <td>plot.getOwners(plot)</td>
  2163. </tr>
  2164. <tr>
  2165. <td class="bold">Info</td>
  2166. <td>list can be modified</td>
  2167. </tr>
  2168. </table>
  2169. <table>
  2170. <tr>
  2171. <th class="command">plot.check</th>
  2172. <th class="desc">returns true if the player is owner of any plot from that location OR if any plot contains all given flags. returns empty if there is no plot</th>
  2173. </tr>
  2174. <tr>
  2175. <td class="bold">Format</td>
  2176. <td>plot.check(location, player, Int flags, Boolean empty)</td>
  2177. </tr>
  2178. <tr>
  2179. <td class="bold">Arguments</td>
  2180. <td>player can be null<br>flags: 0 if not desired<br>1 PLACE_FLAG<br>2 BREAK_FLAG<br>4 BUCKET_FLAG<br>8 HIT_AMBIENT_FLAG<br>16 BLOCK_INTERACT_FLAG<br>32 ENTITY_INTERACT_FLAG</td>
  2181. </tr>
  2182. <tr>
  2183. <td class="bold">Examples</td>
  2184. <td>
  2185. plot.check(loc, null, 1, false) ==> true if place_flag existing<br>
  2186. plot.check(loc, null, 2, false) ==> true if break_flag existing<br>
  2187. plot.check(loc, null, 3, false) ==> true if break_flag and place_flag existing<br>
  2188. plot.check(loc, player, 0, false) ==> true if player is owner<br>
  2189. plot.check(loc, player, 0, true) ==> true if player is owner or if there is no plot
  2190. </td>
  2191. </tr>
  2192. </table>
  2193. <table>
  2194. <tr>
  2195. <th class="command">plot.iterator</th>
  2196. <th class="desc">returns the iterator for the plots in a world [for a player]</th>
  2197. </tr>
  2198. <tr>
  2199. <td class="bold">Format</td>
  2200. <td>plot.iterator(world, [uuid])</td>
  2201. </tr>
  2202. </table>
  2203. </section>
  2204. <section id="Table">
  2205. <table>
  2206. <tr>
  2207. <th class="command">table.new</th>
  2208. <th class="desc">returns a table object</th>
  2209. </tr>
  2210. <tr>
  2211. <td class="bold">Format</td>
  2212. <td>table.new(color, width, width, width, ...)</td>
  2213. </tr>
  2214. </table>
  2215. <table>
  2216. <tr>
  2217. <th class="command">table.getStart</th>
  2218. <th class="desc">returns the head of a table</th>
  2219. </tr>
  2220. <tr>
  2221. <td class="bold">Format</td>
  2222. <td>table.getStart(table)</td>
  2223. </tr>
  2224. </table>
  2225. <table>
  2226. <tr>
  2227. <th class="command">table.getMiddle</th>
  2228. <th class="desc">returns the middle of a table</th>
  2229. </tr>
  2230. <tr>
  2231. <td class="bold">Format</td>
  2232. <td>table.getMiddle(table)</td>
  2233. </tr>
  2234. </table>
  2235. <table>
  2236. <tr>
  2237. <th class="command">table.getEnd</th>
  2238. <th class="desc">returns the end of a table</th>
  2239. </tr>
  2240. <tr>
  2241. <td class="bold">Format</td>
  2242. <td>table.getEnd(table)</td>
  2243. </tr>
  2244. </table>
  2245. <table>
  2246. <tr>
  2247. <th class="command">table.get</th>
  2248. <th class="desc">returns a line of a table</th>
  2249. </tr>
  2250. <tr>
  2251. <td class="bold">Format</td>
  2252. <td>table.get(table, args...)</td>
  2253. </tr>
  2254. </table>
  2255. <table>
  2256. <tr>
  2257. <th class="command">table.setSize</th>
  2258. <th class="desc">defines the pixel size of a character</th>
  2259. </tr>
  2260. <tr>
  2261. <td class="bold">Format</td>
  2262. <td>table.setSize("character", pixel_int)</td>
  2263. </tr>
  2264. </table>
  2265. <table>
  2266. <tr>
  2267. <th class="command">table.setEmpty1</th>
  2268. <th class="desc">defines the 1 pixel empty character</th>
  2269. </tr>
  2270. <tr>
  2271. <td class="bold">Format</td>
  2272. <td>table.setEmpty1(string)</td>
  2273. </tr>
  2274. </table>
  2275. <table>
  2276. <tr>
  2277. <th class="command">table.setEmpty2</th>
  2278. <th class="desc">defines the 2 pixel empty character</th>
  2279. </tr>
  2280. <tr>
  2281. <td class="bold">Format</td>
  2282. <td>table.setEmpty2(string)</td>
  2283. </tr>
  2284. </table>
  2285. <table>
  2286. <tr>
  2287. <th class="command">table.setEmpty4</th>
  2288. <th class="desc">defines the 4 pixel empty character</th>
  2289. </tr>
  2290. <tr>
  2291. <td class="bold">Format</td>
  2292. <td>table.setEmpty4(string)</td>
  2293. </tr>
  2294. </table>
  2295. </section>
  2296. <section id="Command">
  2297. <table>
  2298. <tr>
  2299. <th class="command">command.add</th>
  2300. <th class="desc">registers a custom command</th>
  2301. </tr>
  2302. <tr>
  2303. <td class="bold">Format</td>
  2304. <td>command.add(string)</td>
  2305. </tr>
  2306. </table>
  2307. <table>
  2308. <tr>
  2309. <th class="command">command.remove</th>
  2310. <th class="desc">removes a custom command</th>
  2311. </tr>
  2312. <tr>
  2313. <td class="bold">Format</td>
  2314. <td>command.remove(string)</td>
  2315. </tr>
  2316. </table>
  2317. <table>
  2318. <tr>
  2319. <th class="command">command.clear</th>
  2320. <th class="desc">removes all custom commands</th>
  2321. </tr>
  2322. <tr>
  2323. <td class="bold">Format</td>
  2324. <td>command.clear()</td>
  2325. </tr>
  2326. </table>
  2327. <table>
  2328. <tr>
  2329. <th class="command">command.exists</th>
  2330. <th class="desc">returns true if a custom command exists</th>
  2331. </tr>
  2332. <tr>
  2333. <td class="bold">Format</td>
  2334. <td>command.exists(string)</td>
  2335. </tr>
  2336. </table>
  2337. <table>
  2338. <tr>
  2339. <th class="command">command.addIgnored</th>
  2340. <th class="desc">ignores a (vanilla) command-help</th>
  2341. </tr>
  2342. <tr>
  2343. <td class="bold">Format</td>
  2344. <td>command.addIgnored(string)</td>
  2345. </tr>
  2346. </table>
  2347. <table>
  2348. <tr>
  2349. <th class="command">command.clearIgnored</th>
  2350. <th class="desc">removes all ignored command-helps</th>
  2351. </tr>
  2352. <tr>
  2353. <td class="bold">Format</td>
  2354. <td>command.clearIgnored()</td>
  2355. </tr>
  2356. </table>
  2357. <table>
  2358. <tr>
  2359. <th class="command">command.newHelp</th>
  2360. <th class="desc">returns a help-object</th>
  2361. </tr>
  2362. <tr>
  2363. <td class="bold">Format</td>
  2364. <td>command.newHelp(string, perm)</td>
  2365. </tr>
  2366. </table>
  2367. <table>
  2368. <tr>
  2369. <th class="command">command.newHelpLiteral</th>
  2370. <th class="desc">returns a help-sub-object</th>
  2371. </tr>
  2372. <tr>
  2373. <td class="bold">Format</td>
  2374. <td>command.newHelpLiteral(string, [perm])</td>
  2375. </tr>
  2376. </table>
  2377. <table>
  2378. <tr>
  2379. <th class="command">command.newHelpBool</th>
  2380. <th class="desc">returns a help-sub-object</th>
  2381. </tr>
  2382. <tr>
  2383. <td class="bold">Format</td>
  2384. <td>command.newHelpBool(string, [perm])</td>
  2385. </tr>
  2386. </table>
  2387. <table>
  2388. <tr>
  2389. <th class="command">command.newHelpDouble</th>
  2390. <th class="desc">returns a help-sub-object</th>
  2391. </tr>
  2392. <tr>
  2393. <td class="bold">Format</td>
  2394. <td>command.newHelpDouble(string, min, max, [perm])</td>
  2395. </tr>
  2396. </table>
  2397. <table>
  2398. <tr>
  2399. <th class="command">command.newHelpFloat</th>
  2400. <th class="desc">returns a help-sub-object</th>
  2401. </tr>
  2402. <tr>
  2403. <td class="bold">Format</td>
  2404. <td>command.newHelpFloat(string, min, max, [perm])</td>
  2405. </tr>
  2406. </table>
  2407. <table>
  2408. <tr>
  2409. <th class="command">command.newHelpInt</th>
  2410. <th class="desc">returns a help-sub-object</th>
  2411. </tr>
  2412. <tr>
  2413. <td class="bold">Format</td>
  2414. <td>command.newHelpInt(string, min, max, [perm])</td>
  2415. </tr>
  2416. </table>
  2417. <table>
  2418. <tr>
  2419. <th class="command">command.newHelpLong</th>
  2420. <th class="desc">returns a help-sub-object</th>
  2421. </tr>
  2422. <tr>
  2423. <td class="bold">Format</td>
  2424. <td>command.newHelpLong(string, min, max, [perm])</td>
  2425. </tr>
  2426. </table>
  2427. <table>
  2428. <tr>
  2429. <th class="command">command.newHelpString</th>
  2430. <th class="desc">returns a help-sub-object</th>
  2431. </tr>
  2432. <tr>
  2433. <td class="bold">Format</td>
  2434. <td>command.newHelpString(string, boolean, [perm])</td>
  2435. </tr>
  2436. <tr>
  2437. <td class="bold">Arguments</td>
  2438. <td>boolean true means greedy</td>
  2439. </tr>
  2440. </table>
  2441. <table>
  2442. <tr>
  2443. <th class="command">command.newHelpSpecial</th>
  2444. <th class="desc">returns a help-sub-object</th>
  2445. </tr>
  2446. <tr>
  2447. <td class="bold">Format</td>
  2448. <td>command.newHelpSpecial(type, string, [perm])</td>
  2449. </tr>
  2450. <tr>
  2451. <td class="bold">Arguments</td>
  2452. <td>type = "Item", "Block", "Potion", "Enchantment", "Player"</td>
  2453. </tr>
  2454. </table>
  2455. <table>
  2456. <tr>
  2457. <th class="command">command.addHelp</th>
  2458. <th class="desc">registers a command-help</th>
  2459. </tr>
  2460. <tr>
  2461. <td class="bold">Format</td>
  2462. <td>command.addHelp(help-object)</td>
  2463. </tr>
  2464. </table>
  2465. <table>
  2466. <tr>
  2467. <th class="command">command.addHelpChild</th>
  2468. <th class="desc">help-sub-object2 is added tp help-(sub-)object1 as a new argument</th>
  2469. </tr>
  2470. <tr>
  2471. <td class="bold">Format</td>
  2472. <td>command.addHelpChild(help-(sub-)object1, help-sub-object2)</td>
  2473. </tr>
  2474. </table>
  2475. <table>
  2476. <tr>
  2477. <th class="command">command.addHelpAlias</th>
  2478. <th class="desc">help-object1 refers to help-object2</th>
  2479. </tr>
  2480. <tr>
  2481. <td class="bold">Format</td>
  2482. <td>command.addHelpAlias(help-object1, help-object2)</td>
  2483. </tr>
  2484. </table>
  2485. <table>
  2486. <tr>
  2487. <th class="command">command.sendHelp</th>
  2488. <th class="desc">sends all registered command-helps to all players</th>
  2489. </tr>
  2490. <tr>
  2491. <td class="bold">Format</td>
  2492. <td>command.sendHelp([player])</td>
  2493. </tr>
  2494. </table>
  2495. <table>
  2496. <tr>
  2497. <th class="command">command.clearHelp</th>
  2498. <th class="desc">removes all registered command-helps</th>
  2499. </tr>
  2500. <tr>
  2501. <td class="bold">Format</td>
  2502. <td>command.clearHelp()</td>
  2503. </tr>
  2504. </table>
  2505. </section>
  2506. <section id="Scoreboard">
  2507. <table>
  2508. <tr>
  2509. <th class="command">sb.add</th>
  2510. <th class="desc">adds text to the scoreboard</th>
  2511. </tr>
  2512. <tr>
  2513. <td class="bold">Format</td>
  2514. <td>sb.add(player, unique_index, string)</td>
  2515. </tr>
  2516. <tr>
  2517. <td class="bold">Arguments</td>
  2518. <td>index from 1 to 99</td>
  2519. </tr>
  2520. <tr>
  2521. <td class="bold">Info</td>
  2522. <td>vanilla: maximum 12 rows</td>
  2523. </tr>
  2524. </table>
  2525. <table>
  2526. <tr>
  2527. <th class="command">sb.remove</th>
  2528. <th class="desc">removes a row from the scoreboard</th>
  2529. </tr>
  2530. <tr>
  2531. <td class="bold">Format</td>
  2532. <td>sb.remove(player, unique_index)</td>
  2533. </tr>
  2534. <tr>
  2535. <td class="bold">Arguments</td>
  2536. <td>index as number from 1 to 99</td>
  2537. </tr>
  2538. </table>
  2539. <table>
  2540. <tr>
  2541. <th class="command">sb.addRaw</th>
  2542. <th class="desc">adds text to the scoreboard</th>
  2543. </tr>
  2544. <tr>
  2545. <td class="bold">Format</td>
  2546. <td>sb.addRaw(player, index, unique_string)</td>
  2547. </tr>
  2548. <tr>
  2549. <td class="bold">Arguments</td>
  2550. <td>index from 1 to 99</td>
  2551. </tr>
  2552. <tr>
  2553. <td class="bold">Info</td>
  2554. <td>vanilla: maximum 12 rows</td>
  2555. </tr>
  2556. </table>
  2557. <table>
  2558. <tr>
  2559. <th class="command">sb.removeRaw</th>
  2560. <th class="desc">removes a row from the scoreboard</th>
  2561. </tr>
  2562. <tr>
  2563. <td class="bold">Format</td>
  2564. <td>sb.removeRaw(player, unique_string)</td>
  2565. </tr>
  2566. </table>
  2567. <table>
  2568. <tr>
  2569. <th class="command">sb.setTitle</th>
  2570. <th class="desc">sets a scoreboard title</th>
  2571. </tr>
  2572. <tr>
  2573. <td class="bold">Format</td>
  2574. <td>sb.setTitle(player, text)</td>
  2575. </tr>
  2576. </table>
  2577. <table>
  2578. <tr>
  2579. <th class="command">sb.clear</th>
  2580. <th class="desc">clears the scoreboard of a player</th>
  2581. </tr>
  2582. <tr>
  2583. <td class="bold">Format</td>
  2584. <td>sb.clear(player)</td>
  2585. </tr>
  2586. </table>
  2587. </section>
  2588. <section id="Script">
  2589. <table>
  2590. <tr>
  2591. <th class="command">script.start</th>
  2592. <th class="desc">connects all scripts, starts them as one script and returns the script</th>
  2593. </tr>
  2594. <tr>
  2595. <td class="bold">Format</td>
  2596. <td>script.start(scriptpath1, scriptpath2, ...)</td>
  2597. </tr>
  2598. </table>
  2599. <table>
  2600. <tr>
  2601. <th class="command">script.startNamed</th>
  2602. <th class="desc">connects all scripts, starts them as one script and returns the script</th>
  2603. </tr>
  2604. <tr>
  2605. <td class="bold">Format</td>
  2606. <td>script.startNamed(custom_name, scriptpath1, scriptpath2, ...)</td>
  2607. </tr>
  2608. <td class="bold">Info</td>
  2609. <td>named scripts can be selected with script.get by their custom_name</td>
  2610. <tr>
  2611. </tr>
  2612. </table>
  2613. <table>
  2614. <tr>
  2615. <th class="command">script.callEvent</th>
  2616. <th class="desc">calls an event</th>
  2617. </tr>
  2618. <tr>
  2619. <td class="bold">Format</td>
  2620. <td>script.callEvent(event, [script])</td>
  2621. </tr>
  2622. </table>
  2623. </section>
  2624. <section id="Title">
  2625. <table>
  2626. <tr>
  2627. <th class="command">title.send</th>
  2628. <th class="desc">shows a player a title (and subtitle if set)</th>
  2629. </tr>
  2630. <tr>
  2631. <td class="bold">Format</td>
  2632. <td>title.send(player, title, [subtitle], [fadeIn | 20], [stay | 60], [fadeOut | 20])</td>
  2633. </tr>
  2634. </table>
  2635. <table>
  2636. <tr>
  2637. <th class="command">title.remove</th>
  2638. <th class="desc">removes the shown title</th>
  2639. </tr>
  2640. <tr>
  2641. <td class="bold">Format</td>
  2642. <td>title.remove(player)</td>
  2643. </tr>
  2644. </table>
  2645. </section>
  2646. <section id="Permission">
  2647. <table>
  2648. <tr>
  2649. <th class="command">perm.clear</th>
  2650. <th class="desc">removes all permissions from a player</th>
  2651. </tr>
  2652. <tr>
  2653. <td class="bold">Format</td>
  2654. <td>perm.clear(player)</td>
  2655. </tr>
  2656. </table>
  2657. <table>
  2658. <tr>
  2659. <th class="command">perm.add</th>
  2660. <th class="desc">adds a permission to a player</th>
  2661. </tr>
  2662. <tr>
  2663. <td class="bold">Format</td>
  2664. <td>perm.add(perm, player)</td>
  2665. </tr>
  2666. </table>
  2667. <table>
  2668. <tr>
  2669. <th class="command">perm.has</th>
  2670. <th class="desc">returns true if a player has the permission</th>
  2671. </tr>
  2672. <tr>
  2673. <td class="bold">Format</td>
  2674. <td>perm.has(perm, player)</td>
  2675. </tr>
  2676. </table>
  2677. <table>
  2678. <tr>
  2679. <th class="command">perm.update</th>
  2680. <th class="desc">updates the permissions of a player</th>
  2681. </tr>
  2682. <tr>
  2683. <td class="bold">Format</td>
  2684. <td>perm.update(player)</td>
  2685. </tr>
  2686. <tr>
  2687. <td class="bold">Info</td>
  2688. <td>call this after adding all player permissions</td>
  2689. </tr>
  2690. </table>
  2691. </section>
  2692. <section id="Player">
  2693. <table>
  2694. <tr>
  2695. <th class="command">players.toWorldList</th>
  2696. <th class="desc">returns a list with all players in a world</th>
  2697. </tr>
  2698. <tr>
  2699. <td class="bold">Format</td>
  2700. <td>players.toWorldList(World)</td>
  2701. </tr>
  2702. </table>
  2703. <table>
  2704. <tr>
  2705. <th class="command">players.near</th>
  2706. <th class="desc">returns a list with all players within a radius of a location</th>
  2707. </tr>
  2708. <tr>
  2709. <td class="bold">Format</td>
  2710. <td>players.near(location, radius)</td>
  2711. </tr>
  2712. </table>
  2713. <table>
  2714. <tr>
  2715. <th class="command">players.getAmount</th>
  2716. <th class="desc">returns the number of online players</th>
  2717. </tr>
  2718. <tr>
  2719. <td class="bold">Format</td>
  2720. <td>players.getAmount()</td>
  2721. </tr>
  2722. </table>
  2723. <table>
  2724. <tr>
  2725. <th class="command">player.damageArmor</th>
  2726. <th class="desc">damages the armor of a player, portioned on all armor parts</th>
  2727. </tr>
  2728. <tr>
  2729. <td class="bold">Format</td>
  2730. <td>player.damageArmor(player, damage, damage_source)</td>
  2731. </tr>
  2732. <tr>
  2733. <td class="bold">Arguments</td>
  2734. <td>damage is cast to float</td>
  2735. </tr>
  2736. </table>
  2737. <table>
  2738. <tr>
  2739. <th class="command">player.getHead</th>
  2740. <th class="desc">returns the head of a player as an itemstack</th>
  2741. </tr>
  2742. <tr>
  2743. <td class="bold">Format</td>
  2744. <td>player.getHead(uuid, name)</td>
  2745. </tr>
  2746. <tr>
  2747. <td class="bold">Arguments</td>
  2748. <td>uuid and(!) name of the same(!) player</td>
  2749. </tr>
  2750. </table>
  2751. <table>
  2752. <tr>
  2753. <th class="command">player.getNearest</th>
  2754. <th class="desc">returns the next player to a location</th>
  2755. </tr>
  2756. <tr>
  2757. <td class="bold">Format</td>
  2758. <td>player.getNearest(location)</td>
  2759. </tr>
  2760. <tr>
  2761. <td class="bold">Info</td>
  2762. <td>searches in a radius of 10 blocks</td>
  2763. </tr>
  2764. </table>
  2765. <table>
  2766. <tr>
  2767. <th class="command">player.setDisplayName</th>
  2768. <th class="desc">sets the name of a player in the tab list</th>
  2769. </tr>
  2770. <tr>
  2771. <td class="bold">Format</td>
  2772. <td>player.setDisplayName(player, text)</td>
  2773. </tr>
  2774. </table>
  2775. <table>
  2776. <tr>
  2777. <th class="command">player.action</th>
  2778. <th class="desc">shows a message in the action bar</th>
  2779. </tr>
  2780. <tr>
  2781. <td class="bold">Format</td>
  2782. <td>player.action(receiver, text)</td>
  2783. </tr>
  2784. </table>
  2785. <table>
  2786. <tr>
  2787. <th class="command">player.getTargetBlock</th>
  2788. <th class="desc">returns the block a player is looking at</th>
  2789. </tr>
  2790. <tr>
  2791. <td class="bold">Format</td>
  2792. <td>player.getTargetBlock(player, radius, [fluidmode|false])</td>
  2793. </tr>
  2794. <tr>
  2795. <td class="bold">Arguments</td>
  2796. <td>
  2797. Vanilla default radius: 5<br>
  2798. radius will be cast to int<br>
  2799. fluidmode: true does not ignore water
  2800. </td>
  2801. </tr>
  2802. </table>
  2803. <table>
  2804. <tr>
  2805. <th class="command">player.getName</th>
  2806. <th class="desc">returns the name of a player</th>
  2807. </tr>
  2808. <tr>
  2809. <td class="bold">Format</td>
  2810. <td>player.getName(uuid / string_uuid / player)</td>
  2811. </tr>
  2812. <tr>
  2813. <td class="bold">Info</td>
  2814. <td>uuid and string_uuid can return null</td>
  2815. </tr>
  2816. </table>
  2817. <table>
  2818. <tr>
  2819. <th class="command">player.getUuid</th>
  2820. <th class="desc">returns the uuid of a player</th>
  2821. </tr>
  2822. <tr>
  2823. <td class="bold">Format</td>
  2824. <td>player.getUuid(player / player_name)</td>
  2825. </tr>
  2826. <tr>
  2827. <td class="bold">Info</td>
  2828. <td>player_name can return null</td>
  2829. </tr>
  2830. </table>
  2831. <table>
  2832. <tr>
  2833. <th class="command">player.getUuidFromId</th>
  2834. <th class="desc">returns the uuid of a player from their id</th>
  2835. </tr>
  2836. <tr>
  2837. <td class="bold">Format</td>
  2838. <td>player.getUuidFromId(player_id)</td>
  2839. </tr>
  2840. </table>
  2841. <table>
  2842. <tr>
  2843. <th class="command">player.getNameFromId</th>
  2844. <th class="desc">returns the name of a player from their id</th>
  2845. </tr>
  2846. <tr>
  2847. <td class="bold">Format</td>
  2848. <td>player.getNameFromId(player_id)</td>
  2849. </tr>
  2850. </table>
  2851. <table>
  2852. <tr>
  2853. <th class="command">player.getId</th>
  2854. <th class="desc">returns the id of a player</th>
  2855. </tr>
  2856. <tr>
  2857. <td class="bold">Format</td>
  2858. <td>player.getId(player / uuid / string_uuid)</td>
  2859. </tr>
  2860. </table>
  2861. <table>
  2862. <tr>
  2863. <th class="command">player.get</th>
  2864. <th class="desc">returns a player</th>
  2865. </tr>
  2866. <tr>
  2867. <td class="bold">Format</td>
  2868. <td>player.get(player / uuid / string_uuid)</td>
  2869. </tr>
  2870. </table>
  2871. <table>
  2872. <tr>
  2873. <th class="command">player.respawn</th>
  2874. <th class="desc">forces the respawn of a dead player</th>
  2875. </tr>
  2876. <tr>
  2877. <td class="bold">Format</td>
  2878. <td>player.respawn(player)</td>
  2879. </tr>
  2880. </table>
  2881. <table>
  2882. <tr>
  2883. <th class="command">player.setCompass</th>
  2884. <th class="desc">sets the target of a compass</th>
  2885. </tr>
  2886. <tr>
  2887. <td class="bold">Format</td>
  2888. <td>player.setCompass(player, location)</td>
  2889. </tr>
  2890. </table>
  2891. <table>
  2892. <tr>
  2893. <th class="command">player.setHunger</th>
  2894. <th class="desc">sets the hunger of a player</th>
  2895. </tr>
  2896. <tr>
  2897. <td class="bold">Format</td>
  2898. <td>player.setHunger(player, number)</td>
  2899. </tr>
  2900. <tr>
  2901. <td class="bold">Info</td>
  2902. <td>Vanilla default: 0-20</td>
  2903. </tr>
  2904. </table>
  2905. <table>
  2906. <tr>
  2907. <th class="command">player.getHunger</th>
  2908. <th class="desc">returns the hunger of a player</th>
  2909. </tr>
  2910. <tr>
  2911. <td class="bold">Format</td>
  2912. <td>player.getHunger(player)</td>
  2913. </tr>
  2914. </table>
  2915. <table>
  2916. <tr>
  2917. <th class="command">player.setSaturation</th>
  2918. <th class="desc">sets the saturation of a player</th>
  2919. </tr>
  2920. <tr>
  2921. <td class="bold">Format</td>
  2922. <td>player.setSaturation(player, number)</td>
  2923. </tr>
  2924. <tr>
  2925. <td class="bold">Info</td>
  2926. <td>Vanilla default: 5, maximum: 20</td>
  2927. </tr>
  2928. </table>
  2929. <table>
  2930. <tr>
  2931. <th class="command">player.getSaturation</th>
  2932. <th class="desc">returns the saturation of a player</th>
  2933. </tr>
  2934. <tr>
  2935. <td class="bold">Format</td>
  2936. <td>player.getSaturation(player)</td>
  2937. </tr>
  2938. </table>
  2939. <table>
  2940. <tr>
  2941. <th class="command">player.setGamemode</th>
  2942. <th class="desc">set the gamemode for a player</th>
  2943. </tr>
  2944. <tr>
  2945. <td class="bold">Format</td>
  2946. <td>player.setGamemode(player, gamemode)</td>
  2947. </tr>
  2948. <tr>
  2949. <td class="bold">Arguments</td>
  2950. <td>gamemode as "SURVIVAL" / "CREATIVE" / "ADVENTURE" / "SPECTATOR"</td>
  2951. </tr>
  2952. </table>
  2953. <table>
  2954. <tr>
  2955. <th class="command">player.isSurvival</th>
  2956. <th class="desc">returns true if a player is in gamemode survival</th>
  2957. </tr>
  2958. <tr>
  2959. <td class="bold">Format</td>
  2960. <td>player.isSurvival(player)</td>
  2961. </tr>
  2962. </table>
  2963. <table>
  2964. <tr>
  2965. <th class="command">player.isCreative</th>
  2966. <th class="desc">returns true if a player is in gamemode creative</th>
  2967. </tr>
  2968. <tr>
  2969. <td class="bold">Format</td>
  2970. <td>player.isCreative(player)</td>
  2971. </tr>
  2972. </table>
  2973. <table>
  2974. <tr>
  2975. <th class="command">player.isAdventure</th>
  2976. <th class="desc">returns true if a player is in gamemode adventure</th>
  2977. </tr>
  2978. <tr>
  2979. <td class="bold">Format</td>
  2980. <td>player.isAdventure(player)</td>
  2981. </tr>
  2982. </table>
  2983. <table>
  2984. <tr>
  2985. <th class="command">player.isSpectator</th>
  2986. <th class="desc">returns true if a player is in gamemode spectator</th>
  2987. </tr>
  2988. <tr>
  2989. <td class="bold">Format</td>
  2990. <td>player.isSpectator(player)</td>
  2991. </tr>
  2992. </table>
  2993. <table>
  2994. <tr>
  2995. <th class="command">player.hasFly</th>
  2996. <th class="desc">returns true if a player is allowed to fly</th>
  2997. </tr>
  2998. <tr>
  2999. <td class="bold">Format</td>
  3000. <td>player.hasFly(player)</td>
  3001. </tr>
  3002. </table>
  3003. <table>
  3004. <tr>
  3005. <th class="command">player.isFlying</th>
  3006. <th class="desc">returns true if a player is flying</th>
  3007. </tr>
  3008. <tr>
  3009. <td class="bold">Format</td>
  3010. <td>player.isFlying(player)</td>
  3011. </tr>
  3012. </table>
  3013. <table>
  3014. <tr>
  3015. <th class="command">player.setFly</th>
  3016. <th class="desc">set if a player is allowed to fly</th>
  3017. </tr>
  3018. <tr>
  3019. <td class="bold">Format</td>
  3020. <td>player.setFly(player, boolean)</td>
  3021. </tr>
  3022. </table>
  3023. <table>
  3024. <tr>
  3025. <th class="command">player.dropInventory</th>
  3026. <th class="desc">drops the inventory of a player at a location</th>
  3027. </tr>
  3028. <tr>
  3029. <td class="bold">Format</td>
  3030. <td>player.dropInventory(player, location)</td>
  3031. </tr>
  3032. </table>
  3033. <table>
  3034. <tr>
  3035. <th class="command">player.getItemAmount</th>
  3036. <th class="desc">returns the amount of an exact itemstack from a players inventory</th>
  3037. </tr>
  3038. <tr>
  3039. <td class="bold">Format</td>
  3040. <td>player.getItemAmount(player, itemstack)</td>
  3041. </tr>
  3042. <table>
  3043. <tr>
  3044. <th class="command">player.damageItem</th>
  3045. <th class="desc">damages the item in the hand of a player</th>
  3046. </tr>
  3047. <tr>
  3048. <td class="bold">Format</td>
  3049. <td>player.damageItem(player, damage_amount)</td>
  3050. </tr>
  3051. <tr>
  3052. <td class="bold">Info</td>
  3053. <td>unbreaking (and more) is considered</td>
  3054. </tr>
  3055. </table>
  3056. <table>
  3057. <tr>
  3058. <th class="command">player.setSpawn</th>
  3059. <th class="desc">sets the spawn location of a player</th>
  3060. </tr>
  3061. <tr>
  3062. <td class="bold">Format</td>
  3063. <td>player.setSpawn(player, location)</td>
  3064. </tr>
  3065. </table>
  3066. <table>
  3067. <tr>
  3068. <th class="command">player.getSpawn</th>
  3069. <th class="desc">returns the spawn location of a player</th>
  3070. </tr>
  3071. <tr>
  3072. <td class="bold">Format</td>
  3073. <td>player.getSpawn(player)</td>
  3074. </tr>
  3075. <tr>
  3076. <td class="bold">Format</td>
  3077. <td>spawn is linked to the bed spawn, if no bed spawn exists the return value may be null</td>
  3078. </tr>
  3079. </table>
  3080. <table>
  3081. <tr>
  3082. <th class="command">player.giveItem</th>
  3083. <th class="desc">gives an itemstack to a player and returns the item amount which didn't fit in a players inventory</th>
  3084. </tr>
  3085. <tr>
  3086. <td class="bold">Format</td>
  3087. <td>player.giveItem(player, itemstack)</td>
  3088. </tr>
  3089. </table>
  3090. <table>
  3091. <tr>
  3092. <th class="command">player.addItem</th>
  3093. <th class="desc">returns 0 if the itemstack is added, otherwise the itemstack won't be added and the not fitting item amount is returned</th>
  3094. </tr>
  3095. <tr>
  3096. <td class="bold">Format</td>
  3097. <td>player.addItem(player, itemstack)</td>
  3098. </tr>
  3099. </table>
  3100. <table>
  3101. <tr>
  3102. <th class="command">player.removeItem</th>
  3103. <th class="desc">returns 0 if the itemstack is removed, otherwise the itemstack won't be removed and the missing item amount is returned</th>
  3104. </tr>
  3105. <tr>
  3106. <td class="bold">Format</td>
  3107. <td>player.removeItem(player, itemstack)</td>
  3108. </tr>
  3109. </table>
  3110. <table>
  3111. <tr>
  3112. <th class="command">player.getIP</th>
  3113. <th class="desc">returns the ip-address of a player as string</th>
  3114. </tr>
  3115. <tr>
  3116. <td class="bold">Format</td>
  3117. <td>player.getIp(player)</td>
  3118. </tr>
  3119. </table>
  3120. <table>
  3121. <tr>
  3122. <th class="command">player.getInv</th>
  3123. <th class="desc">returns the (non-copy) inventory of a player</th>
  3124. </tr>
  3125. <tr>
  3126. <td class="bold">Format</td>
  3127. <td>player.getInv(player)</td>
  3128. </tr>
  3129. </table>
  3130. <table>
  3131. <tr>
  3132. <th class="command">player.getEnderInv</th>
  3133. <th class="desc">returns the (non-copy) ender inventory of a player</th>
  3134. </tr>
  3135. <tr>
  3136. <td class="bold">Format</td>
  3137. <td>player.getEnderInv(player)</td>
  3138. </tr>
  3139. </table>
  3140. <table>
  3141. <tr>
  3142. <th class="command">player.getTargetEntity</th>
  3143. <th class="desc">returns the targeted entity</th>
  3144. </tr>
  3145. <tr>
  3146. <td class="bold">Format</td>
  3147. <td>player.getTargetEntity(player, radius)</td>
  3148. </tr>
  3149. <tr>
  3150. <td class="bold">Arguments</td>
  3151. <td>radius will be cast to int<br></td>
  3152. </tr>
  3153. </table>
  3154. <table>
  3155. <tr>
  3156. <th class="command">player.getLevel</th>
  3157. <th class="desc">returns the level of a player</th>
  3158. </tr>
  3159. <tr>
  3160. <td class="bold">Format</td>
  3161. <td>player.getLevel(player)</td>
  3162. </tr>
  3163. </table>
  3164. <table>
  3165. <tr>
  3166. <th class="command">player.setLevel</th>
  3167. <th class="desc">sets the level of a player</th>
  3168. </tr>
  3169. <tr>
  3170. <td class="bold">Format</td>
  3171. <td>player.setLevel(player, level)</td>
  3172. </tr>
  3173. <tr>
  3174. <td class="bold">Arguments</td>
  3175. <td>level is cast to int</td>
  3176. </tr>
  3177. </table>
  3178. <table>
  3179. <tr>
  3180. <th class="command">player.getExp</th>
  3181. <th class="desc">returns the experience of a player</th>
  3182. </tr>
  3183. <tr>
  3184. <td class="bold">Format</td>
  3185. <td>player.getExp(player)</td>
  3186. </tr>
  3187. </table>
  3188. <table>
  3189. <tr>
  3190. <th class="command">player.setExp</th>
  3191. <th class="desc">sets the experience of a player</th>
  3192. </tr>
  3193. <tr>
  3194. <td class="bold">Format</td>
  3195. <td>player.setExp(player, exp)</td>
  3196. </tr>
  3197. <tr>
  3198. <td class="bold">Arguments</td>
  3199. <td>exp is cast to float</td>
  3200. </tr>
  3201. </table>
  3202. <table>
  3203. <tr>
  3204. <th class="command">player.addTotalExp</th>
  3205. <th class="desc">modifies the experience of a player</th>
  3206. </tr>
  3207. <tr>
  3208. <td class="bold">Format</td>
  3209. <td>player.addTotalExp(player, exp)</td>
  3210. </tr>
  3211. <tr>
  3212. <td class="bold">Arguments</td>
  3213. <td>exp is cast to int</td>
  3214. </tr>
  3215. </table>
  3216. <table>
  3217. <tr>
  3218. <th class="command">player.hide</th>
  3219. <th class="desc">hides a player</th>
  3220. </tr>
  3221. <tr>
  3222. <td class="bold">Format</td>
  3223. <td>player.hide(player)</td>
  3224. </tr>
  3225. </table>
  3226. <table>
  3227. <tr>
  3228. <th class="command">player.show</th>
  3229. <th class="desc">shows a player</th>
  3230. </tr>
  3231. <tr>
  3232. <td class="bold">Format</td>
  3233. <td>player.show(player)</td>
  3234. </tr>
  3235. </table>
  3236. <table>
  3237. <tr>
  3238. <th class="command">player.setFlySpeed</th>
  3239. <th class="desc">sets the fly speed of a player</th>
  3240. </tr>
  3241. <tr>
  3242. <td class="bold">Format</td>
  3243. <td>player.setFlySpeed(player, speed)</td>
  3244. </tr>
  3245. <tr>
  3246. <td class="bold">Arguments</td>
  3247. <td>speed is cast to float</td>
  3248. </tr>
  3249. </table>
  3250. <table>
  3251. <tr>
  3252. <th class="command">player.setWalkSpeed</th>
  3253. <th class="desc">sets the walk speed of a player</th>
  3254. </tr>
  3255. <tr>
  3256. <td class="bold">Format</td>
  3257. <td>player.setWalkSpeed(player, speed)</td>
  3258. </tr>
  3259. <tr>
  3260. <td class="bold">Arguments</td>
  3261. <td>speed is cast to float</td>
  3262. </tr>
  3263. </table>
  3264. <table>
  3265. <tr>
  3266. <th class="command">player.isSneaking</th>
  3267. <th class="desc">returns true if a player is sneaking</th>
  3268. </tr>
  3269. <tr>
  3270. <td class="bold">Format</td>
  3271. <td>player.isSneaking(player)</td>
  3272. </tr>
  3273. </table>
  3274. <table>
  3275. <tr>
  3276. <th class="command">player.isBlocking</th>
  3277. <th class="desc">returns true if a player is blocking with their shield</th>
  3278. </tr>
  3279. <tr>
  3280. <td class="bold">Format</td>
  3281. <td>player.isBlocking(player)</td>
  3282. </tr>
  3283. </table>
  3284. <table>
  3285. <tr>
  3286. <th class="command">player.setSlot</th>
  3287. <th class="desc">sets the active slot of a player</th>
  3288. </tr>
  3289. <tr>
  3290. <td class="bold">Format</td>
  3291. <td>player.setSlot(player, slot)</td>
  3292. </tr>
  3293. <tr>
  3294. <td class="bold">Arguments</td>
  3295. <td>slot from 0 to 8</td>
  3296. </tr>
  3297. </table>
  3298. </section>
  3299. <section id="Inventory">
  3300. <table>
  3301. <tr>
  3302. <th class="command">inv.new</th>
  3303. <th class="desc">returns a new custom inventory</th>
  3304. </tr>
  3305. <tr>
  3306. <td class="bold">Format</td>
  3307. <td>inv.new(slotdata, title)</td>
  3308. </tr>
  3309. <tr>
  3310. <td class="bold">Arguments</td>
  3311. <td>
  3312. slotdata as string:<br>
  3313. 0 = no slot, throws no event<br>
  3314. 1 = normal slot, throws inv_click event<br>
  3315. 2 = button slot, throws snuvi_click event
  3316. </td>
  3317. </tr>
  3318. <tr>
  3319. <td class="bold">Examples</td>
  3320. <td>inv.new("002122000")</td>
  3321. </tr>
  3322. </table>
  3323. </table>
  3324. <table>
  3325. <tr>
  3326. <th class="command">inv.getSize</th>
  3327. <th class="desc">returns the size of an inventory</th>
  3328. </tr>
  3329. <tr>
  3330. <td class="bold">Format</td>
  3331. <td>inv.getSize(inventory)</td>
  3332. </tr>
  3333. <table>
  3334. <tr>
  3335. <th class="command">inv.setItem</th>
  3336. <th class="desc">sets an itemstack on a specific slot in an inventory</th>
  3337. </tr>
  3338. <tr>
  3339. <td class="bold">Format</td>
  3340. <td>inv.setItem(inventory, slotindex, itemstack)</td>
  3341. </tr>
  3342. </table>
  3343. <table>
  3344. <tr>
  3345. <th class="command">inv.getItem</th>
  3346. <th class="desc">returns an itemstack from a specific slot of an inventory</th>
  3347. </tr>
  3348. <tr>
  3349. <td class="bold">Format</td>
  3350. <td>inv.getItem(inventory, slotindex)</td>
  3351. </tr>
  3352. </table>
  3353. <table>
  3354. <tr>
  3355. <th class="command">inv.open</th>
  3356. <th class="desc">shows an inventory to a player</th>
  3357. </tr>
  3358. <tr>
  3359. <td class="bold">Format</td>
  3360. <td>inv.open(inventory, player)</td>
  3361. </tr>
  3362. </table>
  3363. <table>
  3364. <tr>
  3365. <th class="command">inv.close</th>
  3366. <th class="desc">closes an inventory of a player</th>
  3367. </tr>
  3368. <tr>
  3369. <td class="bold">Format</td>
  3370. <td>inv.close(player)</td>
  3371. </tr>
  3372. </table>
  3373. <table>
  3374. <tr>
  3375. <th class="command">inv.clear</th>
  3376. <th class="desc">clears an inventory</th>
  3377. </tr>
  3378. <tr>
  3379. <td class="bold">Format</td>
  3380. <td>inv.clear(inv)</td>
  3381. </tr>
  3382. </table>
  3383. <table>
  3384. <tr>
  3385. <th class="command">inv.getID</th>
  3386. <th class="desc">returns the id of an inventory or -1 if no custom inventory</th>
  3387. </tr>
  3388. <tr>
  3389. <td class="bold">Format</td>
  3390. <td>inv.getID(inventory)</td>
  3391. </tr>
  3392. </table>
  3393. </section>
  3394. <section id="World">
  3395. <table>
  3396. <tr>
  3397. <th class="command">world.get</th>
  3398. <th class="desc">returns a world</th>
  3399. </tr>
  3400. <tr>
  3401. <td class="bold">Format</td>
  3402. <td>world.get(name)</td>
  3403. </tr>
  3404. </table>
  3405. <table>
  3406. <tr>
  3407. <th class="command">world.getName</th>
  3408. <th class="desc">returns the name of a world</th>
  3409. </tr>
  3410. <tr>
  3411. <td class="bold">Format</td>
  3412. <td>world.getName(world)</td>
  3413. </tr>
  3414. </table>
  3415. <table>
  3416. <tr>
  3417. <th class="command">world.getPlayers</th>
  3418. <th class="desc">returns a list with all players in a world</th>
  3419. </tr>
  3420. <tr>
  3421. <td class="bold">Format</td>
  3422. <td>world.getPlayers(world)</td>
  3423. </tr>
  3424. </table>
  3425. <table>
  3426. <tr>
  3427. <th class="command">world.setDifficulty</th>
  3428. <th class="desc">sets the difficulty of a world</th>
  3429. </tr>
  3430. <tr>
  3431. <td class="bold">Format</td>
  3432. <td>world.setDifficulty(world, <a href="https://papermc.io/javadocs/paper/1.18/org/bukkit/Difficulty.html" target="_blank">difficulty</a>)</td>
  3433. </tr>
  3434. </table>
  3435. <table>
  3436. <tr>
  3437. <th class="command">world.setSpawn</th>
  3438. <th class="desc">sets the world spawn</th>
  3439. </tr>
  3440. <tr>
  3441. <td class="bold">Format</td>
  3442. <td>world.setSpawn(world, location)</td>
  3443. </tr>
  3444. </table>
  3445. <table>
  3446. <tr>
  3447. <th class="command">world.getSpawn</th>
  3448. <th class="desc">returns the world spawn as location</th>
  3449. </tr>
  3450. <tr>
  3451. <td class="bold">Format</td>
  3452. <td>world.getSpawn(world)</td>
  3453. </tr>
  3454. </table>
  3455. <table>
  3456. <tr>
  3457. <th class="command">world.getAll</th>
  3458. <th class="desc">returns a list with all loaded worlds</th>
  3459. </tr>
  3460. <tr>
  3461. <td class="bold">Format</td>
  3462. <td>world.getAll()</td>
  3463. </tr>
  3464. </table>
  3465. <table>
  3466. <tr>
  3467. <th class="command">world.setTime</th>
  3468. <th class="desc">sets the time for a world</th>
  3469. </tr>
  3470. <tr>
  3471. <td class="bold">Format</td>
  3472. <td>world.setTime(world, time)</td>
  3473. </tr>
  3474. <tr>
  3475. <td class="bold">Arguments</td>
  3476. <td>time from 0 to 24000</td>
  3477. </tr>
  3478. </table>
  3479. <table>
  3480. <tr>
  3481. <th class="command">world.getTime</th>
  3482. <th class="desc">returns the time of a world</th>
  3483. </tr>
  3484. <tr>
  3485. <td class="bold">Format</td>
  3486. <td>world.getTime(world)</td>
  3487. </tr>
  3488. </table>
  3489. <table>
  3490. <tr>
  3491. <th class="command">world.hasRain</th>
  3492. <th class="desc">returns true if it is raining in the world</th>
  3493. </tr>
  3494. <tr>
  3495. <td class="bold">Format</td>
  3496. <td>world.hasStorm(world)</td>
  3497. </tr>
  3498. </table>
  3499. <table>
  3500. <tr>
  3501. <th class="command">world.hasThunder</th>
  3502. <th class="desc">returns true if there is thunder in the world</th>
  3503. </tr>
  3504. <tr>
  3505. <td class="bold">Format</td>
  3506. <td>world.hasThunder(world)</td>
  3507. </tr>
  3508. </table>
  3509. <table>
  3510. <tr>
  3511. <th class="command">world.clearWeather</th>
  3512. <th class="desc">clears the weather of a world</th>
  3513. </tr>
  3514. <tr>
  3515. <td class="bold">Format</td>
  3516. <td>world.clearWeather(world, ticks)</td>
  3517. </tr>
  3518. <tr>
  3519. <td class="bold">Info</td>
  3520. <td>ticks when the next rain is allowed to start</td>
  3521. </tr>
  3522. </table>
  3523. <table>
  3524. <tr>
  3525. <th class="command">world.setRain</th>
  3526. <th class="desc">sets the weather of a world to rain</th>
  3527. </tr>
  3528. <tr>
  3529. <td class="bold">Format</td>
  3530. <td>world.setRain(world, ticks)</td>
  3531. </tr>
  3532. <tr>
  3533. <td class="bold">Info</td>
  3534. <td>ticks how long the rain stays</td>
  3535. </tr>
  3536. </table>
  3537. <table>
  3538. <tr>
  3539. <th class="command">world.setThunder</th>
  3540. <th class="desc">sets the weather of a world to thunder</th>
  3541. </tr>
  3542. <tr>
  3543. <td class="bold">Format</td>
  3544. <td>world.setThunder(world, ticks)</td>
  3545. </tr>
  3546. <tr>
  3547. <td class="bold">Info</td>
  3548. <td>ticks how long the thunder stays</td>
  3549. </tr>
  3550. </table>
  3551. <table>
  3552. <tr>
  3553. <th class="command">world.getEntities</th>
  3554. <th class="desc">returns a list with all entities in a world</th>
  3555. </tr>
  3556. <tr>
  3557. <td class="bold">Format</td>
  3558. <td>world.getEntities(world)</td>
  3559. </tr>
  3560. </table>
  3561. <table>
  3562. <tr>
  3563. <th class="command">world.load</th>
  3564. <th class="desc">returns the loaded world</th>
  3565. </tr>
  3566. <tr>
  3567. <td class="bold">Format</td>
  3568. <td>world.load(name)</td>
  3569. </tr>
  3570. </table>
  3571. <table>
  3572. <tr>
  3573. <th class="command">world.unload</th>
  3574. <th class="desc">returns true if unloading a world is successful</th>
  3575. </tr>
  3576. <tr>
  3577. <td class="bold">Format</td>
  3578. <td>world.unload(world)</td>
  3579. </tr>
  3580. </table>
  3581. </section>
  3582. <section id="Entity">
  3583. <table>
  3584. <tr>
  3585. <th class="command">Xentity.getType</th>
  3586. <th class="desc">returns the type of an entity</th>
  3587. </tr>
  3588. <tr>
  3589. <td class="bold">Format</td>
  3590. <td>entity.getType(entity)</td>
  3591. </tr>
  3592. </table>
  3593. <table>
  3594. <tr>
  3595. <th class="command">Xentity.setName</th>
  3596. <th class="desc">sets the name of an entity, true for an always visible name</th>
  3597. </tr>
  3598. <tr>
  3599. <td class="bold">Format</td>
  3600. <td>entity.setName(entity, name, nameVisibility|false)</td>
  3601. </tr>
  3602. </table>
  3603. <table>
  3604. <tr>
  3605. <th class="command">Xentity.getName</th>
  3606. <th class="desc">returns the name of an entity</th>
  3607. </tr>
  3608. <tr>
  3609. <td class="bold">Format</td>
  3610. <td>entity.getName(entity)</td>
  3611. </tr>
  3612. </table>
  3613. <table>
  3614. <tr>
  3615. <th class="command">Xentity.getLocation</th>
  3616. <th class="desc">returns the location of an entity</th>
  3617. </tr>
  3618. <tr>
  3619. <td class="bold">Format</td>
  3620. <td>entity.getLocation(entity / player)</td>
  3621. </tr>
  3622. </table>
  3623. <table>
  3624. <tr>
  3625. <th class="command">Xentity.teleport</th>
  3626. <th class="desc">teleports an entity</th>
  3627. </tr>
  3628. <tr>
  3629. <td class="bold">Format</td>
  3630. <td>entity.teleport(entity / player, location)</td>
  3631. </tr>
  3632. </table>
  3633. <table>
  3634. <tr>
  3635. <th class="command">Xentity.setInvulnerable</th>
  3636. <th class="desc">sets an entity (in)vulverable</th>
  3637. </tr>
  3638. <tr>
  3639. <td class="bold">Format</td>
  3640. <td>entity.setInvulnerable(entity / player, boolean)</td>
  3641. </tr>
  3642. </table>
  3643. <table>
  3644. <tr>
  3645. <th class="command">Xentity.throw</th>
  3646. <th class="desc">throws an entity in relative direction to the entity</th>
  3647. </tr>
  3648. <tr>
  3649. <td class="bold">Format</td>
  3650. <td>entity.throw(entity / player, x, y, z)</td>
  3651. </tr>
  3652. <tr>
  3653. <td class="bold">Info</td>
  3654. <td>x/y/z is claimed in the interval from -3.9 to 3.9 by minecraft</td>
  3655. </tr>
  3656. </table>
  3657. <table>
  3658. <tr>
  3659. <th class="command">Xentity.setInvisible</th>
  3660. <th class="desc">sets an entity (in)visible</th>
  3661. </tr>
  3662. <tr>
  3663. <td class="bold">Format</td>
  3664. <td>entity.setInvisible(entity / player, boolean)</td>
  3665. </tr>
  3666. </table>
  3667. <table>
  3668. <tr>
  3669. <th class="command">Xentity.clearEffects</th>
  3670. <th class="desc">remove all effects from an entity</th>
  3671. </tr>
  3672. <tr>
  3673. <td class="bold">Format</td>
  3674. <td>entity.clearEffects(entity)</td>
  3675. </tr>
  3676. </table>
  3677. <table>
  3678. <tr>
  3679. <th class="command">Xentity.remove</th>
  3680. <th class="desc">removes an entity</th>
  3681. </tr>
  3682. <tr>
  3683. <td class="bold">Format</td>
  3684. <td>entity.remove(entity)</td>
  3685. </tr>
  3686. </table>
  3687. <table>
  3688. <tr>
  3689. <th class="command">Xentity.removeAll</th>
  3690. <th class="desc">remove specific entities from an area</th>
  3691. </tr>
  3692. <tr>
  3693. <td class="bold">Format</td>
  3694. <td>entity.removeAll(entity_class, location, radius)</td>
  3695. </tr>
  3696. <tr>
  3697. <td class="bold">Info</td>
  3698. <td>not all entity_classes are allowed (filtered and blocked)</td>
  3699. </tr>
  3700. <tr>
  3701. <td class="bold">Examples</td>
  3702. <td>entity.removeAll("net.minecraft.entity.passive.CowEntity", location, radius)</td>
  3703. </tr>
  3704. </table>
  3705. <table>
  3706. <tr>
  3707. <th class="command">Xentity.setSilent</th>
  3708. <th class="desc">true sets an entity silent</th>
  3709. </tr>
  3710. <tr>
  3711. <td class="bold">Format</td>
  3712. <td>entity.setSilent(entity, boolean)</td>
  3713. </tr>
  3714. </table>
  3715. <table>
  3716. <tr>
  3717. <th class="command">Xentity.mount</th>
  3718. <th class="desc">let an entity ride another entity (for any living entities)</th>
  3719. </tr>
  3720. <tr>
  3721. <td class="bold">Format</td>
  3722. <td>entity.mount(entity, horse_entity)</td>
  3723. </tr>
  3724. </table>
  3725. <table>
  3726. <tr>
  3727. <th class="command">Xentity.unmount</th>
  3728. <th class="desc">unmounts the rider</th>
  3729. </tr>
  3730. <tr>
  3731. <td class="bold">Format</td>
  3732. <td>entity.unmount(entity)</td>
  3733. </tr>
  3734. </table>
  3735. <table>
  3736. <tr>
  3737. <th class="command">Xentity.isWet</th>
  3738. <th class="desc">returns true if an entity is wet</th>
  3739. </tr>
  3740. <tr>
  3741. <td class="bold">Format</td>
  3742. <td>entity.isWet(entity)</td>
  3743. </tr>
  3744. </table>
  3745. <table>
  3746. <tr>
  3747. <th class="command">Xentity.isBurning</th>
  3748. <th class="desc">returns true if an entity burns</th>
  3749. </tr>
  3750. <tr>
  3751. <td class="bold">Format</td>
  3752. <td>entity.isBurning(entity)</td>
  3753. </tr>
  3754. </table>
  3755. <table>
  3756. <tr>
  3757. <th class="command">Xentity.setBurning</th>
  3758. <th class="desc">sets an entity on fire</th>
  3759. </tr>
  3760. <tr>
  3761. <td class="bold">Format</td>
  3762. <td>entity.setBurning(entity, seconds)</td>
  3763. </tr>
  3764. <tr>
  3765. <td class="bold">Info</td>
  3766. <td>0 seconds extinguish the entity</td>
  3767. </tr>
  3768. </table>
  3769. <table>
  3770. <tr>
  3771. <th class="command">Xentity.setNoPickup</th>
  3772. <th class="desc">this arrow-entity cannot be picked up</th>
  3773. </tr>
  3774. <tr>
  3775. <td class="bold">Format</td>
  3776. <td>entity.setNoPickup(arrow-entity)</td>
  3777. </tr>
  3778. </table>
  3779. <table>
  3780. <tr>
  3781. <th class="command">Xentity.get</th>
  3782. <th class="desc">returns the next entity to a location</th>
  3783. </tr>
  3784. <tr>
  3785. <td class="bold">Format</td>
  3786. <td>entity.get(location, radius, entity_class)</td>
  3787. </tr>
  3788. <tr>
  3789. <td class="bold">Examples</td>
  3790. <td>entity.get(location, radius, "net.minecraft.entity.passive.CowEntity")</td>
  3791. </tr>
  3792. </table>
  3793. <table>
  3794. <tr>
  3795. <th class="command">Xentity.getItemFromFrame</th>
  3796. <th class="desc">returns the itemstack of an itemframe</th>
  3797. </tr>
  3798. <tr>
  3799. <td class="bold">Format</td>
  3800. <td>entity.getItemFromFrame(itemframe-entity)</td>
  3801. </tr>
  3802. </table>
  3803. <table>
  3804. <tr>
  3805. <th class="command">Xentity.spawnItemFrame</th>
  3806. <th class="desc">sets an itemframe with an itemstack</th>
  3807. </tr>
  3808. <tr>
  3809. <td class="bold">Format</td>
  3810. <td>entity.spawnItemFrame(location, direction, itemstack)</td>
  3811. </tr>
  3812. <tr>
  3813. <td class="bold">Arguments</td>
  3814. <td>direction "north" / "east" / "south" / "west"</td>
  3815. </tr>
  3816. </table>
  3817. <table>
  3818. <tr>
  3819. <th class="command">Xentity.spawn</th>
  3820. <th class="desc">spawns an entity and returns the entity</th>
  3821. </tr>
  3822. <tr>
  3823. <td class="bold">Format</td>
  3824. <td>entity.spawn(type, location, [daten])</td>
  3825. </tr>
  3826. </table>
  3827. <table>
  3828. <tr>
  3829. <th class="command">Xentity.getEnchantmentModifier</th>
  3830. <th class="desc">returns the summarized enchantment modificator of the armor for the damagesource</th>
  3831. </tr>
  3832. <tr>
  3833. <td class="bold">Format</td>
  3834. <td>entity.getEnchantmentModifier(entity, damagesource)</td>
  3835. </tr>
  3836. </table>
  3837. <table>
  3838. <tr>
  3839. <th class="command">Xentity.setGravity</th>
  3840. <th class="desc">toggles the gravity of an entity</th>
  3841. </tr>
  3842. <tr>
  3843. <td class="bold">Format</td>
  3844. <td>entity.setGravity(entity, boolean)</td>
  3845. </tr>
  3846. <table>
  3847. <tr>
  3848. <th class="command">Xentity.setPickupDelay</th>
  3849. <th class="desc">unknown</th>
  3850. </tr>
  3851. <tr>
  3852. <td class="bold">Format</td>
  3853. <td>entity.setPickupDelay(item-entity, ticks)</td>
  3854. </tr>
  3855. </table>
  3856. <table>
  3857. <tr>
  3858. <th class="command">Xentity.setGrowingAge</th>
  3859. <th class="desc">sets the growing age of an entity</th>
  3860. </tr>
  3861. <tr>
  3862. <td class="bold">Format</td>
  3863. <td>entity.setGrowingAge(entity, age_int)</td>
  3864. </tr>
  3865. </table>
  3866. <table>
  3867. <tr>
  3868. <th class="command">Xentity.getEffectAmplifier</th>
  3869. <th class="desc">returns the amplifier (effect level), 0 if not existing</th>
  3870. </tr>
  3871. <tr>
  3872. <td class="bold">Format</td>
  3873. <td>entity.hasEffect(entity / player, effect)</td>
  3874. </tr>
  3875. <tr>
  3876. <td class="bold">Arguments</td>
  3877. <td>String <a href="https://minecraft-de.gamepedia.com/Statuseffekt" target="_blank">effect</a></td>
  3878. </tr>
  3879. </table>
  3880. <table>
  3881. <tr>
  3882. <th class="command">Xentity.addEffect</th>
  3883. <th class="desc">adds an effect to an entity</th>
  3884. </tr>
  3885. <tr>
  3886. <td class="bold">Format</td>
  3887. <td>entity.addEffect(entity / player, effect, ticks, amplifier, [particle|true])</td>
  3888. </tr>
  3889. <tr>
  3890. <td class="bold">Arguments</td>
  3891. <td>String <a href="https://minecraft-de.gamepedia.com/Statuseffekt" target="_blank">effect</a> / number ticks (infinite: 32760) / number amplifier (1 means potion-level 1)</td>
  3892. </tr>
  3893. </table>
  3894. <table>
  3895. <tr>
  3896. <th class="command">Xentity.getPotionType</th>
  3897. <th class="desc">returns the type of a potion</th>
  3898. </tr>
  3899. <tr>
  3900. <td class="bold">Format</td>
  3901. <td>entity.getPotionType(potion-entity)</td>
  3902. </tr>
  3903. </table>
  3904. <table>
  3905. <tr>
  3906. <th class="command">Xentity.near</th>
  3907. <th class="desc">returns a list with all entities within a location / a radius of an entity</th>
  3908. </tr>
  3909. <tr>
  3910. <td class="bold">Format</td>
  3911. <td>entity.near(location / entity, radius)</td>
  3912. </tr>
  3913. </table>
  3914. <table>
  3915. <tr>
  3916. <th class="command">Xentity.getLook</th>
  3917. <th class="desc">returns an array with vectors</th>
  3918. </tr>
  3919. <tr>
  3920. <td class="bold">Format</td>
  3921. <td>entity.getLook(entity / player)</td>
  3922. </tr>
  3923. <tr>
  3924. <td class="bold">Examples</td>
  3925. <td>array[0] = x<br>array[1] = y<br>array[2] = z</td>
  3926. </tr>
  3927. </table>
  3928. <table>
  3929. <tr>
  3930. <th class="command">Xentity.getMotion</th>
  3931. <th class="desc">returns an array with vectors</th>
  3932. </tr>
  3933. <tr>
  3934. <td class="bold">Format</td>
  3935. <td>entity.getMotion(entity)</td>
  3936. </tr>
  3937. </table>
  3938. <table>
  3939. <tr>
  3940. <th class="command">Xentity.addTag</th>
  3941. <th class="desc">adds a tag to an entity</th>
  3942. </tr>
  3943. <tr>
  3944. <td class="bold">Format</td>
  3945. <td>entity.addTag(entity, tag as string)</td>
  3946. </tr>
  3947. </table>
  3948. <table>
  3949. <tr>
  3950. <th class="command">Xentity.removeTag</th>
  3951. <th class="desc">removes a tag from an entity</th>
  3952. </tr>
  3953. <tr>
  3954. <td class="bold">Format</td>
  3955. <td>entity.removeTag(entity, tag as string)</td>
  3956. </tr>
  3957. </table>
  3958. <table>
  3959. <tr>
  3960. <th class="command">Xentity.clearTag</th>
  3961. <th class="desc">removes all tags from an entity</th>
  3962. </tr>
  3963. <tr>
  3964. <td class="bold">Format</td>
  3965. <td>entity.clearTag(entity)</td>
  3966. </tr>
  3967. </table>
  3968. <table>
  3969. <tr>
  3970. <th class="command">Xentity.hasTag</th>
  3971. <th class="desc">returns true if an entity has a tag</th>
  3972. </tr>
  3973. <tr>
  3974. <td class="bold">Format</td>
  3975. <td>entity.hasTag(entity, tag as string)</td>
  3976. </tr>
  3977. <tr>
  3978. <td class="bold">Info</td>
  3979. <td>default entity-tags: no_tick, mod_spawned</td>
  3980. </tr>
  3981. </table>
  3982. <table>
  3983. <tr>
  3984. <th class="command">entity.frame.hide</th>
  3985. <th class="desc">hides an item frame</th>
  3986. </tr>
  3987. <tr>
  3988. <td class="bold">Format</td>
  3989. <td>entity.frame.hide(entity_frame)</td>
  3990. </tr>
  3991. </table>
  3992. <table>
  3993. <tr>
  3994. <th class="command">entity.frame.show</th>
  3995. <th class="desc">shows an item frame</th>
  3996. </tr>
  3997. <tr>
  3998. <td class="bold">Format</td>
  3999. <td>entity.frame.show(entity_frame)</td>
  4000. </tr>
  4001. </table>
  4002. <table>
  4003. <tr>
  4004. <th class="command">entity.frame.setFixed</th>
  4005. <th class="desc">sets the fix tag for an item frame</th>
  4006. </tr>
  4007. <tr>
  4008. <td class="bold">Format</td>
  4009. <td>entity.frame.setFixed(entity_frame, boolean)</td>
  4010. </tr>
  4011. </table>
  4012. <table>
  4013. <tr>
  4014. <th class="command">Xcreeper.explode</th>
  4015. <th class="desc">let a creeper explode</th>
  4016. </tr>
  4017. <tr>
  4018. <td class="bold">Format</td>
  4019. <td>creeper.explode(entity)</td>
  4020. </tr>
  4021. </table>
  4022. <table>
  4023. <tr>
  4024. <th class="command">Xsheep.isSheared</th>
  4025. <th class="desc">returns true if a sheep is sheared</th>
  4026. </tr>
  4027. <tr>
  4028. <td class="bold">Format</td>
  4029. <td>sheep.isSheared(entity)</td>
  4030. </tr>
  4031. </table>
  4032. <table>
  4033. <tr>
  4034. <th class="command">Xsheep.getColor(entity)</th>
  4035. <th class="desc">returns the color of a sheep</th>
  4036. </tr>
  4037. <tr>
  4038. <td class="bold">Format</td>
  4039. <td>sheep.getColor(entity)</td>
  4040. </tr>
  4041. </table>
  4042. <table>
  4043. <tr>
  4044. <th class="command">Xpet.isTamed</th>
  4045. <th class="desc">returns true if a pet is tamed</th>
  4046. </tr>
  4047. <tr>
  4048. <td class="bold">Format</td>
  4049. <td>pet.isTamed(tamable_entity)</td>
  4050. </tr>
  4051. </table>
  4052. <table>
  4053. <tr>
  4054. <th class="command">Xpet.setTamed</th>
  4055. <th class="desc">set tame state for a tamable entity</th>
  4056. </tr>
  4057. <tr>
  4058. <td class="bold">Format</td>
  4059. <td>
  4060. pet.setTamed(tamable_entity, boolean, [owner])
  4061. </td>
  4062. </tr>
  4063. <tr>
  4064. <td class="bold">Example</td>
  4065. <td>
  4066. pet.setTamed(horse, true)<br>
  4067. pet.setTamed(horse, false)<br>
  4068. pet.setTamed(horse, true, owner)<br>
  4069. pet.setTamed(horse, false, owner)<br>
  4070. </td>
  4071. </tr>
  4072. </table>
  4073. <table>
  4074. <tr>
  4075. <th class="command">Xpet.getOwner</th>
  4076. <th class="desc">returns the owner's uuid from an pet</th>
  4077. </tr>
  4078. <tr>
  4079. <td class="bold">Format</td>
  4080. <td>pet.getOwner(tamable_entity)</td>
  4081. </tr>
  4082. </table>
  4083. </section>
  4084. <section id="Living">
  4085. <table>
  4086. <tr>
  4087. <th class="command">Xliving.setHealth</th>
  4088. <th class="desc">sets the health points for a living entity</th>
  4089. </tr>
  4090. <tr>
  4091. <td class="bold">Format</td>
  4092. <td>living.setHealth(living_entity, amount)</td>
  4093. </tr>
  4094. </table>
  4095. <table>
  4096. <tr>
  4097. <th class="command">Xliving.getHealth</th>
  4098. <th class="desc">returns the health points from a living entity</th>
  4099. </tr>
  4100. <tr>
  4101. <td class="bold">Format</td>
  4102. <td>living.getHealth(living_entity)</td>
  4103. </tr>
  4104. </table>
  4105. <table>
  4106. <tr>
  4107. <th class="command">Xliving.damage</th>
  4108. <th class="desc">damages a living entity</th>
  4109. </tr>
  4110. <tr>
  4111. <td class="bold">Format</td>
  4112. <td>living.damage(living_entity, damage_amount, [damagesource])</td>
  4113. </tr>
  4114. <tr>
  4115. <td class="bold">Info</td>
  4116. <td>triggers events on the next server tick</td>
  4117. </tr>
  4118. </table>
  4119. <table>
  4120. <tr>
  4121. <th class="command">Xliving.heal</th>
  4122. <th class="desc">heals a living entity</th>
  4123. </tr>
  4124. <tr>
  4125. <td class="bold">Format</td>
  4126. <td>living.heal(living_entity, heal_amount)</td>
  4127. </tr>
  4128. <tr>
  4129. <td class="bold">Info</td>
  4130. <td>triggers events on the next server tick</td>
  4131. </tr>
  4132. </table>
  4133. <table>
  4134. <tr>
  4135. <th class="command">Xliving.setEquip</th>
  4136. <th class="desc">set the equipment of a living entity</th>
  4137. </tr>
  4138. <tr>
  4139. <td class="bold">Format</td>
  4140. <td>living.setEquip(living_entity, bodypart, itemstack)</td>
  4141. </tr>
  4142. <tr>
  4143. <td class="bold">Info</td>
  4144. <td>bodypart: "head" / "chest" / "legs" / "feet" / "hand" / "offhand"</td>
  4145. </tr>
  4146. </table>
  4147. <table>
  4148. <tr>
  4149. <th class="command">Xliving.getEquip</th>
  4150. <th class="desc">returns the equipment of a living_entity</th>
  4151. </tr>
  4152. <tr>
  4153. <td class="bold">Format</td>
  4154. <td>living.getEquip(living_entity, bodypart)</td>
  4155. </tr>
  4156. <tr>
  4157. <td class="bold">Arguments</td>
  4158. <td>bodypart: "head" / "chest" / "legs" / "feet" / "hand" / "offhand"</td>
  4159. </tr>
  4160. </table>
  4161. <table>
  4162. <tr>
  4163. <th class="command">Xliving.near</th>
  4164. <th class="desc">returns a list with all living entities within a location / a radius of an entity</th>
  4165. </tr>
  4166. <tr>
  4167. <td class="bold">Format</td>
  4168. <td>living.near(location / entity, radius)</td>
  4169. </tr>
  4170. </table>
  4171. <table>
  4172. <tr>
  4173. <th class="command">Xliving.removeAi</th>
  4174. <th class="desc">removes the AI of an entity</th>
  4175. </tr>
  4176. <tr>
  4177. <td class="bold">Format</td>
  4178. <td>living.removeAi(living_entity)</td>
  4179. </tr>
  4180. </table>
  4181. <table>
  4182. <tr>
  4183. <th class="command">X</th>
  4184. <th class="desc">commands for living properties</th>
  4185. </tr>
  4186. <tr>
  4187. <td class="bold">Format</td>
  4188. <td>
  4189. living.get...(living_entity)<br>
  4190. living.getBase...(living_entity)<br>
  4191. living.set..(living_entity, value)<br>
  4192. living.setPersistent...(living_entity, value)
  4193. </td>
  4194. </tr>
  4195. <tr>
  4196. <td class="bold">Properties</td>
  4197. <td>
  4198. ...maxHealth<br>
  4199. ...AttackKnockback<br>
  4200. ...AttackDamage<br>
  4201. ...AttackSpeed<br>
  4202. ...FollowRange<br>
  4203. ...Luck<br>
  4204. ...Armor<br>
  4205. ...ArmorThoughness<br>
  4206. ...MovementSpeed<br>
  4207. ...FlyingSpeed<br>
  4208. ...KnockbackResistance
  4209. </td>
  4210. </tr>
  4211. </table>
  4212. <table>
  4213. <tr>
  4214. <th class="command">Xliving.shootProjectile</th>
  4215. <th class="desc">returns the shooten entity. A projectile is shooten into viewing direction of the player</th>
  4216. </tr>
  4217. <tr>
  4218. <td class="bold">Format</td>
  4219. <td>living.shootProjectile(living_entity, String entity_class, Number power, [data])</td>
  4220. </tr>
  4221. <tr>
  4222. <td class="bold">Arguments</td>
  4223. <td>
  4224. data: always null, except for arrows and potions use itemstacks<br>
  4225. <br>
  4226. entity_classes:<br>
  4227. <br>
  4228. me.km.entities.EntityItemProjectile<br>
  4229. net.minecraft.entity.projectile.SnowballEntity<br>
  4230. net.minecraft.entity.projectile.EggEntity<br>
  4231. net.minecraft.entity.item.EnderPearlEntity<br>
  4232. net.minecraft.entity.projectile.PotionEntity<br>
  4233. net.minecraft.entity.item.ExpBottleEntity<br>
  4234. net.minecraft.entity.projectile.ArrowEntity<br>
  4235. net.minecraft.entity.projectile.TippedArrowEntity<br>
  4236. net.minecraft.entity.projectile.SpectralArrowEntity<br>
  4237. net.minecraft.entity.projectile.ArrowEntity<br>
  4238. net.minecraft.entity.projectile.SmallFireballEntity<br>
  4239. net.minecraft.entity.projectile.WitherSkullEntity<br>
  4240. net.minecraft.entity.projectile.DragonFireballEntity<br>
  4241. net.minecraft.entity.projectile.FireballEntity
  4242. </td>
  4243. </tr>
  4244. </table>
  4245. <table>
  4246. <tr>
  4247. <th class="command">Xliving.isBlocking</th>
  4248. <th class="desc">returns true if an entity is blocking (e.g. activated shield)</th>
  4249. </tr>
  4250. <tr>
  4251. <td class="bold">Format</td>
  4252. <td>living.isBlocking(entity)</td>
  4253. </tr>
  4254. </table>
  4255. </section>
  4256. <section id="Particle">
  4257. <table>
  4258. <tr>
  4259. <th class="command">particle.get</th>
  4260. <th class="desc">returns a particle</th>
  4261. </tr>
  4262. <tr>
  4263. <td class="bold">Format</td>
  4264. <td>particle.get(<a href="https://papermc.io/javadocs/paper/1.18/org/bukkit/Particle.html" target="_blank">name</a>)</td>
  4265. </tr>
  4266. </table>
  4267. <table>
  4268. <tr>
  4269. <th class="command">particle.getAll</th>
  4270. <th class="desc">returns an array of all particles</th>
  4271. </tr>
  4272. <tr>
  4273. <td class="bold">Format</td>
  4274. <td>particle.getAll()</td>
  4275. </tr>
  4276. </table>
  4277. <table>
  4278. <tr>
  4279. <th class="command">particle.spawn</th>
  4280. <th class="desc">spawns a particle</th>
  4281. </tr>
  4282. <tr>
  4283. <td class="bold">Format</td>
  4284. <td>particle.spawn(location, particle, [count | 1], [speed | 0.0], [offX | 0.0], [offY | 0.0], [offZ | 0.0])</td>
  4285. </tr>
  4286. </table>
  4287. <table>
  4288. <tr>
  4289. <th class="command">particle.spawnPlayer</th>
  4290. <th class="desc">spawns a particle</th>
  4291. </tr>
  4292. <tr>
  4293. <td class="bold">Format</td>
  4294. <td>particle.spawnPlayer(location, particle, player, [count | 1], [speed | 0.0], [offX | 0.0], [offY | 0.0], [offZ | 0.0])</td>
  4295. </tr>
  4296. </table>
  4297. </section>
  4298. <section id="Sound">
  4299. <table>
  4300. <tr>
  4301. <th class="command">sound.get</th>
  4302. <th class="desc">returns a sound</th>
  4303. </tr>
  4304. <tr>
  4305. <td class="bold">Format</td>
  4306. <td>sound.get(<a href="https://papermc.io/javadocs/paper/1.18/org/bukkit/Sound.html" target="_blank">name</a>)</td>
  4307. </tr>
  4308. </table>
  4309. <table>
  4310. <tr>
  4311. <th class="command">sound.getCategory</th>
  4312. <th class="desc">returns a sound category</th>
  4313. </tr>
  4314. <tr>
  4315. <td class="bold">Format</td>
  4316. <td>sound.getCategory(<a href="https://papermc.io/javadocs/paper/1.18/org/bukkit/SoundCategory.html" target="_blank">name</a>)</td>
  4317. </tr>
  4318. </table>
  4319. <table>
  4320. <tr>
  4321. <th class="command">sound.spawn</th>
  4322. <th class="desc">plays a sound</th>
  4323. </tr>
  4324. <tr>
  4325. <td class="bold">Format</td>
  4326. <td>sound.spawn(location, sound, sound_category, [volume | 1.0], [pitch | random from 0.9 to 1.0])</td>
  4327. </tr>
  4328. </table>
  4329. <table>
  4330. <tr>
  4331. <th class="command">sound.spawnForPlayer</th>
  4332. <th class="desc">plays a sound for a player</th>
  4333. </tr>
  4334. <tr>
  4335. <td class="bold">Format</td>
  4336. <td>sound.spawnForPlayer(player, sound, sound_category, [volume | 1.0], [pitch | random from 0.9 to 1.0])</td>
  4337. </tr>
  4338. </table>
  4339. </section>
  4340. <section id="Human">
  4341. <table>
  4342. <tr>
  4343. <th class="command">human.spawn</th>
  4344. <th class="desc">returns the spawned human</th>
  4345. </tr>
  4346. <tr>
  4347. <td class="bold">Format</td>
  4348. <td>human.spawn(location, name)</td>
  4349. </tr>
  4350. </table>
  4351. <table>
  4352. <tr>
  4353. <th class="command">human.setSkin</th>
  4354. <th class="desc">sets the skin of a human</th>
  4355. </tr>
  4356. <tr>
  4357. <td class="bold">Format</td>
  4358. <td>human.setSkin(human, <a href="https://mineskin.org/gallery" target="_blank">texture_value</a>, <a href="https://mineskin.org/gallery" target="_blank">texture_signature</a>)</td>
  4359. </tr>
  4360. </table>
  4361. <table>
  4362. <tr>
  4363. <th class="command">human.setName</th>
  4364. <th class="desc">sets the name of a human</th>
  4365. </tr>
  4366. <tr>
  4367. <td class="bold">Format</td>
  4368. <td>human.setName(human, name)</td>
  4369. </tr>
  4370. </table>
  4371. </section>
  4372. <section id="Damage">
  4373. <table>
  4374. <tr>
  4375. <th class="command">damage.get</th>
  4376. <th class="desc">returns a damage_source</th>
  4377. </tr>
  4378. <tr>
  4379. <td class="bold">Format</td>
  4380. <td>damage.get(damage_name)</td>
  4381. </tr>
  4382. <tr>
  4383. <td class="bold">Arguments</td>
  4384. <td>
  4385. damage_name:
  4386. inFire, lightningBolt, onFire, lava, hotFloor, inWall, cramming, drown, starve, cactus, fall, flyIntoWall, outOfWorld, generic, magic, wither, anvil, fallingBlock, dragonBreath, dryout, sweetBerryBush, freeze, fallingStalactite, stalagmite
  4387. </td>
  4388. </tr>
  4389. </table>
  4390. <table>
  4391. <tr>
  4392. <th class="command">damage.getType</th>
  4393. <th class="desc">returns the type of a damage_source as string</th>
  4394. </tr>
  4395. <tr>
  4396. <td class="bold">Format</td>
  4397. <td>damage.getType(damage_source)</td>
  4398. </tr>
  4399. </table>
  4400. <table>
  4401. <tr>
  4402. <th class="command">damage.getImmediateSource</th>
  4403. <th class="desc">returns the direct damager entity of a damage_source</th>
  4404. </tr>
  4405. <tr>
  4406. <td class="bold">Format</td>
  4407. <td>damage.getImmediateSource(damage_source)</td>
  4408. </tr>
  4409. </table>
  4410. <table>
  4411. <tr>
  4412. <th class="command">damage.getTrueSource</th>
  4413. <th class="desc">returns the indirect damager entity of a damage_source</th>
  4414. </tr>
  4415. <tr>
  4416. <td class="bold">Format</td>
  4417. <td>damage.getTrueSource(damage_source)</td>
  4418. </tr>
  4419. </table>
  4420. <table>
  4421. <tr>
  4422. <th class="command">damage.isCreativePlayer</th>
  4423. <th class="desc">returns true if the damage_source can damage an creative player</th>
  4424. </tr>
  4425. <tr>
  4426. <td class="bold">Format</td>
  4427. <td>damage.isCreativePlayer(damage_source)</td>
  4428. </tr>
  4429. </table>
  4430. <table>
  4431. <tr>
  4432. <th class="command">damage.isAbsolute</th>
  4433. <th class="desc">returns true if the damage ignores modifications by potion effects or enchantments</th>
  4434. </tr>
  4435. <tr>
  4436. <td class="bold">Format</td>
  4437. <td>damage.isAbsolute(damage_source)</td>
  4438. </tr>
  4439. </table>
  4440. <table>
  4441. <tr>
  4442. <th class="command">damage.isDifficultyscaled</th>
  4443. <th class="desc">returns true if the damage_source will have its damageamount scaled based on the current difficulty</th>
  4444. </tr>
  4445. <tr>
  4446. <td class="bold">Format</td>
  4447. <td>damage.isDifficultyscaled(damage_source)</td>
  4448. </tr>
  4449. </table>
  4450. <table>
  4451. <tr>
  4452. <th class="command">damage.isExplosion</th>
  4453. <th class="desc">returns true if the damage is explosion based</th>
  4454. </tr>
  4455. <tr>
  4456. <td class="bold">Format</td>
  4457. <td>damage.isExplosion(damage_source)</td>
  4458. </tr>
  4459. </table>
  4460. <table>
  4461. <tr>
  4462. <th class="command">damage.isFire</th>
  4463. <th class="desc">returns true if the damage is fire based</th>
  4464. </tr>
  4465. <tr>
  4466. <td class="bold">Format</td>
  4467. <td>damage.isFire(damage_source)</td>
  4468. </tr>
  4469. </table>
  4470. <table>
  4471. <tr>
  4472. <th class="command">damage.isMagic</th>
  4473. <th class="desc">returns true if the damage is magic based</th>
  4474. </tr>
  4475. <tr>
  4476. <td class="bold">Format</td>
  4477. <td>damage.isMagic(damage_source)</td>
  4478. </tr>
  4479. </table>
  4480. <table>
  4481. <tr>
  4482. <th class="command">damage.isProjectile</th>
  4483. <th class="desc">returns true if the damage is projectile based</th>
  4484. </tr>
  4485. <tr>
  4486. <td class="bold">Format</td>
  4487. <td>damage.isProjectile(damage_source)</td>
  4488. </tr>
  4489. </table>
  4490. <table>
  4491. <tr>
  4492. <th class="command">damage.isUnblockable</th>
  4493. <th class="desc">returns true if the damage cannot be blocked by armor</th>
  4494. </tr>
  4495. <tr>
  4496. <td class="bold">Format</td>
  4497. <td>damage.isUnblockable(damage_source)</td>
  4498. </tr>
  4499. </table>
  4500. <table>
  4501. <tr>
  4502. <th class="command">damage.isFall</th>
  4503. <th class="desc">returns true if the damage is fall based</th>
  4504. </tr>
  4505. <tr>
  4506. <td class="bold">Format</td>
  4507. <td>damage.isFall(damage_source)</td>
  4508. </tr>
  4509. </table>
  4510. <table>
  4511. <tr>
  4512. <th class="command">damage.isDamagingHelmet</th>
  4513. <th class="desc">returns true if the damage is damaging helmet based</th>
  4514. </tr>
  4515. <tr>
  4516. <td class="bold">Format</td>
  4517. <td>damage.isDamagingHelmet(damage_source)</td>
  4518. </tr>
  4519. </table>
  4520. <table>
  4521. <tr>
  4522. <th class="command">damage.isSweep</th>
  4523. <th class="desc">returns true if the damage is sweep based</th>
  4524. </tr>
  4525. <tr>
  4526. <td class="bold">Format</td>
  4527. <td>damage.isSweep(damage_source)</td>
  4528. </tr>
  4529. </table>
  4530. <table>
  4531. <tr>
  4532. <th class="command">damage.sting</th>
  4533. <th class="desc">returns a sting damage_source</th>
  4534. </tr>
  4535. <tr>
  4536. <td class="bold">Format</td>
  4537. <td>damage.sting(living_entity)</td>
  4538. </tr>
  4539. </table>
  4540. <table>
  4541. <tr>
  4542. <th class="command">damage.mobAttack</th>
  4543. <th class="desc">returns a mob attack damage_source</th>
  4544. </tr>
  4545. <tr>
  4546. <td class="bold">Format</td>
  4547. <td>damage.mobAttack(living_entity)</td>
  4548. </tr>
  4549. </table>
  4550. <table>
  4551. <tr>
  4552. <th class="command">damage.indirect</th>
  4553. <th class="desc">returns a indirect damage_source</th>
  4554. </tr>
  4555. <tr>
  4556. <td class="bold">Format</td>
  4557. <td>damage.indirect(entity, living_entity)</td>
  4558. </tr>
  4559. </table>
  4560. <table>
  4561. <tr>
  4562. <th class="command">damage.playerAttack</th>
  4563. <th class="desc">returns a player attack damage_source</th>
  4564. </tr>
  4565. <tr>
  4566. <td class="bold">Format</td>
  4567. <td>damage.playerAttack(player)</td>
  4568. </tr>
  4569. </table>
  4570. <table>
  4571. <tr>
  4572. <th class="command">damage.arrow</th>
  4573. <th class="desc">returns a arrow damage_source</th>
  4574. </tr>
  4575. <tr>
  4576. <td class="bold">Format</td>
  4577. <td>damage.arrow(arrow, entity)</td>
  4578. </tr>
  4579. </table>
  4580. <table>
  4581. <tr>
  4582. <th class="command">damage.trident</th>
  4583. <th class="desc">returns a trident damage_source</th>
  4584. </tr>
  4585. <tr>
  4586. <td class="bold">Format</td>
  4587. <td>damage.trident(entity1, entity2)</td>
  4588. </tr>
  4589. </table>
  4590. <table>
  4591. <tr>
  4592. <th class="command">damage.firework</th>
  4593. <th class="desc">returns a firework damage_source</th>
  4594. </tr>
  4595. <tr>
  4596. <td class="bold">Format</td>
  4597. <td>damage.firework(firework, entity)</td>
  4598. </tr>
  4599. </table>
  4600. <table>
  4601. <tr>
  4602. <th class="command">damage.fireball</th>
  4603. <th class="desc">returns a fireball damage_source</th>
  4604. </tr>
  4605. <tr>
  4606. <td class="bold">Format</td>
  4607. <td>damage.fireball(large_fireball, entity)</td>
  4608. </tr>
  4609. </table>
  4610. <table>
  4611. <tr>
  4612. <th class="command">damage.witherSkull</th>
  4613. <th class="desc">returns a wither skull damage_source</th>
  4614. </tr>
  4615. <tr>
  4616. <td class="bold">Format</td>
  4617. <td>damage.witherSkull(wither_skull, entity)</td>
  4618. </tr>
  4619. </table>
  4620. <table>
  4621. <tr>
  4622. <th class="command">damage.projectile</th>
  4623. <th class="desc">returns a projectile damage_source</th>
  4624. </tr>
  4625. <tr>
  4626. <td class="bold">Format</td>
  4627. <td>damage.projectile(entity1, entity2)</td>
  4628. </tr>
  4629. </table>
  4630. <table>
  4631. <tr>
  4632. <th class="command">damage.indirectMagic</th>
  4633. <th class="desc">returns a indirect magic damage_source</th>
  4634. </tr>
  4635. <tr>
  4636. <td class="bold">Format</td>
  4637. <td>damage.indirectMagic(entity1, entity2)</td>
  4638. </tr>
  4639. </table>
  4640. <table>
  4641. <tr>
  4642. <th class="command">damage.thorns</th>
  4643. <th class="desc">returns a thorns damage_source</th>
  4644. </tr>
  4645. <tr>
  4646. <td class="bold">Format</td>
  4647. <td>damage.thorns(entity)</td>
  4648. </tr>
  4649. </table>
  4650. <table>
  4651. <tr>
  4652. <th class="command">damage.explosion</th>
  4653. <th class="desc">returns a explosion damage_source</th>
  4654. </tr>
  4655. <tr>
  4656. <td class="bold">Format</td>
  4657. <td>damage.explosion(living_entity)</td>
  4658. </tr>
  4659. </table>
  4660. <table>
  4661. <tr>
  4662. <th class="command">damage.explosionBed</th>
  4663. <th class="desc">returns a explosion bed damage_source</th>
  4664. </tr>
  4665. <tr>
  4666. <td class="bold">Format</td>
  4667. <td>damage.explosionBed()</td>
  4668. </tr>
  4669. </table>
  4670. </section>
  4671. <section id="Data">
  4672. <table>
  4673. <tr>
  4674. <th class="command">data.set</th>
  4675. <th class="desc">sets data for a player (script-across)</th>
  4676. </tr>
  4677. <tr>
  4678. <td class="bold">Format</td>
  4679. <td>data.set(player, key, value)</td>
  4680. </tr>
  4681. </table>
  4682. <table>
  4683. <tr>
  4684. <th class="command">data.get</th>
  4685. <th class="desc">returns data from a player (script-across)</th>
  4686. </tr>
  4687. <tr>
  4688. <td class="bold">Format</td>
  4689. <td>data.get(player, key)</td>
  4690. </tr>
  4691. </table>
  4692. <table>
  4693. <tr>
  4694. <th class="command">data.setTimer</th>
  4695. <th class="desc">sets timed data for a player (script-across)</th>
  4696. </tr>
  4697. <tr>
  4698. <td class="bold">Format</td>
  4699. <td>data.setTimer(player, key, ticks)</td>
  4700. </tr>
  4701. <tr>
  4702. <td class="bold">Arguments</td>
  4703. <td>set ticks to -1 to delete the timer<br>when the timer expires the event player_data_tick is thrown</td>
  4704. </tr>
  4705. </table>
  4706. <table>
  4707. <tr>
  4708. <th class="command">data.getTimer</th>
  4709. <th class="desc">returns the remaining ticks of timed data (script-across)</th>
  4710. </tr>
  4711. <tr>
  4712. <td class="bold">Format</td>
  4713. <td>data.getTimer(player, key)</td>
  4714. </tr>
  4715. </table>
  4716. <table>
  4717. <tr>
  4718. <th class="command">data.clear</th>
  4719. <th class="desc">deletes all data from a player (script-across)</th>
  4720. </tr>
  4721. <tr>
  4722. <td class="bold">Format</td>
  4723. <td>data.clear(player)</td>
  4724. </tr>
  4725. </table>
  4726. </section>
  4727. <section id="Shop">
  4728. <table>
  4729. <tr>
  4730. <th class="command">Xshop.new</th>
  4731. <th class="desc">returns a new shop</th>
  4732. </tr>
  4733. <tr>
  4734. <td class="bold">Format</td>
  4735. <td>shop.new()</td>
  4736. </tr>
  4737. </table>
  4738. <table>
  4739. <tr>
  4740. <th class="command">Xshop.addOffer</th>
  4741. <th class="desc">adds an offer to a shop</th>
  4742. </tr>
  4743. <tr>
  4744. <td class="bold">Format</td>
  4745. <td>shop.addOffer(shop, buy_item, sell_item, max_uses)</td>
  4746. </tr>
  4747. </table>
  4748. <table>
  4749. <tr>
  4750. <th class="command">Xshop.addDoubleOffer</th>
  4751. <th class="desc">adds a double offer to a shop</th>
  4752. </tr>
  4753. <tr>
  4754. <td class="bold">Format</td>
  4755. <td>shop.addDoubleOffer(shop, buy_item_1, buy_item_2, sell_item, max_uses)</td>
  4756. </tr>
  4757. </table>
  4758. <table>
  4759. <tr>
  4760. <th class="command">Xshop.open</th>
  4761. <th class="desc">shows a shop to a player</th>
  4762. </tr>
  4763. <tr>
  4764. <td class="bold">Format</td>
  4765. <td>shop.open(shop, player, shop_name)</td>
  4766. </tr>
  4767. </table>
  4768. </section>
  4769. <section id="Boss">
  4770. <table>
  4771. <tr>
  4772. <th class="command">boss.create</th>
  4773. <th class="desc">returns a bossbar</th>
  4774. </tr>
  4775. <tr>
  4776. <td class="bold">Format</td>
  4777. <td>boss.create(title, color, barstyle)</td>
  4778. </tr>
  4779. <tr>
  4780. <td class="bold">Arguments</td>
  4781. <td>
  4782. title as string<br>
  4783. <a href="https://papermc.io/javadocs/paper/1.18/org/bukkit/boss/BarColor.html" target="_blank">color</a> as string<br>
  4784. <a href="https://papermc.io/javadocs/paper/1.18/org/bukkit/boss/BarStyle.html" target="_blank">barstyle</a> as string
  4785. </td>
  4786. </tr>
  4787. </table>
  4788. <table>
  4789. <tr>
  4790. <th class="command">boss.addPlayer</th>
  4791. <th class="desc">add a player to the bossbar</th>
  4792. </tr>
  4793. <tr>
  4794. <td class="bold">Format</td>
  4795. <td>boss.addPlayer(bossbar, player)</td>
  4796. </tr>
  4797. </table>
  4798. <table>
  4799. <tr>
  4800. <th class="command">boss.removePlayer</th>
  4801. <th class="desc">remove a player from the bossbar</th>
  4802. </tr>
  4803. <tr>
  4804. <td class="bold">Format</td>
  4805. <td>boss.removePlayer(bossbar, player)</td>
  4806. </tr>
  4807. </table>
  4808. <table>
  4809. <tr>
  4810. <th class="command">boss.removeAll</th>
  4811. <th class="desc">remove all players from the bossbar</th>
  4812. </tr>
  4813. <tr>
  4814. <td class="bold">Format</td>
  4815. <td>boss.removeAll(bossbar)</td>
  4816. </tr>
  4817. </table>
  4818. <table>
  4819. <tr>
  4820. <th class="command">boss.addFlag</th>
  4821. <th class="desc">adds a flag to the bossbar</th>
  4822. </tr>
  4823. <tr>
  4824. <td class="bold">Format</td>
  4825. <td>boss.addFlag(bossbar, flag)</td>
  4826. </tr>
  4827. <tr>
  4828. <td class="bold">Arguments</td>
  4829. <td><a href="https://papermc.io/javadocs/paper/1.18/org/bukkit/boss/BarFlag.html" target="_blank">flag</a> as string</td>
  4830. </tr>
  4831. </table>
  4832. <table>
  4833. <tr>
  4834. <th class="command">boss.removeFlag</th>
  4835. <th class="desc">removes a flag from the bossbar</th>
  4836. </tr>
  4837. <tr>
  4838. <td class="bold">Format</td>
  4839. <td>boss.removeFlag(bossbar, flag)</td>
  4840. </tr>
  4841. <tr>
  4842. <td class="bold">Arguments</td>
  4843. <td><a href="https://papermc.io/javadocs/paper/1.18/org/bukkit/boss/BarFlag.html" target="_blank">flag</a> as string</td>
  4844. </tr>
  4845. </table>
  4846. <table>
  4847. <tr>
  4848. <th class="command">boss.setTitle</th>
  4849. <th class="desc">sets the title for the bossbar</th>
  4850. </tr>
  4851. <tr>
  4852. <td class="bold">Format</td>
  4853. <td>boss.setTitle(string)</td>
  4854. </tr>
  4855. </table>
  4856. <table>
  4857. <tr>
  4858. <th class="command">boss.setProgress</th>
  4859. <th class="desc">sets the progress of the bossbar</th>
  4860. </tr>
  4861. <tr>
  4862. <td class="bold">Format</td>
  4863. <td>boss.setProgress(double)</td>
  4864. </tr>
  4865. <tr>
  4866. <td class="bold">Arguments</td>
  4867. <td>double from 0 to 1</td>
  4868. </tr>
  4869. </table>
  4870. </section>