docu_minecraft.php 176 KB

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