docu_minecraft.php 167 KB

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