Polycode.xml 334 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474
  1. <?xml version="1.0" ?>
  2. <docs>
  3. <classes>
  4. <class name="BasicFile" extends="CoreFile">
  5. <static_members>
  6. </static_members>
  7. <members>
  8. <member name="file" type="FILE">
  9. </member>
  10. </members>
  11. <methods>
  12. <method name="read" return_type="Integer">
  13. <params>
  14. <param name="ptr" type="nil">
  15. </param>
  16. <param name="size" type="size_t">
  17. </param>
  18. <param name="count" type="size_t">
  19. </param>
  20. </params>
  21. </method>
  22. <method name="write" return_type="Integer">
  23. <params>
  24. <param name="ptr" type="nil">
  25. </param>
  26. <param name="size" type="size_t">
  27. </param>
  28. <param name="count" type="size_t">
  29. </param>
  30. </params>
  31. </method>
  32. <method name="seek" return_type="Integer">
  33. <params>
  34. <param name="offset" type="Integer">
  35. </param>
  36. <param name="origin" type="Integer">
  37. </param>
  38. </params>
  39. </method>
  40. <method name="tell" return_type="Integer">
  41. </method>
  42. </methods>
  43. </class>
  44. <class name="BasicFileProvider" extends="CoreFileProvider">
  45. <static_members>
  46. </static_members>
  47. <members>
  48. </members>
  49. <methods>
  50. <method name="BasicFileProvider" return_type="nil">
  51. </method>
  52. <method name="openFile" return_type="CoreFile">
  53. <params>
  54. <param name="fileName" type="String">
  55. </param>
  56. <param name="opts" type="String">
  57. </param>
  58. </params>
  59. </method>
  60. <method name="closeFile" return_type="nil">
  61. <params>
  62. <param name="file" type="CoreFile">
  63. </param>
  64. </params>
  65. </method>
  66. <method name="addSource" return_type="nil">
  67. <params>
  68. <param name="source" type="String">
  69. </param>
  70. </params>
  71. </method>
  72. <method name="removeSource" return_type="nil">
  73. <params>
  74. <param name="source" type="String">
  75. </param>
  76. </params>
  77. </method>
  78. </methods>
  79. </class>
  80. <class name="BezierCurve">
  81. <desc><![CDATA[ A Bezier curve. This class can be used to draw smooth curves or move things smoothly on curves. It's also used internally for skeletal animation. The curves are 3-dimensional, but convenience methods are added for 2d curves and there is a caching mechanism for 2d height data to speed up bezier curve usage in animation.A bezier curve consists of control points, each having 3 points: one middle point and two 'handles'. The middle point is the actual position of the control point and the two side points serve as vectors defining how the curve curves towards the next control points.]]></desc>
  82. <static_members>
  83. </static_members>
  84. <members>
  85. <member name="insertPoint" type="BezierPoInteger">
  86. <desc><![CDATA[ The point after which new control points should be added. If NULL, new control points are added to the end of the curve.]]></desc>
  87. </member>
  88. <member name="evaluationAccuracy" type="Number">
  89. <desc><![CDATA[ Accuracy value for X-axis curve evaluation. The higher this number, the faster but less accurate X-axis curve evaluation is. Defaults to 0.01]]></desc>
  90. </member>
  91. </members>
  92. <methods>
  93. <method name="BezierCurve" return_type="nil">
  94. <desc><![CDATA[ Default constructor.]]></desc>
  95. </method>
  96. <method name="getControlPoint" return_type="BezierPoInteger">
  97. <desc><![CDATA[ Returns a control point by index. ]]></desc>
  98. <params>
  99. <param name="index" type="Integer">
  100. <desc><![CDATA[Index of the control point to return.]]></desc>
  101. </param>
  102. </params>
  103. </method>
  104. <method name="getNumControlPoints" return_type="Integer">
  105. <desc><![CDATA[ Returns the total number of control points in the curve. ]]></desc>
  106. </method>
  107. <method name="addControlPoint" return_type="nil">
  108. <desc><![CDATA[ @see addControlPoint3dWithHandles()]]></desc>
  109. <params>
  110. <param name="p1x" type="Number">
  111. </param>
  112. <param name="p1y" type="Number">
  113. </param>
  114. <param name="p1z" type="Number">
  115. </param>
  116. <param name="p2x" type="Number">
  117. </param>
  118. <param name="p2y" type="Number">
  119. </param>
  120. <param name="p2z" type="Number">
  121. </param>
  122. <param name="p3x" type="Number">
  123. </param>
  124. <param name="p3y" type="Number">
  125. </param>
  126. <param name="p3z" type="Number">
  127. </param>
  128. </params>
  129. </method>
  130. <method name="addControlPoint3dWithHandles" return_type="nil">
  131. <desc><![CDATA[ Adds a new control point to the curve after the last point. ]]></desc>
  132. <params>
  133. <param name="p1x" type="Number">
  134. <desc><![CDATA[X position of the first handle point.]]></desc>
  135. </param>
  136. <param name="p1y" type="Number">
  137. <desc><![CDATA[Y position of the first handle point.]]></desc>
  138. </param>
  139. <param name="p1z" type="Number">
  140. <desc><![CDATA[Z position of the first handle point.]]></desc>
  141. </param>
  142. <param name="p2x" type="Number">
  143. <desc><![CDATA[X position of the middle point.]]></desc>
  144. </param>
  145. <param name="p2y" type="Number">
  146. <desc><![CDATA[Y position of the middle point.]]></desc>
  147. </param>
  148. <param name="p2z" type="Number">
  149. <desc><![CDATA[Z position of the middle point.]]></desc>
  150. </param>
  151. <param name="p3x" type="Number">
  152. <desc><![CDATA[X position of the second handle point.]]></desc>
  153. </param>
  154. <param name="p3y" type="Number">
  155. <desc><![CDATA[Y position of the second handle point.]]></desc>
  156. </param>
  157. <param name="p3z" type="Number">
  158. <desc><![CDATA[Z position of the second handle point.]]></desc>
  159. </param>
  160. </params>
  161. </method>
  162. <method name="addControlPoint3d" return_type="nil">
  163. <desc><![CDATA[ Adds a new control point to the curve with handles in the same place as the middle points. ]]></desc>
  164. <params>
  165. <param name="x" type="Number">
  166. <desc><![CDATA[X position of the point and both handles.]]></desc>
  167. </param>
  168. <param name="y" type="Number">
  169. <desc><![CDATA[Y position of the point and both handles.]]></desc>
  170. </param>
  171. <param name="z" type="Number">
  172. <desc><![CDATA[Z position of the point and both handles.]]></desc>
  173. </param>
  174. </params>
  175. </method>
  176. <method name="addControlPoint2dWithHandles" return_type="nil">
  177. <desc><![CDATA[ Adds a new control point to the curve after the last point ]]></desc>
  178. <params>
  179. <param name="p1x" type="Number">
  180. <desc><![CDATA[X position of the first handle point.]]></desc>
  181. </param>
  182. <param name="p1y" type="Number">
  183. <desc><![CDATA[Y position of the first handle point.]]></desc>
  184. </param>
  185. <param name="p2x" type="Number">
  186. <desc><![CDATA[X position of the middle point.]]></desc>
  187. </param>
  188. <param name="p2y" type="Number">
  189. <desc><![CDATA[Y position of the middle point.]]></desc>
  190. </param>
  191. <param name="p3x" type="Number">
  192. <desc><![CDATA[X position of the second handle point.]]></desc>
  193. </param>
  194. <param name="p3y" type="Number">
  195. <desc><![CDATA[Y position of the second handle point.]]></desc>
  196. </param>
  197. </params>
  198. </method>
  199. <method name="addControlPoint2d" return_type="nil">
  200. <desc><![CDATA[ Adds a new control point to the curve with handles in the same place as the middle points ]]></desc>
  201. <params>
  202. <param name="x" type="Number">
  203. <desc><![CDATA[X position of the point and both handles.]]></desc>
  204. </param>
  205. <param name="y" type="Number">
  206. <desc><![CDATA[Y position of the point and both handles.]]></desc>
  207. </param>
  208. </params>
  209. </method>
  210. <method name="getPointAt" return_type="Vector3">
  211. <desc><![CDATA[ Returns the 3d point of the curve at a specified point on the curve. ]]></desc>
  212. <params>
  213. <param name="a" type="Number">
  214. <desc><![CDATA[Normalized (0-1) position along the curve.]]></desc>
  215. </param>
  216. </params>
  217. </method>
  218. <method name="getPointBetween" return_type="Vector3">
  219. <desc><![CDATA[ Returns the 3d point of the curve at a specified point between two points. ]]></desc>
  220. <params>
  221. <param name="a" type="Number">
  222. <desc><![CDATA[Normalized (0-1) position between two points]]></desc>
  223. </param>
  224. <param name="bp1" type="BezierPoInteger">
  225. </param>
  226. <param name="bp2" type="BezierPoInteger">
  227. </param>
  228. </params>
  229. </method>
  230. <method name="clearControlPoints" return_type="nil">
  231. <desc><![CDATA[ Removes all curve control points.]]></desc>
  232. </method>
  233. <method name="getYValueAtX" return_type="Number">
  234. <desc><![CDATA[ Returns the Y-axis value of the curve at specified X-axis value.]]></desc>
  235. <params>
  236. <param name="x" type="Number">
  237. </param>
  238. </params>
  239. </method>
  240. <method name="getTValueAtX" return_type="Number">
  241. <desc><![CDATA[ Returns the normalized curve position value at specified X-axis value.]]></desc>
  242. <params>
  243. <param name="x" type="Number">
  244. </param>
  245. </params>
  246. </method>
  247. <method name="removePoint" return_type="nil">
  248. <desc><![CDATA[ Removes (and deletes!) a given point by pointer.]]></desc>
  249. <params>
  250. <param name="point" type="BezierPoInteger">
  251. </param>
  252. </params>
  253. </method>
  254. <method name="setHeightCacheResolution" return_type="nil">
  255. <params>
  256. <param name="resolution" type="Number">
  257. </param>
  258. </params>
  259. </method>
  260. <method name="rebuildHeightCache" return_type="nil">
  261. </method>
  262. <method name="recalculateDistances" return_type="nil">
  263. </method>
  264. </methods>
  265. </class>
  266. <class name="BezierPoint">
  267. <desc><![CDATA[ A curve point defined by 3 positions. @see BezierCurve]]></desc>
  268. <static_members>
  269. </static_members>
  270. <members>
  271. <member name="p1" type="Vector3">
  272. <desc><![CDATA[ First handle position.]]></desc>
  273. </member>
  274. <member name="p2" type="Vector3">
  275. <desc><![CDATA[ Middle position.]]></desc>
  276. </member>
  277. <member name="p3" type="Vector3">
  278. <desc><![CDATA[ Second handle position.]]></desc>
  279. </member>
  280. </members>
  281. <methods>
  282. <method name="BezierPoint" return_type="nil">
  283. <desc><![CDATA[ Constructor ]]></desc>
  284. <params>
  285. <param name="p1x" type="Number">
  286. <desc><![CDATA[X position of the first handle point.]]></desc>
  287. </param>
  288. <param name="p1y" type="Number">
  289. <desc><![CDATA[Y position of the first handle point.]]></desc>
  290. </param>
  291. <param name="p1z" type="Number">
  292. <desc><![CDATA[Z position of the first handle point.]]></desc>
  293. </param>
  294. <param name="p2x" type="Number">
  295. <desc><![CDATA[X position of the middle point.]]></desc>
  296. </param>
  297. <param name="p2y" type="Number">
  298. <desc><![CDATA[Y position of the middle point.]]></desc>
  299. </param>
  300. <param name="p2z" type="Number">
  301. <desc><![CDATA[Z position of the middle point.]]></desc>
  302. </param>
  303. <param name="p3x" type="Number">
  304. <desc><![CDATA[X position of the second handle point.]]></desc>
  305. </param>
  306. <param name="p3y" type="Number">
  307. <desc><![CDATA[Y position of the second handle point.]]></desc>
  308. </param>
  309. <param name="p3z" type="Number">
  310. <desc><![CDATA[Z position of the second handle point.]]></desc>
  311. </param>
  312. </params>
  313. </method>
  314. </methods>
  315. </class>
  316. <class name="Bone" extends="Entity">
  317. <desc><![CDATA[ Skeleton bone. Bones are bound to vertices of a mesh and when transformed, move the bound vertices of the mesh along with them. Bones are subclassed from Entity, but have their own hierarchy system. @see Skeleton]]></desc>
  318. <static_members>
  319. </static_members>
  320. <members>
  321. <member name="parentBoneId" type="Integer">
  322. <desc><![CDATA[ Id of the bone.]]></desc>
  323. </member>
  324. <member name="boneMatrix" type="Matrix4">
  325. </member>
  326. <member name="restMatrix" type="Matrix4">
  327. </member>
  328. <member name="baseMatrix" type="Matrix4">
  329. </member>
  330. <member name="finalMatrix" type="Matrix4">
  331. </member>
  332. <member name="baseRotation" type="Quaternion">
  333. </member>
  334. <member name="baseScale" type="Vector3">
  335. </member>
  336. <member name="basePosition" type="Vector3">
  337. </member>
  338. <member name="disableAnimation" type="Boolean">
  339. </member>
  340. </members>
  341. <methods>
  342. <method name="Bone" return_type="nil">
  343. <desc><![CDATA[ Constructor. ]]></desc>
  344. <params>
  345. <param name="boneName" type="String">
  346. <desc><![CDATA[Name of the bone.]]></desc>
  347. </param>
  348. </params>
  349. </method>
  350. <method name="getName" return_type="String">
  351. <desc><![CDATA[ Returns the name of the bone. ]]></desc>
  352. </method>
  353. <method name="setParentBone" return_type="nil">
  354. <desc><![CDATA[ Sets the parent bone of this bone. ]]></desc>
  355. <params>
  356. <param name="bone" type="Bone">
  357. <desc><![CDATA[New parent bone.]]></desc>
  358. </param>
  359. </params>
  360. </method>
  361. <method name="addChildBone" return_type="nil">
  362. <desc><![CDATA[ Adds another bone as the child of this bone. ]]></desc>
  363. <params>
  364. <param name="bone" type="Bone">
  365. <desc><![CDATA[New parent bone.]]></desc>
  366. </param>
  367. </params>
  368. </method>
  369. <method name="getParentBone" return_type="Bone">
  370. <desc><![CDATA[ Returns the parent bone of this bone. ]]></desc>
  371. </method>
  372. <method name="getNumChildBones" return_type="Integer">
  373. <desc><![CDATA[ Returns the number of child bones of this bone. ]]></desc>
  374. </method>
  375. <method name="getChildBone" return_type="Bone">
  376. <desc><![CDATA[ Returns the child bone of this bone at the specified index. ]]></desc>
  377. <params>
  378. <param name="index" type="Integer">
  379. <desc><![CDATA[Index of the child bone to return.]]></desc>
  380. </param>
  381. </params>
  382. </method>
  383. <method name="getBoneMatrix" return_type="Matrix4">
  384. <desc><![CDATA[ Returns the bone matrix ]]></desc>
  385. </method>
  386. <method name="setBoneMatrix" return_type="nil">
  387. <desc><![CDATA[ Sets the bone matrix. ]]></desc>
  388. <params>
  389. <param name="matrix" type="Matrix4">
  390. </param>
  391. </params>
  392. </method>
  393. <method name="getRestMatrix" return_type="Matrix4">
  394. <desc><![CDATA[ Returns the rest matrix of this bone. ]]></desc>
  395. </method>
  396. <method name="getFullRestMatrix" return_type="Matrix4">
  397. <desc><![CDATA[ Returns the full rest matrix of this bone. ]]></desc>
  398. </method>
  399. <method name="getParentRestMatrix" return_type="Matrix4">
  400. <desc><![CDATA[ Returns the rest matrix of this bone's parent. ]]></desc>
  401. </method>
  402. <method name="getFinalMatrix" return_type="Matrix4">
  403. <desc><![CDATA[ @see getBoneMatrix()]]></desc>
  404. </method>
  405. <method name="setRestMatrix" return_type="nil">
  406. <desc><![CDATA[ Sets the rest matrix for this bone. ]]></desc>
  407. <params>
  408. <param name="matrix" type="Matrix4">
  409. <desc><![CDATA[New rest matrix.]]></desc>
  410. </param>
  411. </params>
  412. </method>
  413. <method name="setBaseMatrix" return_type="nil">
  414. <desc><![CDATA[ Sets the base matrix for this bone. ]]></desc>
  415. <params>
  416. <param name="matrix" type="Matrix4">
  417. <desc><![CDATA[New base matrix.]]></desc>
  418. </param>
  419. </params>
  420. </method>
  421. <method name="getBaseMatrix" return_type="Matrix4">
  422. <desc><![CDATA[ Returns the base matrix of this bone. ]]></desc>
  423. </method>
  424. <method name="getFullBaseMatrix" return_type="Matrix4">
  425. <desc><![CDATA[ Returns the full base matrix of this bone. ]]></desc>
  426. </method>
  427. <method name="rebuildFinalMatrix" return_type="nil">
  428. </method>
  429. <method name="buildFinalMatrix" return_type="Matrix4">
  430. </method>
  431. <method name="intializeBone" return_type="nil">
  432. <params>
  433. <param name="basePosition" type="Vector3">
  434. </param>
  435. <param name="baseScale" type="Vector3">
  436. </param>
  437. <param name="baseRotation" type="Quaternion">
  438. </param>
  439. <param name="restPosition" type="Vector3">
  440. </param>
  441. <param name="restScale" type="Vector3">
  442. </param>
  443. <param name="restRotation" type="Quaternion">
  444. </param>
  445. </params>
  446. </method>
  447. </methods>
  448. </class>
  449. <class name="Camera" extends="Entity">
  450. <desc><![CDATA[ Camera in a 3D scene. Cameras can be added to a scene and changed between dynamically. You can also set a shader to a camera that will run as a screen shader for post-processing effects.]]></desc>
  451. <class_notes>NOTE: Camera instances are not automatically garbage collected.</class_notes>
  452. <static_members>
  453. <static_member name="ORTHO_SIZE_MANUAL" type="Integer" value="0">
  454. <desc><![CDATA[ ProjectionMode: Orthographic projection, with manually set size. ]]></desc>
  455. </static_member>
  456. <static_member name="ORTHO_SIZE_LOCK_HEIGHT" type="Integer" value="1">
  457. <desc><![CDATA[ ProjectionMode: Orthographic projection, with height specified used and width scaled proportionally . ]]></desc>
  458. </static_member>
  459. <static_member name="ORTHO_SIZE_LOCK_WIDTH" type="Integer" value="2">
  460. <desc><![CDATA[ ProjectionMode: Orthographic projection, with width specified used and height scaled proportionally. ]]></desc>
  461. </static_member>
  462. <static_member name="ORTHO_SIZE_VIEWPORT" type="Integer" value="3">
  463. <desc><![CDATA[ ProjectionMode: Orthographic projection, scaled to viewport backing resolution. ]]></desc>
  464. </static_member>
  465. <static_member name="PERSPECTIVE_FOV" type="Integer" value="4">
  466. <desc><![CDATA[ ProjectionMode: Perspective projection, with field of view specified. ]]></desc>
  467. </static_member>
  468. <static_member name="PERSPECTIVE_FRUSTUM" type="Integer" value="5">
  469. <desc><![CDATA[ ProjectionMode: Perspective projection, with bounds set by edges of frustum. ]]></desc>
  470. </static_member>
  471. <static_member name="MANUAL_MATRIX" type="Integer" value="6">
  472. <desc><![CDATA[ ProjectionMode: Manual matrix projection. Use setProjectionMatrix to set the matrix. ]]></desc>
  473. </static_member>
  474. </static_members>
  475. <members>
  476. <member name="frustumCulling" type="Boolean">
  477. <desc><![CDATA[ Toggles the frustum culling of the camera. (Defaults to true).]]></desc>
  478. </member>
  479. <member name="topLeftOrtho" type="Boolean">
  480. <desc><![CDATA[ If set to true, the orthographic projection will be set with the 0,0 coordinate in the top left corner of the viewport. Otherwise, the 0,0 coordinate is in the center.]]></desc>
  481. </member>
  482. <member name="cameraShift" type="Vector2">
  483. <desc><![CDATA[ Shifts camera frustum by factor of the frustum size. (x=-1 will shift the frustum to the left by a whole screen width).]]></desc>
  484. </member>
  485. </members>
  486. <methods>
  487. <method name="Camera" return_type="nil">
  488. <desc><![CDATA[ Constructor. ]]></desc>
  489. <params>
  490. <param name="parentScene" type="Scene">
  491. <desc><![CDATA[Scene to add the camera to.]]></desc>
  492. </param>
  493. </params>
  494. </method>
  495. <method name="buildFrustumPlanes" return_type="nil">
  496. <desc><![CDATA[ Builds the frustum clipping planes for this camera ]]></desc>
  497. </method>
  498. <method name="isSphereInFrustum" return_type="Boolean">
  499. <desc><![CDATA[ Checks if the camera can see a sphere. ]]></desc>
  500. <params>
  501. <param name="pos" type="Vector3">
  502. <desc><![CDATA[Position of the sphere to check.]]></desc>
  503. </param>
  504. <param name="fRadius" type="Number">
  505. <desc><![CDATA[Radius of the sphere.]]></desc>
  506. </param>
  507. </params>
  508. </method>
  509. <method name="isAABBInFrustum" return_type="Boolean">
  510. <desc><![CDATA[ Checks if an Axis-aligned bounding box is visible to the camera. ]]></desc>
  511. <params>
  512. <param name="aabb" type="AABB">
  513. <desc><![CDATA[An axis-aligned bounding box]]></desc>
  514. </param>
  515. </params>
  516. </method>
  517. <method name="setOrthoMode" return_type="nil">
  518. <desc><![CDATA[ Toggles orthographic projection mode for camera. ]]></desc>
  519. <params>
  520. <param name="mode" type="Boolean">
  521. <desc><![CDATA[If true, sets the camera into orthographic projection mode.]]></desc>
  522. </param>
  523. </params>
  524. </method>
  525. <method name="setOrthoSize" return_type="nil">
  526. <desc><![CDATA[ Sets the orthographic size of the camera. ]]></desc>
  527. <params>
  528. <param name="orthoSizeX" type="Number">
  529. <desc><![CDATA[Orthographic width]]></desc>
  530. </param>
  531. <param name="orthoSizeY" type="Number">
  532. <desc><![CDATA[Orthographic height]]></desc>
  533. </param>
  534. </params>
  535. </method>
  536. <method name="setFrustumMode" return_type="nil">
  537. <desc><![CDATA[ Switches into frustum mode and sets up the planes. ]]></desc>
  538. <params>
  539. <param name="left" type="Number">
  540. </param>
  541. <param name="right" type="Number">
  542. </param>
  543. <param name="bottom" type="Number">
  544. </param>
  545. <param name="top" type="Number">
  546. </param>
  547. <param name="front" type="Number">
  548. </param>
  549. <param name="back" type="Number">
  550. </param>
  551. </params>
  552. </method>
  553. <method name="getOrthoMode" return_type="Boolean">
  554. <desc><![CDATA[ Returns true if camera is in orthographic projection mode. ]]></desc>
  555. </method>
  556. <method name="getOrthoSizeX" return_type="Number">
  557. <desc><![CDATA[ Returns the width of the camera's orthographic frustum. ]]></desc>
  558. </method>
  559. <method name="getOrthoSizeY" return_type="Number">
  560. <desc><![CDATA[ Returns the height of the camera's orthographic frustum. ]]></desc>
  561. </method>
  562. <method name="setFOV" return_type="nil">
  563. <desc><![CDATA[ Sets the field of view (FOV) for the camera. The larger the field of view, the more the camera can see, the smaller it is, the more zoomed in it is. ]]></desc>
  564. <params>
  565. <param name="fov" type="Number">
  566. <desc><![CDATA[The new FOV value.]]></desc>
  567. </param>
  568. </params>
  569. </method>
  570. <method name="getFOV" return_type="Number">
  571. <desc><![CDATA[ Returns the current FOV value for the camera. ]]></desc>
  572. </method>
  573. <method name="setClippingPlanes" return_type="nil">
  574. <desc><![CDATA[ Sets the clipping planes for the camera. ]]></desc>
  575. <params>
  576. <param name="nearClipPlane" type="Number">
  577. <desc><![CDATA[Near clipping plane.]]></desc>
  578. </param>
  579. <param name="farClipPlane" type="Number">
  580. <desc><![CDATA[Far clipping plane.]]></desc>
  581. </param>
  582. </params>
  583. </method>
  584. <method name="getNearClippingPlane" return_type="Number">
  585. <desc><![CDATA[ Returns the near clipping plane of the camera. ]]></desc>
  586. </method>
  587. <method name="getFarClippingPlane" return_type="Number">
  588. <desc><![CDATA[ Returns the far clipping plane of the camera. ]]></desc>
  589. </method>
  590. <method name="setParentScene" return_type="nil">
  591. <desc><![CDATA[ Sets the parent scene of the camera. ]]></desc>
  592. <params>
  593. <param name="parentScene" type="Scene">
  594. <desc><![CDATA[New parent scene.]]></desc>
  595. </param>
  596. </params>
  597. </method>
  598. <method name="getParentScene" return_type="Scene">
  599. <desc><![CDATA[ Returns the camera's parent scene. ]]></desc>
  600. </method>
  601. <method name="createProjectionMatrix" return_type="Matrix4">
  602. </method>
  603. <method name="hasFilterShader" return_type="Boolean">
  604. <desc><![CDATA[ Check if camera has a post filter material applied ]]></desc>
  605. </method>
  606. <method name="drawFilter" return_type="nil">
  607. <desc><![CDATA[ Binds target buffers and renders the scene in multiple passes based on the post filter material.]]></desc>
  608. <params>
  609. <param name="targetBuffer" type="RenderBuffer">
  610. </param>
  611. </params>
  612. </method>
  613. <method name="setPostFilter" return_type="nil">
  614. <desc><![CDATA[ Sets the post-processing shader for the camera. ]]></desc>
  615. <params>
  616. <param name="material" type="Material">
  617. <desc><![CDATA[Post processing shader material.]]></desc>
  618. </param>
  619. </params>
  620. </method>
  621. <method name="setPostFilterByName" return_type="nil">
  622. <desc><![CDATA[ Sets the post-processing shader for the camera by name. The material needs have been added as a resource. ]]></desc>
  623. <params>
  624. <param name="shaderName" type="String">
  625. <desc><![CDATA[The material name of the post-processing filter.]]></desc>
  626. </param>
  627. </params>
  628. </method>
  629. <method name="removePostFilter" return_type="nil">
  630. <desc><![CDATA[ Removes the currently assigned post filter.]]></desc>
  631. </method>
  632. <method name="getScreenShaderMaterial" return_type="Material">
  633. <desc><![CDATA[ Returns the shader material applied to the camera.]]></desc>
  634. </method>
  635. <method name="Clone" return_type="Entity">
  636. <desc><![CDATA[ Clones the camera.]]></desc>
  637. <params>
  638. <param name="deepClone" type="Boolean">
  639. </param>
  640. <param name="ignoreEditorOnly" type="Boolean">
  641. </param>
  642. </params>
  643. </method>
  644. <method name="applyClone" return_type="nil">
  645. <desc><![CDATA[ Applies clone parameters to the camera.]]></desc>
  646. <params>
  647. <param name="clone" type="Entity">
  648. </param>
  649. <param name="deepClone" type="Boolean">
  650. </param>
  651. <param name="ignoreEditorOnly" type="Boolean">
  652. </param>
  653. </params>
  654. </method>
  655. <method name="getProjectionMatrix" return_type="Matrix4">
  656. <desc><![CDATA[ Returns the camera's projection matrix. ]]></desc>
  657. </method>
  658. <method name="setCustomProjectionMatrix" return_type="nil">
  659. <desc><![CDATA[ Manually sets the camera's projection matrix. Projection mode must be set to MANUAL_MATRIX. ]]></desc>
  660. <params>
  661. <param name="matrix" type="Matrix4">
  662. <desc><![CDATA[Custom projection matrix. @see setProjectionMode]]></desc>
  663. </param>
  664. </params>
  665. </method>
  666. <method name="getViewport" return_type="Rectangle">
  667. <desc><![CDATA[ Return's the camera's pixel viewport based on the last render pass.]]></desc>
  668. </method>
  669. <method name="setViewport" return_type="nil">
  670. <params>
  671. <param name="viewport" type="Rectangle">
  672. </param>
  673. </params>
  674. </method>
  675. <method name="setOrthoSizeMode" return_type="nil">
  676. <desc><![CDATA[ @deprecated use setProjectionMode(ProjectionMode mode) ]]></desc>
  677. <params>
  678. <param name="orthoSizeMode" type="Integer">
  679. </param>
  680. </params>
  681. </method>
  682. <method name="getOrthoSizeMode" return_type="Integer">
  683. <desc><![CDATA[ @deprecated use getProjectionMode() ]]></desc>
  684. </method>
  685. <method name="setProjectionMode" return_type="nil">
  686. <desc><![CDATA[ Sets the projection mode of the camera. Possible values are ORTHO_SIZE_MANUAL, ORTHO_SIZE_LOCK_HEIGHT,ORTHO_SIZE_LOCK_WIDTH, ORTHO_SIZE_LOCK_WIDTH, PERSPECTIVE_FOV, PERSPECTIVE_FRUSTUM and MANUAL_MATRIX. See the documentation of each individual mode for details. ]]></desc>
  687. <params>
  688. <param name="mode" type="Integer">
  689. <desc><![CDATA[New projection mode.]]></desc>
  690. </param>
  691. </params>
  692. </method>
  693. <method name="getProjectionMode" return_type="Integer">
  694. <desc><![CDATA[ Returns the current projection mode. ]]></desc>
  695. </method>
  696. <method name="projectRayFrom2DCoordinate" return_type="Vector3">
  697. <params>
  698. <param name="coordinate" type="Vector2">
  699. </param>
  700. <param name="viewport" type="Rectangle">
  701. </param>
  702. </params>
  703. </method>
  704. <method name="renderFullScreenQuad" return_type="nil">
  705. <params>
  706. <param name="drawBuffer" type="GPUDrawBuffer">
  707. </param>
  708. <param name="shaderPass" type="Integer">
  709. </param>
  710. </params>
  711. </method>
  712. <method name="getShaderPass" return_type="ShaderPass">
  713. <params>
  714. <param name="index" type="Integer">
  715. </param>
  716. </params>
  717. </method>
  718. <method name="getNumShaderPasses" return_type="Integer">
  719. </method>
  720. </methods>
  721. </class>
  722. <class name="Color">
  723. <desc><![CDATA[ Stores and manipulates color information. Color is always RGBA in Polycode.]]></desc>
  724. <static_members>
  725. <static_member name="BLEND_NORMAL" type="Integer" value="0">
  726. </static_member>
  727. <static_member name="BLEND_REPLACE_COLOR" type="Integer" value="1">
  728. </static_member>
  729. <static_member name="BLEND_ADDITIVE" type="Integer" value="2">
  730. </static_member>
  731. </static_members>
  732. <members>
  733. <member name="r" type="Number">
  734. <desc><![CDATA[ Red value.]]></desc>
  735. </member>
  736. <member name="g" type="Number">
  737. <desc><![CDATA[ Green value.]]></desc>
  738. </member>
  739. <member name="b" type="Number">
  740. <desc><![CDATA[ Blue value.]]></desc>
  741. </member>
  742. <member name="a" type="Number">
  743. <desc><![CDATA[ Alpha value.]]></desc>
  744. </member>
  745. </members>
  746. <methods>
  747. <method name="Color" return_type="nil">
  748. <desc><![CDATA[ Create from 0-1 floating point data. ]]></desc>
  749. <params>
  750. <param name="r" type="Number">
  751. <desc><![CDATA[Red value 0-1.]]></desc>
  752. </param>
  753. <param name="g" type="Number">
  754. <desc><![CDATA[Green value 0-1]]></desc>
  755. </param>
  756. <param name="b" type="Number">
  757. <desc><![CDATA[Blue value 0-1]]></desc>
  758. </param>
  759. <param name="a" type="Number">
  760. <desc><![CDATA[Alpha value 0-1]]></desc>
  761. </param>
  762. </params>
  763. </method>
  764. <method name="ColorWithInts" return_type="Color" static="true">
  765. <desc><![CDATA[ Create from 0-255 integer data. ]]></desc>
  766. <params>
  767. <param name="r" type="Integer">
  768. <desc><![CDATA[Red value 0-255.]]></desc>
  769. </param>
  770. <param name="g" type="Integer">
  771. <desc><![CDATA[Green value 0-255.]]></desc>
  772. </param>
  773. <param name="b" type="Integer">
  774. <desc><![CDATA[Blue value 0-255.]]></desc>
  775. </param>
  776. <param name="a" type="Integer">
  777. <desc><![CDATA[Alpha value 0-255.]]></desc>
  778. </param>
  779. </params>
  780. </method>
  781. <method name="ColorWithHex" return_type="Color" static="true">
  782. <desc><![CDATA[ Create from integer color. ]]></desc>
  783. <params>
  784. <param name="hex" type="Integer">
  785. <desc><![CDATA[Integer color value.]]></desc>
  786. </param>
  787. </params>
  788. </method>
  789. <method name="setColorHex" return_type="nil">
  790. <desc><![CDATA[ Sets the color ]]></desc>
  791. <params>
  792. <param name="hex" type="Integer">
  793. <desc><![CDATA[32-bit integer with color values.]]></desc>
  794. </param>
  795. </params>
  796. </method>
  797. <method name="setColorHexRGB" return_type="nil">
  798. <desc><![CDATA[ Sets the color ]]></desc>
  799. <params>
  800. <param name="hex" type="Integer">
  801. <desc><![CDATA[24-bit integer with RGB color values.]]></desc>
  802. </param>
  803. </params>
  804. </method>
  805. <method name="setColorHexFromString" return_type="nil">
  806. <desc><![CDATA[ Sets the color ]]></desc>
  807. <params>
  808. <param name="hex" type="String">
  809. <desc><![CDATA[String with hex RGBA color values.]]></desc>
  810. </param>
  811. </params>
  812. </method>
  813. <method name="setColorHexRGBFromString" return_type="nil">
  814. <desc><![CDATA[ Sets the color ]]></desc>
  815. <params>
  816. <param name="hex" type="String">
  817. <desc><![CDATA[String with hex RGB color values.]]></desc>
  818. </param>
  819. </params>
  820. </method>
  821. <method name="setColorHSV" return_type="nil">
  822. <desc><![CDATA[ Sets the color ]]></desc>
  823. <params>
  824. <param name="h" type="Number">
  825. <desc><![CDATA[Hue.]]></desc>
  826. </param>
  827. <param name="s" type="Number">
  828. <desc><![CDATA[Saturation.]]></desc>
  829. </param>
  830. <param name="v" type="Number">
  831. <desc><![CDATA[Value.]]></desc>
  832. </param>
  833. </params>
  834. </method>
  835. <method name="setColorRGBA" return_type="nil">
  836. <desc><![CDATA[ Sets the color ]]></desc>
  837. <params>
  838. <param name="r" type="Integer">
  839. <desc><![CDATA[Red value 0-255.]]></desc>
  840. </param>
  841. <param name="g" type="Integer">
  842. <desc><![CDATA[Green value 0-255.]]></desc>
  843. </param>
  844. <param name="b" type="Integer">
  845. <desc><![CDATA[Blue value 0-255.]]></desc>
  846. </param>
  847. <param name="a" type="Integer">
  848. <desc><![CDATA[Alpha value 0-255.]]></desc>
  849. </param>
  850. </params>
  851. </method>
  852. <method name="setColorRGB" return_type="nil">
  853. <desc><![CDATA[ Sets the color ]]></desc>
  854. <params>
  855. <param name="r" type="Integer">
  856. <desc><![CDATA[Red value 0-255.]]></desc>
  857. </param>
  858. <param name="g" type="Integer">
  859. <desc><![CDATA[Green value 0-255.]]></desc>
  860. </param>
  861. <param name="b" type="Integer">
  862. <desc><![CDATA[Blue value 0-255.]]></desc>
  863. </param>
  864. </params>
  865. </method>
  866. <method name="setColor" return_type="nil">
  867. <desc><![CDATA[ Set from 0-1 floating point data. ]]></desc>
  868. <params>
  869. <param name="r" type="Number">
  870. <desc><![CDATA[Red value 0-1.]]></desc>
  871. </param>
  872. <param name="g" type="Number">
  873. <desc><![CDATA[Green value 0-1]]></desc>
  874. </param>
  875. <param name="b" type="Number">
  876. <desc><![CDATA[Blue value 0-1]]></desc>
  877. </param>
  878. <param name="a" type="Number">
  879. <desc><![CDATA[Alpha value 0-1]]></desc>
  880. </param>
  881. </params>
  882. </method>
  883. <method name="blendColor" return_type="Color">
  884. <desc><![CDATA[ Returns a new color after blending the second color with specified blending mode. ]]></desc>
  885. <params>
  886. <param name="c2" type="Color">
  887. <desc><![CDATA[Color to blend with]]></desc>
  888. </param>
  889. <param name="mode" type="Integer">
  890. <desc><![CDATA[Blending mode to use. Currently possible values are Color.BLEND_NORMAL, Color.BLEND_REPLACE_COLOR and Color.BLEND_ADDITIVE]]></desc>
  891. </param>
  892. <param name="amount" type="Number">
  893. <desc><![CDATA[Amount to blend.]]></desc>
  894. </param>
  895. <param name="c3" type="Color">
  896. </param>
  897. </params>
  898. </method>
  899. <method name="Random" return_type="nil">
  900. <desc><![CDATA[ Sets the color to a random color. This does not affect alpha.]]></desc>
  901. </method>
  902. <method name="getBrightness" return_type="Number">
  903. <desc><![CDATA[ Retuns the brightness of the color ]]></desc>
  904. </method>
  905. <method name="RGBtoHSV" return_type="nil" static="true">
  906. <params>
  907. <param name="r" type="Number">
  908. </param>
  909. <param name="g" type="Number">
  910. </param>
  911. <param name="b" type="Number">
  912. </param>
  913. <param name="h" type="Number">
  914. </param>
  915. <param name="s" type="Number">
  916. </param>
  917. <param name="v" type="Number">
  918. </param>
  919. </params>
  920. </method>
  921. <method name="getHue" return_type="Number">
  922. <desc><![CDATA[ Returns the hue of the color's HSV component. ]]></desc>
  923. </method>
  924. <method name="getSaturation" return_type="Number">
  925. <desc><![CDATA[ Returns the saturation of the color's HSV component. ]]></desc>
  926. </method>
  927. <method name="getValue" return_type="Number">
  928. <desc><![CDATA[ Returns the value of the color's HSV component ]]></desc>
  929. </method>
  930. <method name="getUint" return_type="Integer">
  931. <desc><![CDATA[ Returns the color as a 32-bit usigned integer. ]]></desc>
  932. </method>
  933. </methods>
  934. </class>
  935. <class name="ConfigEntry">
  936. <static_members>
  937. </static_members>
  938. <members>
  939. <member name="key" type="String">
  940. </member>
  941. <member name="configNamespace" type="String">
  942. </member>
  943. <member name="numVal" type="Number">
  944. </member>
  945. <member name="stringVal" type="String">
  946. </member>
  947. <member name="isString" type="Boolean">
  948. </member>
  949. </members>
  950. <methods>
  951. </methods>
  952. </class>
  953. <class name="Config">
  954. <desc><![CDATA[ Saves and loads simple config files. Config stores, loads and saves string and number values associated by string keys. You can use to easily save and load settings and preferences and other data. Configs are separated by namespaces, so you can have multiple configs with the same keys.]]></desc>
  955. <static_members>
  956. </static_members>
  957. <members>
  958. </members>
  959. <methods>
  960. <method name="Config" return_type="nil">
  961. <desc><![CDATA[ Default constructor.]]></desc>
  962. </method>
  963. <method name="loadConfig" return_type="nil">
  964. <desc><![CDATA[ Load config from a specified file into the specified namespace. ]]></desc>
  965. <params>
  966. <param name="configNamespace" type="String">
  967. <desc><![CDATA[Namespace of the config to load data into.]]></desc>
  968. </param>
  969. <param name="fileName" type="String">
  970. <desc><![CDATA[Path to the file to load.]]></desc>
  971. </param>
  972. </params>
  973. </method>
  974. <method name="saveConfig" return_type="nil">
  975. <desc><![CDATA[ Save config to a specified file from the specified namespace. ]]></desc>
  976. <params>
  977. <param name="configNamespace" type="String">
  978. <desc><![CDATA[Namespace of the config to save data from.]]></desc>
  979. </param>
  980. <param name="fileName" type="String">
  981. <desc><![CDATA[Path to the file to save data to.]]></desc>
  982. </param>
  983. </params>
  984. </method>
  985. <method name="getEntry" return_type="ConfigEntry">
  986. <params>
  987. <param name="configNamespace" type="String">
  988. </param>
  989. <param name="key" type="String">
  990. </param>
  991. </params>
  992. </method>
  993. <method name="setStringValue" return_type="nil">
  994. <desc><![CDATA[ Sets a string value into the specified config namespace. ]]></desc>
  995. <params>
  996. <param name="configNamespace" type="String">
  997. <desc><![CDATA[Namespace to set value in.]]></desc>
  998. </param>
  999. <param name="key" type="String">
  1000. <desc><![CDATA[String key of the value.]]></desc>
  1001. </param>
  1002. <param name="value" type="String">
  1003. <desc><![CDATA[The string value to save.]]></desc>
  1004. </param>
  1005. </params>
  1006. </method>
  1007. <method name="setNumericValue" return_type="nil">
  1008. <desc><![CDATA[ Sets a numeric value into the specified config namespace. ]]></desc>
  1009. <params>
  1010. <param name="configNamespace" type="String">
  1011. <desc><![CDATA[Namespace to set value in.]]></desc>
  1012. </param>
  1013. <param name="key" type="String">
  1014. <desc><![CDATA[String key of the value.]]></desc>
  1015. </param>
  1016. <param name="value" type="Number">
  1017. <desc><![CDATA[The numeric value to save.]]></desc>
  1018. </param>
  1019. </params>
  1020. </method>
  1021. <method name="getNumericValue" return_type="Number">
  1022. <desc><![CDATA[ Returns a numeric value by a string key. ]]></desc>
  1023. <params>
  1024. <param name="configNamespace" type="String">
  1025. <desc><![CDATA[Namespace to get the value from.]]></desc>
  1026. </param>
  1027. <param name="key" type="String">
  1028. <desc><![CDATA[String key of the value.]]></desc>
  1029. </param>
  1030. </params>
  1031. </method>
  1032. <method name="getStringValue" return_type="String">
  1033. <desc><![CDATA[ Returns a string value by a string key. ]]></desc>
  1034. <params>
  1035. <param name="configNamespace" type="String">
  1036. <desc><![CDATA[Namespace to get the value from.]]></desc>
  1037. </param>
  1038. <param name="key" type="String">
  1039. <desc><![CDATA[String key of the value.]]></desc>
  1040. </param>
  1041. </params>
  1042. </method>
  1043. <method name="setBoolValue" return_type="nil">
  1044. <desc><![CDATA[ Sets a string value that represents boolean (true|false) key. ]]></desc>
  1045. <params>
  1046. <param name="configNamespace" type="String">
  1047. <desc><![CDATA[Namespace to set value in.]]></desc>
  1048. </param>
  1049. <param name="key" type="String">
  1050. <desc><![CDATA[String key of the value.]]></desc>
  1051. </param>
  1052. <param name="value" type="Boolean">
  1053. <desc><![CDATA[The string value to save.]]></desc>
  1054. </param>
  1055. </params>
  1056. </method>
  1057. <method name="getBoolValue" return_type="Boolean">
  1058. <desc><![CDATA[ Returns a boolean value by eveluating a string key (true|1 = true). ]]></desc>
  1059. <params>
  1060. <param name="configNamespace" type="String">
  1061. <desc><![CDATA[Namespace to get the value from.]]></desc>
  1062. </param>
  1063. <param name="key" type="String">
  1064. <desc><![CDATA[String key of the value.]]></desc>
  1065. </param>
  1066. </params>
  1067. </method>
  1068. </methods>
  1069. </class>
  1070. <class name="Core" extends="EventDispatcher">
  1071. <desc><![CDATA[ The main core of the framework. The core deals with system-level functions, such as window initialization and OS interaction. Each platform has its own implementation of this base class. NOTE: SOME OF THE FUNCTIONALITY IN THE CORE IS NOT FULLY IMPLEMENTED!!]]></desc>
  1072. <static_members>
  1073. <static_member name="EVENTBASE_CORE" type="Integer" value="0x200">
  1074. </static_member>
  1075. <static_member name="EVENT_CORE_RESIZE" type="Integer" value="EVENTBASE_CORE + 0">
  1076. </static_member>
  1077. <static_member name="EVENT_LOST_FOCUS" type="Integer" value="EVENTBASE_CORE + 1">
  1078. </static_member>
  1079. <static_member name="EVENT_GAINED_FOCUS" type="Integer" value="EVENTBASE_CORE + 2">
  1080. </static_member>
  1081. <static_member name="EVENT_UNDO" type="Integer" value="EVENTBASE_CORE + 3">
  1082. </static_member>
  1083. <static_member name="EVENT_REDO" type="Integer" value="EVENTBASE_CORE + 4">
  1084. </static_member>
  1085. <static_member name="EVENT_COPY" type="Integer" value="EVENTBASE_CORE + 5">
  1086. </static_member>
  1087. <static_member name="EVENT_CUT" type="Integer" value="EVENTBASE_CORE + 6">
  1088. </static_member>
  1089. <static_member name="EVENT_SELECT_ALL" type="Integer" value="EVENTBASE_CORE + 7">
  1090. </static_member>
  1091. <static_member name="EVENT_PASTE" type="Integer" value="EVENTBASE_CORE + 8">
  1092. </static_member>
  1093. <static_member name="EVENT_GYRO_ROTATION" type="Integer" value="EVENTBASE_CORE + 9">
  1094. </static_member>
  1095. <static_member name="EVENT_ACCELEROMETER_MOTION" type="Integer" value="EVENTBASE_CORE + 10">
  1096. </static_member>
  1097. <static_member name="CURSOR_ARROW" type="Integer" value="0">
  1098. </static_member>
  1099. <static_member name="CURSOR_TEXT" type="Integer" value="1">
  1100. </static_member>
  1101. <static_member name="CURSOR_POINTER" type="Integer" value="2">
  1102. </static_member>
  1103. <static_member name="CURSOR_CROSSHAIR" type="Integer" value="3">
  1104. </static_member>
  1105. <static_member name="CURSOR_RESIZE_LEFT_RIGHT" type="Integer" value="4">
  1106. </static_member>
  1107. <static_member name="CURSOR_RESIZE_UP_DOWN" type="Integer" value="5">
  1108. </static_member>
  1109. <static_member name="CURSOR_OPEN_HAND" type="Integer" value="6">
  1110. </static_member>
  1111. </static_members>
  1112. <members>
  1113. <member name="eventMutex" type="CoreMutex">
  1114. </member>
  1115. <member name="paused" type="Boolean">
  1116. </member>
  1117. <member name="pauseOnLoseFocus" type="Boolean">
  1118. </member>
  1119. <member name="defaultScreenWidth" type="Integer">
  1120. <desc><![CDATA[ Default width of the desktop screen]]></desc>
  1121. </member>
  1122. <member name="defaultScreenHeight" type="Integer">
  1123. <desc><![CDATA[ Default height of the desktop screen]]></desc>
  1124. </member>
  1125. <member name="deviceAttitude" type="Quaternion">
  1126. </member>
  1127. </members>
  1128. <methods>
  1129. <method name="Update" return_type="Boolean">
  1130. </method>
  1131. <method name="Render" return_type="nil">
  1132. </method>
  1133. <method name="fixedUpdate" return_type="Boolean">
  1134. </method>
  1135. <method name="systemUpdate" return_type="Boolean">
  1136. </method>
  1137. <method name="updateAndRender" return_type="Boolean">
  1138. </method>
  1139. <method name="enableMouse" return_type="nil">
  1140. <desc><![CDATA[ Show or hide cursor. ]]></desc>
  1141. <params>
  1142. <param name="newval" type="Boolean">
  1143. <desc><![CDATA[True to show mouse, false to hide it.]]></desc>
  1144. </param>
  1145. </params>
  1146. </method>
  1147. <method name="captureMouse" return_type="nil">
  1148. <desc><![CDATA[ Capture the mouse. The mouse will be unable to exit the polycode screen. ]]></desc>
  1149. <params>
  1150. <param name="newval" type="Boolean">
  1151. <desc><![CDATA[True to capture the mouse, false to uncapture it.]]></desc>
  1152. </param>
  1153. </params>
  1154. </method>
  1155. <method name="setCursor" return_type="nil">
  1156. <desc><![CDATA[ Sets the cursor the application is using. ]]></desc>
  1157. <params>
  1158. <param name="cursorType" type="Integer">
  1159. <desc><![CDATA[Type of cursor to use. Possible values are CURSOR_ARROW, CURSOR_TEXT, CURSOR_POINTER, CURSOR_CROSSHAIR, CURSOR_RESIZE_LEFT_RIGHT, CURSOR_RESIZE_UP_DOWN]]></desc>
  1160. </param>
  1161. </params>
  1162. </method>
  1163. <method name="warpCursor" return_type="nil">
  1164. <desc><![CDATA[ Warps the cursor to a specified point in the window. ]]></desc>
  1165. <params>
  1166. <param name="x" type="Integer">
  1167. <desc><![CDATA[New cursor x position]]></desc>
  1168. </param>
  1169. <param name="y" type="Integer">
  1170. <desc><![CDATA[New cursor y position]]></desc>
  1171. </param>
  1172. </params>
  1173. </method>
  1174. <method name="createThread" return_type="nil">
  1175. <desc><![CDATA[ Launches a Threaded class into its own thread. See the documentation for Threaded for information on how to crated threaded classes. ]]></desc>
  1176. <params>
  1177. <param name="target" type="Threaded">
  1178. <desc><![CDATA[Target threaded class. @see Threaded]]></desc>
  1179. </param>
  1180. </params>
  1181. </method>
  1182. <method name="lockMutex" return_type="nil">
  1183. <desc><![CDATA[ Locks a mutex. Legacy method. Use the "lock" method of CoreMutex! ]]></desc>
  1184. <params>
  1185. <param name="mutex" type="CoreMutex">
  1186. <desc><![CDATA[Mutex to lock.]]></desc>
  1187. </param>
  1188. </params>
  1189. </method>
  1190. <method name="unlockMutex" return_type="nil">
  1191. <desc><![CDATA[ Unlocks a mutex. Legacy method. Use the "unlock" method of CoreMutex! ]]></desc>
  1192. <params>
  1193. <param name="mutex" type="CoreMutex">
  1194. <desc><![CDATA[Mutex to lock.]]></desc>
  1195. </param>
  1196. </params>
  1197. </method>
  1198. <method name="createMutex" return_type="CoreMutex">
  1199. <desc><![CDATA[ Creates a mutex ]]></desc>
  1200. </method>
  1201. <method name="copyStringToClipboard" return_type="nil">
  1202. <desc><![CDATA[ Copies the specified string to system clipboard. ]]></desc>
  1203. <params>
  1204. <param name="str" type="String">
  1205. <desc><![CDATA[String to copy to clipboard.]]></desc>
  1206. </param>
  1207. </params>
  1208. </method>
  1209. <method name="getClipboardString" return_type="String">
  1210. <desc><![CDATA[ Returns the system clipboard as a string. ]]></desc>
  1211. </method>
  1212. <method name="getServices" return_type="CoreServices">
  1213. <desc><![CDATA[ Returns the core services. See CoreServices for a detailed explanation of services. ]]></desc>
  1214. </method>
  1215. <method name="getFPS" return_type="Number">
  1216. <desc><![CDATA[ Returns the current average frames per second. ]]></desc>
  1217. </method>
  1218. <method name="Shutdown" return_type="nil">
  1219. <desc><![CDATA[ Shuts down the core and quits the application.]]></desc>
  1220. </method>
  1221. <method name="isFullscreen" return_type="Boolean">
  1222. <desc><![CDATA[ Checks if core is in fullscreen mode. ]]></desc>
  1223. </method>
  1224. <method name="getAALevel" return_type="Integer">
  1225. <desc><![CDATA[ Returns the current anti-aliasing level. ]]></desc>
  1226. </method>
  1227. <method name="getInput" return_type="CoreInput">
  1228. <desc><![CDATA[ Returns the input class. See CoreInput for details in input. ]]></desc>
  1229. </method>
  1230. <method name="getXRes" return_type="Number">
  1231. <desc><![CDATA[ Returns current horizontal resolution. ]]></desc>
  1232. </method>
  1233. <method name="getYRes" return_type="Number">
  1234. <desc><![CDATA[ Returns current vertical resolution. ]]></desc>
  1235. </method>
  1236. <method name="getBackingXRes" return_type="Number">
  1237. <desc><![CDATA[ Returns actual current horizontal resolution. ]]></desc>
  1238. </method>
  1239. <method name="getBackingYRes" return_type="Number">
  1240. <desc><![CDATA[ Returns actual current vertical resolution. ]]></desc>
  1241. </method>
  1242. <method name="getScreenInfo" return_type="nil" static="true">
  1243. <desc><![CDATA[ Provides the current width, height, and refresh rate of the screen. ]]></desc>
  1244. <params>
  1245. <param name="width" type="Integer">
  1246. <desc><![CDATA[If non-NULL, current screen width will be written here (or 0 if unknown).]]></desc>
  1247. </param>
  1248. <param name="height" type="Integer">
  1249. <desc><![CDATA[If non-NULL, current screen height will be written here (or 0 if unknown).]]></desc>
  1250. </param>
  1251. <param name="hz" type="Integer">
  1252. <desc><![CDATA[If non-NULL, current screen refresh rate will be written here (or 0 if unknown).]]></desc>
  1253. </param>
  1254. </params>
  1255. </method>
  1256. <method name="getScreenWidth" return_type="Integer">
  1257. </method>
  1258. <method name="getScreenHeight" return_type="Integer">
  1259. </method>
  1260. <method name="createFolder" return_type="nil">
  1261. <desc><![CDATA[ Creates a folder on disk with the specified path. ]]></desc>
  1262. <params>
  1263. <param name="folderPath" type="String">
  1264. <desc><![CDATA[Path to create the folder in.]]></desc>
  1265. </param>
  1266. </params>
  1267. </method>
  1268. <method name="copyDiskItem" return_type="nil">
  1269. <desc><![CDATA[ Copies a disk item from one path to another ]]></desc>
  1270. <params>
  1271. <param name="itemPath" type="String">
  1272. <desc><![CDATA[Path to the item to copy.]]></desc>
  1273. </param>
  1274. <param name="destItemPath" type="String">
  1275. <desc><![CDATA[Destination path to copy to.]]></desc>
  1276. </param>
  1277. </params>
  1278. </method>
  1279. <method name="moveDiskItem" return_type="nil">
  1280. <desc><![CDATA[ Moves a disk item from one path to another ]]></desc>
  1281. <params>
  1282. <param name="itemPath" type="String">
  1283. <desc><![CDATA[Path to the item to move.]]></desc>
  1284. </param>
  1285. <param name="destItemPath" type="String">
  1286. <desc><![CDATA[Destination path to move to.]]></desc>
  1287. </param>
  1288. </params>
  1289. </method>
  1290. <method name="removeDiskItem" return_type="nil">
  1291. <desc><![CDATA[ Removes a disk item. ]]></desc>
  1292. <params>
  1293. <param name="itemPath" type="String">
  1294. <desc><![CDATA[Path to the item to remove.]]></desc>
  1295. </param>
  1296. </params>
  1297. </method>
  1298. <method name="openFolderPicker" return_type="String">
  1299. <desc><![CDATA[ Opens a system folder picker and suspends operation. ]]></desc>
  1300. </method>
  1301. <method name="setFramerate" return_type="nil">
  1302. <params>
  1303. <param name="frameRate" type="Integer">
  1304. </param>
  1305. <param name="maxFixedCycles" type="Integer">
  1306. </param>
  1307. </params>
  1308. </method>
  1309. <method name="openFilePicker" return_array="true" return_type="String">
  1310. <desc><![CDATA[ Opens a system file picker for the specified extensions. ]]></desc>
  1311. <params>
  1312. <param name="extensions" param_array="true" type="CoreFileExtension">
  1313. <desc><![CDATA[An STL vector containing the allowed file extensions that can be selected.]]></desc>
  1314. </param>
  1315. <param name="allowMultiple" type="Boolean">
  1316. <desc><![CDATA[If set to true, the picker can select multiple files.]]></desc>
  1317. </param>
  1318. </params>
  1319. </method>
  1320. <method name="saveFilePicker" return_type="String">
  1321. <params>
  1322. <param name="extensions" param_array="true" type="CoreFileExtension">
  1323. </param>
  1324. </params>
  1325. </method>
  1326. <method name="handleVideoModeChange" return_type="nil">
  1327. <params>
  1328. <param name="modeInfo" type="VideoModeChangeInfo">
  1329. </param>
  1330. </params>
  1331. </method>
  1332. <method name="flushRenderContext" return_type="nil">
  1333. </method>
  1334. <method name="prepareRenderContext" return_type="nil">
  1335. </method>
  1336. <method name="openFile" return_type="CoreFile">
  1337. <params>
  1338. <param name="fileName" type="String">
  1339. </param>
  1340. <param name="opts" type="String">
  1341. </param>
  1342. </params>
  1343. </method>
  1344. <method name="closeFile" return_type="nil">
  1345. <params>
  1346. <param name="file" type="CoreFile">
  1347. </param>
  1348. </params>
  1349. </method>
  1350. <method name="addFileSource" return_type="nil">
  1351. <params>
  1352. <param name="type" type="String">
  1353. </param>
  1354. <param name="source" type="String">
  1355. </param>
  1356. </params>
  1357. </method>
  1358. <method name="removeFileSource" return_type="nil">
  1359. <params>
  1360. <param name="type" type="String">
  1361. </param>
  1362. <param name="source" type="String">
  1363. </param>
  1364. </params>
  1365. </method>
  1366. <method name="parseFolder" return_array="true" return_type="OSFileEntry">
  1367. <params>
  1368. <param name="pathString" type="String">
  1369. </param>
  1370. <param name="showHidden" type="Boolean">
  1371. </param>
  1372. </params>
  1373. </method>
  1374. <method name="systemParseFolder" return_type="Boolean">
  1375. <params>
  1376. <param name="pathString" type="String">
  1377. </param>
  1378. <param name="showHidden" type="Boolean">
  1379. </param>
  1380. <param name="targetVector" param_array="true" type="OSFileEntry&">
  1381. </param>
  1382. </params>
  1383. </method>
  1384. <method name="getResourcePathForFile" return_type="String">
  1385. <params>
  1386. <param name="fileName" type="String">
  1387. </param>
  1388. </params>
  1389. </method>
  1390. <method name="setVideoMode" return_type="nil">
  1391. <desc><![CDATA[ Sets a new video mode. ]]></desc>
  1392. <params>
  1393. <param name="xRes" type="Integer">
  1394. <desc><![CDATA[New horizontal resolution of the renderer.]]></desc>
  1395. </param>
  1396. <param name="yRes" type="Integer">
  1397. <desc><![CDATA[New vertical resolution of the renderer.]]></desc>
  1398. </param>
  1399. <param name="fullScreen" type="Boolean">
  1400. <desc><![CDATA[True to launch in fullscreen, false to launch in window.]]></desc>
  1401. </param>
  1402. <param name="vSync" type="Boolean">
  1403. <desc><![CDATA[Level of anti-aliasing. Possible values are 2,4 and 6.]]></desc>
  1404. </param>
  1405. <param name="aaLevel" type="Integer">
  1406. </param>
  1407. <param name="anisotropyLevel" type="Integer">
  1408. </param>
  1409. <param name="retinaSupport" type="Boolean">
  1410. </param>
  1411. </params>
  1412. </method>
  1413. <method name="resizeTo" return_type="nil">
  1414. <desc><![CDATA[ Resizes the renderer. ]]></desc>
  1415. <params>
  1416. <param name="xRes" type="Integer">
  1417. <desc><![CDATA[New horizontal resolution of the renderer.]]></desc>
  1418. </param>
  1419. <param name="yRes" type="Integer">
  1420. <desc><![CDATA[New vertical resolution of the renderer.]]></desc>
  1421. </param>
  1422. </params>
  1423. </method>
  1424. <method name="doSleep" return_type="nil">
  1425. </method>
  1426. <method name="openURL" return_type="nil">
  1427. <desc><![CDATA[ Launches the default browser and directs it to specified URL ]]></desc>
  1428. <params>
  1429. <param name="url" type="String">
  1430. <desc><![CDATA[URL to launch.]]></desc>
  1431. </param>
  1432. </params>
  1433. </method>
  1434. <method name="getElapsed" return_type="Number">
  1435. <desc><![CDATA[ Returns the time elapsed since last frame. ]]></desc>
  1436. </method>
  1437. <method name="getTicks" return_type="Integer">
  1438. <desc><![CDATA[ Returns the total ticks elapsed since launch. ]]></desc>
  1439. </method>
  1440. <method name="getRefreshIntervalMs" return_type="Integer">
  1441. <desc><![CDATA[ Returns the target number of milliseconds between frames ]]></desc>
  1442. </method>
  1443. <method name="getTimeSleptMs" return_type="Integer">
  1444. </method>
  1445. <method name="getFixedTimestep" return_type="Number">
  1446. </method>
  1447. <method name="getTicksFloat" return_type="Number">
  1448. <desc><![CDATA[ Returns the total ticks elapsed since launch. ]]></desc>
  1449. </method>
  1450. <method name="setUserPointer" return_type="nil">
  1451. <params>
  1452. <param name="ptr" type="nil">
  1453. </param>
  1454. </params>
  1455. </method>
  1456. <method name="getUserPointer" return_type="nil">
  1457. </method>
  1458. <method name="executeExternalCommand" return_type="String">
  1459. <params>
  1460. <param name="command" type="String">
  1461. </param>
  1462. <param name="args" type="String">
  1463. </param>
  1464. <param name="inDirectory" type="String">
  1465. </param>
  1466. </params>
  1467. </method>
  1468. <method name="getDefaultWorkingDirectory" return_type="String">
  1469. <desc><![CDATA[ Returns the default working path of the application.]]></desc>
  1470. </method>
  1471. <method name="getUserHomeDirectory" return_type="String">
  1472. <desc><![CDATA[ Returns the default working path of the application.]]></desc>
  1473. </method>
  1474. <method name="makeApplicationMain" return_type="nil">
  1475. <desc><![CDATA[ Brings the application on top (Cocoa only for now).]]></desc>
  1476. </method>
  1477. <method name="getEventMutex" return_type="CoreMutex">
  1478. </method>
  1479. <method name="removeThread" return_type="nil">
  1480. <params>
  1481. <param name="thread" type="Threaded">
  1482. </param>
  1483. </params>
  1484. </method>
  1485. </methods>
  1486. </class>
  1487. <class name="VideoModeChangeInfo">
  1488. <static_members>
  1489. </static_members>
  1490. <members>
  1491. <member name="xRes" type="Integer">
  1492. </member>
  1493. <member name="yRes" type="Integer">
  1494. </member>
  1495. <member name="fullScreen" type="Boolean">
  1496. </member>
  1497. <member name="vSync" type="Boolean">
  1498. </member>
  1499. <member name="aaLevel" type="Integer">
  1500. </member>
  1501. <member name="anisotropyLevel" type="Integer">
  1502. </member>
  1503. <member name="retinaSupport" type="Boolean">
  1504. </member>
  1505. </members>
  1506. <methods>
  1507. </methods>
  1508. </class>
  1509. <class name="PolycodeViewBase">
  1510. <static_members>
  1511. </static_members>
  1512. <members>
  1513. <member name="windowData" type="nil">
  1514. </member>
  1515. <member name="resizable" type="Boolean">
  1516. </member>
  1517. </members>
  1518. <methods>
  1519. <method name="PolycodeViewBase" return_type="nil">
  1520. </method>
  1521. </methods>
  1522. </class>
  1523. <class name="DummyCore" extends="Core">
  1524. <static_members>
  1525. </static_members>
  1526. <members>
  1527. </members>
  1528. <methods>
  1529. <method name="DummyCore" return_type="nil">
  1530. </method>
  1531. <method name="Render" return_type="nil">
  1532. </method>
  1533. <method name="systemUpdate" return_type="Boolean">
  1534. </method>
  1535. <method name="setCursor" return_type="nil">
  1536. <params>
  1537. <param name="cursorType" type="Integer">
  1538. </param>
  1539. </params>
  1540. </method>
  1541. <method name="createThread" return_type="nil">
  1542. <params>
  1543. <param name="target" type="Threaded">
  1544. </param>
  1545. </params>
  1546. </method>
  1547. <method name="createMutex" return_type="CoreMutex">
  1548. </method>
  1549. <method name="copyStringToClipboard" return_type="nil">
  1550. <params>
  1551. <param name="str" type="String">
  1552. </param>
  1553. </params>
  1554. </method>
  1555. <method name="getClipboardString" return_type="String">
  1556. </method>
  1557. <method name="createFolder" return_type="nil">
  1558. <params>
  1559. <param name="folderPath" type="String">
  1560. </param>
  1561. </params>
  1562. </method>
  1563. <method name="copyDiskItem" return_type="nil">
  1564. <params>
  1565. <param name="itemPath" type="String">
  1566. </param>
  1567. <param name="destItemPath" type="String">
  1568. </param>
  1569. </params>
  1570. </method>
  1571. <method name="moveDiskItem" return_type="nil">
  1572. <params>
  1573. <param name="itemPath" type="String">
  1574. </param>
  1575. <param name="destItemPath" type="String">
  1576. </param>
  1577. </params>
  1578. </method>
  1579. <method name="removeDiskItem" return_type="nil">
  1580. <params>
  1581. <param name="itemPath" type="String">
  1582. </param>
  1583. </params>
  1584. </method>
  1585. <method name="openFolderPicker" return_type="String">
  1586. </method>
  1587. <method name="openFilePicker" return_array="true" return_type="String">
  1588. <params>
  1589. <param name="extensions" param_array="true" type="CoreFileExtension">
  1590. </param>
  1591. <param name="allowMultiple" type="Boolean">
  1592. </param>
  1593. </params>
  1594. </method>
  1595. <method name="saveFilePicker" return_type="String">
  1596. <params>
  1597. <param name="extensions" param_array="true" type="CoreFileExtension">
  1598. </param>
  1599. </params>
  1600. </method>
  1601. <method name="handleVideoModeChange" return_type="nil">
  1602. <params>
  1603. <param name="modeInfo" type="VideoModeChangeInfo">
  1604. </param>
  1605. </params>
  1606. </method>
  1607. <method name="flushRenderContext" return_type="nil">
  1608. </method>
  1609. <method name="openURL" return_type="nil">
  1610. <params>
  1611. <param name="url" type="String">
  1612. </param>
  1613. </params>
  1614. </method>
  1615. <method name="getTicks" return_type="Integer">
  1616. </method>
  1617. <method name="executeExternalCommand" return_type="String">
  1618. <params>
  1619. <param name="command" type="String">
  1620. </param>
  1621. <param name="args" type="String">
  1622. </param>
  1623. <param name="inDirectory" type="String">
  1624. </param>
  1625. </params>
  1626. </method>
  1627. <method name="systemParseFolder" return_type="Boolean">
  1628. <params>
  1629. <param name="pathString" type="String">
  1630. </param>
  1631. <param name="showHidden" type="Boolean">
  1632. </param>
  1633. <param name="targetVector" param_array="true" type="OSFileEntry&">
  1634. </param>
  1635. </params>
  1636. </method>
  1637. </methods>
  1638. </class>
  1639. <class name="TimeInfo">
  1640. <static_members>
  1641. </static_members>
  1642. <members>
  1643. <member name="seconds" type="Integer">
  1644. </member>
  1645. <member name="minutes" type="Integer">
  1646. </member>
  1647. <member name="hours" type="Integer">
  1648. </member>
  1649. <member name="month" type="Integer">
  1650. </member>
  1651. <member name="monthDay" type="Integer">
  1652. </member>
  1653. <member name="weekDay" type="Integer">
  1654. </member>
  1655. <member name="year" type="Integer">
  1656. </member>
  1657. <member name="yearDay" type="Integer">
  1658. </member>
  1659. </members>
  1660. <methods>
  1661. <method name="TimeInfo" return_type="nil">
  1662. </method>
  1663. </methods>
  1664. </class>
  1665. <class name="CoreMutex">
  1666. <static_members>
  1667. </static_members>
  1668. <members>
  1669. <member name="mutexID" type="Integer">
  1670. </member>
  1671. </members>
  1672. <methods>
  1673. <method name="lock" return_type="nil">
  1674. </method>
  1675. <method name="unlock" return_type="nil">
  1676. </method>
  1677. </methods>
  1678. </class>
  1679. <class name="CoreMotionEvent" extends="Event">
  1680. <static_members>
  1681. </static_members>
  1682. <members>
  1683. <member name="amount" type="Vector3">
  1684. </member>
  1685. </members>
  1686. <methods>
  1687. </methods>
  1688. </class>
  1689. <class name="CoreFileExtension">
  1690. <static_members>
  1691. </static_members>
  1692. <members>
  1693. <member name="extension" type="String">
  1694. </member>
  1695. <member name="description" type="String">
  1696. </member>
  1697. </members>
  1698. <methods>
  1699. <method name="CoreFileExtension" return_type="nil">
  1700. </method>
  1701. </methods>
  1702. </class>
  1703. <class name="OSFileEntry">
  1704. <static_members>
  1705. <static_member name="TYPE_FILE" type="Integer" value="0">
  1706. </static_member>
  1707. <static_member name="TYPE_FOLDER" type="Integer" value="1">
  1708. </static_member>
  1709. </static_members>
  1710. <members>
  1711. <member name="name" type="String">
  1712. </member>
  1713. <member name="extension" type="String">
  1714. </member>
  1715. <member name="nameWithoutExtension" type="String">
  1716. </member>
  1717. <member name="basePath" type="String">
  1718. </member>
  1719. <member name="fullPath" type="String">
  1720. </member>
  1721. <member name="type" type="Integer">
  1722. </member>
  1723. </members>
  1724. <methods>
  1725. <method name="OSFileEntry" return_type="nil">
  1726. </method>
  1727. <method name="init" return_type="nil">
  1728. <params>
  1729. <param name="path" type="String">
  1730. </param>
  1731. <param name="name" type="String">
  1732. </param>
  1733. <param name="type" type="Integer">
  1734. </param>
  1735. </params>
  1736. </method>
  1737. </methods>
  1738. </class>
  1739. <class name="CoreInput" extends="EventDispatcher">
  1740. <desc><![CDATA[ User input event dispatcher. The Core input class is where all of the input events originate. You can add event listeners to this class to listen for user input events or poll it manually to check the state of user input.]]></desc>
  1741. <static_members>
  1742. <static_member name="MOUSE_BUTTON1" type="Integer" value="0">
  1743. <desc><![CDATA[ Left mouse button.]]></desc>
  1744. </static_member>
  1745. <static_member name="MOUSE_BUTTON2" type="Integer" value="1">
  1746. <desc><![CDATA[ Right mouse button]]></desc>
  1747. </static_member>
  1748. <static_member name="MOUSE_BUTTON3" type="Integer" value="2">
  1749. <desc><![CDATA[ Middle mouse button]]></desc>
  1750. </static_member>
  1751. </static_members>
  1752. <members>
  1753. <member name="simulateTouchWithMouse" type="Boolean">
  1754. <desc><![CDATA[ If set to true, will fire touch events on mouse input. Defaults to false.]]></desc>
  1755. </member>
  1756. <member name="simulateTouchAsPen" type="Boolean">
  1757. <desc><![CDATA[ If set to true, simulated touches will have type TYPE_PEN.]]></desc>
  1758. </member>
  1759. <member name="simulateMouseWithTouch" type="Boolean">
  1760. <desc><![CDATA[ If set to true, will fire mouse events on touch input. Defaults to false.]]></desc>
  1761. </member>
  1762. <member name="ignoreOffScreenTouch" type="Boolean">
  1763. <desc><![CDATA[ If set to true, will not send touch events outside of the screen as define by current core resolution. Defaults to false.]]></desc>
  1764. </member>
  1765. <member name="keyRepeat" type="Boolean">
  1766. <desc><![CDATA[ If set to false, will ignore repeat system keypress events if a key is already pressed-down. Defaults to true.]]></desc>
  1767. </member>
  1768. <member name="mousePosition" type="Vector2">
  1769. </member>
  1770. <member name="deltaMousePosition" type="Vector2">
  1771. </member>
  1772. </members>
  1773. <methods>
  1774. <method name="CoreInput" return_type="nil">
  1775. </method>
  1776. <method name="getMousePosition" return_type="Vector2">
  1777. <desc><![CDATA[ Returns the current mouse position. ]]></desc>
  1778. </method>
  1779. <method name="getKeyState" return_type="Boolean">
  1780. <desc><![CDATA[ Returns the state of the specified key. ]]></desc>
  1781. <params>
  1782. <param name="keyCode" type="PolyKEY">
  1783. <desc><![CDATA[The key to check for]]></desc>
  1784. </param>
  1785. </params>
  1786. </method>
  1787. <method name="getJoystickButtonState" return_type="Boolean">
  1788. <desc><![CDATA[ Returns the state of the specified joystick button for the specified joystick index. If the joystick index is invalid, returns false ]]></desc>
  1789. <params>
  1790. <param name="joystickIndex" type="Integer">
  1791. <desc><![CDATA[Joystick index to check the state on]]></desc>
  1792. </param>
  1793. <param name="button" type="Integer">
  1794. <desc><![CDATA[Joystick button to check the stat of.]]></desc>
  1795. </param>
  1796. </params>
  1797. </method>
  1798. <method name="getJoystickAxisValue" return_type="Number">
  1799. <desc><![CDATA[ Returns the value of the specified joystick axis for the specified joystick index. If the joystick index is invalid, returns 0 ]]></desc>
  1800. <params>
  1801. <param name="joystickIndex" type="Integer">
  1802. <desc><![CDATA[Joystick index to check the state on]]></desc>
  1803. </param>
  1804. <param name="axis" type="Integer">
  1805. <desc><![CDATA[Joystick axis to get the value of.]]></desc>
  1806. </param>
  1807. </params>
  1808. </method>
  1809. <method name="getMouseDelta" return_type="Vector2">
  1810. <desc><![CDATA[ Returns the current mouse position as delta from last frame. ]]></desc>
  1811. </method>
  1812. <method name="getMouseButtonState" return_type="Boolean">
  1813. <desc><![CDATA[ Returns the state of the specified mouse button ]]></desc>
  1814. <params>
  1815. <param name="mouseButton" type="Integer">
  1816. <desc><![CDATA[Mouse button to check the state of. Possible values are CoreInput.MOUSE_BUTTON1, CoreInput.MOUSE_BUTTON2 and CoreInput.MOUSE_BUTTON3]]></desc>
  1817. </param>
  1818. </params>
  1819. </method>
  1820. <method name="getNumJoysticks" return_type="Integer">
  1821. <desc><![CDATA[ Returns the current number of active joysticks. ]]></desc>
  1822. </method>
  1823. <method name="getJoystickInfoByIndex" return_type="JoystickInfo">
  1824. <desc><![CDATA[ Returns joystick info for specified joystick index. ]]></desc>
  1825. <params>
  1826. <param name="index" type="Integer">
  1827. <desc><![CDATA[Joystick index. Returns NULL if index is invalid.]]></desc>
  1828. </param>
  1829. </params>
  1830. </method>
  1831. <method name="getJoystickInfoByID" return_type="JoystickInfo">
  1832. <desc><![CDATA[ Returns joystick info for specified joystick device ID. Returns NULL if the joystick device ID is invalid. ]]></desc>
  1833. <params>
  1834. <param name="deviceID" type="Integer">
  1835. <desc><![CDATA[Joystick device ID.]]></desc>
  1836. </param>
  1837. </params>
  1838. </method>
  1839. <method name="addJoystick" return_type="nil">
  1840. <params>
  1841. <param name="deviceID" type="Integer">
  1842. </param>
  1843. </params>
  1844. </method>
  1845. <method name="removeJoystick" return_type="nil">
  1846. <params>
  1847. <param name="deviceID" type="Integer">
  1848. </param>
  1849. </params>
  1850. </method>
  1851. <method name="joystickAxisMoved" return_type="nil">
  1852. <params>
  1853. <param name="axisID" type="Integer">
  1854. </param>
  1855. <param name="value" type="Number">
  1856. </param>
  1857. <param name="deviceID" type="Integer">
  1858. </param>
  1859. </params>
  1860. </method>
  1861. <method name="joystickButtonDown" return_type="nil">
  1862. <params>
  1863. <param name="buttonID" type="Integer">
  1864. </param>
  1865. <param name="deviceID" type="Integer">
  1866. </param>
  1867. </params>
  1868. </method>
  1869. <method name="joystickButtonUp" return_type="nil">
  1870. <params>
  1871. <param name="buttonID" type="Integer">
  1872. </param>
  1873. <param name="deviceID" type="Integer">
  1874. </param>
  1875. </params>
  1876. </method>
  1877. <method name="mouseWheelUp" return_type="nil">
  1878. <params>
  1879. <param name="ticks" type="Integer">
  1880. </param>
  1881. </params>
  1882. </method>
  1883. <method name="mouseWheelDown" return_type="nil">
  1884. <params>
  1885. <param name="ticks" type="Integer">
  1886. </param>
  1887. </params>
  1888. </method>
  1889. <method name="setMouseButtonState" return_type="nil">
  1890. <params>
  1891. <param name="mouseButton" type="Integer">
  1892. </param>
  1893. <param name="state" type="Boolean">
  1894. </param>
  1895. <param name="ticks" type="Integer">
  1896. </param>
  1897. </params>
  1898. </method>
  1899. <method name="setMousePosition" return_type="nil">
  1900. <params>
  1901. <param name="x" type="Integer">
  1902. </param>
  1903. <param name="y" type="Integer">
  1904. </param>
  1905. <param name="ticks" type="Integer">
  1906. </param>
  1907. </params>
  1908. </method>
  1909. <method name="setKeyState" return_type="nil">
  1910. <params>
  1911. <param name="keyCode" type="PolyKEY">
  1912. </param>
  1913. <param name="code" type="wchar_t">
  1914. </param>
  1915. <param name="newState" type="Boolean">
  1916. </param>
  1917. <param name="ticks" type="Integer">
  1918. </param>
  1919. </params>
  1920. </method>
  1921. <method name="setDeltaPosition" return_type="nil">
  1922. <params>
  1923. <param name="x" type="Integer">
  1924. </param>
  1925. <param name="y" type="Integer">
  1926. </param>
  1927. </params>
  1928. </method>
  1929. <method name="touchesBegan" return_type="nil">
  1930. <params>
  1931. <param name="touch" type="TouchInfo">
  1932. </param>
  1933. <param name="touches" param_array="true" type="TouchInfo">
  1934. </param>
  1935. <param name="ticks" type="Integer">
  1936. </param>
  1937. </params>
  1938. </method>
  1939. <method name="touchesMoved" return_type="nil">
  1940. <params>
  1941. <param name="touch" type="TouchInfo">
  1942. </param>
  1943. <param name="touches" param_array="true" type="TouchInfo">
  1944. </param>
  1945. <param name="ticks" type="Integer">
  1946. </param>
  1947. </params>
  1948. </method>
  1949. <method name="touchesEnded" return_type="nil">
  1950. <params>
  1951. <param name="touch" type="TouchInfo">
  1952. </param>
  1953. <param name="touches" param_array="true" type="TouchInfo">
  1954. </param>
  1955. <param name="ticks" type="Integer">
  1956. </param>
  1957. </params>
  1958. </method>
  1959. <method name="createEvent" return_type="InputEvent" static="true">
  1960. <params>
  1961. <param name="event" type="Event">
  1962. </param>
  1963. </params>
  1964. </method>
  1965. <method name="clearInput" return_type="nil">
  1966. </method>
  1967. </methods>
  1968. </class>
  1969. <class name="JoystickInfo">
  1970. <desc><![CDATA[ Joystick info.]]></desc>
  1971. <static_members>
  1972. </static_members>
  1973. <members>
  1974. <member name="deviceID" type="Integer">
  1975. <desc><![CDATA[ Internal device ID.]]></desc>
  1976. </member>
  1977. <member name="deviceIndex" type="Integer">
  1978. <desc><![CDATA[ Joystick index.]]></desc>
  1979. </member>
  1980. </members>
  1981. <methods>
  1982. <method name="JoystickInfo" return_type="nil">
  1983. </method>
  1984. </methods>
  1985. </class>
  1986. <class name="CoreServices" extends="EventDispatcher">
  1987. <desc><![CDATA[ Global services singleton. CoreServices instantiates and provides global Singleton access to all of the main manager classes in Polycode as well as the Renderer and Config classes.]]></desc>
  1988. <static_members>
  1989. </static_members>
  1990. <members>
  1991. </members>
  1992. <methods>
  1993. <method name="getInstance" return_type="CoreServices" static="true">
  1994. <desc><![CDATA[ Returns the singleton instance. NOTE: The singleton instance is unique to each thread and currently Polycode does not support multithreaded access to the core services. The reason for this is being able to run multiple cores in the same application and still have global singleton access to these services.]]></desc>
  1995. </method>
  1996. <method name="setInstance" return_type="nil" static="true">
  1997. <params>
  1998. <param name="_instance" type="CoreServices">
  1999. </param>
  2000. </params>
  2001. </method>
  2002. <method name="getRenderMutex" return_type="CoreMutex" static="true">
  2003. </method>
  2004. <method name="createInstance" return_type="nil" static="true">
  2005. </method>
  2006. <method name="setRenderer" return_type="nil">
  2007. <params>
  2008. <param name="renderer" type="Renderer">
  2009. </param>
  2010. </params>
  2011. </method>
  2012. <method name="getRenderer" return_type="Renderer">
  2013. <desc><![CDATA[ Returns the main renderer. ]]></desc>
  2014. </method>
  2015. <method name="Update" return_type="nil">
  2016. <params>
  2017. <param name="elapsed" type="Integer">
  2018. </param>
  2019. </params>
  2020. </method>
  2021. <method name="fixedUpdate" return_type="nil">
  2022. </method>
  2023. <method name="Render" return_type="nil">
  2024. <params>
  2025. <param name="viewport" type="Rectangle">
  2026. </param>
  2027. </params>
  2028. </method>
  2029. <method name="setCore" return_type="nil">
  2030. <params>
  2031. <param name="core" type="Core">
  2032. </param>
  2033. </params>
  2034. </method>
  2035. <method name="getCore" return_type="Core">
  2036. <desc><![CDATA[ Returns the core. ]]></desc>
  2037. </method>
  2038. <method name="getInput" return_type="CoreInput">
  2039. <desc><![CDATA[ Returns the core input. ]]></desc>
  2040. </method>
  2041. <method name="getMaterialManager" return_type="MaterialManager">
  2042. <desc><![CDATA[ Returns the material manager. The material manager is responsible for loading and managing textures, shaders and materials. ]]></desc>
  2043. </method>
  2044. <method name="getSceneManager" return_type="SceneManager">
  2045. <desc><![CDATA[ Returns the scene manager. The screen manager is responsible for maintaining and rendering 3D scenes. ]]></desc>
  2046. </method>
  2047. <method name="getTimerManager" return_type="TimerManager">
  2048. <desc><![CDATA[ Returns the timer manager. The timer manager is responsible for updating timers in the framework. ]]></desc>
  2049. </method>
  2050. <method name="getTweenManager" return_type="TweenManager">
  2051. <desc><![CDATA[ Returns the tween manager. The tween manager is responsible for updating animated tweens in the framework. ]]></desc>
  2052. </method>
  2053. <method name="getResourceManager" return_type="ResourceManager">
  2054. <desc><![CDATA[ Returns the resource manager. The resource manager is responsible for loading and unloading resources. ]]></desc>
  2055. </method>
  2056. <method name="getSoundManager" return_type="SoundManager">
  2057. <desc><![CDATA[ Returns the sound manager. The sound manager is responsible for loading and playing sounds. ]]></desc>
  2058. </method>
  2059. <method name="getLogger" return_type="Logger">
  2060. <desc><![CDATA[ Returns the logger. It can log messages and broadcast them to listeners.]]></desc>
  2061. </method>
  2062. <method name="getConfig" return_type="Config">
  2063. <desc><![CDATA[ Returns the config. The config loads and saves data to disk. ]]></desc>
  2064. </method>
  2065. </methods>
  2066. </class>
  2067. <class name="Cubemap" extends="Resource">
  2068. <static_members>
  2069. <static_member name="CUBEMAP_XPOS" type="Integer" value="0">
  2070. </static_member>
  2071. <static_member name="CUBEMAP_XNEG" type="Integer" value="1">
  2072. </static_member>
  2073. <static_member name="CUBEMAP_YPOS" type="Integer" value="2">
  2074. </static_member>
  2075. <static_member name="CUBEMAP_YNEG" type="Integer" value="3">
  2076. </static_member>
  2077. <static_member name="CUBEMAP_ZPOS" type="Integer" value="4">
  2078. </static_member>
  2079. <static_member name="CUBEMAP_ZNEG" type="Integer" value="5">
  2080. </static_member>
  2081. </static_members>
  2082. <members>
  2083. </members>
  2084. <methods>
  2085. <method name="Cubemap" return_type="nil">
  2086. <params>
  2087. <param name="t0" type="Texture">
  2088. </param>
  2089. <param name="t1" type="Texture">
  2090. </param>
  2091. <param name="t2" type="Texture">
  2092. </param>
  2093. <param name="t3" type="Texture">
  2094. </param>
  2095. <param name="t4" type="Texture">
  2096. </param>
  2097. <param name="t5" type="Texture">
  2098. </param>
  2099. </params>
  2100. </method>
  2101. <method name="getTexture" return_type="Texture">
  2102. <params>
  2103. <param name="index" type="Integer">
  2104. </param>
  2105. </params>
  2106. </method>
  2107. <method name="setTexture" return_type="nil">
  2108. <params>
  2109. <param name="texture" type="Texture">
  2110. </param>
  2111. <param name="index" type="Integer">
  2112. </param>
  2113. </params>
  2114. </method>
  2115. <method name="recreateFromTextures" return_type="nil">
  2116. </method>
  2117. </methods>
  2118. </class>
  2119. <class name="Data">
  2120. <desc><![CDATA[ Stores, saves and loads data. This class can save and load arbitrary data to and from disk and convert it to strings.]]></desc>
  2121. <static_members>
  2122. </static_members>
  2123. <members>
  2124. </members>
  2125. <methods>
  2126. <method name="Data" return_type="nil">
  2127. <desc><![CDATA[ Default constructor]]></desc>
  2128. </method>
  2129. <method name="loadFromFile" return_type="Boolean">
  2130. <desc><![CDATA[ Loads data from a file. ]]></desc>
  2131. <params>
  2132. <param name="fileName" type="String">
  2133. <desc><![CDATA[Path to the file to load data from.]]></desc>
  2134. </param>
  2135. </params>
  2136. </method>
  2137. <method name="getAsString" return_type="String">
  2138. <desc><![CDATA[ Retuns data as a string with the specified encoding. ]]></desc>
  2139. <params>
  2140. <param name="encoding" type="Integer">
  2141. <desc><![CDATA[The encoding to use. Currently only supports String.ENCODING_UTF8]]></desc>
  2142. </param>
  2143. </params>
  2144. </method>
  2145. <method name="setFromString" return_type="nil">
  2146. <desc><![CDATA[ Sets the data from a string with the specified encoding. ]]></desc>
  2147. <params>
  2148. <param name="str" type="String">
  2149. <desc><![CDATA[The string to create the data from.]]></desc>
  2150. </param>
  2151. <param name="encoding" type="Integer">
  2152. <desc><![CDATA[The encoding to use. Currently only supports String.ENCODING_UTF8]]></desc>
  2153. </param>
  2154. </params>
  2155. </method>
  2156. <method name="saveToFile" return_type="Boolean">
  2157. <desc><![CDATA[ Saves the data to a file. ]]></desc>
  2158. <params>
  2159. <param name="fileName" type="String">
  2160. <desc><![CDATA[Path to the file to save data to.]]></desc>
  2161. </param>
  2162. </params>
  2163. </method>
  2164. <method name="getData" return_type="char">
  2165. <desc><![CDATA[ Returns pointer to the data. ]]></desc>
  2166. </method>
  2167. </methods>
  2168. </class>
  2169. <class name="MouseEventResult">
  2170. <static_members>
  2171. </static_members>
  2172. <members>
  2173. <member name="hit" type="Boolean">
  2174. </member>
  2175. <member name="blocked" type="Boolean">
  2176. </member>
  2177. </members>
  2178. <methods>
  2179. </methods>
  2180. </class>
  2181. <class name="EntityProp">
  2182. <static_members>
  2183. </static_members>
  2184. <members>
  2185. <member name="propName" type="String">
  2186. </member>
  2187. <member name="propValue" type="String">
  2188. </member>
  2189. </members>
  2190. <methods>
  2191. </methods>
  2192. </class>
  2193. <class name="AABB">
  2194. <static_members>
  2195. </static_members>
  2196. <members>
  2197. <member name="min" type="Vector3">
  2198. </member>
  2199. <member name="max" type="Vector3">
  2200. </member>
  2201. </members>
  2202. <methods>
  2203. </methods>
  2204. </class>
  2205. <class name="Rotation">
  2206. <static_members>
  2207. </static_members>
  2208. <members>
  2209. <member name="pitch" type="Number">
  2210. </member>
  2211. <member name="yaw" type="Number">
  2212. </member>
  2213. <member name="roll" type="Number">
  2214. </member>
  2215. </members>
  2216. <methods>
  2217. <method name="Rotation" return_type="nil">
  2218. </method>
  2219. </methods>
  2220. </class>
  2221. <class name="Entity" extends="EventDispatcher">
  2222. <desc><![CDATA[ Base class for both 2D and 3D objects in Polycode. It provides position and color transformations as well as hierarchy for all Polycode objects.]]></desc>
  2223. <class_notes>NOTE: Entity instances are not automatically garbage collected.</class_notes>
  2224. <static_members>
  2225. </static_members>
  2226. <members>
  2227. <member name="ownsChildren" type="Boolean">
  2228. <desc><![CDATA[ If set to true, will automatically delete children upon destruction. (defaults to false).]]></desc>
  2229. </member>
  2230. <member name="billboardMode" type="Boolean">
  2231. <desc><![CDATA[ @name Rendering properties Methods and properties affecting the way the entity is rendered. If this flag is true, the entity will always face the camera. False by default.]]></desc>
  2232. </member>
  2233. <member name="color" type="Color">
  2234. <desc><![CDATA[ The entity's color.]]></desc>
  2235. </member>
  2236. <member name="enabled" type="Boolean">
  2237. <desc><![CDATA[ If this flag is set to false, this entity will not be rendered or updated.]]></desc>
  2238. </member>
  2239. <member name="visible" type="Boolean">
  2240. <desc><![CDATA[ If this flag is set to false, this entity will not be rendered.]]></desc>
  2241. </member>
  2242. <member name="depthWrite" type="Boolean">
  2243. <desc><![CDATA[ If this flag is set to false, this entity will not write to the depth buffer when it's rendered.]]></desc>
  2244. </member>
  2245. <member name="depthTest" type="Boolean">
  2246. <desc><![CDATA[ If this flag is set to false, this entity will not check the depth buffer when it's rendering.]]></desc>
  2247. </member>
  2248. <member name="colorAffectsChildren" type="Boolean">
  2249. <desc><![CDATA[ If set to false, the children of this entity will not multiply by this entity's color. Set to true by default.]]></desc>
  2250. </member>
  2251. <member name="visibilityAffectsChildren" type="Boolean">
  2252. <desc><![CDATA[ If set to false, the children will be rendered even if the entity is invisible.]]></desc>
  2253. </member>
  2254. <member name="ignoreParentMatrix" type="Boolean">
  2255. <desc><![CDATA[ If set to true, the entity's transformations will not be affected by its parents. Defaults to false.]]></desc>
  2256. </member>
  2257. <member name="enableScissor" type="Boolean">
  2258. <desc><![CDATA[ If set to true, will constrain the rendering of this entity into the viewport coordinates defined by scissorBox. @see scissorBox]]></desc>
  2259. </member>
  2260. <member name="scissorBox" type="Rectangle">
  2261. <desc><![CDATA[ Defines the viewport coordinates to clip rendering to if enableScissor is defined. @see enableScissor]]></desc>
  2262. </member>
  2263. <member name="editorOnly" type="Boolean">
  2264. <desc><![CDATA[ Flags an editor only entity. If set to true, this entity will not be saved to file by entity instances or show up in the IDE entity editor.]]></desc>
  2265. </member>
  2266. <member name="id" type="String">
  2267. <desc><![CDATA[ String ID of the entity. Can be used to retrieve specific entities by their ID.]]></desc>
  2268. </member>
  2269. <member name="collisionShapeType" type="char">
  2270. <desc><![CDATA[ Entity collision type for physics module. This is set per physics module documentaiton.]]></desc>
  2271. </member>
  2272. <member name="processInputEvents" type="Boolean">
  2273. <desc><![CDATA[ If set to true, will automatically process mouse events and dispatch its own input events if mouse events intersect with the entity's bounding box. Defaults to false. Attention: All of the entity's parents' processInputEvents flags must be set to true for this to function including the parent Scene's rootEntity!]]></desc>
  2274. </member>
  2275. <member name="blockMouseInput" type="Boolean">
  2276. <desc><![CDATA[ If set to true, will block input events for entities below itself in the parent's entiy list.]]></desc>
  2277. </member>
  2278. <member name="snapToPixels" type="Boolean">
  2279. <desc><![CDATA[ If set to true, will round the position of this entity to integral values. Use this if you need pixel-perfect positioning in 2D.]]></desc>
  2280. </member>
  2281. <member name="mouseOver" type="Boolean">
  2282. </member>
  2283. <member name="rendererVis" type="Boolean">
  2284. </member>
  2285. <member name="layerID" type="char">
  2286. <desc><![CDATA[ Layer ID. Used by entity instances to separate entities into groups.]]></desc>
  2287. </member>
  2288. </members>
  2289. <methods>
  2290. <method name="Entity" return_type="nil">
  2291. </method>
  2292. <method name="initEntity" return_type="nil">
  2293. </method>
  2294. <method name="Render" return_type="nil">
  2295. <desc><![CDATA[ Main render method. Override this to do your own drawing.]]></desc>
  2296. <params>
  2297. <param name="buffer" type="GPUDrawBuffer">
  2298. </param>
  2299. </params>
  2300. </method>
  2301. <method name="Update" return_type="nil">
  2302. <desc><![CDATA[ Main update method. Override this to do your updates before the render cycle.]]></desc>
  2303. </method>
  2304. <method name="fixedUpdate" return_type="nil">
  2305. </method>
  2306. <method name="transformAndRender" return_type="nil">
  2307. <params>
  2308. <param name="drawBuffer" type="GPUDrawBuffer">
  2309. </param>
  2310. <param name="parentScissorBox" type="Rectangle">
  2311. </param>
  2312. </params>
  2313. </method>
  2314. <method name="renderChildren" return_type="nil">
  2315. <params>
  2316. <param name="buffer" type="GPUDrawBuffer">
  2317. </param>
  2318. <param name="parentScissorBox" type="Rectangle">
  2319. </param>
  2320. </params>
  2321. </method>
  2322. <method name="Clone" return_type="Entity">
  2323. <desc><![CDATA[ Clones the entity, return an exact copy. This method must be implemented in an Entity subclass for you to be able to clone it. ]]></desc>
  2324. <params>
  2325. <param name="deepClone" type="Boolean">
  2326. <desc><![CDATA[If true, perform a deep clone, cloning all the children.]]></desc>
  2327. </param>
  2328. <param name="ignoreEditorOnly" type="Boolean">
  2329. <desc><![CDATA[If true, ignore all child entities where editorOnly is set to true (will still clone the entity you call Clone() on even if its editorOnly flag is set to true.]]></desc>
  2330. </param>
  2331. </params>
  2332. </method>
  2333. <method name="applyClone" return_type="nil">
  2334. <desc><![CDATA[ This method must be implemented by all subclasses implementing Clone.]]></desc>
  2335. <params>
  2336. <param name="clone" type="Entity">
  2337. </param>
  2338. <param name="deepClone" type="Boolean">
  2339. </param>
  2340. <param name="ignoreEditorOnly" type="Boolean">
  2341. </param>
  2342. </params>
  2343. </method>
  2344. <method name="dirtyMatrix" return_type="nil">
  2345. <desc><![CDATA[ @name Matrix operations. These methods operate directly on the entity's matrix. Sets the state of the dirty matrix flag. The dirty matrix flag gets set automatically when a transformation is applied to the entity and the transfrom matrix needs to be rebuilt. This method is provided to manually override that flag.]]></desc>
  2346. <params>
  2347. <param name="val" type="Boolean">
  2348. <desc><![CDATA[New value of the dirty matrix flag.]]></desc>
  2349. </param>
  2350. </params>
  2351. </method>
  2352. <method name="rebuildTransformMatrix" return_type="nil">
  2353. <desc><![CDATA[ Forces the transformation matrix to be rebuilt.]]></desc>
  2354. </method>
  2355. <method name="updateEntityMatrix" return_type="nil">
  2356. <desc><![CDATA[ Forces the matrix to be rebuilt if the matrix flag is dirty. This is also called on all of the entity's children.]]></desc>
  2357. </method>
  2358. <method name="getTransformMatrix" return_type="Matrix4">
  2359. <desc><![CDATA[ Returns the entity's transform matrix.]]></desc>
  2360. </method>
  2361. <method name="getConcatenatedMatrix" return_type="Matrix4">
  2362. <desc><![CDATA[ Returns the entity's matrix multiplied by its parent's concatenated matrix. This, in effect, returns the entity's actual world transformation.]]></desc>
  2363. </method>
  2364. <method name="getConcatenatedMatrixRelativeTo" return_type="Matrix4">
  2365. <desc><![CDATA[ Returns the concatenated matrix up to the specified parent entity. ]]></desc>
  2366. <params>
  2367. <param name="relativeEntity" type="Entity">
  2368. <desc><![CDATA[Parent entity, relative to which to return the transform matrix.]]></desc>
  2369. </param>
  2370. </params>
  2371. </method>
  2372. <method name="getAnchorAdjustedMatrix" return_type="Matrix4">
  2373. <desc><![CDATA[ Returns the concatenated matrix, multiplied by the entity's anchor adjustment. @see setAnchorPoint]]></desc>
  2374. </method>
  2375. <method name="getConcatenatedRollMatrix" return_type="Matrix4">
  2376. <desc><![CDATA[ Returns Same as getConcatenatedMatrix(), but contains only roll information for rotation. Used internally for billboards.]]></desc>
  2377. </method>
  2378. <method name="setTransformByMatrixPure" return_type="nil">
  2379. <desc><![CDATA[ Sets the transform matrix directly, without setting all of the individual transfrom properties of the entity.]]></desc>
  2380. <params>
  2381. <param name="matrix" type="Matrix4">
  2382. <desc><![CDATA[4x4 transform matrix to apply.]]></desc>
  2383. </param>
  2384. </params>
  2385. </method>
  2386. <method name="getLookAtMatrix" return_type="Matrix4">
  2387. <desc><![CDATA[ Returns the matrix for the entity looking at a location based on a location and an up vector. ]]></desc>
  2388. <params>
  2389. <param name="loc" type="Vector3">
  2390. <desc><![CDATA[Location to look at.]]></desc>
  2391. </param>
  2392. <param name="upVector" type="Vector3">
  2393. <desc><![CDATA[Up vector.]]></desc>
  2394. </param>
  2395. </params>
  2396. </method>
  2397. <method name="addChild" return_type="nil">
  2398. <desc><![CDATA[ @name Hierarchy operations. These methods add and remove entities to and from each other. Adds another entity as a child. The children inherit the parent's transforms.]]></desc>
  2399. <params>
  2400. <param name="newChild" type="Entity">
  2401. <desc><![CDATA[The entity to be added.]]></desc>
  2402. </param>
  2403. </params>
  2404. </method>
  2405. <method name="removeChild" return_type="nil">
  2406. <desc><![CDATA[ Removes an entity from the entity's children.]]></desc>
  2407. <params>
  2408. <param name="entityToRemove" type="Entity">
  2409. <desc><![CDATA[Entity to be removed.]]></desc>
  2410. </param>
  2411. </params>
  2412. </method>
  2413. <method name="moveChildUp" return_type="nil">
  2414. <desc><![CDATA[ Moves the specified child one position up the render list.]]></desc>
  2415. <params>
  2416. <param name="child" type="Entity">
  2417. </param>
  2418. </params>
  2419. </method>
  2420. <method name="moveChildDown" return_type="nil">
  2421. <desc><![CDATA[ Moves the specified child one position down the render list.]]></desc>
  2422. <params>
  2423. <param name="child" type="Entity">
  2424. </param>
  2425. </params>
  2426. </method>
  2427. <method name="moveChildTop" return_type="nil">
  2428. <desc><![CDATA[ Moves the specified child up to the top of the render list.]]></desc>
  2429. <params>
  2430. <param name="child" type="Entity">
  2431. </param>
  2432. </params>
  2433. </method>
  2434. <method name="moveChildBottom" return_type="nil">
  2435. <desc><![CDATA[ Moves the specified child up to the bottom of the render list.]]></desc>
  2436. <params>
  2437. <param name="child" type="Entity">
  2438. </param>
  2439. </params>
  2440. </method>
  2441. <method name="setParentEntity" return_type="nil">
  2442. <desc><![CDATA[ Manually sets the entity's parent. This method does not add the entity to the parent and should not be called manually.]]></desc>
  2443. <params>
  2444. <param name="entity" type="Entity">
  2445. <desc><![CDATA[Parent entity.]]></desc>
  2446. </param>
  2447. </params>
  2448. </method>
  2449. <method name="getParentEntity" return_type="Entity">
  2450. <desc><![CDATA[ Returns the parent entity of the entity.]]></desc>
  2451. </method>
  2452. <method name="getNumChildren" return_type="Integer">
  2453. <desc><![CDATA[ Returns the number of child entities belonging to this entity. ]]></desc>
  2454. </method>
  2455. <method name="getChildAtIndex" return_type="Entity">
  2456. <desc><![CDATA[ Returns the child entity at specified index. ]]></desc>
  2457. <params>
  2458. <param name="index" type="Integer">
  2459. <desc><![CDATA[Index to return entity at.]]></desc>
  2460. </param>
  2461. </params>
  2462. </method>
  2463. <method name="setOwnsChildrenRecursive" return_type="nil">
  2464. <desc><![CDATA[ Sets the ownsChildren flag for this entity and recursively for all its child entities. @see ownsChildren]]></desc>
  2465. <params>
  2466. <param name="val" type="Boolean">
  2467. </param>
  2468. </params>
  2469. </method>
  2470. <method name="getPosition" return_type="Vector3">
  2471. <desc><![CDATA[ @name Transform operations. These methods apply various transformations to the entity. Returns the entity's position.]]></desc>
  2472. </method>
  2473. <method name="getPosition2D" return_type="Vector2">
  2474. <desc><![CDATA[ Returns the entity's position as a Vector2]]></desc>
  2475. </method>
  2476. <method name="getCombinedPosition" return_type="Vector3">
  2477. <desc><![CDATA[ Returns the entity's position added to the combined position of its parent. This method is here only for convenience of calculating certain properties and should not be used to get an entity's actual position in the world. To get the actual world position of the entity, use the entity's concatendated matrix.@see getConcatenatedMatrix()]]></desc>
  2478. </method>
  2479. <method name="setPosition" return_type="nil">
  2480. <desc><![CDATA[ Sets the entity's position.]]></desc>
  2481. <params>
  2482. <param name="x" type="Number">
  2483. <desc><![CDATA[X-axis value.]]></desc>
  2484. </param>
  2485. <param name="y" type="Number">
  2486. <desc><![CDATA[Y-axis value.]]></desc>
  2487. </param>
  2488. <param name="z" type="Number">
  2489. <desc><![CDATA[Z-axis value.]]></desc>
  2490. </param>
  2491. </params>
  2492. </method>
  2493. <method name="setPositionX" return_type="nil">
  2494. <desc><![CDATA[ Returns the entity's position on the X axis.]]></desc>
  2495. <params>
  2496. <param name="x" type="Number">
  2497. <desc><![CDATA[X-axis value.]]></desc>
  2498. </param>
  2499. </params>
  2500. </method>
  2501. <method name="setPositionY" return_type="nil">
  2502. <desc><![CDATA[ Returns the entity's position on the Y axis.]]></desc>
  2503. <params>
  2504. <param name="y" type="Number">
  2505. <desc><![CDATA[Y-axis value.]]></desc>
  2506. </param>
  2507. </params>
  2508. </method>
  2509. <method name="Translate" return_type="nil">
  2510. <desc><![CDATA[ Translates the entity relative to its current position.]]></desc>
  2511. <params>
  2512. <param name="x" type="Number">
  2513. <desc><![CDATA[X-axis value.]]></desc>
  2514. </param>
  2515. <param name="y" type="Number">
  2516. <desc><![CDATA[Y-axis value.]]></desc>
  2517. </param>
  2518. <param name="z" type="Number">
  2519. <desc><![CDATA[Z-axis value.]]></desc>
  2520. </param>
  2521. </params>
  2522. </method>
  2523. <method name="setPositionZ" return_type="nil">
  2524. <desc><![CDATA[ Returns the entity's position on the Z axis.]]></desc>
  2525. <params>
  2526. <param name="z" type="Number">
  2527. <desc><![CDATA[Z-axis value.]]></desc>
  2528. </param>
  2529. </params>
  2530. </method>
  2531. <method name="setScaleX" return_type="nil">
  2532. <desc><![CDATA[ Returns the entity's scale on the X axis.]]></desc>
  2533. <params>
  2534. <param name="x" type="Number">
  2535. <desc><![CDATA[X-axis scale value.]]></desc>
  2536. </param>
  2537. </params>
  2538. </method>
  2539. <method name="setScaleY" return_type="nil">
  2540. <desc><![CDATA[ Returns the entity's scale on the Y axis.]]></desc>
  2541. <params>
  2542. <param name="y" type="Number">
  2543. <desc><![CDATA[Y-axis scale value.]]></desc>
  2544. </param>
  2545. </params>
  2546. </method>
  2547. <method name="setScaleZ" return_type="nil">
  2548. <desc><![CDATA[ Returns the entity's scale on the Z axis.]]></desc>
  2549. <params>
  2550. <param name="z" type="Number">
  2551. <desc><![CDATA[Z-axis scale value.]]></desc>
  2552. </param>
  2553. </params>
  2554. </method>
  2555. <method name="Scale" return_type="nil">
  2556. <desc><![CDATA[ Scales the entity relative to its current scale.]]></desc>
  2557. <params>
  2558. <param name="x" type="Number">
  2559. <desc><![CDATA[X-axis value.]]></desc>
  2560. </param>
  2561. <param name="y" type="Number">
  2562. <desc><![CDATA[Y-axis value.]]></desc>
  2563. </param>
  2564. <param name="z" type="Number">
  2565. <desc><![CDATA[Z-axis value.]]></desc>
  2566. </param>
  2567. </params>
  2568. </method>
  2569. <method name="setScale" return_type="nil">
  2570. <desc><![CDATA[ Sets the entity's scale.]]></desc>
  2571. <params>
  2572. <param name="x" type="Number">
  2573. <desc><![CDATA[X-axis value.]]></desc>
  2574. </param>
  2575. <param name="y" type="Number">
  2576. <desc><![CDATA[Y-axis value.]]></desc>
  2577. </param>
  2578. <param name="z" type="Number">
  2579. <desc><![CDATA[Z-axis value.]]></desc>
  2580. </param>
  2581. </params>
  2582. </method>
  2583. <method name="getCompoundScale" return_type="Vector3">
  2584. <desc><![CDATA[ Returns the entity's scale multiplied by its parent's compound scale. ]]></desc>
  2585. </method>
  2586. <method name="getScale" return_type="Vector3">
  2587. <desc><![CDATA[ Returns the entity's scale.]]></desc>
  2588. </method>
  2589. <method name="getRotationEuler" return_type="Vector3">
  2590. <desc><![CDATA[ Returns the entity's rotation as euler angles ]]></desc>
  2591. </method>
  2592. <method name="getCombinedPitch" return_type="Number">
  2593. <desc><![CDATA[ Returns the entity's pitch combined with the combined pitch of its parent.]]></desc>
  2594. </method>
  2595. <method name="getCombinedYaw" return_type="Number">
  2596. <desc><![CDATA[ Returns the entity's yaw combined with the combined yaw of its parent.]]></desc>
  2597. </method>
  2598. <method name="getCombinedRoll" return_type="Number">
  2599. <desc><![CDATA[ Returns the entity's roll combined with the combined roll of its parent.]]></desc>
  2600. </method>
  2601. <method name="rebuildRotation" return_type="nil">
  2602. <desc><![CDATA[ Forces the rotation quaternion to be rebuilt.]]></desc>
  2603. </method>
  2604. <method name="setRotationEuler" return_type="nil">
  2605. <desc><![CDATA[ Sets rotation from euler angles ]]></desc>
  2606. <params>
  2607. <param name="rotation" type="Vector3">
  2608. <desc><![CDATA[New rotation values]]></desc>
  2609. </param>
  2610. </params>
  2611. </method>
  2612. <method name="setPitch" return_type="nil">
  2613. <desc><![CDATA[ Sets the pitch rotation of the entity. ]]></desc>
  2614. <params>
  2615. <param name="pitch" type="Number">
  2616. <desc><![CDATA[New pitch value in degrees.]]></desc>
  2617. </param>
  2618. </params>
  2619. </method>
  2620. <method name="setYaw" return_type="nil">
  2621. <desc><![CDATA[ Sets the yaw rotation of the entity. ]]></desc>
  2622. <params>
  2623. <param name="yaw" type="Number">
  2624. <desc><![CDATA[New yaw value in degrees.]]></desc>
  2625. </param>
  2626. </params>
  2627. </method>
  2628. <method name="setRoll" return_type="nil">
  2629. <desc><![CDATA[ Sets the roll rotation of the entity. ]]></desc>
  2630. <params>
  2631. <param name="roll" type="Number">
  2632. <desc><![CDATA[New roll value in degrees.]]></desc>
  2633. </param>
  2634. </params>
  2635. </method>
  2636. <method name="Roll" return_type="nil">
  2637. <desc><![CDATA[ Rolls the entity relative to its current roll. ]]></desc>
  2638. <params>
  2639. <param name="roll" type="Number">
  2640. <desc><![CDATA[Roll value in degrees.]]></desc>
  2641. </param>
  2642. </params>
  2643. </method>
  2644. <method name="Yaw" return_type="nil">
  2645. <desc><![CDATA[ Yaws the entity relative to its current yaw. ]]></desc>
  2646. <params>
  2647. <param name="yaw" type="Number">
  2648. <desc><![CDATA[Yaw value in degrees.]]></desc>
  2649. </param>
  2650. </params>
  2651. </method>
  2652. <method name="Pitch" return_type="nil">
  2653. <desc><![CDATA[ Pitches the entity relative to its current pitch. ]]></desc>
  2654. <params>
  2655. <param name="pitch" type="Number">
  2656. <desc><![CDATA[Pitch value in degrees.]]></desc>
  2657. </param>
  2658. </params>
  2659. </method>
  2660. <method name="getPitch" return_type="Number">
  2661. <desc><![CDATA[ Returns the current pitch of the entity. ]]></desc>
  2662. </method>
  2663. <method name="getYaw" return_type="Number">
  2664. <desc><![CDATA[ Returns the current yaw of the entity. ]]></desc>
  2665. </method>
  2666. <method name="getRoll" return_type="Number">
  2667. <desc><![CDATA[ Returns the current roll of the entity. ]]></desc>
  2668. </method>
  2669. <method name="getWidth" return_type="Number">
  2670. <desc><![CDATA[ Returns the bounding box X value.]]></desc>
  2671. </method>
  2672. <method name="getHeight" return_type="Number">
  2673. <desc><![CDATA[ Returns the bounding box Y value.]]></desc>
  2674. </method>
  2675. <method name="getDepth" return_type="Number">
  2676. <desc><![CDATA[ Returns the bounding box Z value.]]></desc>
  2677. </method>
  2678. <method name="setWidth" return_type="nil">
  2679. <desc><![CDATA[ Sets the bounding box X value.]]></desc>
  2680. <params>
  2681. <param name="width" type="Number">
  2682. </param>
  2683. </params>
  2684. </method>
  2685. <method name="setHeight" return_type="nil">
  2686. <desc><![CDATA[ Sets the bounding box Y value.]]></desc>
  2687. <params>
  2688. <param name="height" type="Number">
  2689. </param>
  2690. </params>
  2691. </method>
  2692. <method name="setDepth" return_type="nil">
  2693. <desc><![CDATA[ Sets the bounding box Z value.]]></desc>
  2694. <params>
  2695. <param name="depth" type="Number">
  2696. </param>
  2697. </params>
  2698. </method>
  2699. <method name="setRotationQuat" return_type="nil">
  2700. <desc><![CDATA[ Sets the rotation with quaternion value.]]></desc>
  2701. <params>
  2702. <param name="w" type="Number">
  2703. </param>
  2704. <param name="x" type="Number">
  2705. </param>
  2706. <param name="y" type="Number">
  2707. </param>
  2708. <param name="z" type="Number">
  2709. </param>
  2710. </params>
  2711. </method>
  2712. <method name="setRotationByQuaternion" return_type="nil">
  2713. <params>
  2714. <param name="quaternion" type="Quaternion">
  2715. </param>
  2716. </params>
  2717. </method>
  2718. <method name="getRotationQuat" return_type="Quaternion">
  2719. <desc><![CDATA[ Returns the current rotation as a quaternion. ]]></desc>
  2720. </method>
  2721. <method name="getConcatenatedQuat" return_type="Quaternion">
  2722. </method>
  2723. <method name="lookAt" return_type="nil">
  2724. <desc><![CDATA[ Orients the entity towards the specified location with the provided up vector. The up vector determines which side of the entity will be pointing in that direction. ]]></desc>
  2725. <params>
  2726. <param name="loc" type="Vector3">
  2727. <desc><![CDATA[Location to look at.]]></desc>
  2728. </param>
  2729. <param name="upVector" type="Vector3">
  2730. <desc><![CDATA[The up vector.]]></desc>
  2731. </param>
  2732. </params>
  2733. </method>
  2734. <method name="lookAtEntity" return_type="nil">
  2735. <desc><![CDATA[ Orients the entity towards another entity with the provided up vector. The up vector determines which side of the entity will be pointing in that direction. ]]></desc>
  2736. <params>
  2737. <param name="entity" type="Entity">
  2738. <desc><![CDATA[Entity to look at.]]></desc>
  2739. </param>
  2740. <param name="upVector" type="Vector3">
  2741. <desc><![CDATA[The up vector. @see lookAt()]]></desc>
  2742. </param>
  2743. </params>
  2744. </method>
  2745. <method name="getCombinedColor" return_type="Color">
  2746. <desc><![CDATA[ Returns the entity's color multiplied by its parent entity's combined color. ]]></desc>
  2747. </method>
  2748. <method name="setColor" return_type="nil">
  2749. <desc><![CDATA[ Sets the color of the entity as normalized floating point values. ]]></desc>
  2750. <params>
  2751. <param name="r" type="Number">
  2752. <desc><![CDATA[Red value as a 0-1 floating point number.]]></desc>
  2753. </param>
  2754. <param name="g" type="Number">
  2755. <desc><![CDATA[Green value as a 0-1 floating point number.]]></desc>
  2756. </param>
  2757. <param name="b" type="Number">
  2758. <desc><![CDATA[Blue value as a 0-1 floating point number.]]></desc>
  2759. </param>
  2760. <param name="a" type="Number">
  2761. <desc><![CDATA[Alpha value as a 0-1 floating point number.]]></desc>
  2762. </param>
  2763. </params>
  2764. </method>
  2765. <method name="setColorInt" return_type="nil">
  2766. <desc><![CDATA[ Sets the color of the entity as 0-255 integers. ]]></desc>
  2767. <params>
  2768. <param name="r" type="Integer">
  2769. <desc><![CDATA[Red value as a 0-255 integer.]]></desc>
  2770. </param>
  2771. <param name="g" type="Integer">
  2772. <desc><![CDATA[Green value as a 0-255 integer.]]></desc>
  2773. </param>
  2774. <param name="b" type="Integer">
  2775. <desc><![CDATA[Blue value as a 0-255 integer.]]></desc>
  2776. </param>
  2777. <param name="a" type="Integer">
  2778. <desc><![CDATA[Alpha value as a 0-255 integer.]]></desc>
  2779. </param>
  2780. </params>
  2781. </method>
  2782. <method name="setAnchorPoint" return_type="nil">
  2783. <desc><![CDATA[ Sets the anchor (center) point of the entity as normalized half bounding box coordinates. (i.e. -1.0 or 1.0 will offset the entity by half on a particular axis). ]]></desc>
  2784. <params>
  2785. <param name="anchorPoint" type="Vector3">
  2786. <desc><![CDATA[Anchor point as a 3D Vector.]]></desc>
  2787. </param>
  2788. </params>
  2789. </method>
  2790. <method name="getAnchorPoint" return_type="Vector3">
  2791. <desc><![CDATA[ Returns the current anchor (center) point of the entity.]]></desc>
  2792. </method>
  2793. <method name="onMouseDown" return_type="MouseEventResult">
  2794. <params>
  2795. <param name="ray" type="Ray">
  2796. </param>
  2797. <param name="mouseButton" type="Integer">
  2798. </param>
  2799. <param name="timestamp" type="Integer">
  2800. </param>
  2801. </params>
  2802. </method>
  2803. <method name="onMouseUp" return_type="MouseEventResult">
  2804. <params>
  2805. <param name="ray" type="Ray">
  2806. </param>
  2807. <param name="mouseButton" type="Integer">
  2808. </param>
  2809. <param name="timestamp" type="Integer">
  2810. </param>
  2811. </params>
  2812. </method>
  2813. <method name="onMouseMove" return_type="MouseEventResult">
  2814. <params>
  2815. <param name="ray" type="Ray">
  2816. </param>
  2817. <param name="timestamp" type="Integer">
  2818. </param>
  2819. </params>
  2820. </method>
  2821. <method name="onMouseWheelUp" return_type="MouseEventResult">
  2822. <params>
  2823. <param name="ray" type="Ray">
  2824. </param>
  2825. <param name="timestamp" type="Integer">
  2826. </param>
  2827. </params>
  2828. </method>
  2829. <method name="onMouseWheelDown" return_type="MouseEventResult">
  2830. <params>
  2831. <param name="ray" type="Ray">
  2832. </param>
  2833. <param name="timestamp" type="Integer">
  2834. </param>
  2835. </params>
  2836. </method>
  2837. <method name="setDepthOnly" return_type="nil">
  2838. <desc><![CDATA[ If this flag is set to true, this entity will render only into the depth buffer. This, effectively, means that it will be invisible, but still obscuring other entities.]]></desc>
  2839. <params>
  2840. <param name="val" type="Boolean">
  2841. </param>
  2842. </params>
  2843. </method>
  2844. <method name="getDepthOnly" return_type="Boolean">
  2845. </method>
  2846. <method name="setUserData" return_type="nil">
  2847. <desc><![CDATA[ If this flag is set to true, this entity's transformations will not take into account its parent, making its transforms always relative to 0. Sets user data pointer. ]]></desc>
  2848. <params>
  2849. <param name="userData" type="nil">
  2850. <desc><![CDATA[User data pointer]]></desc>
  2851. </param>
  2852. </params>
  2853. </method>
  2854. <method name="getUserData" return_type="nil">
  2855. <desc><![CDATA[ Returns the user data pointer. ]]></desc>
  2856. </method>
  2857. <method name="setBlendingMode" return_type="nil">
  2858. <desc><![CDATA[ Sets the entity's blending mode. ]]></desc>
  2859. <params>
  2860. <param name="newBlendingMode" type="Integer">
  2861. <desc><![CDATA[New blending mode to set. Possible values are Renderer.BLEND_MODE_NORMAL, Renderer.BLEND_MODE_LIGHTEN, Renderer.BLEND_MODE_COLOR, Renderer.BLEND_MODE_PREMULTIPLIED, Renderer.BLEND_MODE_MULTIPLY. See the Renderer class for details on individual blending modes. @see Renderer]]></desc>
  2862. </param>
  2863. </params>
  2864. </method>
  2865. <method name="getBlendingMode" return_type="Integer">
  2866. </method>
  2867. <method name="getEntityById" return_type="Entity">
  2868. <desc><![CDATA[ Returns the first child entity that has the specified string id. ]]></desc>
  2869. <params>
  2870. <param name="id" type="String">
  2871. <desc><![CDATA[Specified id to search for.]]></desc>
  2872. </param>
  2873. <param name="recursive" type="Boolean">
  2874. <desc><![CDATA[If set to true, will search all child entities recursively.]]></desc>
  2875. </param>
  2876. </params>
  2877. </method>
  2878. <method name="getEntitiesByTag" return_array="true" return_type="Entity">
  2879. <desc><![CDATA[ Returns all child entities which have the specified tag. ]]></desc>
  2880. <params>
  2881. <param name="tag" type="String">
  2882. <desc><![CDATA[Tag to search for.]]></desc>
  2883. </param>
  2884. <param name="recursive" type="Boolean">
  2885. <desc><![CDATA[If set to true, will search all child entities recursively.]]></desc>
  2886. </param>
  2887. </params>
  2888. </method>
  2889. <method name="getEntitiesByLayerID" return_array="true" return_type="Entity">
  2890. <desc><![CDATA[ Returns all child entities that have the specified layer ID. Layer IDs are used by the entity instances to separate entities into groups. ]]></desc>
  2891. <params>
  2892. <param name="layerID" type="char">
  2893. <desc><![CDATA[ID to search for.]]></desc>
  2894. </param>
  2895. <param name="recursive" type="Boolean">
  2896. <desc><![CDATA[If set to true, will search all child entities recursively.]]></desc>
  2897. </param>
  2898. </params>
  2899. </method>
  2900. <method name="getEntityProp" return_type="String">
  2901. <desc><![CDATA[ Returns custom string dictionary property of the entity based on the property name. ]]></desc>
  2902. <params>
  2903. <param name="propName" type="String">
  2904. <desc><![CDATA[name to look up.]]></desc>
  2905. </param>
  2906. </params>
  2907. </method>
  2908. <method name="setEntityProp" return_type="nil">
  2909. <desc><![CDATA[ Sets the entity property for a specified property name in the entity's custom property dictionary. ]]></desc>
  2910. <params>
  2911. <param name="propName" type="String">
  2912. <desc><![CDATA[Property name to set.]]></desc>
  2913. </param>
  2914. <param name="propValue" type="String">
  2915. <desc><![CDATA[Value to set for the specified property name.]]></desc>
  2916. </param>
  2917. </params>
  2918. </method>
  2919. <method name="setInverseY" return_type="nil">
  2920. <desc><![CDATA[ If set to true, the y position of the entity matrix will be multiplied by -1.0, inverting its Y-axis coordinate system.]]></desc>
  2921. <params>
  2922. <param name="val" type="Boolean">
  2923. </param>
  2924. </params>
  2925. </method>
  2926. <method name="getInverseY" return_type="Boolean">
  2927. <desc><![CDATA[ Returns true if the entity is set to use an inverse Y-coordinate system.]]></desc>
  2928. </method>
  2929. <method name="doUpdates" return_type="nil">
  2930. </method>
  2931. <method name="doFixedUpdates" return_type="nil">
  2932. </method>
  2933. <method name="buildPositionMatrix" return_type="Matrix4">
  2934. </method>
  2935. <method name="setRenderer" return_type="nil">
  2936. <params>
  2937. <param name="renderer" type="Renderer">
  2938. </param>
  2939. </params>
  2940. </method>
  2941. <method name="customHitDetection" return_type="Boolean">
  2942. <desc><![CDATA[ Implement this method to do custom ray hit detection beyond a bounding box check. Always returns true by default.]]></desc>
  2943. <params>
  2944. <param name="ray" type="Ray">
  2945. </param>
  2946. </params>
  2947. </method>
  2948. <method name="getNumTags" return_type="Integer">
  2949. <desc><![CDATA[ Returns the number of tags this entity has.]]></desc>
  2950. </method>
  2951. <method name="getTagAtIndex" return_type="String">
  2952. <desc><![CDATA[ Returns the tag at specified index or an empty string if index is invalid.]]></desc>
  2953. <params>
  2954. <param name="index" type="Integer">
  2955. </param>
  2956. </params>
  2957. </method>
  2958. <method name="hasTag" return_type="Boolean">
  2959. <desc><![CDATA[ Returns true if this entity contains the specified tag. ]]></desc>
  2960. <params>
  2961. <param name="tag" type="String">
  2962. <desc><![CDATA[Tag to look up.]]></desc>
  2963. </param>
  2964. </params>
  2965. </method>
  2966. <method name="clearTags" return_type="nil">
  2967. <desc><![CDATA[ Removes all tags from this entity.]]></desc>
  2968. </method>
  2969. <method name="addTag" return_type="nil">
  2970. <desc><![CDATA[ Adds a string tag to the entity. ]]></desc>
  2971. <params>
  2972. <param name="tag" type="String">
  2973. <desc><![CDATA[Tag to add.]]></desc>
  2974. </param>
  2975. </params>
  2976. </method>
  2977. <method name="getScreenPosition" return_type="Vector2">
  2978. <desc><![CDATA[ Returns the screen pixel position of the entity ]]></desc>
  2979. <params>
  2980. <param name="projectionMatrix" type="Matrix4">
  2981. <desc><![CDATA[Projection matrix to use.]]></desc>
  2982. </param>
  2983. <param name="cameraMatrix" type="Matrix4">
  2984. <desc><![CDATA[Camera matrix to use.]]></desc>
  2985. </param>
  2986. <param name="viewport" type="Rectangle">
  2987. <desc><![CDATA[Viewport rectangle.]]></desc>
  2988. </param>
  2989. </params>
  2990. </method>
  2991. <method name="recalculateAABBAllChildren" return_type="nil">
  2992. </method>
  2993. <method name="recalculateAABB" return_type="nil">
  2994. </method>
  2995. <method name="getWorldAABB" return_type="AABB">
  2996. <desc><![CDATA[ Return axis-aligned bounding box in world space.]]></desc>
  2997. </method>
  2998. <method name="getLocalBoundingBox" return_type="Vector3">
  2999. <desc><![CDATA[ Returns the bounding box of the entity. This is used for hit-testing as well as visibility calculation.]]></desc>
  3000. </method>
  3001. <method name="setLocalBoundingBox" return_type="nil">
  3002. <desc><![CDATA[ Sets the bounding box of the entity as a 3D Vector. This is used for hit-testing as well as visibility calculation.]]></desc>
  3003. <params>
  3004. <param name="box" type="Vector3">
  3005. </param>
  3006. </params>
  3007. </method>
  3008. <method name="setLocalBoundingBoxX" return_type="nil">
  3009. <desc><![CDATA[ Sets the bounding box X-axis value of the entity.]]></desc>
  3010. <params>
  3011. <param name="x" type="Number">
  3012. </param>
  3013. </params>
  3014. </method>
  3015. <method name="setLocalBoundingBoxY" return_type="nil">
  3016. <desc><![CDATA[ Sets the bounding box Y-axis value of the entity.]]></desc>
  3017. <params>
  3018. <param name="y" type="Number">
  3019. </param>
  3020. </params>
  3021. </method>
  3022. <method name="setLocalBoundingBoxZ" return_type="nil">
  3023. <desc><![CDATA[ Sets the bounding box Z-axis value of the entity.]]></desc>
  3024. <params>
  3025. <param name="z" type="Number">
  3026. </param>
  3027. </params>
  3028. </method>
  3029. <method name="setContainerScene" return_type="nil">
  3030. <params>
  3031. <param name="scene" type="Scene">
  3032. </param>
  3033. </params>
  3034. </method>
  3035. <method name="getContainerScene" return_type="Scene">
  3036. </method>
  3037. <method name="attachScript" return_type="nil">
  3038. <params>
  3039. <param name="script" type="Script">
  3040. </param>
  3041. </params>
  3042. </method>
  3043. <method name="detachScript" return_type="nil">
  3044. <params>
  3045. <param name="script" type="Script">
  3046. </param>
  3047. </params>
  3048. </method>
  3049. <method name="getNumScripts" return_type="Integer">
  3050. </method>
  3051. <method name="getScriptAtIndex" return_type="ScriptInstance">
  3052. <params>
  3053. <param name="index" type="Integer">
  3054. </param>
  3055. </params>
  3056. </method>
  3057. </methods>
  3058. </class>
  3059. <class name="Event">
  3060. <desc><![CDATA[ Event base class. Subclass this class to pass complex data through events.]]></desc>
  3061. <static_members>
  3062. <static_member name="EVENTBASE_EVENT" type="Integer" value="0x100">
  3063. </static_member>
  3064. <static_member name="COMPLETE_EVENT" type="Integer" value="EVENTBASE_EVENT + 0">
  3065. </static_member>
  3066. <static_member name="CHANGE_EVENT" type="Integer" value="EVENTBASE_EVENT + 1">
  3067. </static_member>
  3068. <static_member name="CANCEL_EVENT" type="Integer" value="EVENTBASE_EVENT + 2">
  3069. </static_member>
  3070. <static_member name="NOTIFY_EVENT" type="Integer" value="EVENTBASE_EVENT + 3">
  3071. </static_member>
  3072. <static_member name="FIRE_EVENT" type="Integer" value="EVENTBASE_EVENT + 4">
  3073. </static_member>
  3074. <static_member name="RESOURCE_RELOAD_EVENT" type="Integer" value="EVENTBASE_EVENT + 5">
  3075. </static_member>
  3076. <static_member name="SELECT_EVENT" type="Integer" value="EVENTBASE_EVENT + 6">
  3077. </static_member>
  3078. <static_member name="REMOVE_EVENT" type="Integer" value="EVENTBASE_EVENT + 7">
  3079. </static_member>
  3080. <static_member name="RESOURCE_CHANGE_EVENT" type="Integer" value="EVENTBASE_EVENT + 8">
  3081. </static_member>
  3082. <static_member name="EVENTBASE_NONPOLYCODE" type="Integer" value="0x10000">
  3083. </static_member>
  3084. </static_members>
  3085. <members>
  3086. <member name="deleteOnDispatch" type="Boolean">
  3087. </member>
  3088. <member name="cancelEventFlag" type="Boolean">
  3089. </member>
  3090. </members>
  3091. <methods>
  3092. <method name="Event" return_type="nil">
  3093. <desc><![CDATA[ Default constructor.]]></desc>
  3094. </method>
  3095. <method name="getEventCode" return_type="Integer">
  3096. <desc><![CDATA[ Returns the event code for this event. ]]></desc>
  3097. </method>
  3098. <method name="getDispatcher" return_type="EventDispatcher">
  3099. <desc><![CDATA[ Returns the event dispatcher which originated the event. ]]></desc>
  3100. </method>
  3101. <method name="setEventCode" return_type="nil">
  3102. <params>
  3103. <param name="eventCode" type="Integer">
  3104. </param>
  3105. </params>
  3106. </method>
  3107. <method name="setDispatcher" return_type="nil">
  3108. <params>
  3109. <param name="dispatcher" type="EventDispatcher">
  3110. </param>
  3111. </params>
  3112. </method>
  3113. <method name="getEventType" return_type="String">
  3114. </method>
  3115. <method name="cancelEvent" return_type="nil">
  3116. </method>
  3117. </methods>
  3118. </class>
  3119. <class name="EventDispatcher" extends="EventHandler">
  3120. <desc><![CDATA[ Can dispatch events. The event dispatcher is base class which allows its subclass to dispatch custom events which EventHandler subclasses can then listen to. EventDispatcher and EventHandler are the two main classes in the Polycode event system. If you are familiar with ActionScript3's event system, you will find this to be very similar, except that it uses integers for event codes for speed, rather than strings.]]></desc>
  3121. <static_members>
  3122. </static_members>
  3123. <members>
  3124. </members>
  3125. <methods>
  3126. <method name="EventDispatcher" return_type="nil">
  3127. <desc><![CDATA[ Default constructor]]></desc>
  3128. </method>
  3129. <method name="removeAllHandlers" return_type="nil">
  3130. <desc><![CDATA[ Removes all current event handlers from this dispatcher.]]></desc>
  3131. </method>
  3132. <method name="removeAllHandlersForListener" return_type="nil">
  3133. <desc><![CDATA[ Removes all current event handlers from this dispatcher for a specific event listener. ]]></desc>
  3134. <params>
  3135. <param name="handler" type="EventHandler">
  3136. <desc><![CDATA[listener to remove handlers for.]]></desc>
  3137. </param>
  3138. </params>
  3139. </method>
  3140. <method name="addEventListener" return_type="nil">
  3141. <desc><![CDATA[ Adds an event listener for a specific event code. Once a listener is registered for a specific event code, that listener will start getting event callbacks into the handleEvent() method. ]]></desc>
  3142. <params>
  3143. <param name="handler" type="EventHandler">
  3144. <desc><![CDATA[The event handler to add as a listener]]></desc>
  3145. </param>
  3146. <param name="eventCode" type="Integer">
  3147. <desc><![CDATA[The requested event code to listen to. @see EventHandler]]></desc>
  3148. </param>
  3149. </params>
  3150. </method>
  3151. <method name="addEventListenerUnique" return_type="nil">
  3152. <desc><![CDATA[ Adds an event listener for specified event code if it hasn't already been added, otherwise does nothing. ]]></desc>
  3153. <params>
  3154. <param name="handler" type="EventHandler">
  3155. <desc><![CDATA[The event handler to add as a listener]]></desc>
  3156. </param>
  3157. <param name="eventCode" type="Integer">
  3158. <desc><![CDATA[The requested event code to listen to.]]></desc>
  3159. </param>
  3160. </params>
  3161. </method>
  3162. <method name="hasEventListener" return_type="Boolean">
  3163. <desc><![CDATA[ Returns true if this event dispatcher is registered with the specified EventHandler with the specified event code. ]]></desc>
  3164. <params>
  3165. <param name="handler" type="EventHandler">
  3166. <desc><![CDATA[EventHandler to check.]]></desc>
  3167. </param>
  3168. <param name="eventCode" type="Integer">
  3169. <desc><![CDATA[The event code to check.]]></desc>
  3170. </param>
  3171. </params>
  3172. </method>
  3173. <method name="removeEventListener" return_type="nil">
  3174. <desc><![CDATA[ Removes a listener for a specific handler and event code. ]]></desc>
  3175. <params>
  3176. <param name="handler" type="EventHandler">
  3177. <desc><![CDATA[The event handler to remove as a listener]]></desc>
  3178. </param>
  3179. <param name="eventCode" type="Integer">
  3180. <desc><![CDATA[The requested event code to remove listener for. @see EventHandler]]></desc>
  3181. </param>
  3182. </params>
  3183. </method>
  3184. <method name="__dispatchEvent" return_type="nil">
  3185. <params>
  3186. <param name="event" type="Event">
  3187. </param>
  3188. <param name="eventCode" type="Integer">
  3189. </param>
  3190. </params>
  3191. </method>
  3192. <method name="dispatchEvent" return_type="nil">
  3193. <desc><![CDATA[ Dispatches an event to all handlers listening for the event code specified. ]]></desc>
  3194. <params>
  3195. <param name="event" type="Event">
  3196. <desc><![CDATA[Event class to dispatch to listeners. You can subclass the Event class to send data in your events.]]></desc>
  3197. </param>
  3198. <param name="eventCode" type="Integer">
  3199. <desc><![CDATA[The event code to dispatch the event for. @see Event @see EventHandler]]></desc>
  3200. </param>
  3201. </params>
  3202. </method>
  3203. <method name="dispatchEventNoDelete" return_type="nil">
  3204. <params>
  3205. <param name="event" type="Event">
  3206. </param>
  3207. <param name="eventCode" type="Integer">
  3208. </param>
  3209. </params>
  3210. </method>
  3211. </methods>
  3212. </class>
  3213. <class name="EventHandler">
  3214. <desc><![CDATA[ Can handle events from EventDispatcher classes.]]></desc>
  3215. <static_members>
  3216. </static_members>
  3217. <members>
  3218. </members>
  3219. <methods>
  3220. <method name="EventHandler" return_type="nil">
  3221. <desc><![CDATA[ Default constructor]]></desc>
  3222. </method>
  3223. </methods>
  3224. </class>
  3225. <class name="Font" extends="Resource">
  3226. <static_members>
  3227. </static_members>
  3228. <members>
  3229. <member name="loaded" type="Boolean">
  3230. </member>
  3231. </members>
  3232. <methods>
  3233. <method name="Font" return_type="nil">
  3234. <params>
  3235. <param name="fileName" type="String">
  3236. </param>
  3237. <param name="FTLibrary" type="FT_Library">
  3238. </param>
  3239. </params>
  3240. </method>
  3241. <method name="getFace" return_type="FT_Face">
  3242. </method>
  3243. <method name="isValid" return_type="Boolean">
  3244. </method>
  3245. <method name="setFontName" return_type="nil">
  3246. <params>
  3247. <param name="fontName" type="String">
  3248. </param>
  3249. </params>
  3250. </method>
  3251. <method name="getFontName" return_type="String">
  3252. </method>
  3253. <method name="getFontPath" return_type="String">
  3254. </method>
  3255. </methods>
  3256. </class>
  3257. <class name="LightInfo">
  3258. <static_members>
  3259. </static_members>
  3260. <members>
  3261. <member name="importance" type="Integer">
  3262. </member>
  3263. <member name="position" type="Vector3">
  3264. </member>
  3265. <member name="direction" type="Vector3">
  3266. </member>
  3267. <member name="type" type="Integer">
  3268. </member>
  3269. <member name="diffuseColor" type="Color">
  3270. </member>
  3271. <member name="specularColor" type="Color">
  3272. </member>
  3273. <member name="constantAttenuation" type="Number">
  3274. </member>
  3275. <member name="linearAttenuation" type="Number">
  3276. </member>
  3277. <member name="quadraticAttenuation" type="Number">
  3278. </member>
  3279. <member name="intensity" type="Number">
  3280. </member>
  3281. <member name="spotlightCutoff" type="Number">
  3282. </member>
  3283. <member name="spotlightExponent" type="Number">
  3284. </member>
  3285. <member name="shadowsEnabled" type="Boolean">
  3286. </member>
  3287. <member name="shadowMapTexture" type="Texture">
  3288. </member>
  3289. <member name="lightViewMatrix" type="Matrix4">
  3290. </member>
  3291. </members>
  3292. <methods>
  3293. </methods>
  3294. </class>
  3295. <class name="GPUDrawCall">
  3296. <static_members>
  3297. </static_members>
  3298. <members>
  3299. <member name="mesh" type="Mesh">
  3300. </member>
  3301. <member name="options" type="GPUDrawOptions">
  3302. </member>
  3303. <member name="modelMatrix" type="Matrix4">
  3304. </member>
  3305. <member name="material" type="Material">
  3306. </member>
  3307. </members>
  3308. <methods>
  3309. </methods>
  3310. </class>
  3311. <class name="GPUDrawOptions">
  3312. <static_members>
  3313. </static_members>
  3314. <members>
  3315. <member name="depthTest" type="Boolean">
  3316. </member>
  3317. <member name="depthWrite" type="Boolean">
  3318. </member>
  3319. <member name="linePointSize" type="Number">
  3320. </member>
  3321. <member name="alphaTest" type="Boolean">
  3322. </member>
  3323. <member name="backfaceCull" type="Boolean">
  3324. </member>
  3325. <member name="depthOnly" type="Boolean">
  3326. </member>
  3327. <member name="forceMaterial" type="Boolean">
  3328. </member>
  3329. <member name="blendingMode" type="Integer">
  3330. </member>
  3331. <member name="scissorBox" type="Rectangle">
  3332. </member>
  3333. <member name="enableScissor" type="Boolean">
  3334. </member>
  3335. <member name="drawColor" type="Color">
  3336. </member>
  3337. </members>
  3338. <methods>
  3339. </methods>
  3340. </class>
  3341. <class name="GPUDrawBuffer">
  3342. <static_members>
  3343. </static_members>
  3344. <members>
  3345. <member name="targetFramebuffer" type="RenderBuffer">
  3346. </member>
  3347. <member name="projectionMatrix" type="Matrix4">
  3348. </member>
  3349. <member name="viewMatrix" type="Matrix4">
  3350. </member>
  3351. <member name="cameraMatrix" type="Matrix4">
  3352. </member>
  3353. <member name="clearColor" type="Color">
  3354. </member>
  3355. <member name="clearDepthBuffer" type="Boolean">
  3356. </member>
  3357. <member name="clearColorBuffer" type="Boolean">
  3358. </member>
  3359. <member name="backingResolutionScale" type="Vector2">
  3360. </member>
  3361. <member name="globalMaterial" type="Material">
  3362. </member>
  3363. <member name="viewport" type="Rectangle">
  3364. </member>
  3365. </members>
  3366. <methods>
  3367. <method name="GPUDrawBuffer" return_type="nil">
  3368. </method>
  3369. </methods>
  3370. </class>
  3371. <class name="Image">
  3372. <desc><![CDATA[ An image in memory. Basic RGB or RGBA images stored in memory. Can be loaded from PNG files, created into textures and written to file.]]></desc>
  3373. <class_notes>NOTE: Image instances are not automatically garbage collected.</class_notes>
  3374. <static_members>
  3375. <static_member name="IMAGE_RGB" type="Integer" value="0">
  3376. </static_member>
  3377. <static_member name="IMAGE_RGBA" type="Integer" value="1">
  3378. </static_member>
  3379. <static_member name="IMAGE_FP16" type="Integer" value="2">
  3380. </static_member>
  3381. </static_members>
  3382. <members>
  3383. </members>
  3384. <methods>
  3385. <method name="Image" return_type="nil">
  3386. <desc><![CDATA[ Create image from file name. ]]></desc>
  3387. <params>
  3388. <param name="fileName" type="String">
  3389. <desc><![CDATA[Path to image file to load.]]></desc>
  3390. </param>
  3391. </params>
  3392. </method>
  3393. <method name="BlankImage" return_type="Image" static="true">
  3394. <desc><![CDATA[ Create a blank image of specified size and type. ]]></desc>
  3395. <params>
  3396. <param name="width" type="Integer">
  3397. <desc><![CDATA[Width of the image to create.]]></desc>
  3398. </param>
  3399. <param name="height" type="Integer">
  3400. <desc><![CDATA[Height of the image to create.]]></desc>
  3401. </param>
  3402. <param name="type" type="Integer">
  3403. <desc><![CDATA[Type of image to create. Can be IMAGE_RGBA or IMAGE_RGB.]]></desc>
  3404. </param>
  3405. </params>
  3406. </method>
  3407. <method name="loadImage" return_type="Boolean">
  3408. <desc><![CDATA[ Load an image from a file ]]></desc>
  3409. <params>
  3410. <param name="fileName" type="String">
  3411. <desc><![CDATA[Path to image file to load.]]></desc>
  3412. </param>
  3413. </params>
  3414. </method>
  3415. <method name="saveImage" return_type="Boolean">
  3416. <desc><![CDATA[ Saves the image to a file. Currently only PNG files are supported. ]]></desc>
  3417. <params>
  3418. <param name="fileName" type="String">
  3419. <desc><![CDATA[Path to image file to load.]]></desc>
  3420. </param>
  3421. </params>
  3422. </method>
  3423. <method name="pasteImage" return_type="nil">
  3424. <desc><![CDATA[ Pastes another image into the image ]]></desc>
  3425. <params>
  3426. <param name="image" type="Image">
  3427. <desc><![CDATA[Image to paste]]></desc>
  3428. </param>
  3429. <param name="x" type="Integer">
  3430. <desc><![CDATA[X position of new image within the image]]></desc>
  3431. </param>
  3432. <param name="y" type="Integer">
  3433. <desc><![CDATA[Y position of new image within the image]]></desc>
  3434. </param>
  3435. <param name="blendingMode" type="Integer">
  3436. <desc><![CDATA[Blending mode to use. Currently not used.]]></desc>
  3437. </param>
  3438. <param name="blendAmount" type="Number">
  3439. </param>
  3440. <param name="blendColor" type="Color">
  3441. </param>
  3442. </params>
  3443. </method>
  3444. <method name="createEmpty" return_type="nil">
  3445. <desc><![CDATA[ Recreate the image as an empty image of specified size. The image type stays the same. ]]></desc>
  3446. <params>
  3447. <param name="width" type="Integer">
  3448. <desc><![CDATA[Width of the image to create.]]></desc>
  3449. </param>
  3450. <param name="height" type="Integer">
  3451. <desc><![CDATA[Height of the image to create.]]></desc>
  3452. </param>
  3453. <param name="fillColor" type="Color">
  3454. </param>
  3455. </params>
  3456. </method>
  3457. <method name="fill" return_type="nil">
  3458. <desc><![CDATA[ Fills the image with the specified color values. ]]></desc>
  3459. <params>
  3460. <param name="color" type="Color">
  3461. <desc><![CDATA[The color to fill it with.]]></desc>
  3462. </param>
  3463. </params>
  3464. </method>
  3465. <method name="setPixel" return_type="nil">
  3466. <desc><![CDATA[ Sets a pixel at specified coordinates to specified color. ]]></desc>
  3467. <params>
  3468. <param name="x" type="Integer">
  3469. <desc><![CDATA[X position of pixel.]]></desc>
  3470. </param>
  3471. <param name="y" type="Integer">
  3472. <desc><![CDATA[Y position of pixel.]]></desc>
  3473. </param>
  3474. <param name="r" type="Number">
  3475. <desc><![CDATA[Red value 0-1.]]></desc>
  3476. </param>
  3477. <param name="g" type="Number">
  3478. <desc><![CDATA[Green value 0-1]]></desc>
  3479. </param>
  3480. <param name="b" type="Number">
  3481. <desc><![CDATA[Blue value 0-1]]></desc>
  3482. </param>
  3483. <param name="a" type="Number">
  3484. <desc><![CDATA[Alpha value 0-1]]></desc>
  3485. </param>
  3486. </params>
  3487. </method>
  3488. <method name="getPixel" return_type="Color">
  3489. <desc><![CDATA[ Returns the pixel color at specified position. ]]></desc>
  3490. <params>
  3491. <param name="x" type="Integer">
  3492. <desc><![CDATA[X position of pixel.]]></desc>
  3493. </param>
  3494. <param name="y" type="Integer">
  3495. <desc><![CDATA[Y position of pixel.]]></desc>
  3496. </param>
  3497. </params>
  3498. </method>
  3499. <method name="swap" return_type="nil">
  3500. <params>
  3501. <param name="v1" type="Integer">
  3502. </param>
  3503. <param name="v2" type="Integer">
  3504. </param>
  3505. </params>
  3506. </method>
  3507. <method name="drawLine" return_type="nil">
  3508. <desc><![CDATA[ Draws a line with specified color. ]]></desc>
  3509. <params>
  3510. <param name="x0" type="Integer">
  3511. <desc><![CDATA[Starting x position.]]></desc>
  3512. </param>
  3513. <param name="y0" type="Integer">
  3514. <desc><![CDATA[Starting y position.]]></desc>
  3515. </param>
  3516. <param name="x1" type="Integer">
  3517. <desc><![CDATA[Ending x position.]]></desc>
  3518. </param>
  3519. <param name="y1" type="Integer">
  3520. <desc><![CDATA[Ending y position.]]></desc>
  3521. </param>
  3522. <param name="col" type="Color">
  3523. <desc><![CDATA[Color to use.]]></desc>
  3524. </param>
  3525. </params>
  3526. </method>
  3527. <method name="moveBrushTo" return_type="nil">
  3528. <desc><![CDATA[ Moves brush to specified position ]]></desc>
  3529. <params>
  3530. <param name="x" type="Integer">
  3531. <desc><![CDATA[New brush position X]]></desc>
  3532. </param>
  3533. <param name="y" type="Integer">
  3534. <desc><![CDATA[New brush position Y]]></desc>
  3535. </param>
  3536. </params>
  3537. </method>
  3538. <method name="moveBrush" return_type="nil">
  3539. <desc><![CDATA[ Translates brush a specified amount relative to its current position. ]]></desc>
  3540. <params>
  3541. <param name="x" type="Integer">
  3542. <desc><![CDATA[Amount to translate on X axis]]></desc>
  3543. </param>
  3544. <param name="y" type="Integer">
  3545. <desc><![CDATA[Amount to translate on Y axis]]></desc>
  3546. </param>
  3547. </params>
  3548. </method>
  3549. <method name="drawLineTo" return_type="nil">
  3550. <desc><![CDATA[ Draws a line to specified position. ]]></desc>
  3551. <params>
  3552. <param name="x" type="Integer">
  3553. <desc><![CDATA[Ending x position.]]></desc>
  3554. </param>
  3555. <param name="y" type="Integer">
  3556. <desc><![CDATA[Ending y position.]]></desc>
  3557. </param>
  3558. <param name="col" type="Color">
  3559. <desc><![CDATA[Color to use.]]></desc>
  3560. </param>
  3561. </params>
  3562. </method>
  3563. <method name="fillRect" return_type="nil">
  3564. <desc><![CDATA[ Draws a rectangle with specified color. ]]></desc>
  3565. <params>
  3566. <param name="x" type="Integer">
  3567. <desc><![CDATA[Rectangle x position.]]></desc>
  3568. </param>
  3569. <param name="y" type="Integer">
  3570. <desc><![CDATA[Rectangle y position.]]></desc>
  3571. </param>
  3572. <param name="w" type="Integer">
  3573. <desc><![CDATA[Rectangle width.]]></desc>
  3574. </param>
  3575. <param name="h" type="Integer">
  3576. <desc><![CDATA[Rectangle height.]]></desc>
  3577. </param>
  3578. <param name="col" type="Color">
  3579. <desc><![CDATA[Color to use.]]></desc>
  3580. </param>
  3581. </params>
  3582. </method>
  3583. <method name="perlinNoise" return_type="nil">
  3584. <desc><![CDATA[ Draws perlin noise in the image ]]></desc>
  3585. <params>
  3586. <param name="seed" type="Integer">
  3587. <desc><![CDATA[Seed for the noise]]></desc>
  3588. </param>
  3589. <param name="alpha" type="Boolean">
  3590. <desc><![CDATA[If true, affects alpha, if false only affects the color.]]></desc>
  3591. </param>
  3592. </params>
  3593. </method>
  3594. <method name="fastBlur" return_type="nil">
  3595. <desc><![CDATA[ Blurs the image ]]></desc>
  3596. <params>
  3597. <param name="blurSize" type="Integer">
  3598. <desc><![CDATA[Size of the blur in pixels.]]></desc>
  3599. </param>
  3600. </params>
  3601. </method>
  3602. <method name="fastBlurVert" return_type="nil">
  3603. <params>
  3604. <param name="blurSize" type="Integer">
  3605. </param>
  3606. </params>
  3607. </method>
  3608. <method name="fastBlurHor" return_type="nil">
  3609. <params>
  3610. <param name="blurSize" type="Integer">
  3611. </param>
  3612. </params>
  3613. </method>
  3614. <method name="getPixelsInRect" return_type="char">
  3615. <desc><![CDATA[ Returns an area of the image buffer. The area can go outside of image bounds, in which case the pixels not within the image are zeroed out. This method allocates new memory for the returned buffer and you must free it manually. ]]></desc>
  3616. <params>
  3617. <param name="x" type="Integer">
  3618. <desc><![CDATA[X position of the area to return.]]></desc>
  3619. </param>
  3620. <param name="y" type="Integer">
  3621. <desc><![CDATA[Y position of the area to return.]]></desc>
  3622. </param>
  3623. <param name="width" type="Integer">
  3624. <desc><![CDATA[Width of the area to return.]]></desc>
  3625. </param>
  3626. <param name="height" type="Integer">
  3627. <desc><![CDATA[Height of the area to return.]]></desc>
  3628. </param>
  3629. </params>
  3630. </method>
  3631. <method name="getImagePart" return_type="Image">
  3632. <desc><![CDATA[ Returns a copy of the specified subRect part of the image. ]]></desc>
  3633. <params>
  3634. <param name="subRect" type="Rectangle">
  3635. <desc><![CDATA[The part of the image to copy. (0, 0) refers to the top left of the image.]]></desc>
  3636. </param>
  3637. </params>
  3638. </method>
  3639. <method name="getBrushX" return_type="Integer">
  3640. <desc><![CDATA[ Returns the x position of the brush.]]></desc>
  3641. </method>
  3642. <method name="getBrushY" return_type="Integer">
  3643. <desc><![CDATA[ Returns the y position of the brush.]]></desc>
  3644. </method>
  3645. <method name="isLoaded" return_type="Boolean">
  3646. </method>
  3647. <method name="getType" return_type="Integer">
  3648. </method>
  3649. <method name="getWidth" return_type="Integer">
  3650. <desc><![CDATA[ Returns the width of the image.]]></desc>
  3651. </method>
  3652. <method name="getHeight" return_type="Integer">
  3653. <desc><![CDATA[ Returns the height of the image.]]></desc>
  3654. </method>
  3655. <method name="getPixels" return_type="char">
  3656. <desc><![CDATA[ Returns the raw image data ]]></desc>
  3657. </method>
  3658. <method name="premultiplyAlpha" return_type="nil">
  3659. <desc><![CDATA[ Multiplies the RGB values by alpha for each pixel.]]></desc>
  3660. </method>
  3661. <method name="savePNG" return_type="Boolean">
  3662. <params>
  3663. <param name="fileName" type="String">
  3664. </param>
  3665. </params>
  3666. </method>
  3667. </methods>
  3668. </class>
  3669. <class name="TouchInfo">
  3670. <static_members>
  3671. <static_member name="TYPEBASE" type="Integer" value="0x500">
  3672. </static_member>
  3673. <static_member name="TYPE_TOUCH" type="Integer" value="TYPEBASE + 0">
  3674. </static_member>
  3675. <static_member name="TYPE_PEN" type="Integer" value="TYPEBASE + 1">
  3676. </static_member>
  3677. </static_members>
  3678. <members>
  3679. <member name="id" type="Integer">
  3680. </member>
  3681. <member name="position" type="Vector2">
  3682. </member>
  3683. <member name="type" type="Integer">
  3684. </member>
  3685. </members>
  3686. <methods>
  3687. <method name="TouchInfo" return_type="nil">
  3688. </method>
  3689. </methods>
  3690. </class>
  3691. <class name="InputEvent" extends="Event">
  3692. <desc><![CDATA[ Event dispatched by CoreInput. This event is dispatched by CoreInput when input happens.]]></desc>
  3693. <static_members>
  3694. <static_member name="EVENTBASE_INPUTEVENT" type="Integer" value="0x400">
  3695. <desc><![CDATA[ @name Input event types. Possible input event types dispatched by CoreInput.]]></desc>
  3696. </static_member>
  3697. <static_member name="EVENT_MOUSEDOWN" type="Integer" value="EVENTBASE_INPUTEVENT + 0">
  3698. </static_member>
  3699. <static_member name="EVENT_MOUSEUP" type="Integer" value="EVENTBASE_INPUTEVENT + 1">
  3700. </static_member>
  3701. <static_member name="EVENT_MOUSEMOVE" type="Integer" value="EVENTBASE_INPUTEVENT + 2">
  3702. </static_member>
  3703. <static_member name="EVENT_MOUSEOVER" type="Integer" value="EVENTBASE_INPUTEVENT + 3">
  3704. </static_member>
  3705. <static_member name="EVENT_MOUSEOUT" type="Integer" value="EVENTBASE_INPUTEVENT + 4">
  3706. </static_member>
  3707. <static_member name="EVENT_DOUBLECLICK" type="Integer" value="EVENTBASE_INPUTEVENT + 5">
  3708. </static_member>
  3709. <static_member name="EVENT_MOUSEUP_OUTSIDE" type="Integer" value="EVENTBASE_INPUTEVENT + 6">
  3710. </static_member>
  3711. <static_member name="EVENT_MOUSEWHEEL_UP" type="Integer" value="EVENTBASE_INPUTEVENT + 7">
  3712. </static_member>
  3713. <static_member name="EVENT_MOUSEWHEEL_DOWN" type="Integer" value="EVENTBASE_INPUTEVENT + 8">
  3714. </static_member>
  3715. <static_member name="EVENT_KEYDOWN" type="Integer" value="EVENTBASE_INPUTEVENT + 13">
  3716. </static_member>
  3717. <static_member name="EVENT_KEYUP" type="Integer" value="EVENTBASE_INPUTEVENT + 14">
  3718. </static_member>
  3719. <static_member name="EVENT_JOYBUTTON_DOWN" type="Integer" value="EVENTBASE_INPUTEVENT + 15">
  3720. </static_member>
  3721. <static_member name="EVENT_JOYBUTTON_UP" type="Integer" value="EVENTBASE_INPUTEVENT + 16">
  3722. </static_member>
  3723. <static_member name="EVENT_JOYAXIS_MOVED" type="Integer" value="EVENTBASE_INPUTEVENT + 17">
  3724. </static_member>
  3725. <static_member name="EVENT_JOYDEVICE_ATTACHED" type="Integer" value="EVENTBASE_INPUTEVENT + 18">
  3726. </static_member>
  3727. <static_member name="EVENT_JOYDEVICE_DETACHED" type="Integer" value="EVENTBASE_INPUTEVENT + 19">
  3728. </static_member>
  3729. <static_member name="EVENT_TOUCHES_BEGAN" type="Integer" value="EVENTBASE_INPUTEVENT + 20">
  3730. </static_member>
  3731. <static_member name="EVENT_TOUCHES_MOVED" type="Integer" value="EVENTBASE_INPUTEVENT + 21">
  3732. </static_member>
  3733. <static_member name="EVENT_TOUCHES_ENDED" type="Integer" value="EVENTBASE_INPUTEVENT + 22">
  3734. </static_member>
  3735. </static_members>
  3736. <members>
  3737. <member name="mouseButton" type="Integer">
  3738. <desc><![CDATA[ If this is a mouse click event, the mouse button that's pressed.]]></desc>
  3739. </member>
  3740. <member name="mousePosition" type="Vector2">
  3741. <desc><![CDATA[ If this is a mouse event, the mouse position.]]></desc>
  3742. </member>
  3743. <member name="key" type="PolyKEY">
  3744. <desc><![CDATA[ If this is a key event, the key code that's coming down or up.]]></desc>
  3745. </member>
  3746. <member name="charCode" type="wchar_t">
  3747. <desc><![CDATA[ If this is a key press event, this will contain the unicode character that's being typed.]]></desc>
  3748. </member>
  3749. <member name="timestamp" type="Integer">
  3750. </member>
  3751. <member name="touch" type="TouchInfo">
  3752. </member>
  3753. <member name="touchType" type="Integer">
  3754. </member>
  3755. <member name="joystickDeviceID" type="Integer">
  3756. </member>
  3757. <member name="joystickAxisValue" type="Number">
  3758. </member>
  3759. <member name="joystickButton" type="Integer">
  3760. </member>
  3761. <member name="joystickAxis" type="Integer">
  3762. </member>
  3763. <member name="joystickIndex" type="Integer">
  3764. </member>
  3765. <member name="hitDistance" type="Number">
  3766. </member>
  3767. </members>
  3768. <methods>
  3769. <method name="InputEvent" return_type="nil">
  3770. </method>
  3771. <method name="getMousePosition" return_type="Vector2">
  3772. </method>
  3773. <method name="getKey" return_type="PolyKEY">
  3774. </method>
  3775. <method name="getMouseButton" return_type="Integer">
  3776. </method>
  3777. <method name="getCharCode" return_type="wchar_t">
  3778. </method>
  3779. <method name="keyCode" return_type="Integer">
  3780. </method>
  3781. </methods>
  3782. </class>
  3783. <class name="GlyphData">
  3784. <static_members>
  3785. </static_members>
  3786. <members>
  3787. <member name="glyphs" type="FT_Glyph">
  3788. </member>
  3789. <member name="positions" type="FT_Vector">
  3790. </member>
  3791. <member name="num_glyphs" type="FT_UInt">
  3792. </member>
  3793. <member name="trailingAdvance" type="Integer">
  3794. </member>
  3795. </members>
  3796. <methods>
  3797. <method name="GlyphData" return_type="nil">
  3798. </method>
  3799. <method name="clearData" return_type="nil">
  3800. </method>
  3801. </methods>
  3802. </class>
  3803. <class name="ColorRange">
  3804. <static_members>
  3805. </static_members>
  3806. <members>
  3807. <member name="color" type="Color">
  3808. </member>
  3809. <member name="rangeStart" type="Integer">
  3810. </member>
  3811. <member name="rangeEnd" type="Integer">
  3812. </member>
  3813. </members>
  3814. <methods>
  3815. <method name="ColorRange" return_type="nil">
  3816. <params>
  3817. <param name="color" type="Color">
  3818. </param>
  3819. <param name="rangeStart" type="Integer">
  3820. </param>
  3821. <param name="rangeEnd" type="Integer">
  3822. </param>
  3823. </params>
  3824. </method>
  3825. </methods>
  3826. </class>
  3827. <class name="Label" extends="Image">
  3828. <desc><![CDATA[ An image that can render text into itself. This class is mostly used internally in SceneLabel, but can be used by itself to manually create text-based textures.]]></desc>
  3829. <static_members>
  3830. <static_member name="ANTIALIAS_FULL" type="Integer" value="0">
  3831. </static_member>
  3832. <static_member name="ANTIALIAS_NONE" type="Integer" value="1">
  3833. </static_member>
  3834. <static_member name="ANTIALIAS_STRONG" type="Integer" value="2">
  3835. </static_member>
  3836. <static_member name="ANTIALIAS_LCD" type="Integer" value="3">
  3837. </static_member>
  3838. <static_member name="ANTIALIAS_LCD_HINT" type="Integer" value="4">
  3839. </static_member>
  3840. <static_member name="ANTIALIAS_FULL_HINT" type="Integer" value="5">
  3841. </static_member>
  3842. </static_members>
  3843. <members>
  3844. </members>
  3845. <methods>
  3846. <method name="Label" return_type="nil">
  3847. <desc><![CDATA[ Create a text label. ]]></desc>
  3848. <params>
  3849. <param name="font" type="Font">
  3850. <desc><![CDATA[Font to use for this label.]]></desc>
  3851. </param>
  3852. <param name="text" type="String">
  3853. <desc><![CDATA[Initial text to render.]]></desc>
  3854. </param>
  3855. <param name="size" type="Integer">
  3856. <desc><![CDATA[Pixel size of the text to render.]]></desc>
  3857. </param>
  3858. <param name="antiAliasMode" type="Integer">
  3859. <desc><![CDATA[Antialiasing mode. Can be ANTIALIAS_FULL, ANTIALIAS_NONE or ANTIALIAS_STRONG.]]></desc>
  3860. </param>
  3861. <param name="premultiplyAlpha" type="Boolean">
  3862. <desc><![CDATA[If set to true, will premultiply alpha in the label image. @see Font]]></desc>
  3863. </param>
  3864. <param name="backgroundColor" type="Color">
  3865. </param>
  3866. <param name="foregroundColor" type="Color">
  3867. </param>
  3868. </params>
  3869. </method>
  3870. <method name="setText" return_type="nil">
  3871. <desc><![CDATA[ Sets the text of the label. ]]></desc>
  3872. <params>
  3873. <param name="text" type="String">
  3874. <desc><![CDATA[Text to set.]]></desc>
  3875. </param>
  3876. </params>
  3877. </method>
  3878. <method name="getText" return_type="String">
  3879. <desc><![CDATA[ Returns the current text of the label. ]]></desc>
  3880. </method>
  3881. <method name="getTextWidthForString" return_type="Integer">
  3882. <desc><![CDATA[ Returns the pixel width for the specified string based on the current label font and size settings. ]]></desc>
  3883. <params>
  3884. <param name="text" type="String">
  3885. <desc><![CDATA[Text to return width for.]]></desc>
  3886. </param>
  3887. </params>
  3888. </method>
  3889. <method name="getTextHeightForString" return_type="Integer">
  3890. <desc><![CDATA[ Returns the pixel height for the specified string based on the current label font and size settings. ]]></desc>
  3891. <params>
  3892. <param name="text" type="String">
  3893. <desc><![CDATA[Text to return height for.]]></desc>
  3894. </param>
  3895. </params>
  3896. </method>
  3897. <method name="getTextWidth" return_type="Number">
  3898. <desc><![CDATA[ Returns the width of the current text. ]]></desc>
  3899. </method>
  3900. <method name="getTextHeight" return_type="Number">
  3901. <desc><![CDATA[ Returns the height of the current text. ]]></desc>
  3902. </method>
  3903. <method name="setColorForRange" return_type="nil">
  3904. <desc><![CDATA[ Sets the color for a range of characters in the label. The colors are only applied upon the next call to setText, not the currently rendered text. This call appends the color range to a list of color ranges, so if you are calling this multiple times for the same ranges, you must call clearColors. ]]></desc>
  3905. <params>
  3906. <param name="color" type="Color">
  3907. <desc><![CDATA[The color to set for the specified range.]]></desc>
  3908. </param>
  3909. <param name="rangeStart" type="Integer">
  3910. <desc><![CDATA[Starting index of the specified range.]]></desc>
  3911. </param>
  3912. <param name="rangeEnd" type="Integer">
  3913. <desc><![CDATA[Ending index of the specified range. @see clearColors]]></desc>
  3914. </param>
  3915. </params>
  3916. </method>
  3917. <method name="clearColors" return_type="nil">
  3918. <desc><![CDATA[ Clears the current label colors. @see setColorForRange]]></desc>
  3919. </method>
  3920. <method name="getColorForIndex" return_type="Color">
  3921. <desc><![CDATA[ Returns the text color for specified character index.]]></desc>
  3922. <params>
  3923. <param name="index" type="Integer">
  3924. </param>
  3925. </params>
  3926. </method>
  3927. <method name="getPremultiplyAlpha" return_type="Boolean">
  3928. <desc><![CDATA[ Returns the premultiply alpha setting.]]></desc>
  3929. </method>
  3930. <method name="setPremultiplyAlpha" return_type="nil">
  3931. <desc><![CDATA[ If set to true, will premultiply alpha when text is set to the label.]]></desc>
  3932. <params>
  3933. <param name="val" type="Boolean">
  3934. </param>
  3935. </params>
  3936. </method>
  3937. <method name="setFont" return_type="nil">
  3938. <desc><![CDATA[ Sets the Font used to render text in the label. @see Font]]></desc>
  3939. <params>
  3940. <param name="newFont" type="Font">
  3941. </param>
  3942. </params>
  3943. </method>
  3944. <method name="getFont" return_type="Font">
  3945. <desc><![CDATA[ Returns the Font currently used to render text in the label. @see Font]]></desc>
  3946. </method>
  3947. <method name="setSize" return_type="nil">
  3948. <desc><![CDATA[ Sets the vertical pixel size of text rendered in the label.]]></desc>
  3949. <params>
  3950. <param name="newSize" type="Integer">
  3951. </param>
  3952. </params>
  3953. </method>
  3954. <method name="getSize" return_type="Integer">
  3955. <desc><![CDATA[ Return the current vertical pixel size of text rendered in the label.]]></desc>
  3956. </method>
  3957. <method name="getAntialiasMode" return_type="Integer">
  3958. <desc><![CDATA[ Returns the current antialasing mode.]]></desc>
  3959. </method>
  3960. <method name="setAntialiasMode" return_type="nil">
  3961. <desc><![CDATA[ Sets the antialiasing mode used to render text. ]]></desc>
  3962. <params>
  3963. <param name="newMode" type="Integer">
  3964. <desc><![CDATA[Antialiasing mode. Can be ANTIALIAS_FULL, ANTIALIAS_NONE or ANTIALIAS_STRONG.]]></desc>
  3965. </param>
  3966. </params>
  3967. </method>
  3968. <method name="getBaselineAdjust" return_type="Integer">
  3969. <desc><![CDATA[ Returns the pixel distance from top of image to the baseline of the rendered text.]]></desc>
  3970. </method>
  3971. <method name="setBackgroundColor" return_type="nil">
  3972. <params>
  3973. <param name="color" type="Color">
  3974. </param>
  3975. </params>
  3976. </method>
  3977. <method name="setForegroundColor" return_type="nil">
  3978. <params>
  3979. <param name="color" type="Color">
  3980. </param>
  3981. </params>
  3982. </method>
  3983. <method name="setColors" return_type="nil">
  3984. <params>
  3985. <param name="backgroundColor" type="Color">
  3986. </param>
  3987. <param name="foregroundColor" type="Color">
  3988. </param>
  3989. </params>
  3990. </method>
  3991. <method name="getBackgroundColor" return_type="Color">
  3992. </method>
  3993. <method name="getForegroundColor" return_type="Color">
  3994. </method>
  3995. <method name="optionsChanged" return_type="Boolean">
  3996. </method>
  3997. </methods>
  3998. </class>
  3999. <class name="Material" extends="Resource">
  4000. <class_notes>NOTE: Material instances are not automatically garbage collected.</class_notes>
  4001. <static_members>
  4002. </static_members>
  4003. <members>
  4004. <member name="fp16RenderTargets" type="Boolean">
  4005. </member>
  4006. <member name="shaderModule" type="nil">
  4007. </member>
  4008. <member name="blendingMode" type="Integer">
  4009. </member>
  4010. <member name="screenMaterial" type="Boolean">
  4011. </member>
  4012. </members>
  4013. <methods>
  4014. <method name="Material" return_type="nil">
  4015. <params>
  4016. <param name="name" type="String">
  4017. </param>
  4018. </params>
  4019. </method>
  4020. <method name="addShaderPass" return_type="nil">
  4021. <params>
  4022. <param name="pass" type="ShaderPass">
  4023. </param>
  4024. </params>
  4025. </method>
  4026. <method name="addShaderPassAtIndex" return_type="nil">
  4027. <params>
  4028. <param name="pass" type="ShaderPass">
  4029. </param>
  4030. <param name="shaderIndex" type="Integer">
  4031. </param>
  4032. </params>
  4033. </method>
  4034. <method name="addShader" return_type="nil">
  4035. <params>
  4036. <param name="shader" type="Shader">
  4037. </param>
  4038. <param name="shaderBinding" type="ShaderBinding">
  4039. </param>
  4040. </params>
  4041. </method>
  4042. <method name="addShaderAtIndex" return_type="nil">
  4043. <params>
  4044. <param name="shader" type="Shader">
  4045. </param>
  4046. <param name="shaderBinding" type="ShaderBinding">
  4047. </param>
  4048. <param name="shaderIndex" type="Integer">
  4049. </param>
  4050. </params>
  4051. </method>
  4052. <method name="getNumShaderPasses" return_type="Integer">
  4053. </method>
  4054. <method name="removeShaderPass" return_type="nil">
  4055. <params>
  4056. <param name="shaderIndex" type="Integer">
  4057. </param>
  4058. </params>
  4059. </method>
  4060. <method name="recreateExpectedShaderParams" return_type="nil">
  4061. </method>
  4062. <method name="addShaderRenderTarget" return_type="nil">
  4063. <params>
  4064. <param name="newTarget" type="ShaderRenderTarget">
  4065. </param>
  4066. </params>
  4067. </method>
  4068. <method name="getNumShaderRenderTargets" return_type="Integer">
  4069. </method>
  4070. <method name="getShaderRenderTarget" return_type="ShaderRenderTarget">
  4071. <params>
  4072. <param name="index" type="Integer">
  4073. </param>
  4074. </params>
  4075. </method>
  4076. <method name="removeShaderRenderTarget" return_type="nil">
  4077. <params>
  4078. <param name="index" type="Integer">
  4079. </param>
  4080. </params>
  4081. </method>
  4082. <method name="recreateRenderTarget" return_type="nil">
  4083. <params>
  4084. <param name="renderTarget" type="ShaderRenderTarget">
  4085. </param>
  4086. </params>
  4087. </method>
  4088. <method name="recreateRenderTargets" return_type="nil">
  4089. </method>
  4090. <method name="getName" return_type="String">
  4091. </method>
  4092. <method name="getShaderPass" return_type="ShaderPass">
  4093. <params>
  4094. <param name="index" type="Integer">
  4095. </param>
  4096. </params>
  4097. </method>
  4098. <method name="getShaderBinding" return_type="ShaderBinding">
  4099. <params>
  4100. <param name="index" type="Integer">
  4101. </param>
  4102. </params>
  4103. </method>
  4104. <method name="getShader" return_type="Shader">
  4105. <params>
  4106. <param name="index" type="Integer">
  4107. </param>
  4108. </params>
  4109. </method>
  4110. <method name="loadMaterial" return_type="nil">
  4111. <params>
  4112. <param name="fileName" type="String">
  4113. </param>
  4114. </params>
  4115. </method>
  4116. <method name="setName" return_type="nil">
  4117. <params>
  4118. <param name="name" type="String">
  4119. </param>
  4120. </params>
  4121. </method>
  4122. <method name="clearShaders" return_type="nil">
  4123. </method>
  4124. </methods>
  4125. </class>
  4126. <class name="ShaderPass">
  4127. <static_members>
  4128. </static_members>
  4129. <members>
  4130. <member name="shader" type="Shader">
  4131. </member>
  4132. <member name="wireframe" type="Boolean">
  4133. </member>
  4134. <member name="blendingMode" type="Integer">
  4135. </member>
  4136. <member name="shaderBinding" type="ShaderBinding">
  4137. </member>
  4138. <member name="materialShaderBinding" type="ShaderBinding">
  4139. </member>
  4140. </members>
  4141. <methods>
  4142. <method name="ShaderPass" return_type="nil">
  4143. </method>
  4144. <method name="setAttributeArraysFromMesh" return_type="nil">
  4145. <params>
  4146. <param name="mesh" type="Mesh">
  4147. </param>
  4148. </params>
  4149. </method>
  4150. <method name="setExpectedAttributes" return_type="nil">
  4151. </method>
  4152. <method name="arrayToAttributeName" return_type="String" static="true">
  4153. <params>
  4154. <param name="array" type="VertexDataArray">
  4155. </param>
  4156. </params>
  4157. </method>
  4158. </methods>
  4159. </class>
  4160. <class name="MaterialManager">
  4161. <desc><![CDATA[ Manages loading and reloading of materials, textures and shaders. This class should be only accessed from the CoreServices singleton.]]></desc>
  4162. <static_members>
  4163. </static_members>
  4164. <members>
  4165. <member name="premultiplyAlphaOnLoad" type="Boolean">
  4166. </member>
  4167. <member name="clampDefault" type="Boolean">
  4168. </member>
  4169. <member name="mipmapsDefault" type="Boolean">
  4170. </member>
  4171. <member name="keepTextureData" type="Boolean">
  4172. </member>
  4173. </members>
  4174. <methods>
  4175. <method name="MaterialManager" return_type="nil">
  4176. </method>
  4177. <method name="Update" return_type="nil">
  4178. <params>
  4179. <param name="elapsed" type="Integer">
  4180. </param>
  4181. </params>
  4182. </method>
  4183. <method name="createTexture" return_type="Texture">
  4184. <params>
  4185. <param name="width" type="Integer">
  4186. </param>
  4187. <param name="height" type="Integer">
  4188. </param>
  4189. <param name="imageData" type="char">
  4190. </param>
  4191. <param name="clamp" type="Boolean">
  4192. </param>
  4193. <param name="createMipmaps" type="Boolean">
  4194. </param>
  4195. <param name="type" type="Integer">
  4196. </param>
  4197. </params>
  4198. </method>
  4199. <method name="createNewTexture" return_type="Texture">
  4200. <params>
  4201. <param name="width" type="Integer">
  4202. </param>
  4203. <param name="height" type="Integer">
  4204. </param>
  4205. <param name="clamp" type="Boolean">
  4206. </param>
  4207. <param name="createMipmaps" type="Boolean">
  4208. </param>
  4209. <param name="type" type="Integer">
  4210. </param>
  4211. </params>
  4212. </method>
  4213. <method name="createTextureFromImage" return_type="Texture">
  4214. <params>
  4215. <param name="image" type="Image">
  4216. </param>
  4217. <param name="clamp" type="Boolean">
  4218. </param>
  4219. <param name="createMipmaps" type="Boolean">
  4220. </param>
  4221. </params>
  4222. </method>
  4223. <method name="createTextureFromFile" return_type="Texture">
  4224. <params>
  4225. <param name="fileName" type="String">
  4226. </param>
  4227. <param name="clamp" type="Boolean">
  4228. </param>
  4229. <param name="createMipmaps" type="Boolean">
  4230. </param>
  4231. <param name="resourcePool" type="ResourcePool">
  4232. </param>
  4233. </params>
  4234. </method>
  4235. <method name="deleteTexture" return_type="nil">
  4236. <params>
  4237. <param name="texture" type="Texture">
  4238. </param>
  4239. </params>
  4240. </method>
  4241. <method name="reloadTextures" return_type="nil">
  4242. </method>
  4243. <method name="reloadProgramsAndTextures" return_type="nil">
  4244. </method>
  4245. <method name="reloadPrograms" return_type="nil">
  4246. </method>
  4247. <method name="getTextureByResourcePath" return_type="Texture">
  4248. <params>
  4249. <param name="resourcePath" type="String">
  4250. </param>
  4251. </params>
  4252. </method>
  4253. <method name="createProgramFromFile" return_type="ShaderProgram">
  4254. <params>
  4255. <param name="programPath" type="String">
  4256. </param>
  4257. </params>
  4258. </method>
  4259. <method name="loadMaterialLibraryIntoPool" return_type="nil">
  4260. <params>
  4261. <param name="pool" type="ResourcePool">
  4262. </param>
  4263. <param name="materialFile" type="String">
  4264. </param>
  4265. </params>
  4266. </method>
  4267. <method name="cubemapFromXMLNode" return_type="Cubemap">
  4268. <params>
  4269. <param name="node" type="TiXmlNode">
  4270. </param>
  4271. </params>
  4272. </method>
  4273. <method name="materialFromXMLNode" return_type="Material">
  4274. <params>
  4275. <param name="resourcePool" type="ResourcePool">
  4276. </param>
  4277. <param name="node" type="TiXmlNode">
  4278. </param>
  4279. </params>
  4280. </method>
  4281. <method name="createMaterial" return_type="Material">
  4282. <params>
  4283. <param name="resourcePool" type="ResourcePool">
  4284. </param>
  4285. <param name="materialName" type="String">
  4286. </param>
  4287. <param name="shaderName" type="String">
  4288. </param>
  4289. </params>
  4290. </method>
  4291. <method name="setShaderFromXMLNode" return_type="Shader">
  4292. <params>
  4293. <param name="resourcePool" type="ResourcePool">
  4294. </param>
  4295. <param name="node" type="TiXmlNode">
  4296. </param>
  4297. </params>
  4298. </method>
  4299. <method name="createShaderFromXMLNode" return_type="Shader">
  4300. <params>
  4301. <param name="resourcePool" type="ResourcePool">
  4302. </param>
  4303. <param name="node" type="TiXmlNode">
  4304. </param>
  4305. </params>
  4306. </method>
  4307. <method name="createShader" return_type="Shader">
  4308. <params>
  4309. <param name="resourcePool" type="ResourcePool">
  4310. </param>
  4311. <param name="shaderType" type="String">
  4312. </param>
  4313. <param name="name" type="String">
  4314. </param>
  4315. <param name="vpName" type="String">
  4316. </param>
  4317. <param name="fpName" type="String">
  4318. </param>
  4319. <param name="screenShader" type="Boolean">
  4320. </param>
  4321. </params>
  4322. </method>
  4323. <method name="loadMaterialsFromFile" return_array="true" return_type="Material">
  4324. <params>
  4325. <param name="resourcePool" type="ResourcePool">
  4326. </param>
  4327. <param name="fileName" type="String">
  4328. </param>
  4329. </params>
  4330. </method>
  4331. <method name="loadShadersFromFile" return_array="true" return_type="Shader">
  4332. <params>
  4333. <param name="resourcePool" type="ResourcePool">
  4334. </param>
  4335. <param name="fileName" type="String">
  4336. </param>
  4337. </params>
  4338. </method>
  4339. <method name="loadCubemapsFromFile" return_array="true" return_type="Cubemap">
  4340. <params>
  4341. <param name="fileName" type="String">
  4342. </param>
  4343. </params>
  4344. </method>
  4345. <method name="setAnisotropyAmount" return_type="nil">
  4346. <params>
  4347. <param name="anisotropy" type="Integer">
  4348. </param>
  4349. </params>
  4350. </method>
  4351. <method name="setTextureFilteringMode" return_type="nil">
  4352. <params>
  4353. <param name="textureFilteringMode" type="Integer">
  4354. </param>
  4355. </params>
  4356. </method>
  4357. <method name="getTextureFilteringMode" return_type="Integer">
  4358. </method>
  4359. <method name="addMaterial" return_type="nil">
  4360. <params>
  4361. <param name="material" type="Material">
  4362. </param>
  4363. </params>
  4364. </method>
  4365. <method name="addShader" return_type="nil">
  4366. <params>
  4367. <param name="shader" type="Shader">
  4368. </param>
  4369. </params>
  4370. </method>
  4371. <method name="getNumShaders" return_type="Integer">
  4372. </method>
  4373. <method name="getShaderByIndex" return_type="Shader">
  4374. <params>
  4375. <param name="index" type="Integer">
  4376. </param>
  4377. </params>
  4378. </method>
  4379. </methods>
  4380. </class>
  4381. <class name="Matrix4">
  4382. <desc><![CDATA[ 4x4 Matrix.]]></desc>
  4383. <static_members>
  4384. </static_members>
  4385. <members>
  4386. </members>
  4387. <methods>
  4388. <method name="Matrix4" return_type="nil">
  4389. </method>
  4390. <method name="identity" return_type="nil">
  4391. <desc><![CDATA[ Resets the matrix to identity.]]></desc>
  4392. </method>
  4393. <method name="rotateVector" return_type="Vector3">
  4394. <desc><![CDATA[ Rotates a vector by the matrix values. ]]></desc>
  4395. <params>
  4396. <param name="v2" type="Vector3">
  4397. <desc><![CDATA[Vector to rotate.]]></desc>
  4398. </param>
  4399. </params>
  4400. </method>
  4401. <method name="getPosition" return_type="Vector3">
  4402. <desc><![CDATA[ Returns the position from the matrix. ]]></desc>
  4403. </method>
  4404. <method name="multiplyWithPerspective" return_type="Vector3">
  4405. <params>
  4406. <param name="v2" type="Vector3">
  4407. </param>
  4408. </params>
  4409. </method>
  4410. <method name="multVector3" return_type="Vector3">
  4411. <params>
  4412. <param name="v2" type="Vector3">
  4413. </param>
  4414. </params>
  4415. </method>
  4416. <method name="multVector4" return_type="Vector4">
  4417. <params>
  4418. <param name="v2" type="Vector4">
  4419. </param>
  4420. </params>
  4421. </method>
  4422. <method name="Translate" return_type="nil">
  4423. <desc><![CDATA[ Translates the position in the matrix. ]]></desc>
  4424. <params>
  4425. <param name="x" type="Number">
  4426. <desc><![CDATA[X coordinate.]]></desc>
  4427. </param>
  4428. <param name="y" type="Number">
  4429. <desc><![CDATA[Y coordinate.]]></desc>
  4430. </param>
  4431. <param name="z" type="Number">
  4432. <desc><![CDATA[Z coordinate.]]></desc>
  4433. </param>
  4434. </params>
  4435. </method>
  4436. <method name="setPosition" return_type="nil">
  4437. <desc><![CDATA[ Sets the position in the matrix. ]]></desc>
  4438. <params>
  4439. <param name="x" type="Number">
  4440. <desc><![CDATA[X coordinate.]]></desc>
  4441. </param>
  4442. <param name="y" type="Number">
  4443. <desc><![CDATA[Y coordinate.]]></desc>
  4444. </param>
  4445. <param name="z" type="Number">
  4446. <desc><![CDATA[Z coordinate.]]></desc>
  4447. </param>
  4448. </params>
  4449. </method>
  4450. <method name="setScale" return_type="nil">
  4451. <desc><![CDATA[ Sets the scale in the matrix. ]]></desc>
  4452. <params>
  4453. <param name="scale" type="Vector3">
  4454. <desc><![CDATA[X scale.]]></desc>
  4455. </param>
  4456. </params>
  4457. </method>
  4458. <method name="getEulerAngles" return_type="nil">
  4459. <desc><![CDATA[ Returns the matrix rotation as euler angles. (This might be kind of buggy). ]]></desc>
  4460. <params>
  4461. <param name="ax" type="Number">
  4462. <desc><![CDATA[Pointer to roll angle to set.]]></desc>
  4463. </param>
  4464. <param name="ay" type="Number">
  4465. <desc><![CDATA[Pointer to pitch angle to set.]]></desc>
  4466. </param>
  4467. <param name="az" type="Number">
  4468. <desc><![CDATA[Pointer to yaw angle to set.]]></desc>
  4469. </param>
  4470. </params>
  4471. </method>
  4472. <method name="transpose" return_type="Matrix4">
  4473. <desc><![CDATA[ Returns the transpose of the matrix.]]></desc>
  4474. </method>
  4475. <method name="Inverse" return_type="Matrix4">
  4476. <desc><![CDATA[ Returns the inverse of the matrix.]]></desc>
  4477. </method>
  4478. <method name="inverseAffine" return_type="Matrix4">
  4479. <desc><![CDATA[ Returns the affine inverse of the matrix.]]></desc>
  4480. </method>
  4481. <method name="determinant" return_type="Number">
  4482. <desc><![CDATA[ Returns the determinant of the matrix.]]></desc>
  4483. </method>
  4484. <method name="generalDeterminant" return_type="Number" static="true">
  4485. <desc><![CDATA[ Returns the determinant of any general (square) matrix. ]]></desc>
  4486. <params>
  4487. <param name="a" type="Number">
  4488. <desc><![CDATA[A square matrix as an array of pointers to rows (or columns).]]></desc>
  4489. </param>
  4490. <param name="n" type="Integer">
  4491. <desc><![CDATA[The number of dimensions in matrix A.]]></desc>
  4492. </param>
  4493. </params>
  4494. </method>
  4495. <method name="setOrthoProjection" return_type="nil">
  4496. <params>
  4497. <param name="left" type="Number">
  4498. </param>
  4499. <param name="right" type="Number">
  4500. </param>
  4501. <param name="bottom" type="Number">
  4502. </param>
  4503. <param name="top" type="Number">
  4504. </param>
  4505. <param name="zNear" type="Number">
  4506. </param>
  4507. <param name="zFar" type="Number">
  4508. </param>
  4509. </params>
  4510. </method>
  4511. <method name="setProjectionFrustum" return_type="nil">
  4512. <params>
  4513. <param name="left" type="Number">
  4514. </param>
  4515. <param name="right" type="Number">
  4516. </param>
  4517. <param name="bottom" type="Number">
  4518. </param>
  4519. <param name="top" type="Number">
  4520. </param>
  4521. <param name="zNear" type="Number">
  4522. </param>
  4523. <param name="zFar" type="Number">
  4524. </param>
  4525. </params>
  4526. </method>
  4527. <method name="setProjection" return_type="nil">
  4528. <params>
  4529. <param name="fov" type="Number">
  4530. </param>
  4531. <param name="aspect" type="Number">
  4532. </param>
  4533. <param name="zNear" type="Number">
  4534. </param>
  4535. <param name="zFar" type="Number">
  4536. </param>
  4537. </params>
  4538. </method>
  4539. </methods>
  4540. </class>
  4541. <class name="Mesh" extends="Resource">
  4542. <desc><![CDATA[ A mesh comprised of vertices. When data in the mesh changes, arrayDirtyMap must be set to true for the appropriate array types (color, position, normal, etc). Available types are defined in RenderDataArray.]]></desc>
  4543. <class_notes>NOTE: Mesh instances are not automatically garbage collected.</class_notes>
  4544. <static_members>
  4545. <static_member name="TRISTRIP_MESH" type="Integer" value="0">
  4546. <desc><![CDATA[ Quad based mesh.]]></desc>
  4547. </static_member>
  4548. <static_member name="TRI_MESH" type="Integer" value="1">
  4549. <desc><![CDATA[ Triangle based mesh.]]></desc>
  4550. </static_member>
  4551. <static_member name="TRIFAN_MESH" type="Integer" value="2">
  4552. <desc><![CDATA[ Triangle fan based mesh.]]></desc>
  4553. </static_member>
  4554. <static_member name="LINE_MESH" type="Integer" value="4">
  4555. <desc><![CDATA[ Line based mesh.]]></desc>
  4556. </static_member>
  4557. <static_member name="POINT_MESH" type="Integer" value="5">
  4558. <desc><![CDATA[ Point based mesh.]]></desc>
  4559. </static_member>
  4560. <static_member name="LINE_STRIP_MESH" type="Integer" value="6">
  4561. <desc><![CDATA[ Line strip based mesh.]]></desc>
  4562. </static_member>
  4563. <static_member name="LINE_LOOP_MESH" type="Integer" value="7">
  4564. <desc><![CDATA[ Line loop based mesh.]]></desc>
  4565. </static_member>
  4566. </static_members>
  4567. <members>
  4568. <member name="indexedMesh" type="Boolean">
  4569. </member>
  4570. <member name="vertexPositionArray" type="VertexDataArray">
  4571. </member>
  4572. <member name="vertexColorArray" type="VertexDataArray">
  4573. </member>
  4574. <member name="vertexNormalArray" type="VertexDataArray">
  4575. </member>
  4576. <member name="vertexTexCoordArray" type="VertexDataArray">
  4577. </member>
  4578. <member name="vertexTexCoord2Array" type="VertexDataArray">
  4579. </member>
  4580. <member name="vertexTangentArray" type="VertexDataArray">
  4581. </member>
  4582. <member name="vertexBoneWeightArray" type="VertexDataArray">
  4583. </member>
  4584. <member name="vertexBoneIndexArray" type="VertexDataArray">
  4585. </member>
  4586. <member name="indexArray" type="IndexDataArray">
  4587. </member>
  4588. </members>
  4589. <methods>
  4590. <method name="Mesh" return_type="nil">
  4591. <desc><![CDATA[ Construct with an empty mesh of specified type. ]]></desc>
  4592. <params>
  4593. <param name="meshType" type="Integer">
  4594. <desc><![CDATA[Type of mesh. Possible values are: Mesh.TRISTRIP_MESH, Mesh.TRI_MESH, Mesh.TRIFAN_MESH, Mesh.TRISTRIP_MESH, Mesh.LINE_MESH, Mesh.POINT_MESH.]]></desc>
  4595. </param>
  4596. </params>
  4597. </method>
  4598. <method name="MeshFromFileName" return_type="Mesh" static="true">
  4599. <desc><![CDATA[ Construct from a mesh loaded from a file. ]]></desc>
  4600. <params>
  4601. <param name="fileName" type="String">
  4602. <desc><![CDATA[Path to mesh file.]]></desc>
  4603. </param>
  4604. </params>
  4605. </method>
  4606. <method name="loadMesh" return_type="nil">
  4607. <desc><![CDATA[ Loads a mesh from a file. ]]></desc>
  4608. <params>
  4609. <param name="fileName" type="String">
  4610. <desc><![CDATA[Path to mesh file.]]></desc>
  4611. </param>
  4612. </params>
  4613. </method>
  4614. <method name="clearMesh" return_type="nil">
  4615. <desc><![CDATA[ Clears mesh data.]]></desc>
  4616. </method>
  4617. <method name="saveToFile" return_type="nil">
  4618. <desc><![CDATA[ Saves mesh to a file. ]]></desc>
  4619. <params>
  4620. <param name="fileName" type="String">
  4621. <desc><![CDATA[Path to file to save to.]]></desc>
  4622. </param>
  4623. <param name="writeNormals" type="Boolean">
  4624. </param>
  4625. <param name="writeTangents" type="Boolean">
  4626. </param>
  4627. <param name="writeColors" type="Boolean">
  4628. </param>
  4629. <param name="writeBoneWeights" type="Boolean">
  4630. </param>
  4631. <param name="writeUVs" type="Boolean">
  4632. </param>
  4633. <param name="writeSecondaryUVs" type="Boolean">
  4634. </param>
  4635. </params>
  4636. </method>
  4637. <method name="loadFromFile" return_type="nil">
  4638. <params>
  4639. <param name="inFile" type="CoreFile">
  4640. </param>
  4641. </params>
  4642. </method>
  4643. <method name="getVertexCount" return_type="Integer">
  4644. <desc><![CDATA[ Returns the total vertex count in the mesh. ]]></desc>
  4645. </method>
  4646. <method name="createPlane" return_type="nil">
  4647. <desc><![CDATA[ Creates a plane mesh of specified size. ]]></desc>
  4648. <params>
  4649. <param name="w" type="Number">
  4650. <desc><![CDATA[Width of plane.]]></desc>
  4651. </param>
  4652. <param name="h" type="Number">
  4653. <desc><![CDATA[Depth of plane.]]></desc>
  4654. </param>
  4655. <param name="tilingValue" type="Number">
  4656. </param>
  4657. </params>
  4658. </method>
  4659. <method name="createVPlane" return_type="nil">
  4660. <desc><![CDATA[ Creates a vertical plane mesh of specified size. ]]></desc>
  4661. <params>
  4662. <param name="w" type="Number">
  4663. <desc><![CDATA[Width of plane.]]></desc>
  4664. </param>
  4665. <param name="h" type="Number">
  4666. <desc><![CDATA[Depth of plane.]]></desc>
  4667. </param>
  4668. <param name="tilingValue" type="Number">
  4669. </param>
  4670. </params>
  4671. </method>
  4672. <method name="createCircle" return_type="nil">
  4673. <desc><![CDATA[ Creates a 2D circle. ]]></desc>
  4674. <params>
  4675. <param name="w" type="Number">
  4676. <desc><![CDATA[Width of circle.]]></desc>
  4677. </param>
  4678. <param name="h" type="Number">
  4679. <desc><![CDATA[Height of plane.]]></desc>
  4680. </param>
  4681. <param name="numSegments" type="Integer">
  4682. <desc><![CDATA[Number of segments]]></desc>
  4683. </param>
  4684. <param name="tilingValue" type="Number">
  4685. </param>
  4686. </params>
  4687. </method>
  4688. <method name="createLineCircle" return_type="nil">
  4689. <desc><![CDATA[ Creates a 2D circle with normals pointing outwards from vertices. ]]></desc>
  4690. <params>
  4691. <param name="w" type="Number">
  4692. <desc><![CDATA[Width of circle.]]></desc>
  4693. </param>
  4694. <param name="h" type="Number">
  4695. <desc><![CDATA[Height of plane.]]></desc>
  4696. </param>
  4697. <param name="numSegments" type="Integer">
  4698. <desc><![CDATA[Number of segments]]></desc>
  4699. </param>
  4700. <param name="tilingValue" type="Number">
  4701. </param>
  4702. </params>
  4703. </method>
  4704. <method name="createTorus" return_type="nil">
  4705. <desc><![CDATA[ Creates a torus. ]]></desc>
  4706. <params>
  4707. <param name="radius" type="Number">
  4708. <desc><![CDATA[Radius of the torus.]]></desc>
  4709. </param>
  4710. <param name="tubeRadius" type="Number">
  4711. <desc><![CDATA[Radious of the tube.]]></desc>
  4712. </param>
  4713. <param name="segmentsW" type="Integer">
  4714. <desc><![CDATA[Number of radial segments.]]></desc>
  4715. </param>
  4716. <param name="segmentsH" type="Integer">
  4717. <desc><![CDATA[Number of tube segments.]]></desc>
  4718. </param>
  4719. <param name="tilingValue" type="Number">
  4720. </param>
  4721. </params>
  4722. </method>
  4723. <method name="createBox" return_type="nil">
  4724. <desc><![CDATA[ Creates a cube mesh of specified size. ]]></desc>
  4725. <params>
  4726. <param name="w" type="Number">
  4727. <desc><![CDATA[Width of cube.]]></desc>
  4728. </param>
  4729. <param name="d" type="Number">
  4730. <desc><![CDATA[Depth of cube.]]></desc>
  4731. </param>
  4732. <param name="h" type="Number">
  4733. <desc><![CDATA[Height of cube.]]></desc>
  4734. </param>
  4735. <param name="tilingValue" type="Number">
  4736. </param>
  4737. </params>
  4738. </method>
  4739. <method name="createSphere" return_type="nil">
  4740. <desc><![CDATA[ Creates a sphere mesh of specified size. ]]></desc>
  4741. <params>
  4742. <param name="radius" type="Number">
  4743. <desc><![CDATA[Radius of sphere.]]></desc>
  4744. </param>
  4745. <param name="numRings" type="Integer">
  4746. <desc><![CDATA[Number of rings.]]></desc>
  4747. </param>
  4748. <param name="numSegments" type="Integer">
  4749. <desc><![CDATA[Number of segments.]]></desc>
  4750. </param>
  4751. <param name="tilingValue" type="Number">
  4752. </param>
  4753. </params>
  4754. </method>
  4755. <method name="createIcosphere" return_type="nil">
  4756. <desc><![CDATA[ Creates an icosphere of specified radius ]]></desc>
  4757. <params>
  4758. <param name="radius" type="Number">
  4759. <desc><![CDATA[Radius of sphere.]]></desc>
  4760. </param>
  4761. <param name="subdivisions" type="Integer">
  4762. <desc><![CDATA[0 means you get an icosahedron, don't recommend ever going above about 4 or 5 as they get really big]]></desc>
  4763. </param>
  4764. </params>
  4765. </method>
  4766. <method name="createOctosphere" return_type="nil">
  4767. <desc><![CDATA[ Creates an octosphere of specified radius ]]></desc>
  4768. <params>
  4769. <param name="radius" type="Number">
  4770. <desc><![CDATA[Radius of sphere.]]></desc>
  4771. </param>
  4772. <param name="subdivisions" type="Integer">
  4773. <desc><![CDATA[0 means you get an octagon, don't recommend ever going too high as they get really big]]></desc>
  4774. </param>
  4775. </params>
  4776. </method>
  4777. <method name="createCylinder" return_type="nil">
  4778. <desc><![CDATA[ Creates a cylinder mesh. ]]></desc>
  4779. <params>
  4780. <param name="height" type="Number">
  4781. <desc><![CDATA[Height of the cylinder.]]></desc>
  4782. </param>
  4783. <param name="radius" type="Number">
  4784. <desc><![CDATA[Radius of the cylinder.]]></desc>
  4785. </param>
  4786. <param name="numSegments" type="Integer">
  4787. <desc><![CDATA[Number of segments.]]></desc>
  4788. </param>
  4789. <param name="capped" type="Boolean">
  4790. <desc><![CDATA[Create the end caps.]]></desc>
  4791. </param>
  4792. <param name="tilingValue" type="Number">
  4793. </param>
  4794. </params>
  4795. </method>
  4796. <method name="createCone" return_type="nil">
  4797. <desc><![CDATA[ Creates a cone mesh. ]]></desc>
  4798. <params>
  4799. <param name="height" type="Number">
  4800. <desc><![CDATA[Height of the cone.]]></desc>
  4801. </param>
  4802. <param name="radius" type="Number">
  4803. <desc><![CDATA[Radius of the cone.]]></desc>
  4804. </param>
  4805. <param name="numSegments" type="Integer">
  4806. <desc><![CDATA[Number of segments.]]></desc>
  4807. </param>
  4808. <param name="tilingValue" type="Number">
  4809. </param>
  4810. </params>
  4811. </method>
  4812. <method name="recenterMesh" return_type="Vector3">
  4813. <desc><![CDATA[ Recenters the mesh with all vertices being as equidistant from origin as possible.]]></desc>
  4814. </method>
  4815. <method name="setVertexAtOffset" return_type="nil">
  4816. <params>
  4817. <param name="offset" type="Integer">
  4818. </param>
  4819. <param name="x" type="Number">
  4820. </param>
  4821. <param name="y" type="Number">
  4822. </param>
  4823. <param name="z" type="Number">
  4824. </param>
  4825. </params>
  4826. </method>
  4827. <method name="addVertexWithUVAndNormal" return_type="nil">
  4828. <params>
  4829. <param name="x" type="Number">
  4830. </param>
  4831. <param name="y" type="Number">
  4832. </param>
  4833. <param name="z" type="Number">
  4834. </param>
  4835. <param name="u" type="Number">
  4836. </param>
  4837. <param name="v" type="Number">
  4838. </param>
  4839. <param name="nx" type="Number">
  4840. </param>
  4841. <param name="ny" type="Number">
  4842. </param>
  4843. <param name="nz" type="Number">
  4844. </param>
  4845. </params>
  4846. </method>
  4847. <method name="addTexCoord" return_type="nil">
  4848. <params>
  4849. <param name="u" type="Number">
  4850. </param>
  4851. <param name="v" type="Number">
  4852. </param>
  4853. </params>
  4854. </method>
  4855. <method name="addTexCoord2" return_type="nil">
  4856. <params>
  4857. <param name="u" type="Number">
  4858. </param>
  4859. <param name="v" type="Number">
  4860. </param>
  4861. </params>
  4862. </method>
  4863. <method name="addTangent" return_type="nil">
  4864. <params>
  4865. <param name="x" type="Number">
  4866. </param>
  4867. <param name="y" type="Number">
  4868. </param>
  4869. <param name="z" type="Number">
  4870. </param>
  4871. </params>
  4872. </method>
  4873. <method name="addVertexWithUV" return_type="nil">
  4874. <params>
  4875. <param name="x" type="Number">
  4876. </param>
  4877. <param name="y" type="Number">
  4878. </param>
  4879. <param name="z" type="Number">
  4880. </param>
  4881. <param name="u" type="Number">
  4882. </param>
  4883. <param name="v" type="Number">
  4884. </param>
  4885. </params>
  4886. </method>
  4887. <method name="addVertex" return_type="nil">
  4888. <params>
  4889. <param name="x" type="Number">
  4890. </param>
  4891. <param name="y" type="Number">
  4892. </param>
  4893. <param name="z" type="Number">
  4894. </param>
  4895. </params>
  4896. </method>
  4897. <method name="addNormal" return_type="nil">
  4898. <params>
  4899. <param name="nx" type="Number">
  4900. </param>
  4901. <param name="ny" type="Number">
  4902. </param>
  4903. <param name="nz" type="Number">
  4904. </param>
  4905. </params>
  4906. </method>
  4907. <method name="addBoneAssignments" return_type="nil">
  4908. <params>
  4909. <param name="b1Weight" type="Number">
  4910. </param>
  4911. <param name="b1Index" type="Integer">
  4912. </param>
  4913. <param name="b2Weight" type="Number">
  4914. </param>
  4915. <param name="b2Index" type="Integer">
  4916. </param>
  4917. <param name="b3Weight" type="Number">
  4918. </param>
  4919. <param name="b3Index" type="Integer">
  4920. </param>
  4921. <param name="b4Weight" type="Number">
  4922. </param>
  4923. <param name="b4Index" type="Integer">
  4924. </param>
  4925. </params>
  4926. </method>
  4927. <method name="addColor" return_type="nil">
  4928. <params>
  4929. <param name="r" type="Number">
  4930. </param>
  4931. <param name="g" type="Number">
  4932. </param>
  4933. <param name="b" type="Number">
  4934. </param>
  4935. <param name="a" type="Number">
  4936. </param>
  4937. </params>
  4938. </method>
  4939. <method name="getVertexPosition" return_type="Vector3">
  4940. <params>
  4941. <param name="vertexOffset" type="Integer">
  4942. </param>
  4943. </params>
  4944. </method>
  4945. <method name="getVertexPositionAtIndex" return_type="Vector3">
  4946. <params>
  4947. <param name="index" type="Integer">
  4948. </param>
  4949. </params>
  4950. </method>
  4951. <method name="getVertexTexCoord" return_type="Vector2">
  4952. <params>
  4953. <param name="vertexOffset" type="Integer">
  4954. </param>
  4955. </params>
  4956. </method>
  4957. <method name="getVertexTexCoordAtIndex" return_type="Vector2">
  4958. <params>
  4959. <param name="index" type="Integer">
  4960. </param>
  4961. </params>
  4962. </method>
  4963. <method name="Copy" return_type="Mesh">
  4964. </method>
  4965. <method name="getRadius" return_type="Number">
  4966. <desc><![CDATA[ Returns the radius of the mesh (furthest vertex away from origin). ]]></desc>
  4967. </method>
  4968. <method name="calculateNormals" return_type="nil">
  4969. <desc><![CDATA[ Recalculates the mesh normals ]]></desc>
  4970. </method>
  4971. <method name="calculateTangents" return_type="nil">
  4972. <desc><![CDATA[ Recalculates the tangent space vector for all vertices.]]></desc>
  4973. </method>
  4974. <method name="getMeshType" return_type="Integer">
  4975. <desc><![CDATA[ Returns the mesh type.]]></desc>
  4976. </method>
  4977. <method name="setMeshType" return_type="nil">
  4978. <desc><![CDATA[ Sets a new mesh type. ]]></desc>
  4979. <params>
  4980. <param name="newType" type="Integer">
  4981. <desc><![CDATA[New mesh type. Possible values are: Mesh.TRISTRIP_MESH, Mesh.TRI_MESH, Mesh.TRIFAN_MESH, Mesh.TRISTRIP_MESH, Mesh.LINE_MESH, Mesh.POINT_MESH.]]></desc>
  4982. </param>
  4983. </params>
  4984. </method>
  4985. <method name="getIndexGroupSize" return_type="Integer">
  4986. </method>
  4987. <method name="calculateBBox" return_type="Vector3">
  4988. <desc><![CDATA[ Calculates the mesh bounding box.]]></desc>
  4989. </method>
  4990. <method name="hasVertexBuffer" return_type="Boolean">
  4991. <desc><![CDATA[ Checks if the mesh has a vertex buffer. ]]></desc>
  4992. </method>
  4993. <method name="addIndexedFace" return_type="nil">
  4994. <params>
  4995. <param name="i1" type="Integer">
  4996. </param>
  4997. <param name="i2" type="Integer">
  4998. </param>
  4999. </params>
  5000. </method>
  5001. <method name="addIndex" return_type="nil">
  5002. <params>
  5003. <param name="index" type="Integer">
  5004. </param>
  5005. </params>
  5006. </method>
  5007. <method name="removeVertexRange" return_type="nil">
  5008. <desc><![CDATA[ Removes a range of vertices starting at beginRemoveVertex. vertexRemovalCount should be a multiple of the num if you want to keep your mesh data clean. If this is an indexedMesh, will also remove any faces that reference ]]></desc>
  5009. <params>
  5010. <param name="beginRemoveVertex" type="Integer">
  5011. <desc><![CDATA[First element of the vertex array to remove]]></desc>
  5012. </param>
  5013. <param name="vertexRemovalCount" type="Integer">
  5014. <desc><![CDATA[Number of elements to remove from the vertex array]]></desc>
  5015. </param>
  5016. </params>
  5017. </method>
  5018. <method name="removeFace" return_type="nil">
  5019. <desc><![CDATA[ Removes a face from the mesh. Face is defined as a triangle for TRI_MESH, or a line for LI In indexedMesh mode this may result in orphaned vertices. ]]></desc>
  5020. <params>
  5021. <param name="faceIndex" type="Integer">
  5022. <desc><![CDATA[The 0-indexed face of the mesh (and NOT the index into the indices array!)]]></desc>
  5023. </param>
  5024. </params>
  5025. </method>
  5026. <method name="removeUnusedVertices" return_type="Integer">
  5027. <desc><![CDATA[ For indexedMesh only, removes any unused vertices from the mesh. ]]></desc>
  5028. </method>
  5029. <method name="getIndexCount" return_type="Integer">
  5030. </method>
  5031. <method name="subdivideToRadius" return_type="nil">
  5032. <params>
  5033. <param name="radius" type="Number">
  5034. </param>
  5035. <param name="subdivisions" type="Integer">
  5036. </param>
  5037. </params>
  5038. </method>
  5039. <method name="calculateFaceTangent" return_type="Vector3" static="true">
  5040. <params>
  5041. <param name="v1" type="Vector3">
  5042. </param>
  5043. <param name="v2" type="Vector3">
  5044. </param>
  5045. <param name="v3" type="Vector3">
  5046. </param>
  5047. <param name="texCoord1" type="Vector2">
  5048. </param>
  5049. <param name="texCoord2" type="Vector2">
  5050. </param>
  5051. <param name="texCoord3" type="Vector2">
  5052. </param>
  5053. </params>
  5054. </method>
  5055. <method name="saveAsOBJ" return_type="nil">
  5056. <params>
  5057. <param name="fileName" type="String">
  5058. </param>
  5059. </params>
  5060. </method>
  5061. <method name="normalizeBoneWeights" return_type="nil">
  5062. </method>
  5063. </methods>
  5064. </class>
  5065. <class name="ObjectEntry">
  5066. <desc><![CDATA[ Single entry in an Object. Object entries can be accessed as dictionaries or arrays.]]></desc>
  5067. <static_members>
  5068. <static_member name="UNKNOWN_ENTRY" type="Integer" value="- 1">
  5069. </static_member>
  5070. <static_member name="FLOAT_ENTRY" type="Integer" value="0">
  5071. </static_member>
  5072. <static_member name="INT_ENTRY" type="Integer" value="1">
  5073. </static_member>
  5074. <static_member name="BOOL_ENTRY" type="Integer" value="2">
  5075. </static_member>
  5076. <static_member name="ARRAY_ENTRY" type="Integer" value="3">
  5077. </static_member>
  5078. <static_member name="STRING_ENTRY" type="Integer" value="4">
  5079. </static_member>
  5080. <static_member name="CONTAINER_ENTRY" type="Integer" value="5">
  5081. </static_member>
  5082. </static_members>
  5083. <members>
  5084. <member name="type" type="Integer">
  5085. <desc><![CDATA[ Type of entry. Possible values are (FLOAT_ENTRY, INT_ENTRY, BOOL_ENTRY, ARRAY_ENTRY, STRING_ENTRY, CONTAINER_ENTRY).]]></desc>
  5086. </member>
  5087. <member name="name" type="String">
  5088. <desc><![CDATA[ Lookup key for this object entry.]]></desc>
  5089. </member>
  5090. <member name="NumberVal" type="Number">
  5091. <desc><![CDATA[ Number value of this object entry.]]></desc>
  5092. </member>
  5093. <member name="intVal" type="Integer">
  5094. <desc><![CDATA[ Integer value of this object entry.]]></desc>
  5095. </member>
  5096. <member name="stringVal" type="String">
  5097. <desc><![CDATA[ String value of this object entry.]]></desc>
  5098. </member>
  5099. <member name="boolVal" type="Boolean">
  5100. <desc><![CDATA[ Boolean value of this object entry.]]></desc>
  5101. </member>
  5102. <member name="length" type="Integer">
  5103. <desc><![CDATA[ Length of this object entry if its type is ARRAY_ENTRY.]]></desc>
  5104. </member>
  5105. </members>
  5106. <methods>
  5107. <method name="ObjectEntry" return_type="nil">
  5108. <desc><![CDATA[ Default constructor]]></desc>
  5109. </method>
  5110. <method name="readNumber" return_type="Boolean">
  5111. <desc><![CDATA[ Tries to write the Number value of this[key] to out. ]]></desc>
  5112. <params>
  5113. <param name="key" type="String">
  5114. <desc><![CDATA[A pointer to the value to write the number value to.]]></desc>
  5115. </param>
  5116. <param name="out" type="Number">
  5117. </param>
  5118. </params>
  5119. </method>
  5120. <method name="readString" return_type="Boolean">
  5121. <desc><![CDATA[ Tries to write the String value of this[key] to out. ]]></desc>
  5122. <params>
  5123. <param name="key" type="String">
  5124. <desc><![CDATA[A pointer to the value to write the String value to.]]></desc>
  5125. </param>
  5126. <param name="out" type="String">
  5127. </param>
  5128. </params>
  5129. </method>
  5130. <method name="readBool" return_type="Boolean">
  5131. <desc><![CDATA[ Tries to write the boolean value of this[key] to out. ]]></desc>
  5132. <params>
  5133. <param name="key" type="String">
  5134. <desc><![CDATA[A pointer to the value to write the boolean value to.]]></desc>
  5135. </param>
  5136. <param name="out" type="Boolean">
  5137. </param>
  5138. </params>
  5139. </method>
  5140. <method name="addChild" return_type="ObjectEntry">
  5141. <desc><![CDATA[ Adds an empty child entry. ]]></desc>
  5142. <params>
  5143. <param name="name" type="String">
  5144. <desc><![CDATA[Lookup key for the object entry.]]></desc>
  5145. </param>
  5146. </params>
  5147. </method>
  5148. <method name="getTypedName" return_type="String">
  5149. </method>
  5150. <method name="setTypedName" return_type="nil">
  5151. <params>
  5152. <param name="str" type="String">
  5153. </param>
  5154. </params>
  5155. </method>
  5156. <method name="Clear" return_type="nil">
  5157. </method>
  5158. </methods>
  5159. </class>
  5160. <class name="BinaryObjectReader">
  5161. <static_members>
  5162. </static_members>
  5163. <members>
  5164. <member name="success" type="Boolean">
  5165. </member>
  5166. </members>
  5167. <methods>
  5168. <method name="BinaryObjectReader" return_type="nil">
  5169. <params>
  5170. <param name="fileName" type="String">
  5171. </param>
  5172. <param name="object" type="Object">
  5173. </param>
  5174. </params>
  5175. </method>
  5176. </methods>
  5177. </class>
  5178. <class name="BinaryObjectWriter">
  5179. <static_members>
  5180. </static_members>
  5181. <members>
  5182. </members>
  5183. <methods>
  5184. <method name="BinaryObjectWriter" return_type="nil">
  5185. <params>
  5186. <param name="object" type="Object">
  5187. </param>
  5188. </params>
  5189. </method>
  5190. <method name="parseKeysFromObjectEntry" return_type="nil">
  5191. <params>
  5192. <param name="entry" type="ObjectEntry">
  5193. </param>
  5194. </params>
  5195. </method>
  5196. <method name="writeEntryToFile" return_type="nil">
  5197. <params>
  5198. <param name="entry" type="ObjectEntry">
  5199. </param>
  5200. </params>
  5201. </method>
  5202. <method name="addKey" return_type="Integer">
  5203. <params>
  5204. <param name="key" type="String">
  5205. </param>
  5206. </params>
  5207. </method>
  5208. <method name="getKeyIndex" return_type="Integer">
  5209. <params>
  5210. <param name="key" type="String">
  5211. </param>
  5212. </params>
  5213. </method>
  5214. <method name="writeToFile" return_type="Boolean">
  5215. <params>
  5216. <param name="fileName" type="String">
  5217. </param>
  5218. </params>
  5219. </method>
  5220. </methods>
  5221. </class>
  5222. <class name="OpenGLGraphicsInterface" extends="GraphicsInterface">
  5223. <static_members>
  5224. </static_members>
  5225. <members>
  5226. <member name="lineSmooth" type="Boolean">
  5227. </member>
  5228. </members>
  5229. <methods>
  5230. <method name="OpenGLGraphicsInterface" return_type="nil">
  5231. </method>
  5232. <method name="createTexture" return_type="nil">
  5233. <params>
  5234. <param name="texture" type="Texture">
  5235. </param>
  5236. </params>
  5237. </method>
  5238. <method name="destroyTexture" return_type="nil">
  5239. <params>
  5240. <param name="texture" type="Texture">
  5241. </param>
  5242. </params>
  5243. </method>
  5244. <method name="setViewport" return_type="nil">
  5245. <params>
  5246. <param name="x" type="Integer">
  5247. </param>
  5248. <param name="y" type="Integer">
  5249. </param>
  5250. <param name="width" type="Integer">
  5251. </param>
  5252. <param name="height" type="Integer">
  5253. </param>
  5254. </params>
  5255. </method>
  5256. <method name="clearBuffers" return_type="nil">
  5257. <params>
  5258. <param name="clearColor" type="Color">
  5259. </param>
  5260. <param name="colorBuffer" type="Boolean">
  5261. </param>
  5262. <param name="depthBuffer" type="Boolean">
  5263. </param>
  5264. <param name="stencilBuffer" type="Boolean">
  5265. </param>
  5266. </params>
  5267. </method>
  5268. <method name="setParamInShader" return_type="nil">
  5269. <params>
  5270. <param name="shader" type="Shader">
  5271. </param>
  5272. <param name="param" type="ProgramParam">
  5273. </param>
  5274. <param name="localParam" type="LocalShaderParam">
  5275. </param>
  5276. </params>
  5277. </method>
  5278. <method name="setAttributeInShader" return_type="nil">
  5279. <params>
  5280. <param name="shader" type="Shader">
  5281. </param>
  5282. <param name="attribute" type="ProgramAttribute">
  5283. </param>
  5284. <param name="attributeBinding" type="AttributeBinding">
  5285. </param>
  5286. </params>
  5287. </method>
  5288. <method name="disableAttribute" return_type="nil">
  5289. <params>
  5290. <param name="shader" type="Shader">
  5291. </param>
  5292. <param name="attribute" type="ProgramAttribute">
  5293. </param>
  5294. </params>
  5295. </method>
  5296. <method name="useShader" return_type="nil">
  5297. <params>
  5298. <param name="shader" type="Shader">
  5299. </param>
  5300. </params>
  5301. </method>
  5302. <method name="createProgram" return_type="nil">
  5303. <params>
  5304. <param name="program" type="ShaderProgram">
  5305. </param>
  5306. </params>
  5307. </method>
  5308. <method name="destroyProgram" return_type="nil">
  5309. <params>
  5310. <param name="program" type="ShaderProgram">
  5311. </param>
  5312. </params>
  5313. </method>
  5314. <method name="createVBOForVertexArray" return_type="nil">
  5315. <params>
  5316. <param name="array" type="VertexDataArray">
  5317. </param>
  5318. </params>
  5319. </method>
  5320. <method name="createMesh" return_type="nil">
  5321. <params>
  5322. <param name="mesh" type="Mesh">
  5323. </param>
  5324. </params>
  5325. </method>
  5326. <method name="destroyMesh" return_type="nil">
  5327. <params>
  5328. <param name="mesh" type="Mesh">
  5329. </param>
  5330. </params>
  5331. </method>
  5332. <method name="createShader" return_type="nil">
  5333. <params>
  5334. <param name="shader" type="Shader">
  5335. </param>
  5336. </params>
  5337. </method>
  5338. <method name="destroyShader" return_type="nil">
  5339. <params>
  5340. <param name="shader" type="Shader">
  5341. </param>
  5342. </params>
  5343. </method>
  5344. <method name="beginDrawCall" return_type="nil">
  5345. </method>
  5346. <method name="endDrawCall" return_type="nil">
  5347. </method>
  5348. <method name="setBlendingMode" return_type="nil">
  5349. <params>
  5350. <param name="blendingMode" type="Integer">
  5351. </param>
  5352. </params>
  5353. </method>
  5354. <method name="createRenderBuffer" return_type="nil">
  5355. <params>
  5356. <param name="renderBuffer" type="RenderBuffer">
  5357. </param>
  5358. </params>
  5359. </method>
  5360. <method name="destroyRenderBuffer" return_type="nil">
  5361. <params>
  5362. <param name="renderBuffer" type="RenderBuffer">
  5363. </param>
  5364. </params>
  5365. </method>
  5366. <method name="bindRenderBuffer" return_type="nil">
  5367. <params>
  5368. <param name="renderBuffer" type="RenderBuffer">
  5369. </param>
  5370. </params>
  5371. </method>
  5372. <method name="createVertexBuffer" return_type="nil">
  5373. <params>
  5374. <param name="dataArray" type="VertexDataArray">
  5375. </param>
  5376. </params>
  5377. </method>
  5378. <method name="createIndexBuffer" return_type="nil">
  5379. <params>
  5380. <param name="dataArray" type="IndexDataArray">
  5381. </param>
  5382. </params>
  5383. </method>
  5384. <method name="destroyBuffer" return_type="nil">
  5385. <params>
  5386. <param name="array" type="RenderDataArray">
  5387. </param>
  5388. </params>
  5389. </method>
  5390. <method name="drawIndices" return_type="nil">
  5391. <params>
  5392. <param name="type" type="Integer">
  5393. </param>
  5394. <param name="indexArray" type="IndexDataArray">
  5395. </param>
  5396. </params>
  5397. </method>
  5398. <method name="drawArrays" return_type="nil">
  5399. <params>
  5400. <param name="type" type="Integer">
  5401. </param>
  5402. <param name="vertexCount" type="Integer">
  5403. </param>
  5404. </params>
  5405. </method>
  5406. <method name="enableDepthTest" return_type="nil">
  5407. <params>
  5408. <param name="val" type="Boolean">
  5409. </param>
  5410. </params>
  5411. </method>
  5412. <method name="enableDepthWrite" return_type="nil">
  5413. <params>
  5414. <param name="val" type="Boolean">
  5415. </param>
  5416. </params>
  5417. </method>
  5418. <method name="enableBackfaceCulling" return_type="nil">
  5419. <params>
  5420. <param name="val" type="Boolean">
  5421. </param>
  5422. </params>
  5423. </method>
  5424. <method name="setLineSize" return_type="nil">
  5425. <params>
  5426. <param name="lineSize" type="Number">
  5427. </param>
  5428. </params>
  5429. </method>
  5430. <method name="setWireframeMode" return_type="nil">
  5431. <params>
  5432. <param name="val" type="Boolean">
  5433. </param>
  5434. </params>
  5435. </method>
  5436. <method name="enableScissor" return_type="nil">
  5437. <params>
  5438. <param name="val" type="Boolean">
  5439. </param>
  5440. </params>
  5441. </method>
  5442. <method name="setScissorBox" return_type="nil">
  5443. <params>
  5444. <param name="box" type="Rectangle">
  5445. </param>
  5446. </params>
  5447. </method>
  5448. </methods>
  5449. </class>
  5450. <class name="SceneParticle">
  5451. <static_members>
  5452. </static_members>
  5453. <members>
  5454. <member name="lifetime" type="Number">
  5455. </member>
  5456. <member name="position" type="Vector3">
  5457. </member>
  5458. <member name="velocity" type="Vector3">
  5459. </member>
  5460. <member name="perlinPos" type="Vector3">
  5461. </member>
  5462. <member name="rotation" type="Vector3">
  5463. </member>
  5464. <member name="brightnessDeviation" type="Number">
  5465. </member>
  5466. <member name="scale" type="Number">
  5467. </member>
  5468. <member name="color" type="Color">
  5469. </member>
  5470. <member name="varianceIndex" type="Integer">
  5471. </member>
  5472. </members>
  5473. <methods>
  5474. </methods>
  5475. </class>
  5476. <class name="SceneParticleEmitter" extends="SceneMesh">
  5477. <class_notes>NOTE: SceneParticleEmitter instances are not automatically garbage collected.</class_notes>
  5478. <static_members>
  5479. <static_member name="PARTICLE_TYPE_POINT" type="Integer" value="0">
  5480. </static_member>
  5481. <static_member name="PARTICLE_TYPE_QUAD" type="Integer" value="1">
  5482. </static_member>
  5483. <static_member name="PARTICLE_TYPE_MESH" type="Integer" value="2">
  5484. </static_member>
  5485. </static_members>
  5486. <members>
  5487. <member name="useScaleCurve" type="Boolean">
  5488. </member>
  5489. <member name="scaleCurve" type="BezierCurve">
  5490. <desc><![CDATA[ Bezier curve that controls the scale of the particles.]]></desc>
  5491. </member>
  5492. <member name="useColorCurves" type="Boolean">
  5493. </member>
  5494. <member name="colorCurveR" type="BezierCurve">
  5495. <desc><![CDATA[ Bezier curve that controls the red component of particles' color.]]></desc>
  5496. </member>
  5497. <member name="colorCurveG" type="BezierCurve">
  5498. <desc><![CDATA[ Bezier curve that controls the green component of particles' color.]]></desc>
  5499. </member>
  5500. <member name="colorCurveB" type="BezierCurve">
  5501. <desc><![CDATA[ Bezier curve that controls the blue component of particles' color.]]></desc>
  5502. </member>
  5503. <member name="colorCurveA" type="BezierCurve">
  5504. <desc><![CDATA[ Bezier curve that controls the alpha component of particles' color.]]></desc>
  5505. </member>
  5506. <member name="colorDeviation" type="Color">
  5507. </member>
  5508. </members>
  5509. <methods>
  5510. <method name="SceneParticleEmitter" return_type="nil">
  5511. <params>
  5512. <param name="particleCount" type="Integer">
  5513. </param>
  5514. <param name="lifetime" type="Number">
  5515. </param>
  5516. <param name="speed" type="Number">
  5517. </param>
  5518. </params>
  5519. </method>
  5520. <method name="setParticleCount" return_type="nil">
  5521. <params>
  5522. <param name="newParticleCount" type="Integer">
  5523. </param>
  5524. </params>
  5525. </method>
  5526. <method name="getParticleCount" return_type="Integer">
  5527. </method>
  5528. <method name="setParticleLifetime" return_type="nil">
  5529. <params>
  5530. <param name="lifetime" type="Number">
  5531. </param>
  5532. </params>
  5533. </method>
  5534. <method name="getParticleLifetime" return_type="Number">
  5535. </method>
  5536. <method name="setDirectionDeviation" return_type="nil">
  5537. <params>
  5538. <param name="newDeviation" type="Vector3">
  5539. </param>
  5540. </params>
  5541. </method>
  5542. <method name="getDirectionDeviation" return_type="Vector3">
  5543. </method>
  5544. <method name="setEmitterSize" return_type="nil">
  5545. <params>
  5546. <param name="newSize" type="Vector3">
  5547. </param>
  5548. </params>
  5549. </method>
  5550. <method name="getEmitterSize" return_type="Vector3">
  5551. </method>
  5552. <method name="setGravity" return_type="nil">
  5553. <params>
  5554. <param name="newGravity" type="Vector3">
  5555. </param>
  5556. </params>
  5557. </method>
  5558. <method name="getGravity" return_type="Vector3">
  5559. </method>
  5560. <method name="fixedUpdate" return_type="nil">
  5561. </method>
  5562. <method name="Render" return_type="nil">
  5563. <params>
  5564. <param name="buffer" type="GPUDrawBuffer">
  5565. </param>
  5566. </params>
  5567. </method>
  5568. <method name="updateParticles" return_type="nil">
  5569. </method>
  5570. <method name="rebuildParticles" return_type="nil">
  5571. <params>
  5572. <param name="buffer" type="GPUDrawBuffer">
  5573. </param>
  5574. </params>
  5575. </method>
  5576. <method name="triggerParticles" return_type="nil">
  5577. <params>
  5578. <param name="allAtOnce" type="Boolean">
  5579. </param>
  5580. </params>
  5581. </method>
  5582. <method name="enableParticleSystem" return_type="nil">
  5583. <params>
  5584. <param name="val" type="Boolean">
  5585. </param>
  5586. </params>
  5587. </method>
  5588. <method name="setUseFloorPlane" return_type="nil">
  5589. <params>
  5590. <param name="val" type="Boolean">
  5591. </param>
  5592. </params>
  5593. </method>
  5594. <method name="setFloorPlaneOffset" return_type="nil">
  5595. <params>
  5596. <param name="floorPlaneOffset" type="Number">
  5597. </param>
  5598. </params>
  5599. </method>
  5600. <method name="setFloorDamping" return_type="nil">
  5601. <params>
  5602. <param name="floorDamping" type="Number">
  5603. </param>
  5604. </params>
  5605. </method>
  5606. <method name="setParticlesInWorldSpace" return_type="nil">
  5607. <params>
  5608. <param name="val" type="Boolean">
  5609. </param>
  5610. </params>
  5611. </method>
  5612. <method name="getParticlesInWorldSpace" return_type="Boolean">
  5613. </method>
  5614. <method name="setPerlinEnabled" return_type="nil">
  5615. <params>
  5616. <param name="val" type="Boolean">
  5617. </param>
  5618. </params>
  5619. </method>
  5620. <method name="getPerlinEnabled" return_type="Boolean">
  5621. </method>
  5622. <method name="getParticleSpeed" return_type="Number">
  5623. </method>
  5624. <method name="setParticleSpeed" return_type="nil">
  5625. <params>
  5626. <param name="speed" type="Number">
  5627. </param>
  5628. </params>
  5629. </method>
  5630. <method name="setPerlinValue" return_type="nil">
  5631. <params>
  5632. <param name="perlinValue" type="Vector3">
  5633. </param>
  5634. </params>
  5635. </method>
  5636. <method name="getPerlinValue" return_type="Vector3">
  5637. </method>
  5638. <method name="setParticleType" return_type="nil">
  5639. <params>
  5640. <param name="particleType" type="Integer">
  5641. </param>
  5642. </params>
  5643. </method>
  5644. <method name="getParticleType" return_type="Integer">
  5645. </method>
  5646. <method name="setParticleSize" return_type="nil">
  5647. <params>
  5648. <param name="particleSize" type="Number">
  5649. </param>
  5650. </params>
  5651. </method>
  5652. <method name="getParticleSize" return_type="Number">
  5653. </method>
  5654. <method name="setParticleRotationSpeed" return_type="nil">
  5655. <params>
  5656. <param name="rotationSpeed" type="Vector3">
  5657. </param>
  5658. </params>
  5659. </method>
  5660. <method name="getParticleRotationSpeed" return_type="Vector3">
  5661. </method>
  5662. <method name="setParticleDirection" return_type="nil">
  5663. <params>
  5664. <param name="direction" type="Vector3">
  5665. </param>
  5666. </params>
  5667. </method>
  5668. <method name="getParticleDirection" return_type="Vector3">
  5669. </method>
  5670. <method name="setLoopParticles" return_type="nil">
  5671. <params>
  5672. <param name="val" type="Boolean">
  5673. </param>
  5674. </params>
  5675. </method>
  5676. <method name="getLoopParticles" return_type="Boolean">
  5677. </method>
  5678. <method name="addSourceMesh" return_type="nil">
  5679. <params>
  5680. <param name="mesh" type="Mesh">
  5681. </param>
  5682. </params>
  5683. </method>
  5684. <method name="getNumSourceMeshes" return_type="Integer">
  5685. </method>
  5686. <method name="getSourcesMeshAtIndex" return_type="Mesh">
  5687. <params>
  5688. <param name="index" type="Integer">
  5689. </param>
  5690. </params>
  5691. </method>
  5692. <method name="removeSourceMeshAtIndex" return_type="nil">
  5693. <params>
  5694. <param name="index" type="Integer">
  5695. </param>
  5696. </params>
  5697. </method>
  5698. <method name="positionParticle" return_type="nil">
  5699. <params>
  5700. <param name="index" type="Integer">
  5701. </param>
  5702. </params>
  5703. </method>
  5704. <method name="Clone" return_type="Entity">
  5705. <params>
  5706. <param name="deepClone" type="Boolean">
  5707. </param>
  5708. <param name="ignoreEditorOnly" type="Boolean">
  5709. </param>
  5710. </params>
  5711. </method>
  5712. <method name="applyClone" return_type="nil">
  5713. <params>
  5714. <param name="clone" type="Entity">
  5715. </param>
  5716. <param name="deepClone" type="Boolean">
  5717. </param>
  5718. <param name="ignoreEditorOnly" type="Boolean">
  5719. </param>
  5720. </params>
  5721. </method>
  5722. </methods>
  5723. </class>
  5724. <class name="Perlin">
  5725. <desc><![CDATA[ 2D Perlin noise.]]></desc>
  5726. <static_members>
  5727. </static_members>
  5728. <members>
  5729. </members>
  5730. <methods>
  5731. <method name="Perlin" return_type="nil">
  5732. <desc><![CDATA[ Constructs perlin noise. ]]></desc>
  5733. <params>
  5734. <param name="octaves" type="Integer">
  5735. <desc><![CDATA[Number of noise octaves.]]></desc>
  5736. </param>
  5737. <param name="freq" type="Number">
  5738. <desc><![CDATA[Noise frequency.]]></desc>
  5739. </param>
  5740. <param name="amp" type="Number">
  5741. <desc><![CDATA[Noise amplitude.]]></desc>
  5742. </param>
  5743. <param name="seed" type="Integer">
  5744. <desc><![CDATA[Noise seed.]]></desc>
  5745. </param>
  5746. </params>
  5747. </method>
  5748. <method name="Get2DTiledX" return_type="Number">
  5749. <params>
  5750. <param name="x" type="Number">
  5751. </param>
  5752. <param name="y" type="Number">
  5753. </param>
  5754. <param name="t" type="Number">
  5755. </param>
  5756. </params>
  5757. </method>
  5758. <method name="Get" return_type="Number">
  5759. <desc><![CDATA[ Returns noise value at the specified coordinate. ]]></desc>
  5760. <params>
  5761. <param name="x" type="Number">
  5762. <desc><![CDATA[Horizontal coordinate.]]></desc>
  5763. </param>
  5764. <param name="y" type="Number">
  5765. <desc><![CDATA[Vertical coordinate.]]></desc>
  5766. </param>
  5767. </params>
  5768. </method>
  5769. <method name="Get2D" return_type="Number">
  5770. <params>
  5771. <param name="x" type="Number">
  5772. </param>
  5773. <param name="y" type="Number">
  5774. </param>
  5775. </params>
  5776. </method>
  5777. <method name="Get3D" return_type="Number">
  5778. <params>
  5779. <param name="x" type="Number">
  5780. </param>
  5781. <param name="y" type="Number">
  5782. </param>
  5783. <param name="z" type="Number">
  5784. </param>
  5785. </params>
  5786. </method>
  5787. </methods>
  5788. </class>
  5789. <class name="PhysFSFile" extends="CoreFile">
  5790. <static_members>
  5791. </static_members>
  5792. <members>
  5793. <member name="physFSFile" type="PHYSFS_File">
  5794. </member>
  5795. </members>
  5796. <methods>
  5797. <method name="read" return_type="Integer">
  5798. <params>
  5799. <param name="ptr" type="nil">
  5800. </param>
  5801. <param name="size" type="size_t">
  5802. </param>
  5803. <param name="count" type="size_t">
  5804. </param>
  5805. </params>
  5806. </method>
  5807. <method name="write" return_type="Integer">
  5808. <params>
  5809. <param name="ptr" type="nil">
  5810. </param>
  5811. <param name="size" type="size_t">
  5812. </param>
  5813. <param name="count" type="size_t">
  5814. </param>
  5815. </params>
  5816. </method>
  5817. <method name="seek" return_type="Integer">
  5818. <params>
  5819. <param name="offset" type="Integer">
  5820. </param>
  5821. <param name="origin" type="Integer">
  5822. </param>
  5823. </params>
  5824. </method>
  5825. <method name="tell" return_type="Integer">
  5826. </method>
  5827. </methods>
  5828. </class>
  5829. <class name="PhysFSFileProvider" extends="CoreFileProvider">
  5830. <static_members>
  5831. </static_members>
  5832. <members>
  5833. </members>
  5834. <methods>
  5835. <method name="PhysFSFileProvider" return_type="nil">
  5836. </method>
  5837. <method name="openFile" return_type="CoreFile">
  5838. <params>
  5839. <param name="fileName" type="String">
  5840. </param>
  5841. <param name="opts" type="String">
  5842. </param>
  5843. </params>
  5844. </method>
  5845. <method name="closeFile" return_type="nil">
  5846. <params>
  5847. <param name="file" type="CoreFile">
  5848. </param>
  5849. </params>
  5850. </method>
  5851. <method name="parseFolder" return_type="Boolean">
  5852. <params>
  5853. <param name="pathString" type="String">
  5854. </param>
  5855. <param name="showHidden" type="Boolean">
  5856. </param>
  5857. <param name="targetVector" param_array="true" type="OSFileEntry&">
  5858. </param>
  5859. </params>
  5860. </method>
  5861. <method name="addSource" return_type="nil">
  5862. <params>
  5863. <param name="source" type="String">
  5864. </param>
  5865. </params>
  5866. </method>
  5867. <method name="removeSource" return_type="nil">
  5868. <params>
  5869. <param name="source" type="String">
  5870. </param>
  5871. </params>
  5872. </method>
  5873. </methods>
  5874. </class>
  5875. <class name="Quaternion">
  5876. <desc><![CDATA[ Rotation quaternion.]]></desc>
  5877. <static_members>
  5878. </static_members>
  5879. <members>
  5880. <member name="x" type="Number">
  5881. </member>
  5882. <member name="y" type="Number">
  5883. </member>
  5884. <member name="z" type="Number">
  5885. </member>
  5886. <member name="w" type="Number">
  5887. </member>
  5888. </members>
  5889. <methods>
  5890. <method name="Quaternion" return_type="nil">
  5891. <desc><![CDATA[ Construct from w,x,y,z values. ]]></desc>
  5892. <params>
  5893. <param name="w" type="Number">
  5894. <desc><![CDATA[W value.]]></desc>
  5895. </param>
  5896. <param name="x" type="Number">
  5897. <desc><![CDATA[X value.]]></desc>
  5898. </param>
  5899. <param name="y" type="Number">
  5900. <desc><![CDATA[Y value.]]></desc>
  5901. </param>
  5902. <param name="z" type="Number">
  5903. <desc><![CDATA[Z value.]]></desc>
  5904. </param>
  5905. </params>
  5906. </method>
  5907. <method name="setFromMatrix" return_type="nil">
  5908. <desc><![CDATA[ @name Public members Available public members]]></desc>
  5909. <params>
  5910. <param name="_mat" type="Matrix4">
  5911. </param>
  5912. </params>
  5913. </method>
  5914. <method name="Slerp" return_type="Quaternion" static="true">
  5915. <params>
  5916. <param name="fT" type="Number">
  5917. </param>
  5918. <param name="rkP" type="Quaternion">
  5919. </param>
  5920. <param name="rkQ" type="Quaternion">
  5921. </param>
  5922. <param name="shortestPath" type="Boolean">
  5923. </param>
  5924. </params>
  5925. </method>
  5926. <method name="Dot" return_type="Number">
  5927. <params>
  5928. <param name="rkQ" type="Quaternion">
  5929. </param>
  5930. </params>
  5931. </method>
  5932. <method name="Log" return_type="Quaternion">
  5933. </method>
  5934. <method name="Exp" return_type="Quaternion">
  5935. </method>
  5936. <method name="Norm" return_type="Number">
  5937. </method>
  5938. <method name="Normalize" return_type="Number">
  5939. </method>
  5940. <method name="lookAt" return_type="nil">
  5941. <params>
  5942. <param name="D" type="Vector3">
  5943. </param>
  5944. <param name="upVector" type="Vector3">
  5945. </param>
  5946. </params>
  5947. </method>
  5948. <method name="createFromMatrix" return_type="nil">
  5949. <params>
  5950. <param name="matrix" type="Matrix4">
  5951. </param>
  5952. </params>
  5953. </method>
  5954. <method name="Squad" return_type="Quaternion" static="true">
  5955. <params>
  5956. <param name="fT" type="Number">
  5957. </param>
  5958. <param name="rkP" type="Quaternion">
  5959. </param>
  5960. <param name="rkA" type="Quaternion">
  5961. </param>
  5962. <param name="rkB" type="Quaternion">
  5963. </param>
  5964. <param name="rkQ" type="Quaternion">
  5965. </param>
  5966. <param name="shortestPath" type="Boolean">
  5967. </param>
  5968. </params>
  5969. </method>
  5970. <method name="Inverse" return_type="Quaternion">
  5971. </method>
  5972. <method name="set" return_type="nil">
  5973. <params>
  5974. <param name="w" type="Number">
  5975. </param>
  5976. <param name="x" type="Number">
  5977. </param>
  5978. <param name="y" type="Number">
  5979. </param>
  5980. <param name="z" type="Number">
  5981. </param>
  5982. </params>
  5983. </method>
  5984. <method name="InvSqrt" return_type="Number">
  5985. <params>
  5986. <param name="x" type="Number">
  5987. </param>
  5988. </params>
  5989. </method>
  5990. <method name="fromAxes" return_type="nil">
  5991. <params>
  5992. <param name="az" type="Number">
  5993. </param>
  5994. <param name="ay" type="Number">
  5995. </param>
  5996. <param name="ax" type="Number">
  5997. </param>
  5998. </params>
  5999. </method>
  6000. <method name="fromAngleAxis" return_type="nil">
  6001. <params>
  6002. <param name="rfAngle" type="Number">
  6003. </param>
  6004. <param name="rkAxis" type="Vector3">
  6005. </param>
  6006. </params>
  6007. </method>
  6008. <method name="toEulerAngles" return_type="Vector3">
  6009. </method>
  6010. <method name="toAngleAxis" return_type="nil">
  6011. <params>
  6012. <param name="rfAngle" type="Number">
  6013. </param>
  6014. <param name="rkAxis" type="Vector3">
  6015. </param>
  6016. </params>
  6017. </method>
  6018. <method name="createFromAxisAngle" return_type="nil">
  6019. <params>
  6020. <param name="x" type="Number">
  6021. </param>
  6022. <param name="y" type="Number">
  6023. </param>
  6024. <param name="z" type="Number">
  6025. </param>
  6026. <param name="degrees" type="Number">
  6027. </param>
  6028. </params>
  6029. </method>
  6030. <method name="createMatrix" return_type="Matrix4">
  6031. </method>
  6032. <method name="applyTo" return_type="Vector3">
  6033. <desc><![CDATA[ Rotate a Vector3 by this Quaternion. ]]></desc>
  6034. <params>
  6035. <param name="v" type="Vector3">
  6036. <desc><![CDATA[Vector to operate on.]]></desc>
  6037. </param>
  6038. </params>
  6039. </method>
  6040. </methods>
  6041. </class>
  6042. <class name="QuatTriple">
  6043. <static_members>
  6044. </static_members>
  6045. <members>
  6046. <member name="q1" type="Quaternion">
  6047. </member>
  6048. <member name="q2" type="Quaternion">
  6049. </member>
  6050. <member name="q3" type="Quaternion">
  6051. </member>
  6052. <member name="time" type="Number">
  6053. </member>
  6054. </members>
  6055. <methods>
  6056. </methods>
  6057. </class>
  6058. <class name="QuaternionCurve">
  6059. <static_members>
  6060. </static_members>
  6061. <members>
  6062. </members>
  6063. <methods>
  6064. <method name="QuaternionCurve" return_type="nil">
  6065. <params>
  6066. <param name="wCurve" type="BezierCurve">
  6067. </param>
  6068. <param name="xCurve" type="BezierCurve">
  6069. </param>
  6070. <param name="yCurve" type="BezierCurve">
  6071. </param>
  6072. <param name="zCurve" type="BezierCurve">
  6073. </param>
  6074. </params>
  6075. </method>
  6076. <method name="interpolate" return_type="Quaternion">
  6077. <params>
  6078. <param name="t" type="Number">
  6079. </param>
  6080. <param name="useShortestPath" type="Boolean">
  6081. </param>
  6082. </params>
  6083. </method>
  6084. <method name="generatePointsFromCurves" return_type="nil">
  6085. <params>
  6086. <param name="wCurve" type="BezierCurve">
  6087. </param>
  6088. <param name="xCurve" type="BezierCurve">
  6089. </param>
  6090. <param name="yCurve" type="BezierCurve">
  6091. </param>
  6092. <param name="zCurve" type="BezierCurve">
  6093. </param>
  6094. </params>
  6095. </method>
  6096. </methods>
  6097. </class>
  6098. <class name="Ray">
  6099. <desc><![CDATA[ Ray class. ]]></desc>
  6100. <static_members>
  6101. </static_members>
  6102. <members>
  6103. <member name="origin" type="Vector3">
  6104. </member>
  6105. <member name="direction" type="Vector3">
  6106. </member>
  6107. <member name="inv_direction" type="Vector3">
  6108. </member>
  6109. </members>
  6110. <methods>
  6111. <method name="Ray" return_type="nil">
  6112. </method>
  6113. <method name="boxIntersect" return_type="Number">
  6114. <params>
  6115. <param name="box" type="Vector3">
  6116. </param>
  6117. <param name="transformMatrix" type="Matrix4">
  6118. </param>
  6119. <param name="near" type="Number">
  6120. </param>
  6121. <param name="far" type="Number">
  6122. </param>
  6123. </params>
  6124. </method>
  6125. <method name="planeIntersectPoint" return_type="Vector3">
  6126. <params>
  6127. <param name="planeNormal" type="Vector3">
  6128. </param>
  6129. <param name="planeDistance" type="Number">
  6130. </param>
  6131. </params>
  6132. </method>
  6133. <method name="tranformByMatrix" return_type="Ray">
  6134. <params>
  6135. <param name="matrix" type="Matrix4">
  6136. </param>
  6137. </params>
  6138. </method>
  6139. <method name="closestPointOnRay" return_type="Vector3">
  6140. <desc><![CDATA[ finds the two closest point on the ray to an arbitrary point space.]]></desc>
  6141. <params>
  6142. <param name="point" type="Vector3">
  6143. </param>
  6144. </params>
  6145. </method>
  6146. <method name="closestPointsBetween" return_type="Boolean">
  6147. <desc><![CDATA[ finds the two closest points between two rays, returns false if they're parallel.]]></desc>
  6148. <params>
  6149. <param name="ray2" type="Ray">
  6150. </param>
  6151. <param name="point1" type="Vector3">
  6152. </param>
  6153. <param name="point2" type="Vector3">
  6154. </param>
  6155. </params>
  6156. </method>
  6157. <method name="polygonIntersect" return_type="Boolean">
  6158. <params>
  6159. <param name="v1" type="Vector3">
  6160. </param>
  6161. <param name="v2" type="Vector3">
  6162. </param>
  6163. <param name="v3" type="Vector3">
  6164. </param>
  6165. </params>
  6166. </method>
  6167. </methods>
  6168. </class>
  6169. <class name="Rectangle">
  6170. <desc><![CDATA[ Basic rectangle.]]></desc>
  6171. <static_members>
  6172. </static_members>
  6173. <members>
  6174. <member name="x" type="Number">
  6175. <desc><![CDATA[ X position]]></desc>
  6176. </member>
  6177. <member name="y" type="Number">
  6178. <desc><![CDATA[ Y position]]></desc>
  6179. </member>
  6180. <member name="w" type="Number">
  6181. <desc><![CDATA[ Width]]></desc>
  6182. </member>
  6183. <member name="h" type="Number">
  6184. <desc><![CDATA[ Height]]></desc>
  6185. </member>
  6186. </members>
  6187. <methods>
  6188. <method name="Rectangle" return_type="nil">
  6189. <desc><![CDATA[ Default constructor.]]></desc>
  6190. </method>
  6191. <method name="setRect" return_type="nil">
  6192. <desc><![CDATA[ Set rectangle values.]]></desc>
  6193. <params>
  6194. <param name="x" type="Number">
  6195. </param>
  6196. <param name="y" type="Number">
  6197. </param>
  6198. <param name="w" type="Number">
  6199. </param>
  6200. <param name="h" type="Number">
  6201. </param>
  6202. </params>
  6203. </method>
  6204. <method name="Clipped" return_type="Rectangle">
  6205. <desc><![CDATA[ Return a Rectangle formed by clipping this rectangle to the bounds of the passed rectangle.]]></desc>
  6206. <params>
  6207. <param name="rect" type="Rectangle">
  6208. </param>
  6209. </params>
  6210. </method>
  6211. <method name="minX" return_type="Number">
  6212. <desc><![CDATA[ Return the minimum X coordinate (the left edge).]]></desc>
  6213. </method>
  6214. <method name="maxX" return_type="Number">
  6215. <desc><![CDATA[ Return the maximum X coordinate (the right edge).]]></desc>
  6216. </method>
  6217. <method name="minY" return_type="Number">
  6218. <desc><![CDATA[ Return the minimum Y coordinate (the top edge in a Y-down coordinate system).]]></desc>
  6219. </method>
  6220. <method name="maxY" return_type="Number">
  6221. <desc><![CDATA[ Return the maximum Y coordinate (the bottom edge in a Y-down coordinate system).]]></desc>
  6222. </method>
  6223. </methods>
  6224. </class>
  6225. <class name="RenderDataArray">
  6226. <static_members>
  6227. <static_member name="VERTEX_DATA_ARRAY" type="Integer" value="0">
  6228. <desc><![CDATA[ Vertex position array.]]></desc>
  6229. </static_member>
  6230. <static_member name="COLOR_DATA_ARRAY" type="Integer" value="1">
  6231. <desc><![CDATA[ Vertex color array.]]></desc>
  6232. </static_member>
  6233. <static_member name="NORMAL_DATA_ARRAY" type="Integer" value="2">
  6234. <desc><![CDATA[ Vertex normal array.]]></desc>
  6235. </static_member>
  6236. <static_member name="TEXCOORD_DATA_ARRAY" type="Integer" value="3">
  6237. <desc><![CDATA[ Vertex texture coordinate array.]]></desc>
  6238. </static_member>
  6239. <static_member name="TANGENT_DATA_ARRAY" type="Integer" value="4">
  6240. <desc><![CDATA[ Tangent array.]]></desc>
  6241. </static_member>
  6242. <static_member name="BONE_WEIGHT_DATA_ARRAY" type="Integer" value="5">
  6243. <desc><![CDATA[ Bone weight array.]]></desc>
  6244. </static_member>
  6245. <static_member name="BONE_INDEX_DATA_ARRAY" type="Integer" value="6">
  6246. <desc><![CDATA[ Bone weight array.]]></desc>
  6247. </static_member>
  6248. <static_member name="INDEX_DATA_ARRAY" type="Integer" value="7">
  6249. <desc><![CDATA[ Index data array.]]></desc>
  6250. </static_member>
  6251. <static_member name="TEXCOORD2_DATA_ARRAY" type="Integer" value="8">
  6252. <desc><![CDATA[ Secondary texture coordinate array.]]></desc>
  6253. </static_member>
  6254. </static_members>
  6255. <members>
  6256. <member name="type" type="Integer">
  6257. </member>
  6258. <member name="customArrayName" type="String">
  6259. </member>
  6260. <member name="hasVBO" type="Boolean">
  6261. </member>
  6262. <member name="platformData" type="nil">
  6263. </member>
  6264. </members>
  6265. <methods>
  6266. <method name="RenderDataArray" return_type="nil">
  6267. <params>
  6268. <param name="type" type="Integer">
  6269. </param>
  6270. </params>
  6271. </method>
  6272. <method name="getArrayData" return_type="nil">
  6273. </method>
  6274. <method name="getDataSize" return_type="Integer">
  6275. </method>
  6276. </methods>
  6277. </class>
  6278. <class name="VertexDataArray" extends="RenderDataArray">
  6279. <static_members>
  6280. </static_members>
  6281. <members>
  6282. <member name="countPerVertex" type="char">
  6283. </member>
  6284. </members>
  6285. <methods>
  6286. <method name="VertexDataArray" return_type="nil">
  6287. <params>
  6288. <param name="countPerVertex" type="char">
  6289. </param>
  6290. <param name="type" type="Integer">
  6291. </param>
  6292. </params>
  6293. </method>
  6294. <method name="getCountPerVertex" return_type="char">
  6295. </method>
  6296. <method name="getArrayData" return_type="nil">
  6297. </method>
  6298. <method name="getDataSize" return_type="Integer">
  6299. </method>
  6300. </methods>
  6301. </class>
  6302. <class name="IndexDataArray" extends="RenderDataArray">
  6303. <static_members>
  6304. </static_members>
  6305. <members>
  6306. </members>
  6307. <methods>
  6308. <method name="IndexDataArray" return_type="nil">
  6309. <params>
  6310. <param name="type" type="Integer">
  6311. </param>
  6312. </params>
  6313. </method>
  6314. <method name="getArrayData" return_type="nil">
  6315. </method>
  6316. <method name="getDataSize" return_type="Integer">
  6317. </method>
  6318. </methods>
  6319. </class>
  6320. <class name="LightShadowInfoBinding">
  6321. <static_members>
  6322. </static_members>
  6323. <members>
  6324. <member name="shadowMatrix" type="LocalShaderParam">
  6325. </member>
  6326. <member name="shadowBuffer" type="LocalShaderParam">
  6327. </member>
  6328. </members>
  6329. <methods>
  6330. </methods>
  6331. </class>
  6332. <class name="LightInfoBinding">
  6333. <static_members>
  6334. </static_members>
  6335. <members>
  6336. <member name="position" type="LocalShaderParam">
  6337. </member>
  6338. <member name="direction" type="LocalShaderParam">
  6339. </member>
  6340. <member name="specular" type="LocalShaderParam">
  6341. </member>
  6342. <member name="diffuse" type="LocalShaderParam">
  6343. </member>
  6344. <member name="spotExponent" type="LocalShaderParam">
  6345. </member>
  6346. <member name="spotCosCutoff" type="LocalShaderParam">
  6347. </member>
  6348. <member name="constantAttenuation" type="LocalShaderParam">
  6349. </member>
  6350. <member name="linearAttenuation" type="LocalShaderParam">
  6351. </member>
  6352. <member name="quadraticAttenuation" type="LocalShaderParam">
  6353. </member>
  6354. <member name="shadowEnabled" type="LocalShaderParam">
  6355. </member>
  6356. </members>
  6357. <methods>
  6358. </methods>
  6359. </class>
  6360. <class name="RenderFrame">
  6361. <static_members>
  6362. </static_members>
  6363. <members>
  6364. <member name="jobQueue" type="queue<RendererThreadJob>">
  6365. </member>
  6366. </members>
  6367. <methods>
  6368. </methods>
  6369. </class>
  6370. <class name="RendererThreadJob">
  6371. <static_members>
  6372. </static_members>
  6373. <members>
  6374. <member name="jobType" type="Integer">
  6375. </member>
  6376. <member name="data" type="nil">
  6377. </member>
  6378. <member name="data2" type="nil">
  6379. </member>
  6380. </members>
  6381. <methods>
  6382. </methods>
  6383. </class>
  6384. <class name="RenderThread" extends="Threaded">
  6385. <static_members>
  6386. <static_member name="JOB_REQUEST_CONTEXT_CHANGE" type="Integer" value="0">
  6387. </static_member>
  6388. <static_member name="JOB_CREATE_TEXTURE" type="Integer" value="1">
  6389. </static_member>
  6390. <static_member name="JOB_PROCESS_DRAW_BUFFER" type="Integer" value="2">
  6391. </static_member>
  6392. <static_member name="JOB_END_FRAME" type="Integer" value="3">
  6393. </static_member>
  6394. <static_member name="JOB_CREATE_PROGRAM" type="Integer" value="4">
  6395. </static_member>
  6396. <static_member name="JOB_CREATE_SHADER" type="Integer" value="5">
  6397. </static_member>
  6398. <static_member name="JOB_BEGIN_FRAME" type="Integer" value="6">
  6399. </static_member>
  6400. <static_member name="JOB_CREATE_VERTEX_BUFFERS" type="Integer" value="7">
  6401. </static_member>
  6402. <static_member name="JOB_DESTROY_TEXTURE" type="Integer" value="8">
  6403. </static_member>
  6404. <static_member name="JOB_DESTROY_SHADER" type="Integer" value="9">
  6405. </static_member>
  6406. <static_member name="JOB_DESTROY_PROGRAM" type="Integer" value="10">
  6407. </static_member>
  6408. <static_member name="JOB_DESTROY_BUFFER" type="Integer" value="11">
  6409. </static_member>
  6410. <static_member name="JOB_CREATE_RENDER_BUFFER" type="Integer" value="12">
  6411. </static_member>
  6412. <static_member name="JOB_DESTROY_RENDER_BUFFER" type="Integer" value="13">
  6413. </static_member>
  6414. <static_member name="JOB_SET_TEXTURE_PARAM" type="Integer" value="14">
  6415. </static_member>
  6416. <static_member name="JOB_DESTROY_SHADER_BINDING" type="Integer" value="16">
  6417. </static_member>
  6418. <static_member name="JOB_DESTROY_SHADER_PARAM" type="Integer" value="17">
  6419. </static_member>
  6420. <static_member name="JOB_CREATE_MESH" type="Integer" value="18">
  6421. </static_member>
  6422. <static_member name="JOB_DESTROY_MESH" type="Integer" value="19">
  6423. </static_member>
  6424. </static_members>
  6425. <members>
  6426. </members>
  6427. <methods>
  6428. <method name="RenderThread" return_type="nil">
  6429. </method>
  6430. <method name="setGraphicsInterface" return_type="nil">
  6431. <params>
  6432. <param name="core" type="Core">
  6433. </param>
  6434. <param name="graphicsInterface" type="GraphicsInterface">
  6435. </param>
  6436. </params>
  6437. </method>
  6438. <method name="runThread" return_type="nil">
  6439. </method>
  6440. <method name="enqueueFrame" return_type="nil">
  6441. <params>
  6442. <param name="frame" type="RenderFrame">
  6443. </param>
  6444. </params>
  6445. </method>
  6446. <method name="enqueueJob" return_type="nil">
  6447. <params>
  6448. <param name="jobType" type="Integer">
  6449. </param>
  6450. <param name="data" type="nil">
  6451. </param>
  6452. <param name="data2" type="nil">
  6453. </param>
  6454. </params>
  6455. </method>
  6456. <method name="processJob" return_type="nil">
  6457. <params>
  6458. <param name="job" type="RendererThreadJob">
  6459. </param>
  6460. </params>
  6461. </method>
  6462. <method name="getShaderBinding" return_type="ShaderBinding">
  6463. </method>
  6464. <method name="processDrawBuffer" return_type="nil">
  6465. <params>
  6466. <param name="buffer" type="GPUDrawBuffer">
  6467. </param>
  6468. </params>
  6469. </method>
  6470. <method name="getFrameInfo" return_type="RenderThreadDebugInfo">
  6471. </method>
  6472. <method name="clearFrameQueue" return_type="nil">
  6473. </method>
  6474. <method name="initGlobals" return_type="nil">
  6475. </method>
  6476. <method name="lockRenderMutex" return_type="nil">
  6477. </method>
  6478. <method name="unlockRenderMutex" return_type="nil">
  6479. </method>
  6480. </methods>
  6481. </class>
  6482. <class name="RenderThreadDebugInfo">
  6483. <static_members>
  6484. </static_members>
  6485. <members>
  6486. <member name="buffersProcessed" type="Integer">
  6487. </member>
  6488. <member name="drawCallsProcessed" type="Integer">
  6489. </member>
  6490. <member name="timeTaken" type="Integer">
  6491. </member>
  6492. </members>
  6493. <methods>
  6494. </methods>
  6495. </class>
  6496. <class name="Renderer">
  6497. <static_members>
  6498. <static_member name="BLEND_MODE_NONE" type="Integer" value="0">
  6499. </static_member>
  6500. <static_member name="BLEND_MODE_NORMAL" type="Integer" value="1">
  6501. </static_member>
  6502. <static_member name="BLEND_MODE_LIGHTEN" type="Integer" value="2">
  6503. </static_member>
  6504. <static_member name="BLEND_MODE_COLOR" type="Integer" value="3">
  6505. </static_member>
  6506. <static_member name="BLEND_MODE_PREMULTIPLIED" type="Integer" value="4">
  6507. </static_member>
  6508. <static_member name="BLEND_MODE_MULTIPLY" type="Integer" value="5">
  6509. </static_member>
  6510. <static_member name="BLEND_MODE_MATERIAL" type="Integer" value="6">
  6511. </static_member>
  6512. <static_member name="DEPTH_FUNCTION_GREATER" type="Integer" value="0">
  6513. </static_member>
  6514. <static_member name="DEPTH_FUNCTION_LEQUAL" type="Integer" value="1">
  6515. </static_member>
  6516. </static_members>
  6517. <members>
  6518. </members>
  6519. <methods>
  6520. <method name="setGraphicsInterface" return_type="nil">
  6521. <params>
  6522. <param name="core" type="Core">
  6523. </param>
  6524. <param name="graphicsInterface" type="GraphicsInterface">
  6525. </param>
  6526. </params>
  6527. </method>
  6528. <method name="getRenderThread" return_type="RenderThread">
  6529. </method>
  6530. <method name="createCubemap" return_type="Cubemap">
  6531. <params>
  6532. <param name="t0" type="Texture">
  6533. </param>
  6534. <param name="t1" type="Texture">
  6535. </param>
  6536. <param name="t2" type="Texture">
  6537. </param>
  6538. <param name="t3" type="Texture">
  6539. </param>
  6540. <param name="t4" type="Texture">
  6541. </param>
  6542. <param name="t5" type="Texture">
  6543. </param>
  6544. </params>
  6545. </method>
  6546. <method name="createTexture" return_type="Texture">
  6547. <params>
  6548. <param name="width" type="Integer">
  6549. </param>
  6550. <param name="height" type="Integer">
  6551. </param>
  6552. <param name="textureData" type="char">
  6553. </param>
  6554. <param name="clamp" type="Boolean">
  6555. </param>
  6556. <param name="createMipmaps" type="Boolean">
  6557. </param>
  6558. <param name="type" type="Integer">
  6559. </param>
  6560. <param name="filteringMode" type="Integer">
  6561. </param>
  6562. <param name="anisotropy" type="Integer">
  6563. </param>
  6564. <param name="framebufferTexture" type="Boolean">
  6565. </param>
  6566. </params>
  6567. </method>
  6568. <method name="createRenderBuffer" return_type="RenderBuffer">
  6569. <params>
  6570. <param name="width" type="Integer">
  6571. </param>
  6572. <param name="height" type="Integer">
  6573. </param>
  6574. <param name="attachDepthBuffer" type="Boolean">
  6575. </param>
  6576. <param name="floatingPoint" type="Boolean">
  6577. </param>
  6578. </params>
  6579. </method>
  6580. <method name="destroyRenderBuffer" return_type="nil">
  6581. <params>
  6582. <param name="buffer" type="RenderBuffer">
  6583. </param>
  6584. </params>
  6585. </method>
  6586. <method name="destroyTexture" return_type="nil">
  6587. <params>
  6588. <param name="texture" type="Texture">
  6589. </param>
  6590. </params>
  6591. </method>
  6592. <method name="processDrawBuffer" return_type="nil">
  6593. <params>
  6594. <param name="buffer" type="GPUDrawBuffer">
  6595. </param>
  6596. </params>
  6597. </method>
  6598. <method name="setBackingResolutionScale" return_type="nil">
  6599. <params>
  6600. <param name="xScale" type="Number">
  6601. </param>
  6602. <param name="yScale" type="Number">
  6603. </param>
  6604. </params>
  6605. </method>
  6606. <method name="getBackingResolutionScaleX" return_type="Number">
  6607. </method>
  6608. <method name="getBackingResolutionScaleY" return_type="Number">
  6609. </method>
  6610. <method name="createProgram" return_type="ShaderProgram">
  6611. <params>
  6612. <param name="fileName" type="String">
  6613. </param>
  6614. </params>
  6615. </method>
  6616. <method name="createShader" return_type="Shader">
  6617. <params>
  6618. <param name="vertexProgram" type="ShaderProgram">
  6619. </param>
  6620. <param name="fragmentProgram" type="ShaderProgram">
  6621. </param>
  6622. </params>
  6623. </method>
  6624. <method name="createVertexBuffers" return_type="nil">
  6625. <params>
  6626. <param name="mesh" type="Mesh">
  6627. </param>
  6628. </params>
  6629. </method>
  6630. <method name="enqueueFrameJob" return_type="nil">
  6631. <params>
  6632. <param name="jobType" type="Integer">
  6633. </param>
  6634. <param name="data" type="nil">
  6635. </param>
  6636. </params>
  6637. </method>
  6638. <method name="destroyProgram" return_type="nil">
  6639. <params>
  6640. <param name="program" type="ShaderProgram">
  6641. </param>
  6642. </params>
  6643. </method>
  6644. <method name="destroyShader" return_type="nil">
  6645. <params>
  6646. <param name="shader" type="Shader">
  6647. </param>
  6648. </params>
  6649. </method>
  6650. <method name="destroyBuffer" return_type="nil">
  6651. <params>
  6652. <param name="array" type="RenderDataArray">
  6653. </param>
  6654. </params>
  6655. </method>
  6656. <method name="destroyShaderBinding" return_type="nil">
  6657. <params>
  6658. <param name="binding" type="ShaderBinding">
  6659. </param>
  6660. </params>
  6661. </method>
  6662. <method name="destroyShaderParam" return_type="nil">
  6663. <params>
  6664. <param name="param" type="LocalShaderParam">
  6665. </param>
  6666. </params>
  6667. </method>
  6668. <method name="setTextureParam" return_type="nil">
  6669. <params>
  6670. <param name="param" type="LocalShaderParam">
  6671. </param>
  6672. <param name="texture" type="Texture">
  6673. </param>
  6674. </params>
  6675. </method>
  6676. <method name="setAnisotropyAmount" return_type="nil">
  6677. <params>
  6678. <param name="amount" type="Number">
  6679. </param>
  6680. </params>
  6681. </method>
  6682. <method name="getAnisotropyAmount" return_type="Number">
  6683. </method>
  6684. <method name="createMesh" return_type="Mesh">
  6685. <params>
  6686. <param name="fileName" type="String">
  6687. </param>
  6688. </params>
  6689. </method>
  6690. <method name="destroyMesh" return_type="nil">
  6691. <params>
  6692. <param name="mesh" type="Mesh">
  6693. </param>
  6694. </params>
  6695. </method>
  6696. <method name="unProject" return_type="Vector3" static="true">
  6697. <params>
  6698. <param name="position" type="Vector3">
  6699. </param>
  6700. <param name="modelMatrix" type="Matrix4">
  6701. </param>
  6702. <param name="projectionMatrix" type="Matrix4">
  6703. </param>
  6704. <param name="viewport" type="Rectangle">
  6705. </param>
  6706. </params>
  6707. </method>
  6708. <method name="project" return_type="Vector3" static="true">
  6709. <params>
  6710. <param name="position" type="Vector3">
  6711. </param>
  6712. <param name="modelMatrix" type="Matrix4">
  6713. </param>
  6714. <param name="projectionMatrix" type="Matrix4">
  6715. </param>
  6716. <param name="viewport" type="Rectangle">
  6717. </param>
  6718. </params>
  6719. </method>
  6720. <method name="beginFrame" return_type="nil">
  6721. </method>
  6722. <method name="endFrame" return_type="nil">
  6723. </method>
  6724. </methods>
  6725. </class>
  6726. <class name="Resource" extends="EventDispatcher">
  6727. <desc><![CDATA[ Base class for resources. All resources that are managed by the ResourceManager subclass this.]]></desc>
  6728. <static_members>
  6729. <static_member name="RESOURCE_TEXTURE" type="Integer" value="0">
  6730. </static_member>
  6731. <static_member name="RESOURCE_MATERIAL" type="Integer" value="1">
  6732. </static_member>
  6733. <static_member name="RESOURCE_SHADER" type="Integer" value="2">
  6734. </static_member>
  6735. <static_member name="RESOURCE_PROGRAM" type="Integer" value="3">
  6736. </static_member>
  6737. <static_member name="RESOURCE_MESH" type="Integer" value="5">
  6738. </static_member>
  6739. <static_member name="RESOURCE_CUBEMAP" type="Integer" value="6">
  6740. </static_member>
  6741. <static_member name="RESOURCE_SPRITE" type="Integer" value="7">
  6742. </static_member>
  6743. <static_member name="RESOURCE_ENTITY_INSTANCE" type="Integer" value="8">
  6744. </static_member>
  6745. <static_member name="RESOURCE_FONT" type="Integer" value="9">
  6746. </static_member>
  6747. <static_member name="RESOURCE_SCRIPT" type="Integer" value="10">
  6748. </static_member>
  6749. </static_members>
  6750. <members>
  6751. <member name="reloadOnFileModify" type="Boolean">
  6752. </member>
  6753. <member name="resourceFileTime" type="time_t">
  6754. </member>
  6755. <member name="platformData" type="nil">
  6756. </member>
  6757. </members>
  6758. <methods>
  6759. <method name="Resource" return_type="nil">
  6760. <desc><![CDATA[ @name Public members Available public members]]></desc>
  6761. <params>
  6762. <param name="type" type="Integer">
  6763. </param>
  6764. </params>
  6765. </method>
  6766. <method name="reloadResource" return_type="nil">
  6767. </method>
  6768. <method name="getResourceName" return_type="String">
  6769. </method>
  6770. <method name="getResourceType" return_type="Integer">
  6771. </method>
  6772. <method name="setResourceName" return_type="nil">
  6773. <params>
  6774. <param name="newName" type="String">
  6775. </param>
  6776. </params>
  6777. </method>
  6778. <method name="setResourcePath" return_type="nil">
  6779. <params>
  6780. <param name="path" type="String">
  6781. </param>
  6782. </params>
  6783. </method>
  6784. <method name="getResourcePath" return_type="String">
  6785. </method>
  6786. </methods>
  6787. </class>
  6788. <class name="ScriptResourceLoader" extends="ResourceLoader">
  6789. <static_members>
  6790. </static_members>
  6791. <members>
  6792. </members>
  6793. <methods>
  6794. <method name="ScriptResourceLoader" return_type="nil">
  6795. </method>
  6796. <method name="loadResource" return_type="Resource">
  6797. <params>
  6798. <param name="path" type="String">
  6799. </param>
  6800. <param name="targetPool" type="ResourcePool">
  6801. </param>
  6802. </params>
  6803. </method>
  6804. </methods>
  6805. </class>
  6806. <class name="ResourcePool" extends="EventDispatcher">
  6807. <static_members>
  6808. </static_members>
  6809. <members>
  6810. <member name="reloadResourcesOnModify" type="Boolean">
  6811. </member>
  6812. <member name="dispatchChangeEvents" type="Boolean">
  6813. </member>
  6814. <member name="resourceSubscribers" type="Integer">
  6815. </member>
  6816. <member name="deleteOnUnsubscribe" type="Boolean">
  6817. </member>
  6818. </members>
  6819. <methods>
  6820. <method name="ResourcePool" return_type="nil">
  6821. <params>
  6822. <param name="name" type="String">
  6823. </param>
  6824. <param name="fallbackPool" type="ResourcePool">
  6825. </param>
  6826. </params>
  6827. </method>
  6828. <method name="setFallbackPool" return_type="nil">
  6829. <params>
  6830. <param name="pool" type="ResourcePool">
  6831. </param>
  6832. </params>
  6833. </method>
  6834. <method name="addResource" return_type="nil">
  6835. <params>
  6836. <param name="resource" type="Resource">
  6837. </param>
  6838. </params>
  6839. </method>
  6840. <method name="removeResource" return_type="nil">
  6841. <params>
  6842. <param name="resource" type="Resource">
  6843. </param>
  6844. </params>
  6845. </method>
  6846. <method name="hasResource" return_type="Boolean">
  6847. <params>
  6848. <param name="resource" type="Resource">
  6849. </param>
  6850. </params>
  6851. </method>
  6852. <method name="loadResourcesFromFolder" return_type="nil">
  6853. <params>
  6854. <param name="folder" type="String">
  6855. </param>
  6856. <param name="recursive" type="Boolean">
  6857. </param>
  6858. </params>
  6859. </method>
  6860. <method name="loadResource" return_type="Resource">
  6861. <params>
  6862. <param name="path" type="String">
  6863. </param>
  6864. </params>
  6865. </method>
  6866. <method name="loadResourceWithName" return_type="Resource">
  6867. <params>
  6868. <param name="path" type="String">
  6869. </param>
  6870. <param name="name" type="String">
  6871. </param>
  6872. </params>
  6873. </method>
  6874. <method name="getResource" return_type="Resource">
  6875. <params>
  6876. <param name="resourceType" type="Integer">
  6877. </param>
  6878. <param name="resourceName" type="String">
  6879. </param>
  6880. </params>
  6881. </method>
  6882. <method name="getName" return_type="String">
  6883. </method>
  6884. <method name="setName" return_type="nil">
  6885. <params>
  6886. <param name="name" type="String">
  6887. </param>
  6888. </params>
  6889. </method>
  6890. <method name="getResourceByPath" return_type="Resource">
  6891. <params>
  6892. <param name="resourcePath" type="String">
  6893. </param>
  6894. </params>
  6895. </method>
  6896. <method name="Update" return_type="nil">
  6897. <params>
  6898. <param name="elapsed" type="Integer">
  6899. </param>
  6900. </params>
  6901. </method>
  6902. <method name="getResources" return_array="true" return_type="Resource">
  6903. <params>
  6904. <param name="resourceType" type="Integer">
  6905. </param>
  6906. </params>
  6907. </method>
  6908. <method name="checkForChangedFiles" return_type="nil">
  6909. </method>
  6910. </methods>
  6911. </class>
  6912. <class name="ResourceManager" extends="EventDispatcher">
  6913. <desc><![CDATA[ Manages loading and unloading of resources from directories and archives. Should only be accessed via the CoreServices singleton.]]></desc>
  6914. <static_members>
  6915. </static_members>
  6916. <members>
  6917. </members>
  6918. <methods>
  6919. <method name="ResourceManager" return_type="nil">
  6920. </method>
  6921. <method name="getGlobalPool" return_type="ResourcePool">
  6922. </method>
  6923. <method name="getResourcePoolByName" return_type="ResourcePool">
  6924. <params>
  6925. <param name="name" type="String">
  6926. </param>
  6927. </params>
  6928. </method>
  6929. <method name="addResourceLoader" return_type="nil">
  6930. <params>
  6931. <param name="loader" type="ResourceLoader">
  6932. </param>
  6933. </params>
  6934. </method>
  6935. <method name="getResourceLoaderForExtension" return_type="ResourceLoader">
  6936. <params>
  6937. <param name="extension" type="String">
  6938. </param>
  6939. </params>
  6940. </method>
  6941. <method name="removeResourceLoader" return_type="nil">
  6942. <params>
  6943. <param name="loader" type="ResourceLoader">
  6944. </param>
  6945. </params>
  6946. </method>
  6947. <method name="getNumResourceLoaders" return_type="Integer">
  6948. </method>
  6949. <method name="getResourceLoaderAtIndex" return_type="ResourceLoader">
  6950. <params>
  6951. <param name="index" type="Integer">
  6952. </param>
  6953. </params>
  6954. </method>
  6955. <method name="addResourcePool" return_type="nil">
  6956. <params>
  6957. <param name="pool" type="ResourcePool">
  6958. </param>
  6959. </params>
  6960. </method>
  6961. <method name="removeResourcePool" return_type="nil">
  6962. <params>
  6963. <param name="pool" type="ResourcePool">
  6964. </param>
  6965. </params>
  6966. </method>
  6967. <method name="getResources" return_array="true" return_type="Resource">
  6968. <params>
  6969. <param name="resourceType" type="Integer">
  6970. </param>
  6971. </params>
  6972. </method>
  6973. <method name="removeResource" return_type="nil">
  6974. <params>
  6975. <param name="resource" type="Resource">
  6976. </param>
  6977. </params>
  6978. </method>
  6979. <method name="subscribeToResourcePool" return_type="nil">
  6980. <params>
  6981. <param name="pool" type="ResourcePool">
  6982. </param>
  6983. </params>
  6984. </method>
  6985. <method name="unsubscibeFromResourcePool" return_type="nil">
  6986. <params>
  6987. <param name="pool" type="ResourcePool">
  6988. </param>
  6989. </params>
  6990. </method>
  6991. <method name="Update" return_type="nil">
  6992. <params>
  6993. <param name="elapsed" type="Integer">
  6994. </param>
  6995. </params>
  6996. </method>
  6997. </methods>
  6998. </class>
  6999. <class name="FontResourceLoader" extends="ResourceLoader">
  7000. <static_members>
  7001. </static_members>
  7002. <members>
  7003. </members>
  7004. <methods>
  7005. <method name="FontResourceLoader" return_type="nil">
  7006. </method>
  7007. <method name="loadResource" return_type="Resource">
  7008. <params>
  7009. <param name="path" type="String">
  7010. </param>
  7011. <param name="targetPool" type="ResourcePool">
  7012. </param>
  7013. </params>
  7014. </method>
  7015. </methods>
  7016. </class>
  7017. <class name="ProgramResourceLoader" extends="ResourceLoader">
  7018. <static_members>
  7019. </static_members>
  7020. <members>
  7021. </members>
  7022. <methods>
  7023. <method name="ProgramResourceLoader" return_type="nil">
  7024. </method>
  7025. <method name="loadResource" return_type="Resource">
  7026. <params>
  7027. <param name="path" type="String">
  7028. </param>
  7029. <param name="targetPool" type="ResourcePool">
  7030. </param>
  7031. </params>
  7032. </method>
  7033. </methods>
  7034. </class>
  7035. <class name="DebugBackTraceEntry">
  7036. <static_members>
  7037. </static_members>
  7038. <members>
  7039. <member name="fileName" type="String">
  7040. </member>
  7041. <member name="lineNumber" type="Integer">
  7042. </member>
  7043. </members>
  7044. <methods>
  7045. </methods>
  7046. </class>
  7047. <class name="MeshResourceLoader" extends="ResourceLoader">
  7048. <static_members>
  7049. </static_members>
  7050. <members>
  7051. </members>
  7052. <methods>
  7053. <method name="MeshResourceLoader" return_type="nil">
  7054. </method>
  7055. <method name="loadResource" return_type="Resource">
  7056. <params>
  7057. <param name="path" type="String">
  7058. </param>
  7059. <param name="targetPool" type="ResourcePool">
  7060. </param>
  7061. </params>
  7062. </method>
  7063. </methods>
  7064. </class>
  7065. <class name="MaterialResourceLoader" extends="ResourceLoader">
  7066. <static_members>
  7067. </static_members>
  7068. <members>
  7069. </members>
  7070. <methods>
  7071. <method name="MaterialResourceLoader" return_type="nil">
  7072. </method>
  7073. <method name="loadResource" return_type="Resource">
  7074. <params>
  7075. <param name="path" type="String">
  7076. </param>
  7077. <param name="targetPool" type="ResourcePool">
  7078. </param>
  7079. </params>
  7080. </method>
  7081. </methods>
  7082. </class>
  7083. <class name="TextureResourceLoader" extends="ResourceLoader">
  7084. <static_members>
  7085. </static_members>
  7086. <members>
  7087. </members>
  7088. <methods>
  7089. <method name="TextureResourceLoader" return_type="nil">
  7090. </method>
  7091. <method name="loadResource" return_type="Resource">
  7092. <params>
  7093. <param name="path" type="String">
  7094. </param>
  7095. <param name="targetPool" type="ResourcePool">
  7096. </param>
  7097. </params>
  7098. </method>
  7099. </methods>
  7100. </class>
  7101. <class name="Scene" extends="EventDispatcher">
  7102. <desc><![CDATA[ Rendering container. The Scene class is the main container for all rendering in Polycode. Scenes are automatically rendered and need only be instantiated to immediately add themselves to the rendering pipeline. A Scene is created with a camera automatically.]]></desc>
  7103. <class_notes>NOTE: Scene instances are not automatically garbage collected.</class_notes>
  7104. <static_members>
  7105. <static_member name="SCENE_3D" type="Integer" value="0">
  7106. </static_member>
  7107. <static_member name="SCENE_2D" type="Integer" value="1">
  7108. </static_member>
  7109. <static_member name="SCENE_2D_TOPLEFT" type="Integer" value="2">
  7110. </static_member>
  7111. </static_members>
  7112. <members>
  7113. <member name="clearColor" type="Color">
  7114. <desc><![CDATA[ Scene clear color]]></desc>
  7115. </member>
  7116. <member name="useClearColor" type="Boolean">
  7117. <desc><![CDATA[ If set to true, the renderer will clear the screen prior to rendering the scene @default true]]></desc>
  7118. </member>
  7119. <member name="useClearDepth" type="Boolean">
  7120. <desc><![CDATA[ If set to true, the renderer will clear the depth buffer prior to rendering the scene. @default true]]></desc>
  7121. </member>
  7122. <member name="ambientColor" type="Color">
  7123. <desc><![CDATA[ Ambient color, passed to lighting shaders]]></desc>
  7124. </member>
  7125. <member name="fogColor" type="Color">
  7126. <desc><![CDATA[ Fog color, passed to lighting shaders.]]></desc>
  7127. </member>
  7128. <member name="enabled" type="Boolean">
  7129. <desc><![CDATA[ If this is set to false, the scene is not rendered or updated during the render loop.]]></desc>
  7130. </member>
  7131. <member name="ownsChildren" type="Boolean">
  7132. <desc><![CDATA[ If ownsChildren is set to true, the scene will delete its children upon destruction (defaults to false).]]></desc>
  7133. </member>
  7134. <member name="rootEntity" type="Entity">
  7135. </member>
  7136. <member name="sceneMouseRect" type="Rectangle">
  7137. </member>
  7138. <member name="remapMouse" type="Boolean">
  7139. </member>
  7140. <member name="constrainPickingToViewport" type="Boolean">
  7141. </member>
  7142. </members>
  7143. <methods>
  7144. <method name="Scene" return_type="nil">
  7145. <desc><![CDATA[ Default constructor with options. ]]></desc>
  7146. <params>
  7147. <param name="sceneType" type="Integer">
  7148. <desc><![CDATA[Type of scene to create. Can be Scene.SCENE_2D, Scene.SCENE_3D or Scene.SCENE_2D_TOPLEFT]]></desc>
  7149. </param>
  7150. <param name="virtualScene" type="Boolean">
  7151. <desc><![CDATA[If this flag is set to true, the scene is not rendered to the screen. Use this if you want to render the scene only to a texture.]]></desc>
  7152. </param>
  7153. </params>
  7154. </method>
  7155. <method name="addEntity" return_type="nil">
  7156. <desc><![CDATA[ Adds a new Entity to the scene ]]></desc>
  7157. <params>
  7158. <param name="entity" type="Entity">
  7159. <desc><![CDATA[New entity to add.]]></desc>
  7160. </param>
  7161. </params>
  7162. </method>
  7163. <method name="addChild" return_type="nil">
  7164. <desc><![CDATA[ Adds a new Entity to the scene ]]></desc>
  7165. <params>
  7166. <param name="entity" type="Entity">
  7167. <desc><![CDATA[New entity to add.]]></desc>
  7168. </param>
  7169. </params>
  7170. </method>
  7171. <method name="removeEntity" return_type="nil">
  7172. <desc><![CDATA[ Removes a Entity from the scene ]]></desc>
  7173. <params>
  7174. <param name="entity" type="Entity">
  7175. <desc><![CDATA[New entity to remove.]]></desc>
  7176. </param>
  7177. </params>
  7178. </method>
  7179. <method name="getDefaultCamera" return_type="Camera">
  7180. <desc><![CDATA[ Returns the scene's default camera. ]]></desc>
  7181. </method>
  7182. <method name="getActiveCamera" return_type="Camera">
  7183. <desc><![CDATA[ Returns the scene's active camera. ]]></desc>
  7184. </method>
  7185. <method name="setActiveCamera" return_type="nil">
  7186. <desc><![CDATA[ Sets the scene's active camera. ]]></desc>
  7187. <params>
  7188. <param name="camera" type="Camera">
  7189. <desc><![CDATA[New camera to set as the active camera.]]></desc>
  7190. </param>
  7191. </params>
  7192. </method>
  7193. <method name="enableFog" return_type="nil">
  7194. <desc><![CDATA[ Enables and disables fog in the scene. ]]></desc>
  7195. <params>
  7196. <param name="enable" type="Boolean">
  7197. <desc><![CDATA[If false, disables lighting in the scene, if true, enables it.]]></desc>
  7198. </param>
  7199. </params>
  7200. </method>
  7201. <method name="setFogProperties" return_type="nil">
  7202. <desc><![CDATA[ Sets the fog properties for the scene. ]]></desc>
  7203. <params>
  7204. <param name="fogMode" type="Integer">
  7205. <desc><![CDATA[Fog falloff mode. (Renderer.FOG_LINEAR, Renderer.FOG_EXP, Renderer.FOG_EXP2).]]></desc>
  7206. </param>
  7207. <param name="color" type="Color">
  7208. <desc><![CDATA[Fog color.]]></desc>
  7209. </param>
  7210. <param name="density" type="Number">
  7211. <desc><![CDATA[Fog density.]]></desc>
  7212. </param>
  7213. <param name="startDepth" type="Number">
  7214. <desc><![CDATA[Starting depth of the fog.]]></desc>
  7215. </param>
  7216. <param name="endDepth" type="Number">
  7217. <desc><![CDATA[Ending depth of the fog.]]></desc>
  7218. </param>
  7219. </params>
  7220. </method>
  7221. <method name="setSceneType" return_type="nil">
  7222. <params>
  7223. <param name="newType" type="Integer">
  7224. </param>
  7225. </params>
  7226. </method>
  7227. <method name="fixedUpdate" return_type="nil">
  7228. </method>
  7229. <method name="Update" return_type="nil">
  7230. </method>
  7231. <method name="setVirtual" return_type="nil">
  7232. <params>
  7233. <param name="val" type="Boolean">
  7234. </param>
  7235. </params>
  7236. </method>
  7237. <method name="isVirtual" return_type="Boolean">
  7238. </method>
  7239. <method name="isEnabled" return_type="Boolean">
  7240. </method>
  7241. <method name="setEnabled" return_type="nil">
  7242. <params>
  7243. <param name="enabled" type="Boolean">
  7244. </param>
  7245. </params>
  7246. </method>
  7247. <method name="Render" return_type="nil">
  7248. <params>
  7249. <param name="targetCamera" type="Camera">
  7250. </param>
  7251. <param name="targetFramebuffer" type="RenderBuffer">
  7252. </param>
  7253. <param name="overrideMaterial" type="Material">
  7254. </param>
  7255. <param name="sendLights" type="Boolean">
  7256. </param>
  7257. </params>
  7258. </method>
  7259. <method name="setOverrideMaterial" return_type="nil">
  7260. <params>
  7261. <param name="material" type="Material">
  7262. </param>
  7263. </params>
  7264. </method>
  7265. <method name="projectRayFromCameraAndViewportCoordinate" return_type="Ray">
  7266. <params>
  7267. <param name="camera" type="Camera">
  7268. </param>
  7269. <param name="coordinate" type="Vector2">
  7270. </param>
  7271. </params>
  7272. </method>
  7273. <method name="addLight" return_type="nil">
  7274. <desc><![CDATA[ Adds a light to the scene. ]]></desc>
  7275. <params>
  7276. <param name="light" type="SceneLight">
  7277. <desc><![CDATA[Light to add to the scene.]]></desc>
  7278. </param>
  7279. </params>
  7280. </method>
  7281. <method name="removeLight" return_type="nil">
  7282. <desc><![CDATA[ Removes a light from the scene. ]]></desc>
  7283. <params>
  7284. <param name="light" type="SceneLight">
  7285. <desc><![CDATA[Light to remove from the scene.]]></desc>
  7286. </param>
  7287. </params>
  7288. </method>
  7289. <method name="getNumLights" return_type="Integer">
  7290. </method>
  7291. <method name="getLight" return_type="SceneLight">
  7292. <params>
  7293. <param name="index" type="Integer">
  7294. </param>
  7295. </params>
  7296. </method>
  7297. <method name="doVisibilityChecking" return_type="nil">
  7298. <params>
  7299. <param name="val" type="Boolean">
  7300. </param>
  7301. </params>
  7302. </method>
  7303. <method name="doesVisibilityChecking" return_type="Boolean">
  7304. </method>
  7305. </methods>
  7306. </class>
  7307. <class name="SceneEntityInstanceResourceEntry" extends="Resource">
  7308. <static_members>
  7309. </static_members>
  7310. <members>
  7311. </members>
  7312. <methods>
  7313. <method name="SceneEntityInstanceResourceEntry" return_type="nil">
  7314. <params>
  7315. <param name="instance" type="SceneEntityInstance">
  7316. </param>
  7317. </params>
  7318. </method>
  7319. <method name="getInstance" return_type="SceneEntityInstance">
  7320. </method>
  7321. <method name="reloadResource" return_type="nil">
  7322. </method>
  7323. </methods>
  7324. </class>
  7325. <class name="SceneEntityInstance" extends="Entity">
  7326. <class_notes>NOTE: SceneEntityInstance instances are not automatically garbage collected.</class_notes>
  7327. <static_members>
  7328. </static_members>
  7329. <members>
  7330. <member name="cloneUsingReload" type="Boolean">
  7331. </member>
  7332. <member name="fileName" type="String">
  7333. </member>
  7334. </members>
  7335. <methods>
  7336. <method name="SceneEntityInstance" return_type="nil">
  7337. <params>
  7338. <param name="parentScene" type="Scene">
  7339. </param>
  7340. <param name="fileName" type="String">
  7341. </param>
  7342. </params>
  7343. </method>
  7344. <method name="BlankSceneEntityInstance" return_type="SceneEntityInstance" static="true">
  7345. <params>
  7346. <param name="parentScene" type="Scene">
  7347. </param>
  7348. </params>
  7349. </method>
  7350. <method name="Clone" return_type="Entity">
  7351. <params>
  7352. <param name="deepClone" type="Boolean">
  7353. </param>
  7354. <param name="ignoreEditorOnly" type="Boolean">
  7355. </param>
  7356. </params>
  7357. </method>
  7358. <method name="applyClone" return_type="nil">
  7359. <params>
  7360. <param name="clone" type="Entity">
  7361. </param>
  7362. <param name="deepClone" type="Boolean">
  7363. </param>
  7364. <param name="ignoreEditorOnly" type="Boolean">
  7365. </param>
  7366. </params>
  7367. </method>
  7368. <method name="reloadEntityInstance" return_type="nil">
  7369. </method>
  7370. <method name="clearInstance" return_type="nil">
  7371. </method>
  7372. <method name="parseObjectIntoCurve" return_type="nil">
  7373. <params>
  7374. <param name="entry" type="ObjectEntry">
  7375. </param>
  7376. <param name="curve" type="BezierCurve">
  7377. </param>
  7378. </params>
  7379. </method>
  7380. <method name="loadObjectEntryIntoEntity" return_type="Entity">
  7381. <params>
  7382. <param name="entry" type="ObjectEntry">
  7383. </param>
  7384. <param name="targetEntity" type="Entity">
  7385. </param>
  7386. <param name="entityFileVersion" type="Integer">
  7387. </param>
  7388. </params>
  7389. </method>
  7390. <method name="loadFromFile" return_type="Boolean">
  7391. <params>
  7392. <param name="fileName" type="String">
  7393. </param>
  7394. </params>
  7395. </method>
  7396. <method name="applySceneMesh" return_type="nil">
  7397. <params>
  7398. <param name="entry" type="ObjectEntry">
  7399. </param>
  7400. <param name="sceneMesh" type="SceneMesh">
  7401. </param>
  7402. </params>
  7403. </method>
  7404. <method name="linkResourcePool" return_type="nil">
  7405. <params>
  7406. <param name="pool" type="ResourcePool">
  7407. </param>
  7408. </params>
  7409. </method>
  7410. <method name="getNumLinkedResourePools" return_type="Integer">
  7411. </method>
  7412. <method name="getLinkedResourcePoolAtIndex" return_type="ResourcePool">
  7413. <params>
  7414. <param name="index" type="Integer">
  7415. </param>
  7416. </params>
  7417. </method>
  7418. <method name="unlinkResourcePool" return_type="nil">
  7419. <params>
  7420. <param name="pool" type="ResourcePool">
  7421. </param>
  7422. </params>
  7423. </method>
  7424. <method name="getResourceEntry" return_type="SceneEntityInstanceResourceEntry">
  7425. </method>
  7426. <method name="getTopLevelResourcePool" return_type="ResourcePool">
  7427. </method>
  7428. <method name="hasLayerID" return_type="Boolean">
  7429. <params>
  7430. <param name="layerID" type="char">
  7431. </param>
  7432. </params>
  7433. </method>
  7434. <method name="getNumLayers" return_type="Integer">
  7435. </method>
  7436. <method name="getLayerAtIndex" return_type="SceneEntityInstanceLayer">
  7437. <params>
  7438. <param name="index" type="Integer">
  7439. </param>
  7440. </params>
  7441. </method>
  7442. <method name="removeLayer" return_type="nil">
  7443. <params>
  7444. <param name="layer" type="SceneEntityInstanceLayer">
  7445. </param>
  7446. </params>
  7447. </method>
  7448. <method name="createNewLayer" return_type="SceneEntityInstanceLayer">
  7449. <params>
  7450. <param name="name" type="String">
  7451. </param>
  7452. </params>
  7453. </method>
  7454. <method name="getFileName" return_type="String">
  7455. </method>
  7456. </methods>
  7457. </class>
  7458. <class name="SceneEntityInstanceLayer">
  7459. <static_members>
  7460. </static_members>
  7461. <members>
  7462. <member name="name" type="String">
  7463. </member>
  7464. <member name="layerID" type="char">
  7465. </member>
  7466. <member name="visible" type="Boolean">
  7467. </member>
  7468. <member name="instance" type="SceneEntityInstance">
  7469. </member>
  7470. </members>
  7471. <methods>
  7472. <method name="SceneEntityInstanceLayer" return_type="nil">
  7473. <params>
  7474. <param name="instance" type="SceneEntityInstance">
  7475. </param>
  7476. <param name="name" type="String">
  7477. </param>
  7478. </params>
  7479. </method>
  7480. <method name="setLayerVisibility" return_type="nil">
  7481. <params>
  7482. <param name="val" type="Boolean">
  7483. </param>
  7484. </params>
  7485. </method>
  7486. </methods>
  7487. </class>
  7488. <class name="SceneImage" extends="ScenePrimitive">
  7489. <desc><![CDATA[ 2D screen image display. This ScreenEntity can load and display and image.]]></desc>
  7490. <class_notes>NOTE: SceneImage instances are not automatically garbage collected.</class_notes>
  7491. <static_members>
  7492. </static_members>
  7493. <members>
  7494. </members>
  7495. <methods>
  7496. <method name="SceneImage" return_type="nil">
  7497. <desc><![CDATA[ Create screen image from file. ]]></desc>
  7498. <params>
  7499. <param name="fileName" type="String">
  7500. <desc><![CDATA[]]></desc>
  7501. </param>
  7502. </params>
  7503. </method>
  7504. <method name="SceneImageWithImage" return_type="SceneImage" static="true">
  7505. <desc><![CDATA[ Create screen image from Image. ]]></desc>
  7506. <params>
  7507. <param name="image" type="Image">
  7508. <desc><![CDATA[Image to create from.]]></desc>
  7509. </param>
  7510. </params>
  7511. </method>
  7512. <method name="SceneImageWithTexture" return_type="SceneImage" static="true">
  7513. <desc><![CDATA[ Create screen image from Texture. ]]></desc>
  7514. <params>
  7515. <param name="texture" type="Texture">
  7516. <desc><![CDATA[Texture to create from.]]></desc>
  7517. </param>
  7518. </params>
  7519. </method>
  7520. <method name="Clone" return_type="Entity">
  7521. <params>
  7522. <param name="deepClone" type="Boolean">
  7523. </param>
  7524. <param name="ignoreEditorOnly" type="Boolean">
  7525. </param>
  7526. </params>
  7527. </method>
  7528. <method name="applyClone" return_type="nil">
  7529. <params>
  7530. <param name="clone" type="Entity">
  7531. </param>
  7532. <param name="deepClone" type="Boolean">
  7533. </param>
  7534. <param name="ignoreEditorOnly" type="Boolean">
  7535. </param>
  7536. </params>
  7537. </method>
  7538. <method name="setImageCoordinates" return_type="nil">
  7539. <desc><![CDATA[ Changes which part of the image is displayed. ]]></desc>
  7540. <params>
  7541. <param name="x" type="Number">
  7542. <desc><![CDATA[X position of the display rectangle.]]></desc>
  7543. </param>
  7544. <param name="y" type="Number">
  7545. <desc><![CDATA[Y position of the display rectangle.]]></desc>
  7546. </param>
  7547. <param name="width" type="Number">
  7548. <desc><![CDATA[Width of the display rectangle.]]></desc>
  7549. </param>
  7550. <param name="height" type="Number">
  7551. <desc><![CDATA[Height of the display rectangle.]]></desc>
  7552. </param>
  7553. <param name="realWidth" type="Number">
  7554. </param>
  7555. <param name="realHeight" type="Number">
  7556. </param>
  7557. </params>
  7558. </method>
  7559. <method name="getImageWidth" return_type="Number">
  7560. <desc><![CDATA[ Returns the image width.]]></desc>
  7561. </method>
  7562. <method name="getImageHeight" return_type="Number">
  7563. <desc><![CDATA[ Returns the image height.]]></desc>
  7564. </method>
  7565. </methods>
  7566. </class>
  7567. <class name="SceneLabel" extends="ScenePrimitive">
  7568. <desc><![CDATA[ 3D text label. Creates a 3D text label.]]></desc>
  7569. <class_notes>NOTE: SceneLabel instances are not automatically garbage collected.</class_notes>
  7570. <static_members>
  7571. </static_members>
  7572. <members>
  7573. <member name="positionAtBaseline" type="Boolean">
  7574. </member>
  7575. </members>
  7576. <methods>
  7577. <method name="SceneLabel" return_type="nil">
  7578. <params>
  7579. <param name="text" type="String">
  7580. </param>
  7581. <param name="size" type="Integer">
  7582. </param>
  7583. <param name="fontName" type="String">
  7584. </param>
  7585. <param name="amode" type="Integer">
  7586. </param>
  7587. <param name="actualHeight" type="Number">
  7588. </param>
  7589. <param name="premultiplyAlpha" type="Boolean">
  7590. </param>
  7591. <param name="backgroundColor" type="Color">
  7592. </param>
  7593. <param name="foregroundColor" type="Color">
  7594. </param>
  7595. </params>
  7596. </method>
  7597. <method name="getText" return_type="String">
  7598. </method>
  7599. <method name="setLabelActualHeight" return_type="nil">
  7600. <params>
  7601. <param name="actualHeight" type="Number">
  7602. </param>
  7603. </params>
  7604. </method>
  7605. <method name="getLabelActualHeight" return_type="Number">
  7606. </method>
  7607. <method name="Render" return_type="nil">
  7608. <params>
  7609. <param name="buffer" type="GPUDrawBuffer">
  7610. </param>
  7611. </params>
  7612. </method>
  7613. <method name="getTextWidthForString" return_type="Integer">
  7614. <params>
  7615. <param name="text" type="String">
  7616. </param>
  7617. </params>
  7618. </method>
  7619. <method name="setText" return_type="nil">
  7620. <desc><![CDATA[ Sets new text for the labe. ]]></desc>
  7621. <params>
  7622. <param name="newText" type="String">
  7623. <desc><![CDATA[New text to display.]]></desc>
  7624. </param>
  7625. </params>
  7626. </method>
  7627. <method name="Clone" return_type="Entity">
  7628. <params>
  7629. <param name="deepClone" type="Boolean">
  7630. </param>
  7631. <param name="ignoreEditorOnly" type="Boolean">
  7632. </param>
  7633. </params>
  7634. </method>
  7635. <method name="applyClone" return_type="nil">
  7636. <params>
  7637. <param name="clone" type="Entity">
  7638. </param>
  7639. <param name="deepClone" type="Boolean">
  7640. </param>
  7641. <param name="ignoreEditorOnly" type="Boolean">
  7642. </param>
  7643. </params>
  7644. </method>
  7645. <method name="updateFromLabel" return_type="nil">
  7646. </method>
  7647. <method name="getLabel" return_type="Label">
  7648. </method>
  7649. </methods>
  7650. </class>
  7651. <class name="SceneLight" extends="Entity">
  7652. <desc><![CDATA[ 3D light source. Lights can be point or spot lights and can be set to different colors. ]]></desc>
  7653. <class_notes>NOTE: SceneLight instances are not automatically garbage collected.</class_notes>
  7654. <static_members>
  7655. <static_member name="POINT_LIGHT" type="Integer" value="0">
  7656. </static_member>
  7657. <static_member name="SPOT_LIGHT" type="Integer" value="1">
  7658. </static_member>
  7659. </static_members>
  7660. <members>
  7661. </members>
  7662. <methods>
  7663. <method name="SceneLight" return_type="nil">
  7664. <desc><![CDATA[ Constructs a light with parameters. ]]></desc>
  7665. <params>
  7666. <param name="type" type="Integer">
  7667. <desc><![CDATA[Type of light to create. Can be SceneLight.POINT_LIGHT or SceneLight.SPOT_LIGHT]]></desc>
  7668. </param>
  7669. <param name="parentScene" type="Scene">
  7670. <desc><![CDATA[Scene to light.]]></desc>
  7671. </param>
  7672. <param name="intensity" type="Number">
  7673. <desc><![CDATA[Light color intensity]]></desc>
  7674. </param>
  7675. <param name="constantAttenuation" type="Number">
  7676. <desc><![CDATA[Constant falloff attenuation value]]></desc>
  7677. </param>
  7678. <param name="linearAttenuation" type="Number">
  7679. <desc><![CDATA[Linear falloff attenuation value]]></desc>
  7680. </param>
  7681. <param name="quadraticAttenuation" type="Number">
  7682. <desc><![CDATA[Quadratic falloff attenuation value]]></desc>
  7683. </param>
  7684. </params>
  7685. </method>
  7686. <method name="getIntensity" return_type="Number">
  7687. </method>
  7688. <method name="setIntensity" return_type="nil">
  7689. <desc><![CDATA[ Sets the light's intensity ]]></desc>
  7690. <params>
  7691. <param name="newIntensity" type="Number">
  7692. <desc><![CDATA[New intensity value.]]></desc>
  7693. </param>
  7694. </params>
  7695. </method>
  7696. <method name="setAttenuation" return_type="nil">
  7697. <desc><![CDATA[ Sets the attenuation values for the light. ]]></desc>
  7698. <params>
  7699. <param name="constantAttenuation" type="Number">
  7700. <desc><![CDATA[Constant falloff attenuation value]]></desc>
  7701. </param>
  7702. <param name="linearAttenuation" type="Number">
  7703. <desc><![CDATA[Linear falloff attenuation value]]></desc>
  7704. </param>
  7705. <param name="quadraticAttenuation" type="Number">
  7706. <desc><![CDATA[Quadratic falloff attenuation value]]></desc>
  7707. </param>
  7708. </params>
  7709. </method>
  7710. <method name="getConstantAttenuation" return_type="Number">
  7711. </method>
  7712. <method name="getLinearAttenuation" return_type="Number">
  7713. </method>
  7714. <method name="getQuadraticAttenuation" return_type="Number">
  7715. </method>
  7716. <method name="getType" return_type="Integer">
  7717. </method>
  7718. <method name="renderDepthMap" return_type="nil">
  7719. <params>
  7720. <param name="scene" type="Scene">
  7721. </param>
  7722. </params>
  7723. </method>
  7724. <method name="getZBufferTexture" return_type="Texture">
  7725. </method>
  7726. <method name="setSpecularLightColor" return_type="nil">
  7727. <desc><![CDATA[ Sets the light color. ]]></desc>
  7728. <params>
  7729. <param name="r" type="Number">
  7730. <desc><![CDATA[Red value 0-1.]]></desc>
  7731. </param>
  7732. <param name="g" type="Number">
  7733. <desc><![CDATA[Green value 0-1]]></desc>
  7734. </param>
  7735. <param name="b" type="Number">
  7736. <desc><![CDATA[Blue value 0-1]]></desc>
  7737. </param>
  7738. <param name="a" type="Number">
  7739. <desc><![CDATA[Alpha value 0-1]]></desc>
  7740. </param>
  7741. </params>
  7742. </method>
  7743. <method name="setDiffuseLightColor" return_type="nil">
  7744. <desc><![CDATA[ Sets the light color. ]]></desc>
  7745. <params>
  7746. <param name="r" type="Number">
  7747. <desc><![CDATA[Red value 0-1.]]></desc>
  7748. </param>
  7749. <param name="g" type="Number">
  7750. <desc><![CDATA[Green value 0-1]]></desc>
  7751. </param>
  7752. <param name="b" type="Number">
  7753. <desc><![CDATA[Blue value 0-1]]></desc>
  7754. </param>
  7755. <param name="a" type="Number">
  7756. <desc><![CDATA[Alpha value 0-1]]></desc>
  7757. </param>
  7758. </params>
  7759. </method>
  7760. <method name="setLightColor" return_type="nil">
  7761. <desc><![CDATA[ Sets both the specular and diffust light colors. Use setDiffuseLightColor and setSpecularLightColor to set the individual light colors. ]]></desc>
  7762. <params>
  7763. <param name="r" type="Number">
  7764. <desc><![CDATA[Red value 0-1.]]></desc>
  7765. </param>
  7766. <param name="g" type="Number">
  7767. <desc><![CDATA[Green value 0-1]]></desc>
  7768. </param>
  7769. <param name="b" type="Number">
  7770. <desc><![CDATA[Blue value 0-1]]></desc>
  7771. </param>
  7772. <param name="a" type="Number">
  7773. <desc><![CDATA[Alpha value 0-1]]></desc>
  7774. </param>
  7775. </params>
  7776. </method>
  7777. <method name="setSpotlightProperties" return_type="nil">
  7778. <desc><![CDATA[ Sets the spotlight properties. These control the shape of the spotlight beam. ]]></desc>
  7779. <params>
  7780. <param name="spotlightCutoff" type="Number">
  7781. <desc><![CDATA[Spotlight exponent size]]></desc>
  7782. </param>
  7783. <param name="spotlightExponent" type="Number">
  7784. <desc><![CDATA[Spotlight furstrum cutoff.]]></desc>
  7785. </param>
  7786. </params>
  7787. </method>
  7788. <method name="getSpotlightCutoff" return_type="Number">
  7789. </method>
  7790. <method name="getSpotlightExponent" return_type="Number">
  7791. </method>
  7792. <method name="enableShadows" return_type="nil">
  7793. <desc><![CDATA[ If this is called with 'true', the light will generate a shadow map. ]]></desc>
  7794. <params>
  7795. <param name="val" type="Boolean">
  7796. <desc><![CDATA[If set to true, enables this light to cast shadows.]]></desc>
  7797. </param>
  7798. <param name="resolution" type="Integer">
  7799. <desc><![CDATA[Resolution of the shadow map. (defaults to 256x256).]]></desc>
  7800. </param>
  7801. </params>
  7802. </method>
  7803. <method name="setShadowMapFOV" return_type="nil">
  7804. <desc><![CDATA[ This sets the shadow map field of view. The larger the field of view, the more of the scene it encompasses, but the more quality it loses. ]]></desc>
  7805. <params>
  7806. <param name="fov" type="Number">
  7807. <desc><![CDATA[New field of view value.]]></desc>
  7808. </param>
  7809. </params>
  7810. </method>
  7811. <method name="getShadowMapFOV" return_type="Number">
  7812. <desc><![CDATA[ Returns the light's shadow map field of view.]]></desc>
  7813. </method>
  7814. <method name="getShadowMapResolution" return_type="Integer">
  7815. </method>
  7816. <method name="areShadowsEnabled" return_type="Boolean">
  7817. <desc><![CDATA[ Returns true if shadows are enabled.]]></desc>
  7818. </method>
  7819. <method name="getLightType" return_type="Integer">
  7820. <desc><![CDATA[ Returns the light type.]]></desc>
  7821. </method>
  7822. <method name="setLightImportance" return_type="nil">
  7823. <params>
  7824. <param name="newImportance" type="Integer">
  7825. </param>
  7826. </params>
  7827. </method>
  7828. <method name="getLightImportance" return_type="Integer">
  7829. </method>
  7830. <method name="setLightType" return_type="nil">
  7831. <params>
  7832. <param name="lightType" type="Integer">
  7833. </param>
  7834. </params>
  7835. </method>
  7836. <method name="Clone" return_type="Entity">
  7837. <params>
  7838. <param name="deepClone" type="Boolean">
  7839. </param>
  7840. <param name="ignoreEditorOnly" type="Boolean">
  7841. </param>
  7842. </params>
  7843. </method>
  7844. <method name="applyClone" return_type="nil">
  7845. <params>
  7846. <param name="clone" type="Entity">
  7847. </param>
  7848. <param name="deepClone" type="Boolean">
  7849. </param>
  7850. <param name="ignoreEditorOnly" type="Boolean">
  7851. </param>
  7852. </params>
  7853. </method>
  7854. <method name="getParentScene" return_type="Scene">
  7855. </method>
  7856. <method name="setParentScene" return_type="nil">
  7857. <params>
  7858. <param name="scene" type="Scene">
  7859. </param>
  7860. </params>
  7861. </method>
  7862. <method name="getSpotlightCamera" return_type="Camera">
  7863. </method>
  7864. <method name="getLightInfo" return_type="LightInfo">
  7865. </method>
  7866. </methods>
  7867. </class>
  7868. <class name="SceneCurve" extends="SceneMesh">
  7869. <desc><![CDATA[ BezierCurve scene rendering/placement class. You can use this class to place a bezier curve in scene space for use as animation tracks or rendering.]]></desc>
  7870. <static_members>
  7871. </static_members>
  7872. <members>
  7873. <member name="renderCurve" type="Boolean">
  7874. </member>
  7875. <member name="curveResolution" type="Integer">
  7876. </member>
  7877. </members>
  7878. <methods>
  7879. <method name="SceneCurve" return_type="nil">
  7880. </method>
  7881. <method name="SceneCurveWithCurve" return_type="SceneCurve" static="true">
  7882. <params>
  7883. <param name="curve" type="BezierCurve">
  7884. </param>
  7885. </params>
  7886. </method>
  7887. <method name="getWorldPointAt" return_type="Vector3">
  7888. <params>
  7889. <param name="t" type="Number">
  7890. </param>
  7891. </params>
  7892. </method>
  7893. <method name="Update" return_type="nil">
  7894. </method>
  7895. <method name="Clone" return_type="Entity">
  7896. <params>
  7897. <param name="deepClone" type="Boolean">
  7898. </param>
  7899. <param name="ignoreEditorOnly" type="Boolean">
  7900. </param>
  7901. </params>
  7902. </method>
  7903. <method name="applyClone" return_type="nil">
  7904. <params>
  7905. <param name="clone" type="Entity">
  7906. </param>
  7907. <param name="deepClone" type="Boolean">
  7908. </param>
  7909. <param name="ignoreEditorOnly" type="Boolean">
  7910. </param>
  7911. </params>
  7912. </method>
  7913. <method name="getCurve" return_type="BezierCurve">
  7914. </method>
  7915. </methods>
  7916. </class>
  7917. <class name="SceneLine" extends="SceneMesh">
  7918. <desc><![CDATA[ 3D line class. Can connect two SceneEntity classes with a line.]]></desc>
  7919. <class_notes>NOTE: SceneLine instances are not automatically garbage collected.</class_notes>
  7920. <static_members>
  7921. </static_members>
  7922. <members>
  7923. </members>
  7924. <methods>
  7925. <method name="SceneLine" return_type="nil">
  7926. <desc><![CDATA[ Constructs the line with two taraget entities. ]]></desc>
  7927. <params>
  7928. <param name="ent1" type="Entity">
  7929. <desc><![CDATA[Starting entity.]]></desc>
  7930. </param>
  7931. <param name="ent2" type="Entity">
  7932. <desc><![CDATA[Ending entity.]]></desc>
  7933. </param>
  7934. </params>
  7935. </method>
  7936. <method name="SceneLineWithPositions" return_type="SceneLine" static="true">
  7937. <desc><![CDATA[ Constructs the line with two taraget positions. ]]></desc>
  7938. <params>
  7939. <param name="start" type="Vector3">
  7940. <desc><![CDATA[Starting position.]]></desc>
  7941. </param>
  7942. <param name="end" type="Vector3">
  7943. <desc><![CDATA[Ending position.]]></desc>
  7944. </param>
  7945. </params>
  7946. </method>
  7947. <method name="setStart" return_type="nil">
  7948. <params>
  7949. <param name="start" type="Vector3">
  7950. </param>
  7951. </params>
  7952. </method>
  7953. <method name="setEnd" return_type="nil">
  7954. <params>
  7955. <param name="end" type="Vector3">
  7956. </param>
  7957. </params>
  7958. </method>
  7959. <method name="Update" return_type="nil">
  7960. </method>
  7961. </methods>
  7962. </class>
  7963. <class name="SceneManager">
  7964. <desc><![CDATA[ This class manages all rendered scenes in Polycode.]]></desc>
  7965. <static_members>
  7966. </static_members>
  7967. <members>
  7968. </members>
  7969. <methods>
  7970. <method name="SceneManager" return_type="nil">
  7971. </method>
  7972. <method name="addScene" return_type="nil">
  7973. <desc><![CDATA[ Adds a scene to the render loop. Scenes automatically add themselves to the manager on creation, so there's no need to call this manually unless you remove a scene yourself.]]></desc>
  7974. <params>
  7975. <param name="newScene" type="Scene">
  7976. </param>
  7977. </params>
  7978. </method>
  7979. <method name="removeScene" return_type="nil">
  7980. <desc><![CDATA[ Removes scene from the render loop (does not delete the scene).]]></desc>
  7981. <params>
  7982. <param name="scene" type="Scene">
  7983. </param>
  7984. </params>
  7985. </method>
  7986. <method name="Update" return_type="nil">
  7987. </method>
  7988. <method name="fixedUpdate" return_type="nil">
  7989. </method>
  7990. <method name="Render" return_type="nil">
  7991. <params>
  7992. <param name="viewport" type="Rectangle">
  7993. </param>
  7994. </params>
  7995. </method>
  7996. <method name="renderVirtual" return_type="nil">
  7997. </method>
  7998. <method name="registerRenderTexture" return_type="nil">
  7999. <params>
  8000. <param name="renderTexture" type="SceneRenderTexture">
  8001. </param>
  8002. </params>
  8003. </method>
  8004. <method name="unregisterRenderTexture" return_type="nil">
  8005. <params>
  8006. <param name="renderTexture" type="SceneRenderTexture">
  8007. </param>
  8008. </params>
  8009. </method>
  8010. <method name="setRenderer" return_type="nil">
  8011. <params>
  8012. <param name="renderer" type="Renderer">
  8013. </param>
  8014. </params>
  8015. </method>
  8016. </methods>
  8017. </class>
  8018. <class name="SceneMesh" extends="Entity">
  8019. <desc><![CDATA[ 3D polygonal mesh instance. The SceneMesh is the base for all polygonal 3d geometry. It can have simple textures or complex materials applied to it.]]></desc>
  8020. <class_notes>NOTE: SceneMesh instances are not automatically garbage collected.</class_notes>
  8021. <static_members>
  8022. </static_members>
  8023. <members>
  8024. <member name="lineWidth" type="Number">
  8025. <desc><![CDATA[ Line width for line-based meshes.]]></desc>
  8026. </member>
  8027. <member name="lineSmooth" type="Boolean">
  8028. <desc><![CDATA[ If set to true, will antialias the lines in a line-based mesh. Defaults to false.]]></desc>
  8029. </member>
  8030. <member name="pointSmooth" type="Boolean">
  8031. <desc><![CDATA[ If setto true, will antialias points in a point-based mesh. Defaults to false.]]></desc>
  8032. </member>
  8033. <member name="ownsMesh" type="Boolean">
  8034. <desc><![CDATA[ If true, will delete its Mesh upon destruction or mesh loading. (defaults to true)]]></desc>
  8035. </member>
  8036. <member name="ownsSkeleton" type="Boolean">
  8037. <desc><![CDATA[ If true, will delete its Skeleton upon destruction. (defaults to true)]]></desc>
  8038. </member>
  8039. <member name="useGeometryHitDetection" type="Boolean">
  8040. <desc><![CDATA[ If set to true, will check against actual geometry polygons on ray hit detection. Defaults to false.]]></desc>
  8041. </member>
  8042. <member name="alphaTest" type="Boolean">
  8043. <desc><![CDATA[ Normally, translucent textures do not affect the depth buffer, but if this flag is set to true, this entity's alpha channel is written to the depth buffer at a preset threshold. This flag is set to false by default.]]></desc>
  8044. </member>
  8045. <member name="backfaceCulled" type="Boolean">
  8046. <desc><![CDATA[ If this flag is set to false, backface culling is disabled when rendering this entity, rendering both sides of each face. Set to true by default.]]></desc>
  8047. </member>
  8048. <member name="sendBoneMatricesToMaterial" type="Boolean">
  8049. </member>
  8050. </members>
  8051. <methods>
  8052. <method name="SceneMesh" return_type="nil">
  8053. <desc><![CDATA[ Construct a scene mesh from a mesh file. ]]></desc>
  8054. <params>
  8055. <param name="fileName" type="String">
  8056. <desc><![CDATA[Path to mesh file to load.]]></desc>
  8057. </param>
  8058. </params>
  8059. </method>
  8060. <method name="SceneMeshFromMesh" return_type="SceneMesh" static="true">
  8061. <desc><![CDATA[ Construct scene mesh from an existing Mesh instance.]]></desc>
  8062. <params>
  8063. <param name="mesh" type="Mesh">
  8064. </param>
  8065. </params>
  8066. </method>
  8067. <method name="SceneMeshWithType" return_type="SceneMesh" static="true">
  8068. <desc><![CDATA[ Construct an empty scene mesh with the specified type. ]]></desc>
  8069. <params>
  8070. <param name="meshType" type="Integer">
  8071. <desc><![CDATA[Mesh type to create. See Mesh for possible values.]]></desc>
  8072. </param>
  8073. </params>
  8074. </method>
  8075. <method name="Render" return_type="nil">
  8076. <params>
  8077. <param name="buffer" type="GPUDrawBuffer">
  8078. </param>
  8079. </params>
  8080. </method>
  8081. <method name="getShaderPass" return_type="ShaderPass">
  8082. <params>
  8083. <param name="index" type="Integer">
  8084. </param>
  8085. </params>
  8086. </method>
  8087. <method name="getNumShaderPasses" return_type="Integer">
  8088. </method>
  8089. <method name="addShaderPass" return_type="nil">
  8090. <params>
  8091. <param name="pass" type="ShaderPass">
  8092. </param>
  8093. </params>
  8094. </method>
  8095. <method name="removeShaderPass" return_type="nil">
  8096. <params>
  8097. <param name="shaderIndex" type="Integer">
  8098. </param>
  8099. </params>
  8100. </method>
  8101. <method name="getMesh" return_type="Mesh">
  8102. <desc><![CDATA[ Returns the Mesh instance of the actual mesh.]]></desc>
  8103. </method>
  8104. <method name="getMaterial" return_type="Material">
  8105. <desc><![CDATA[ Returns the material applied.]]></desc>
  8106. </method>
  8107. <method name="loadSkeleton" return_type="Skeleton">
  8108. <desc><![CDATA[ Loads a skeleton from a file and applies it to the scene mesh. ]]></desc>
  8109. <params>
  8110. <param name="fileName" type="String">
  8111. <desc><![CDATA[Filename to load the skeleton from.]]></desc>
  8112. </param>
  8113. </params>
  8114. </method>
  8115. <method name="clearMaterial" return_type="nil">
  8116. <desc><![CDATA[ Clears the currently applied material]]></desc>
  8117. </method>
  8118. <method name="setMaterial" return_type="nil">
  8119. <desc><![CDATA[ Set material from existing Material instance. ]]></desc>
  8120. <params>
  8121. <param name="material" type="Material">
  8122. <desc><![CDATA[Material to apply.]]></desc>
  8123. </param>
  8124. </params>
  8125. </method>
  8126. <method name="rebuildAttributes" return_type="nil">
  8127. </method>
  8128. <method name="setMaterialByName" return_type="nil">
  8129. <desc><![CDATA[ Set material by name. You can create materials in material files and name them there, then use this to set a material by name to a scene mesh. ]]></desc>
  8130. <params>
  8131. <param name="materialName" type="String">
  8132. <desc><![CDATA[Name of material to apply.]]></desc>
  8133. </param>
  8134. <param name="resourcePool" type="ResourcePool">
  8135. </param>
  8136. </params>
  8137. </method>
  8138. <method name="setMesh" return_type="nil">
  8139. <desc><![CDATA[ Set the mesh this scene mesh renders. ]]></desc>
  8140. <params>
  8141. <param name="mesh" type="Mesh">
  8142. <desc><![CDATA[Set a new mesh to render.]]></desc>
  8143. </param>
  8144. </params>
  8145. </method>
  8146. <method name="setSkeleton" return_type="nil">
  8147. <desc><![CDATA[ Sets a skeleton from an existing skeleton instance. ]]></desc>
  8148. <params>
  8149. <param name="skeleton" type="Skeleton">
  8150. <desc><![CDATA[Skeleton to set to this mesh.]]></desc>
  8151. </param>
  8152. </params>
  8153. </method>
  8154. <method name="getSkeleton" return_type="Skeleton">
  8155. <desc><![CDATA[ Returns the skeleton applied to this scene mesh.]]></desc>
  8156. </method>
  8157. <method name="applySkeletonLocally" return_type="nil">
  8158. </method>
  8159. <method name="setLineWidth" return_type="nil">
  8160. <desc><![CDATA[ Sets the line width for line-based meshes.]]></desc>
  8161. <params>
  8162. <param name="newWidth" type="Number">
  8163. </param>
  8164. </params>
  8165. </method>
  8166. <method name="getFilename" return_type="String">
  8167. <desc><![CDATA[ If this mesh was loaded form file, returns the filename of the loaded mesh.]]></desc>
  8168. </method>
  8169. <method name="setFilename" return_type="nil">
  8170. <desc><![CDATA[ Sets the filename path of the mesh.]]></desc>
  8171. <params>
  8172. <param name="fileName" type="String">
  8173. </param>
  8174. </params>
  8175. </method>
  8176. <method name="loadFromFile" return_type="nil">
  8177. <desc><![CDATA[ Loads mesh from file. Deletes current mesh if ownsMesh is set to true.]]></desc>
  8178. <params>
  8179. <param name="fileName" type="String">
  8180. </param>
  8181. </params>
  8182. </method>
  8183. <method name="customHitDetection" return_type="Boolean">
  8184. <params>
  8185. <param name="ray" type="Ray">
  8186. </param>
  8187. </params>
  8188. </method>
  8189. <method name="setForceMaterial" return_type="nil">
  8190. <desc><![CDATA[ The Renderer has an ability to set an override material that is set for all rendered entities. If forceMaterial is set to true, this entity will always use its assigned material, even if an override material is set.]]></desc>
  8191. <params>
  8192. <param name="forceMaterial" type="Boolean">
  8193. </param>
  8194. </params>
  8195. </method>
  8196. <method name="getForceMaterial" return_type="Boolean">
  8197. </method>
  8198. <method name="Clone" return_type="Entity">
  8199. <params>
  8200. <param name="deepClone" type="Boolean">
  8201. </param>
  8202. <param name="ignoreEditorOnly" type="Boolean">
  8203. </param>
  8204. </params>
  8205. </method>
  8206. <method name="applyClone" return_type="nil">
  8207. <params>
  8208. <param name="clone" type="Entity">
  8209. </param>
  8210. <param name="deepClone" type="Boolean">
  8211. </param>
  8212. <param name="ignoreEditorOnly" type="Boolean">
  8213. </param>
  8214. </params>
  8215. </method>
  8216. </methods>
  8217. </class>
  8218. <class name="ScenePrimitive" extends="SceneMesh">
  8219. <desc><![CDATA[ 3D primitive mesh. ]]></desc>
  8220. <class_notes>NOTE: ScenePrimitive instances are not automatically garbage collected.</class_notes>
  8221. <static_members>
  8222. <static_member name="TYPE_BOX" type="Integer" value="0">
  8223. <desc><![CDATA[ A cube. v1 - X size v2 - Y size v3 - Z size v4 - # of tiles]]></desc>
  8224. </static_member>
  8225. <static_member name="TYPE_PLANE" type="Integer" value="1">
  8226. <desc><![CDATA[ A horizontal plane. v1 - X size v2 - Z size v3 - # of tiles]]></desc>
  8227. </static_member>
  8228. <static_member name="TYPE_VPLANE" type="Integer" value="2">
  8229. <desc><![CDATA[ A vertical plane. v1 - X size v2 - Y size v3 - # of tiles]]></desc>
  8230. </static_member>
  8231. <static_member name="TYPE_CYLINDER" type="Integer" value="3">
  8232. <desc><![CDATA[ A cylinder. v1 - Cylinder length v2 - Cylinder radius v3 - Number of segments. v4 - # of tiles]]></desc>
  8233. </static_member>
  8234. <static_member name="TYPE_UNCAPPED_CYLINDER" type="Integer" value="4">
  8235. <desc><![CDATA[ A cylinder. v1 - Cylinder length v2 - Cylinder radius v3 - Number of segments. v4 - # of tiles]]></desc>
  8236. </static_member>
  8237. <static_member name="TYPE_SPHERE" type="Integer" value="5">
  8238. <desc><![CDATA[ A sphere. v1 - Sphere radius v2 - Lat segments v3 - Long segments v4 - # of tiles]]></desc>
  8239. </static_member>
  8240. <static_member name="TYPE_TORUS" type="Integer" value="6">
  8241. <desc><![CDATA[ A torus. v1 - Torus radius. v2 - Pipe radius. v3 - Number of ring segments. v4 - Number of pipe segments. v5 - # of tiles]]></desc>
  8242. </static_member>
  8243. <static_member name="TYPE_CONE" type="Integer" value="7">
  8244. <desc><![CDATA[ A cone. v1 - Cone length. v2 - Cone raidus. v3 - Number of segments. v4 - # of tiles]]></desc>
  8245. </static_member>
  8246. <static_member name="TYPE_CIRCLE" type="Integer" value="8">
  8247. <desc><![CDATA[ A 2D circle. v1 - X size v2 - Y size v3 - Number of segments v4 - # of tiles]]></desc>
  8248. </static_member>
  8249. <static_member name="TYPE_ICOSPHERE" type="Integer" value="9">
  8250. <desc><![CDATA[ An ico sphere. v1 - Sphere radius v2 - number of subdivisions]]></desc>
  8251. </static_member>
  8252. <static_member name="TYPE_OCTOSPHERE" type="Integer" value="10">
  8253. <desc><![CDATA[ An ico sphere. v1 - Sphere radius v2 - number of subdivisions]]></desc>
  8254. </static_member>
  8255. <static_member name="TYPE_LINE_CIRCLE" type="Integer" value="11">
  8256. <desc><![CDATA[ A 2D line circle. v1 - X size v2 - Y size v3 - Number of segments v4 - # of tiles]]></desc>
  8257. </static_member>
  8258. </static_members>
  8259. <members>
  8260. </members>
  8261. <methods>
  8262. <method name="ScenePrimitive" return_type="nil">
  8263. <desc><![CDATA[ Create a primitive mesh of specified type and size. ]]></desc>
  8264. <params>
  8265. <param name="type" type="Integer">
  8266. <desc><![CDATA[Type of primitive to create. Current types are ScenePrimitive.TYPE_BOX, ScenePrimitive.TYPE_PLANE, ScenePrimitive.TYPE_VPLANE, ScenePrimitive.TYPE_SPHERE, ScenePrimitive.TYPE_CYLINDER, ScenePrimitive.TYPE_CONE and ScenePrimitive.TYPE_TORUS]]></desc>
  8267. </param>
  8268. <param name="v1" type="Number">
  8269. <desc><![CDATA[See the constant primitive types for values for these parameters]]></desc>
  8270. </param>
  8271. <param name="v2" type="Number">
  8272. <desc><![CDATA[See the constant primitive types for values for these parameters]]></desc>
  8273. </param>
  8274. <param name="v3" type="Number">
  8275. <desc><![CDATA[See the constant primitive types for values for these parameters]]></desc>
  8276. </param>
  8277. <param name="v4" type="Number">
  8278. <desc><![CDATA[See the constant primitive types for values for these parameters]]></desc>
  8279. </param>
  8280. <param name="v5" type="Number">
  8281. <desc><![CDATA[See the constant primitive types for values for these parameters]]></desc>
  8282. </param>
  8283. </params>
  8284. </method>
  8285. <method name="setPrimitiveOptions" return_type="nil">
  8286. <params>
  8287. <param name="type" type="Integer">
  8288. </param>
  8289. <param name="v1" type="Number">
  8290. </param>
  8291. <param name="v2" type="Number">
  8292. </param>
  8293. <param name="v3" type="Number">
  8294. </param>
  8295. <param name="v4" type="Number">
  8296. </param>
  8297. <param name="v5" type="Number">
  8298. </param>
  8299. </params>
  8300. </method>
  8301. <method name="recreatePrimitive" return_type="nil">
  8302. </method>
  8303. <method name="getPrimitiveType" return_type="Integer">
  8304. </method>
  8305. <method name="getPrimitiveParameter1" return_type="Number">
  8306. </method>
  8307. <method name="getPrimitiveParameter2" return_type="Number">
  8308. </method>
  8309. <method name="getPrimitiveParameter3" return_type="Number">
  8310. </method>
  8311. <method name="getPrimitiveParameter4" return_type="Number">
  8312. </method>
  8313. <method name="getPrimitiveParameter5" return_type="Number">
  8314. </method>
  8315. <method name="Clone" return_type="Entity">
  8316. <params>
  8317. <param name="deepClone" type="Boolean">
  8318. </param>
  8319. <param name="ignoreEditorOnly" type="Boolean">
  8320. </param>
  8321. </params>
  8322. </method>
  8323. <method name="applyClone" return_type="nil">
  8324. <params>
  8325. <param name="clone" type="Entity">
  8326. </param>
  8327. <param name="deepClone" type="Boolean">
  8328. </param>
  8329. <param name="ignoreEditorOnly" type="Boolean">
  8330. </param>
  8331. </params>
  8332. </method>
  8333. </methods>
  8334. </class>
  8335. <class name="SceneRenderTexture">
  8336. <desc><![CDATA[ Renders scenes to texture. This class automatically renders a scene to a texture every frame that you can use to texture anything else. You can set a scene to virtual (see Scene for details) to only render a scene to a texture if you need to. This class automatically adds itself to the render cycle, so you do not need to do anything manual every frame.]]></desc>
  8337. <static_members>
  8338. </static_members>
  8339. <members>
  8340. <member name="enabled" type="Boolean">
  8341. </member>
  8342. </members>
  8343. <methods>
  8344. <method name="SceneRenderTexture" return_type="nil">
  8345. <desc><![CDATA[ Construct a new render texture with parameters. ]]></desc>
  8346. <params>
  8347. <param name="targetScene" type="Scene">
  8348. <desc><![CDATA[Target scene to render.]]></desc>
  8349. </param>
  8350. <param name="targetCamera" type="Camera">
  8351. <desc><![CDATA[to render from.]]></desc>
  8352. </param>
  8353. <param name="renderWidth" type="Integer">
  8354. <desc><![CDATA[Horizontal size of the render texture.]]></desc>
  8355. </param>
  8356. <param name="renderHeight" type="Integer">
  8357. <desc><![CDATA[Vertical size of the render texture.]]></desc>
  8358. </param>
  8359. <param name="floatingPoint" type="Boolean">
  8360. <desc><![CDATA[Pass true if you want fp16 target renders]]></desc>
  8361. </param>
  8362. </params>
  8363. </method>
  8364. <method name="getTargetTexture" return_type="Texture">
  8365. <desc><![CDATA[ Returns the actual render texture.]]></desc>
  8366. </method>
  8367. <method name="getFilterColorBufferTexture" return_type="Texture">
  8368. </method>
  8369. <method name="getFilterZBufferTexture" return_type="Texture">
  8370. </method>
  8371. <method name="Render" return_type="nil">
  8372. </method>
  8373. <method name="saveToImage" return_type="Image">
  8374. </method>
  8375. <method name="resizeRenderTexture" return_type="nil">
  8376. <params>
  8377. <param name="newWidth" type="Integer">
  8378. </param>
  8379. <param name="newHeight" type="Integer">
  8380. </param>
  8381. </params>
  8382. </method>
  8383. <method name="getTargetScene" return_type="Scene">
  8384. <desc><![CDATA[ Returns the target scene.]]></desc>
  8385. </method>
  8386. <method name="getTargetCamera" return_type="Camera">
  8387. <desc><![CDATA[ Returns the target camera.]]></desc>
  8388. </method>
  8389. </methods>
  8390. </class>
  8391. <class name="SceneSound" extends="Entity">
  8392. <desc><![CDATA[ Creates a positional 3D sound.]]></desc>
  8393. <class_notes>NOTE: SceneSound instances are not automatically garbage collected.</class_notes>
  8394. <static_members>
  8395. </static_members>
  8396. <members>
  8397. </members>
  8398. <methods>
  8399. <method name="SceneSound" return_type="nil">
  8400. <params>
  8401. <param name="fileName" type="String">
  8402. </param>
  8403. <param name="referenceDistance" type="Number">
  8404. </param>
  8405. <param name="maxDistance" type="Number">
  8406. </param>
  8407. <param name="directionalSound" type="Boolean">
  8408. </param>
  8409. </params>
  8410. </method>
  8411. <method name="Update" return_type="nil">
  8412. </method>
  8413. <method name="Clone" return_type="Entity">
  8414. <params>
  8415. <param name="deepClone" type="Boolean">
  8416. </param>
  8417. <param name="ignoreEditorOnly" type="Boolean">
  8418. </param>
  8419. </params>
  8420. </method>
  8421. <method name="applyClone" return_type="nil">
  8422. <params>
  8423. <param name="clone" type="Entity">
  8424. </param>
  8425. <param name="deepClone" type="Boolean">
  8426. </param>
  8427. <param name="ignoreEditorOnly" type="Boolean">
  8428. </param>
  8429. </params>
  8430. </method>
  8431. <method name="isDirectionalSound" return_type="Boolean">
  8432. </method>
  8433. <method name="setDirectionalSound" return_type="nil">
  8434. <params>
  8435. <param name="val" type="Boolean">
  8436. </param>
  8437. </params>
  8438. </method>
  8439. <method name="getSound" return_type="Sound">
  8440. <desc><![CDATA[ Returns the sound object associated with this positional sound.]]></desc>
  8441. </method>
  8442. <method name="setLoopOnLoad" return_type="nil">
  8443. <params>
  8444. <param name="val" type="Boolean">
  8445. </param>
  8446. </params>
  8447. </method>
  8448. <method name="getLoopOnLoad" return_type="Boolean">
  8449. </method>
  8450. </methods>
  8451. </class>
  8452. <class name="SceneSoundListener" extends="Entity">
  8453. <desc><![CDATA[ Creates a positional 3D sound listener. There can be only one listener active at any one time.]]></desc>
  8454. <static_members>
  8455. </static_members>
  8456. <members>
  8457. </members>
  8458. <methods>
  8459. <method name="SceneSoundListener" return_type="nil">
  8460. </method>
  8461. <method name="Update" return_type="nil">
  8462. </method>
  8463. </methods>
  8464. </class>
  8465. <class name="SceneSprite" extends="SceneMesh">
  8466. <class_notes>NOTE: SceneSprite instances are not automatically garbage collected.</class_notes>
  8467. <static_members>
  8468. </static_members>
  8469. <members>
  8470. </members>
  8471. <methods>
  8472. <method name="SceneSprite" return_type="nil">
  8473. <params>
  8474. <param name="spriteSet" type="SpriteSet">
  8475. </param>
  8476. </params>
  8477. </method>
  8478. <method name="Clone" return_type="Entity">
  8479. <params>
  8480. <param name="deepClone" type="Boolean">
  8481. </param>
  8482. <param name="ignoreEditorOnly" type="Boolean">
  8483. </param>
  8484. </params>
  8485. </method>
  8486. <method name="applyClone" return_type="nil">
  8487. <params>
  8488. <param name="clone" type="Entity">
  8489. </param>
  8490. <param name="deepClone" type="Boolean">
  8491. </param>
  8492. <param name="ignoreEditorOnly" type="Boolean">
  8493. </param>
  8494. </params>
  8495. </method>
  8496. <method name="getSpriteSet" return_type="SpriteSet">
  8497. </method>
  8498. <method name="getCurrentSprite" return_type="Sprite">
  8499. </method>
  8500. <method name="setSpriteSet" return_type="nil">
  8501. <params>
  8502. <param name="spriteSet" type="SpriteSet">
  8503. </param>
  8504. </params>
  8505. </method>
  8506. <method name="setSpriteByName" return_type="nil">
  8507. <params>
  8508. <param name="spriteName" type="String">
  8509. </param>
  8510. </params>
  8511. </method>
  8512. <method name="setCurrentFrame" return_type="nil">
  8513. <params>
  8514. <param name="frameIndex" type="Integer">
  8515. </param>
  8516. </params>
  8517. </method>
  8518. <method name="getCurrentFrame" return_type="Integer">
  8519. </method>
  8520. <method name="Update" return_type="nil">
  8521. </method>
  8522. <method name="Render" return_type="nil">
  8523. <params>
  8524. <param name="buffer" type="GPUDrawBuffer">
  8525. </param>
  8526. </params>
  8527. </method>
  8528. <method name="getSpriteBoundingBox" return_type="Vector3">
  8529. </method>
  8530. <method name="setPaused" return_type="nil">
  8531. <params>
  8532. <param name="val" type="Boolean">
  8533. </param>
  8534. </params>
  8535. </method>
  8536. <method name="isPaused" return_type="Boolean">
  8537. </method>
  8538. <method name="setSprite" return_type="nil">
  8539. <params>
  8540. <param name="spriteEntry" type="Sprite">
  8541. </param>
  8542. </params>
  8543. </method>
  8544. <method name="setSpriteState" return_type="nil">
  8545. <params>
  8546. <param name="spriteState" type="SpriteState">
  8547. </param>
  8548. <param name="startingFrame" type="Integer">
  8549. </param>
  8550. <param name="playOnce" type="Boolean">
  8551. </param>
  8552. </params>
  8553. </method>
  8554. <method name="setSpriteStateByName" return_type="nil">
  8555. <params>
  8556. <param name="name" type="String">
  8557. </param>
  8558. <param name="startingFrame" type="Integer">
  8559. </param>
  8560. <param name="playOnce" type="Boolean">
  8561. </param>
  8562. </params>
  8563. </method>
  8564. <method name="getCurrentSpriteState" return_type="SpriteState">
  8565. </method>
  8566. <method name="getStartOnRandomFrame" return_type="Boolean">
  8567. </method>
  8568. <method name="setStartOnRandomFrame" return_type="nil">
  8569. <params>
  8570. <param name="val" type="Boolean">
  8571. </param>
  8572. </params>
  8573. </method>
  8574. </methods>
  8575. </class>
  8576. <class name="Sprite" extends="Resource">
  8577. <static_members>
  8578. </static_members>
  8579. <members>
  8580. </members>
  8581. <methods>
  8582. <method name="Sprite" return_type="nil">
  8583. <params>
  8584. <param name="name" type="String">
  8585. </param>
  8586. </params>
  8587. </method>
  8588. <method name="getName" return_type="String">
  8589. </method>
  8590. <method name="setName" return_type="nil">
  8591. <params>
  8592. <param name="name" type="String">
  8593. </param>
  8594. </params>
  8595. </method>
  8596. <method name="addSpriteState" return_type="nil">
  8597. <params>
  8598. <param name="state" type="SpriteState">
  8599. </param>
  8600. </params>
  8601. </method>
  8602. <method name="removeSpriteState" return_type="nil">
  8603. <params>
  8604. <param name="state" type="SpriteState">
  8605. </param>
  8606. </params>
  8607. </method>
  8608. <method name="getNumStates" return_type="Integer">
  8609. </method>
  8610. <method name="getState" return_type="SpriteState">
  8611. <params>
  8612. <param name="index" type="Integer">
  8613. </param>
  8614. </params>
  8615. </method>
  8616. <method name="getStateByName" return_type="SpriteState">
  8617. <params>
  8618. <param name="name" type="String">
  8619. </param>
  8620. </params>
  8621. </method>
  8622. <method name="setParentSpritSet" return_type="nil">
  8623. <params>
  8624. <param name="spriteSet" type="SpriteSet">
  8625. </param>
  8626. </params>
  8627. </method>
  8628. <method name="getParentSpriteSet" return_type="SpriteSet">
  8629. </method>
  8630. </methods>
  8631. </class>
  8632. <class name="SpriteSet" extends="ResourcePool">
  8633. <static_members>
  8634. </static_members>
  8635. <members>
  8636. </members>
  8637. <methods>
  8638. <method name="SpriteSet" return_type="nil">
  8639. <params>
  8640. <param name="fileName" type="String">
  8641. </param>
  8642. <param name="parentPool" type="ResourcePool">
  8643. </param>
  8644. </params>
  8645. </method>
  8646. <method name="setTexture" return_type="nil">
  8647. <params>
  8648. <param name="texture" type="Texture">
  8649. </param>
  8650. </params>
  8651. </method>
  8652. <method name="getTexture" return_type="Texture">
  8653. </method>
  8654. <method name="loadTexture" return_type="Texture">
  8655. <params>
  8656. <param name="imageFileName" type="String">
  8657. </param>
  8658. </params>
  8659. </method>
  8660. <method name="addSpriteEntry" return_type="nil">
  8661. <params>
  8662. <param name="newEntry" type="Sprite">
  8663. </param>
  8664. </params>
  8665. </method>
  8666. <method name="getNumSpriteEntries" return_type="Integer">
  8667. </method>
  8668. <method name="getSpriteEntry" return_type="Sprite">
  8669. <params>
  8670. <param name="index" type="Integer">
  8671. </param>
  8672. </params>
  8673. </method>
  8674. <method name="removeSprite" return_type="nil">
  8675. <params>
  8676. <param name="sprite" type="Sprite">
  8677. </param>
  8678. </params>
  8679. </method>
  8680. <method name="loadSpriteSet" return_type="nil">
  8681. <params>
  8682. <param name="fileName" type="String">
  8683. </param>
  8684. </params>
  8685. </method>
  8686. <method name="addSpriteFrame" return_type="nil">
  8687. <params>
  8688. <param name="frame" type="SpriteFrame">
  8689. </param>
  8690. <param name="assignID" type="Boolean">
  8691. </param>
  8692. </params>
  8693. </method>
  8694. <method name="getNumFrames" return_type="Integer">
  8695. </method>
  8696. <method name="getSpriteFrame" return_type="SpriteFrame">
  8697. <params>
  8698. <param name="index" type="Integer">
  8699. </param>
  8700. </params>
  8701. </method>
  8702. <method name="getSpriteFrameByID" return_type="SpriteFrame">
  8703. <params>
  8704. <param name="frameID" type="Integer">
  8705. </param>
  8706. </params>
  8707. </method>
  8708. <method name="removeFrameByID" return_type="nil">
  8709. <params>
  8710. <param name="frameID" type="Integer">
  8711. </param>
  8712. </params>
  8713. </method>
  8714. <method name="setSpriteFrame" return_type="nil">
  8715. <params>
  8716. <param name="frame" type="SpriteFrame">
  8717. </param>
  8718. </params>
  8719. </method>
  8720. <method name="clearFrames" return_type="nil">
  8721. </method>
  8722. <method name="createGridFrames" return_type="nil">
  8723. <params>
  8724. <param name="xCount" type="Integer">
  8725. </param>
  8726. <param name="yCount" type="Integer">
  8727. </param>
  8728. <param name="defaultAnchor" type="Vector2">
  8729. </param>
  8730. </params>
  8731. </method>
  8732. <method name="createFramesFromIslands" return_type="nil">
  8733. <params>
  8734. <param name="minDistance" type="Integer">
  8735. </param>
  8736. <param name="defaultAnchor" type="Vector2">
  8737. </param>
  8738. </params>
  8739. </method>
  8740. <method name="getSpriteByName" return_type="Sprite">
  8741. <params>
  8742. <param name="spriteName" type="String">
  8743. </param>
  8744. </params>
  8745. </method>
  8746. </methods>
  8747. </class>
  8748. <class name="SpriteFrame">
  8749. <static_members>
  8750. </static_members>
  8751. <members>
  8752. <member name="coordinates" type="Rectangle">
  8753. </member>
  8754. <member name="anchorPoint" type="Vector2">
  8755. </member>
  8756. <member name="frameID" type="Integer">
  8757. </member>
  8758. </members>
  8759. <methods>
  8760. </methods>
  8761. </class>
  8762. <class name="SpriteState">
  8763. <static_members>
  8764. </static_members>
  8765. <members>
  8766. </members>
  8767. <methods>
  8768. <method name="SpriteState" return_type="nil">
  8769. <params>
  8770. <param name="spriteSet" type="SpriteSet">
  8771. </param>
  8772. <param name="name" type="String">
  8773. </param>
  8774. </params>
  8775. </method>
  8776. <method name="setName" return_type="nil">
  8777. <params>
  8778. <param name="name" type="String">
  8779. </param>
  8780. </params>
  8781. </method>
  8782. <method name="getName" return_type="String">
  8783. </method>
  8784. <method name="getNumFrameIDs" return_type="Integer">
  8785. </method>
  8786. <method name="getFrameIDAtIndex" return_type="Integer">
  8787. <params>
  8788. <param name="index" type="Integer">
  8789. </param>
  8790. </params>
  8791. </method>
  8792. <method name="getMeshForFrameIndex" return_type="Mesh">
  8793. <params>
  8794. <param name="index" type="Integer">
  8795. </param>
  8796. </params>
  8797. </method>
  8798. <method name="insertFrame" return_type="nil">
  8799. <params>
  8800. <param name="index" type="Integer">
  8801. </param>
  8802. <param name="frameID" type="Integer">
  8803. </param>
  8804. </params>
  8805. </method>
  8806. <method name="removeFrameByIndex" return_type="nil">
  8807. <params>
  8808. <param name="frameIndex" type="Integer">
  8809. </param>
  8810. </params>
  8811. </method>
  8812. <method name="clearFrames" return_type="nil">
  8813. </method>
  8814. <method name="setPixelsPerUnit" return_type="nil">
  8815. <params>
  8816. <param name="ppu" type="Number">
  8817. </param>
  8818. </params>
  8819. </method>
  8820. <method name="getPixelsPerUnit" return_type="Number">
  8821. </method>
  8822. <method name="rebuildStateMeshes" return_type="nil">
  8823. </method>
  8824. <method name="setStateFPS" return_type="nil">
  8825. <params>
  8826. <param name="fps" type="Number">
  8827. </param>
  8828. </params>
  8829. </method>
  8830. <method name="getStateFPS" return_type="Number">
  8831. </method>
  8832. <method name="getLargestFrameBoundingBox" return_type="Vector3">
  8833. </method>
  8834. <method name="setBoundingBox" return_type="nil">
  8835. <params>
  8836. <param name="boundingBox" type="Vector2">
  8837. </param>
  8838. </params>
  8839. </method>
  8840. <method name="getBoundingBox" return_type="Vector2">
  8841. </method>
  8842. <method name="getSpriteOffset" return_type="Vector2">
  8843. </method>
  8844. <method name="setSpriteOffset" return_type="nil">
  8845. <params>
  8846. <param name="offset" type="Vector2">
  8847. </param>
  8848. </params>
  8849. </method>
  8850. </methods>
  8851. </class>
  8852. <class name="JSScriptInstance" extends="ScriptInstance">
  8853. <static_members>
  8854. </static_members>
  8855. <members>
  8856. <member name="objectRef" type="nil">
  8857. </member>
  8858. </members>
  8859. <methods>
  8860. </methods>
  8861. </class>
  8862. <class name="LuaScriptInstance" extends="ScriptInstance">
  8863. <static_members>
  8864. </static_members>
  8865. <members>
  8866. <member name="tableRef" type="Integer">
  8867. </member>
  8868. </members>
  8869. <methods>
  8870. </methods>
  8871. </class>
  8872. <class name="ScriptInstance">
  8873. <static_members>
  8874. </static_members>
  8875. <members>
  8876. <member name="script" type="Script">
  8877. </member>
  8878. </members>
  8879. <methods>
  8880. </methods>
  8881. </class>
  8882. <class name="ProgramParam">
  8883. <static_members>
  8884. <static_member name="PARAM_UNKNOWN" type="Integer" value="0">
  8885. </static_member>
  8886. <static_member name="PARAM_NUMBER" type="Integer" value="1">
  8887. </static_member>
  8888. <static_member name="PARAM_VECTOR2" type="Integer" value="2">
  8889. </static_member>
  8890. <static_member name="PARAM_VECTOR3" type="Integer" value="3">
  8891. </static_member>
  8892. <static_member name="PARAM_COLOR" type="Integer" value="4">
  8893. </static_member>
  8894. <static_member name="PARAM_MATRIX" type="Integer" value="5">
  8895. </static_member>
  8896. <static_member name="PARAM_TEXTURE" type="Integer" value="6">
  8897. </static_member>
  8898. <static_member name="PARAM_CUBEMAP" type="Integer" value="7">
  8899. </static_member>
  8900. </static_members>
  8901. <members>
  8902. <member name="name" type="String">
  8903. </member>
  8904. <member name="type" type="Integer">
  8905. </member>
  8906. <member name="platformData" type="nil">
  8907. </member>
  8908. <member name="globalParam" type="LocalShaderParam">
  8909. </member>
  8910. </members>
  8911. <methods>
  8912. <method name="ProgramParam" return_type="nil">
  8913. </method>
  8914. <method name="createParamData" return_type="nil" static="true">
  8915. <params>
  8916. <param name="type" type="Integer">
  8917. </param>
  8918. </params>
  8919. </method>
  8920. </methods>
  8921. </class>
  8922. <class name="ProgramAttribute">
  8923. <static_members>
  8924. </static_members>
  8925. <members>
  8926. <member name="size" type="Integer">
  8927. </member>
  8928. <member name="name" type="String">
  8929. </member>
  8930. <member name="platformData" type="nil">
  8931. </member>
  8932. </members>
  8933. <methods>
  8934. <method name="ProgramAttribute" return_type="nil">
  8935. </method>
  8936. </methods>
  8937. </class>
  8938. <class name="ShaderRenderTarget">
  8939. <static_members>
  8940. <static_member name="SIZE_MODE_PIXELS" type="Integer" value="0">
  8941. </static_member>
  8942. <static_member name="SIZE_MODE_NORMALIZED" type="Integer" value="1">
  8943. </static_member>
  8944. </static_members>
  8945. <members>
  8946. <member name="id" type="String">
  8947. </member>
  8948. <member name="width" type="Number">
  8949. </member>
  8950. <member name="height" type="Number">
  8951. </member>
  8952. <member name="sizeMode" type="Integer">
  8953. </member>
  8954. <member name="buffer" type="RenderBuffer">
  8955. </member>
  8956. <member name="normalizedWidth" type="Number">
  8957. </member>
  8958. <member name="normalizedHeight" type="Number">
  8959. </member>
  8960. </members>
  8961. <methods>
  8962. <method name="ShaderRenderTarget" return_type="nil">
  8963. </method>
  8964. </methods>
  8965. </class>
  8966. <class name="RenderTargetBinding">
  8967. <static_members>
  8968. <static_member name="MODE_IN" type="Integer" value="0">
  8969. </static_member>
  8970. <static_member name="MODE_OUT" type="Integer" value="1">
  8971. </static_member>
  8972. <static_member name="MODE_COLOR" type="Integer" value="2">
  8973. </static_member>
  8974. <static_member name="MODE_DEPTH" type="Integer" value="3">
  8975. </static_member>
  8976. </static_members>
  8977. <members>
  8978. <member name="id" type="String">
  8979. </member>
  8980. <member name="name" type="String">
  8981. </member>
  8982. <member name="mode" type="Integer">
  8983. </member>
  8984. <member name="buffer" type="RenderBuffer">
  8985. </member>
  8986. </members>
  8987. <methods>
  8988. </methods>
  8989. </class>
  8990. <class name="Shader" extends="Resource">
  8991. <static_members>
  8992. </static_members>
  8993. <members>
  8994. <member name="numSpotLights" type="Integer">
  8995. </member>
  8996. <member name="numPointLights" type="Integer">
  8997. </member>
  8998. <member name="screenShader" type="Boolean">
  8999. </member>
  9000. <member name="vertexProgram" type="ShaderProgram">
  9001. </member>
  9002. <member name="fragmentProgram" type="ShaderProgram">
  9003. </member>
  9004. <member name="name" type="String">
  9005. </member>
  9006. </members>
  9007. <methods>
  9008. <method name="getType" return_type="Integer">
  9009. </method>
  9010. <method name="setName" return_type="nil">
  9011. <params>
  9012. <param name="name" type="String">
  9013. </param>
  9014. </params>
  9015. </method>
  9016. <method name="getName" return_type="String">
  9017. </method>
  9018. <method name="getParamPointer" return_type="ProgramParam">
  9019. <params>
  9020. <param name="name" type="String">
  9021. </param>
  9022. </params>
  9023. </method>
  9024. <method name="getAttribPointer" return_type="ProgramAttribute">
  9025. <params>
  9026. <param name="name" type="String">
  9027. </param>
  9028. </params>
  9029. </method>
  9030. <method name="reload" return_type="nil">
  9031. </method>
  9032. <method name="getExpectedParamType" return_type="Integer">
  9033. <params>
  9034. <param name="name" type="String">
  9035. </param>
  9036. </params>
  9037. </method>
  9038. <method name="setVertexProgram" return_type="nil">
  9039. <params>
  9040. <param name="vp" type="ShaderProgram">
  9041. </param>
  9042. </params>
  9043. </method>
  9044. <method name="setFragmentProgram" return_type="nil">
  9045. <params>
  9046. <param name="fp" type="ShaderProgram">
  9047. </param>
  9048. </params>
  9049. </method>
  9050. </methods>
  9051. </class>
  9052. <class name="LocalShaderParam">
  9053. <static_members>
  9054. </static_members>
  9055. <members>
  9056. <member name="name" type="String">
  9057. </member>
  9058. <member name="data" type="nil">
  9059. </member>
  9060. <member name="type" type="Integer">
  9061. </member>
  9062. <member name="ownsPointer" type="Boolean">
  9063. </member>
  9064. <member name="arraySize" type="Integer">
  9065. </member>
  9066. <member name="param" type="ProgramParam">
  9067. </member>
  9068. </members>
  9069. <methods>
  9070. <method name="LocalShaderParam" return_type="nil">
  9071. </method>
  9072. <method name="Copy" return_type="LocalShaderParam">
  9073. </method>
  9074. <method name="getNumber" return_type="Number">
  9075. </method>
  9076. <method name="getVector2" return_type="Vector2">
  9077. </method>
  9078. <method name="getVector3" return_type="Vector3">
  9079. </method>
  9080. <method name="getMatrix4" return_type="Matrix4">
  9081. </method>
  9082. <method name="getColor" return_type="Color">
  9083. </method>
  9084. <method name="setNumber" return_type="nil">
  9085. <params>
  9086. <param name="x" type="Number">
  9087. </param>
  9088. </params>
  9089. </method>
  9090. <method name="setVector2" return_type="nil">
  9091. <params>
  9092. <param name="x" type="Vector2">
  9093. </param>
  9094. </params>
  9095. </method>
  9096. <method name="setVector3" return_type="nil">
  9097. <params>
  9098. <param name="x" type="Vector3">
  9099. </param>
  9100. </params>
  9101. </method>
  9102. <method name="setMatrix4" return_type="nil">
  9103. <params>
  9104. <param name="x" type="Matrix4">
  9105. </param>
  9106. </params>
  9107. </method>
  9108. <method name="setColor" return_type="nil">
  9109. <params>
  9110. <param name="x" type="Color">
  9111. </param>
  9112. </params>
  9113. </method>
  9114. <method name="setTexture" return_type="nil">
  9115. <params>
  9116. <param name="texture" type="Texture">
  9117. </param>
  9118. </params>
  9119. </method>
  9120. <method name="getTexture" return_type="Texture">
  9121. </method>
  9122. <method name="setCubemap" return_type="nil">
  9123. <params>
  9124. <param name="cubemap" type="Cubemap">
  9125. </param>
  9126. </params>
  9127. </method>
  9128. <method name="getCubemap" return_type="Cubemap">
  9129. </method>
  9130. <method name="setParamValueFromString" return_type="nil">
  9131. <params>
  9132. <param name="type" type="Integer">
  9133. </param>
  9134. <param name="pvalue" type="String">
  9135. </param>
  9136. </params>
  9137. </method>
  9138. </methods>
  9139. </class>
  9140. <class name="ShaderProgram" extends="Resource">
  9141. <static_members>
  9142. <static_member name="TYPE_VERT" type="Integer" value="0">
  9143. </static_member>
  9144. <static_member name="TYPE_FRAG" type="Integer" value="1">
  9145. </static_member>
  9146. </static_members>
  9147. <members>
  9148. <member name="type" type="Integer">
  9149. </member>
  9150. </members>
  9151. <methods>
  9152. <method name="ShaderProgram" return_type="nil">
  9153. <params>
  9154. <param name="fileName" type="String">
  9155. </param>
  9156. </params>
  9157. </method>
  9158. <method name="reloadProgram" return_type="nil">
  9159. </method>
  9160. <method name="reloadResource" return_type="nil">
  9161. </method>
  9162. </methods>
  9163. </class>
  9164. <class name="AttributeBinding">
  9165. <static_members>
  9166. </static_members>
  9167. <members>
  9168. <member name="name" type="String">
  9169. </member>
  9170. <member name="vertexData" type="VertexDataArray">
  9171. </member>
  9172. <member name="attribute" type="ProgramAttribute">
  9173. </member>
  9174. <member name="enabled" type="Boolean">
  9175. </member>
  9176. </members>
  9177. <methods>
  9178. <method name="AttributeBinding" return_type="nil">
  9179. </method>
  9180. </methods>
  9181. </class>
  9182. <class name="ShaderBinding">
  9183. <static_members>
  9184. </static_members>
  9185. <members>
  9186. <member name="resetAttributes" type="Boolean">
  9187. </member>
  9188. <member name="targetShader" type="Shader">
  9189. </member>
  9190. <member name="accessMutex" type="CoreMutex">
  9191. </member>
  9192. </members>
  9193. <methods>
  9194. <method name="ShaderBinding" return_type="nil">
  9195. </method>
  9196. <method name="copyTo" return_type="nil">
  9197. <params>
  9198. <param name="targetBinding" type="ShaderBinding">
  9199. </param>
  9200. </params>
  9201. </method>
  9202. <method name="addParam" return_type="LocalShaderParam">
  9203. <params>
  9204. <param name="type" type="Integer">
  9205. </param>
  9206. <param name="name" type="String">
  9207. </param>
  9208. </params>
  9209. </method>
  9210. <method name="addParamPointer" return_type="LocalShaderParam">
  9211. <params>
  9212. <param name="type" type="Integer">
  9213. </param>
  9214. <param name="name" type="String">
  9215. </param>
  9216. <param name="ptr" type="nil">
  9217. </param>
  9218. </params>
  9219. </method>
  9220. <method name="getNumLocalParams" return_type="Integer">
  9221. </method>
  9222. <method name="getLocalParam" return_type="LocalShaderParam">
  9223. <params>
  9224. <param name="index" type="Integer">
  9225. </param>
  9226. </params>
  9227. </method>
  9228. <method name="getLocalParamByName" return_type="LocalShaderParam">
  9229. <params>
  9230. <param name="name" type="String">
  9231. </param>
  9232. </params>
  9233. </method>
  9234. <method name="removeParam" return_type="nil">
  9235. <params>
  9236. <param name="name" type="String">
  9237. </param>
  9238. </params>
  9239. </method>
  9240. <method name="loadTextureForParam" return_type="Texture">
  9241. <params>
  9242. <param name="paramName" type="String">
  9243. </param>
  9244. <param name="fileName" type="String">
  9245. </param>
  9246. </params>
  9247. </method>
  9248. <method name="setTextureForParam" return_type="nil">
  9249. <params>
  9250. <param name="paramName" type="String">
  9251. </param>
  9252. <param name="texture" type="Texture">
  9253. </param>
  9254. </params>
  9255. </method>
  9256. <method name="setCubemapForParam" return_type="nil">
  9257. <params>
  9258. <param name="paramName" type="String">
  9259. </param>
  9260. <param name="cubemap" type="Cubemap">
  9261. </param>
  9262. </params>
  9263. </method>
  9264. <method name="getNumAttributeBindings" return_type="Integer">
  9265. </method>
  9266. <method name="getAttributeBinding" return_type="AttributeBinding">
  9267. <params>
  9268. <param name="index" type="Integer">
  9269. </param>
  9270. </params>
  9271. </method>
  9272. <method name="addAttributeBinding" return_type="AttributeBinding">
  9273. <params>
  9274. <param name="name" type="String">
  9275. </param>
  9276. <param name="dataArray" type="VertexDataArray">
  9277. </param>
  9278. </params>
  9279. </method>
  9280. <method name="getAttributeBindingByName" return_type="AttributeBinding">
  9281. <params>
  9282. <param name="name" type="String">
  9283. </param>
  9284. </params>
  9285. </method>
  9286. <method name="addRenderTargetBinding" return_type="nil">
  9287. <params>
  9288. <param name="binding" type="RenderTargetBinding">
  9289. </param>
  9290. </params>
  9291. </method>
  9292. <method name="removeRenderTargetBinding" return_type="nil">
  9293. <params>
  9294. <param name="binding" type="RenderTargetBinding">
  9295. </param>
  9296. </params>
  9297. </method>
  9298. <method name="getNumRenderTargetBindings" return_type="Integer">
  9299. </method>
  9300. <method name="getRenderTargetBinding" return_type="RenderTargetBinding">
  9301. <params>
  9302. <param name="index" type="Integer">
  9303. </param>
  9304. </params>
  9305. </method>
  9306. <method name="getNumInTargetBindings" return_type="Integer">
  9307. </method>
  9308. <method name="getInTargetBinding" return_type="RenderTargetBinding">
  9309. <params>
  9310. <param name="index" type="Integer">
  9311. </param>
  9312. </params>
  9313. </method>
  9314. <method name="getNumColorTargetBindings" return_type="Integer">
  9315. </method>
  9316. <method name="getColorTargetBinding" return_type="RenderTargetBinding">
  9317. <params>
  9318. <param name="index" type="Integer">
  9319. </param>
  9320. </params>
  9321. </method>
  9322. <method name="getNumDepthTargetBindings" return_type="Integer">
  9323. </method>
  9324. <method name="getDepthTargetBinding" return_type="RenderTargetBinding">
  9325. <params>
  9326. <param name="index" type="Integer">
  9327. </param>
  9328. </params>
  9329. </method>
  9330. <method name="getNumOutTargetBindings" return_type="Integer">
  9331. </method>
  9332. <method name="getOutTargetBinding" return_type="RenderTargetBinding">
  9333. <params>
  9334. <param name="index" type="Integer">
  9335. </param>
  9336. </params>
  9337. </method>
  9338. </methods>
  9339. </class>
  9340. <class name="SkeletonAnimation">
  9341. <desc><![CDATA[ Skeleton animation.]]></desc>
  9342. <static_members>
  9343. </static_members>
  9344. <members>
  9345. </members>
  9346. <methods>
  9347. <method name="SkeletonAnimation" return_type="nil">
  9348. <params>
  9349. <param name="name" type="String">
  9350. </param>
  9351. <param name="duration" type="Number">
  9352. </param>
  9353. </params>
  9354. </method>
  9355. <method name="addBoneTrack" return_type="nil">
  9356. <desc><![CDATA[ Adds a new bone track ]]></desc>
  9357. <params>
  9358. <param name="boneTrack" type="BoneTrack">
  9359. <desc><![CDATA[New bone track to add.]]></desc>
  9360. </param>
  9361. </params>
  9362. </method>
  9363. <method name="getName" return_type="String">
  9364. <desc><![CDATA[ Returns the animation name.]]></desc>
  9365. </method>
  9366. <method name="Play" return_type="nil">
  9367. <desc><![CDATA[ Plays the animation.]]></desc>
  9368. <params>
  9369. <param name="once" type="Boolean">
  9370. </param>
  9371. </params>
  9372. </method>
  9373. <method name="Stop" return_type="nil">
  9374. <desc><![CDATA[ Stops the animation.]]></desc>
  9375. </method>
  9376. <method name="Reset" return_type="nil">
  9377. </method>
  9378. <method name="Update" return_type="nil">
  9379. </method>
  9380. <method name="setSpeed" return_type="nil">
  9381. <desc><![CDATA[ Sets the animation multiplier speed. ]]></desc>
  9382. <params>
  9383. <param name="speed" type="Number">
  9384. <desc><![CDATA[Number to multiply the animation speed by.]]></desc>
  9385. </param>
  9386. </params>
  9387. </method>
  9388. <method name="setWeight" return_type="nil">
  9389. <params>
  9390. <param name="newWeight" type="Number">
  9391. </param>
  9392. </params>
  9393. </method>
  9394. <method name="getWeight" return_type="Number">
  9395. </method>
  9396. <method name="isPlaying" return_type="Boolean">
  9397. </method>
  9398. </methods>
  9399. </class>
  9400. <class name="Skeleton" extends="Entity">
  9401. <desc><![CDATA[ 3D skeleton. Skeletons are applied to scene meshes and can be animated with loaded animations.]]></desc>
  9402. <static_members>
  9403. </static_members>
  9404. <members>
  9405. </members>
  9406. <methods>
  9407. <method name="Skeleton" return_type="nil">
  9408. <desc><![CDATA[ Construct skeleton from a skeleton file. ]]></desc>
  9409. <params>
  9410. <param name="fileName" type="String">
  9411. <desc><![CDATA[Skeleton file to load.]]></desc>
  9412. </param>
  9413. </params>
  9414. </method>
  9415. <method name="BlankSkeleton" return_type="Skeleton" static="true">
  9416. <desc><![CDATA[ Construct a blank skeleton.]]></desc>
  9417. </method>
  9418. <method name="loadSkeleton" return_type="nil">
  9419. <desc><![CDATA[ Loads a new skeleton from file. ]]></desc>
  9420. <params>
  9421. <param name="fileName" type="String">
  9422. <desc><![CDATA[Skeleton file to load.]]></desc>
  9423. </param>
  9424. </params>
  9425. </method>
  9426. <method name="playAnimationByName" return_type="nil">
  9427. <desc><![CDATA[ Play back a loaded animation. ]]></desc>
  9428. <params>
  9429. <param name="animName" type="String">
  9430. <desc><![CDATA[Name of animation to play.]]></desc>
  9431. </param>
  9432. <param name="weight" type="Number">
  9433. <desc><![CDATA[If true, will only play the animation once.]]></desc>
  9434. </param>
  9435. <param name="once" type="Boolean">
  9436. </param>
  9437. <param name="restartIfPlaying" type="Boolean">
  9438. </param>
  9439. </params>
  9440. </method>
  9441. <method name="playAnimation" return_type="nil">
  9442. <params>
  9443. <param name="animation" type="SkeletonAnimation">
  9444. </param>
  9445. <param name="weight" type="Number">
  9446. </param>
  9447. <param name="once" type="Boolean">
  9448. </param>
  9449. <param name="restartIfPlaying" type="Boolean">
  9450. </param>
  9451. </params>
  9452. </method>
  9453. <method name="setBaseAnimationByName" return_type="nil">
  9454. <params>
  9455. <param name="animName" type="String">
  9456. </param>
  9457. </params>
  9458. </method>
  9459. <method name="setBaseAnimation" return_type="nil">
  9460. <params>
  9461. <param name="animation" type="SkeletonAnimation">
  9462. </param>
  9463. </params>
  9464. </method>
  9465. <method name="stopAllAnimations" return_type="nil">
  9466. </method>
  9467. <method name="getBaseAnimation" return_type="SkeletonAnimation">
  9468. </method>
  9469. <method name="addAnimation" return_type="nil">
  9470. <desc><![CDATA[ Loads in a new animation from a file and adds it to the skeleton. ]]></desc>
  9471. <params>
  9472. <param name="name" type="String">
  9473. <desc><![CDATA[Name of the new animation.]]></desc>
  9474. </param>
  9475. <param name="fileName" type="String">
  9476. <desc><![CDATA[File to load animation from.]]></desc>
  9477. </param>
  9478. </params>
  9479. </method>
  9480. <method name="getAnimation" return_type="SkeletonAnimation">
  9481. <desc><![CDATA[ Returns a SkeletonAnimation by its name. ]]></desc>
  9482. <params>
  9483. <param name="name" type="String">
  9484. <desc><![CDATA[of animation to return.]]></desc>
  9485. </param>
  9486. </params>
  9487. </method>
  9488. <method name="stopAnimationByName" return_type="nil">
  9489. <params>
  9490. <param name="name" type="String">
  9491. </param>
  9492. </params>
  9493. </method>
  9494. <method name="stopAnimation" return_type="nil">
  9495. <params>
  9496. <param name="animation" type="SkeletonAnimation">
  9497. </param>
  9498. </params>
  9499. </method>
  9500. <method name="Update" return_type="nil">
  9501. </method>
  9502. <method name="getBoneByName" return_type="Bone">
  9503. <desc><![CDATA[ Get bone instance by its name ]]></desc>
  9504. <params>
  9505. <param name="name" type="String">
  9506. <desc><![CDATA[Name of the bone.]]></desc>
  9507. </param>
  9508. </params>
  9509. </method>
  9510. <method name="bonesVisible" return_type="nil">
  9511. <desc><![CDATA[ Toggles bone visibility on and off. ]]></desc>
  9512. <params>
  9513. <param name="val" type="Boolean">
  9514. <desc><![CDATA[If true, bones will be rendered, if false, they will not.]]></desc>
  9515. </param>
  9516. </params>
  9517. </method>
  9518. <method name="getNumBones" return_type="Integer">
  9519. <desc><![CDATA[ Returns the number of bones in the skeleton]]></desc>
  9520. </method>
  9521. <method name="getBone" return_type="Bone">
  9522. <desc><![CDATA[ Returns a bone at the specified index. ]]></desc>
  9523. <params>
  9524. <param name="index" type="Integer">
  9525. <desc><![CDATA[Bone index.]]></desc>
  9526. </param>
  9527. </params>
  9528. </method>
  9529. <method name="addBone" return_type="nil">
  9530. <params>
  9531. <param name="bone" type="Bone">
  9532. </param>
  9533. </params>
  9534. </method>
  9535. <method name="removeBone" return_type="nil">
  9536. <params>
  9537. <param name="bone" type="Bone">
  9538. </param>
  9539. </params>
  9540. </method>
  9541. <method name="getBoneIndexByBone" return_type="Integer">
  9542. <params>
  9543. <param name="bone" type="Bone">
  9544. </param>
  9545. </params>
  9546. </method>
  9547. </methods>
  9548. </class>
  9549. <class name="BoneTrack">
  9550. <static_members>
  9551. </static_members>
  9552. <members>
  9553. <member name="scaleX" type="BezierCurve">
  9554. </member>
  9555. <member name="scaleY" type="BezierCurve">
  9556. </member>
  9557. <member name="scaleZ" type="BezierCurve">
  9558. </member>
  9559. <member name="QuatW" type="BezierCurve">
  9560. </member>
  9561. <member name="QuatX" type="BezierCurve">
  9562. </member>
  9563. <member name="QuatY" type="BezierCurve">
  9564. </member>
  9565. <member name="QuatZ" type="BezierCurve">
  9566. </member>
  9567. <member name="LocX" type="BezierCurve">
  9568. </member>
  9569. <member name="LocY" type="BezierCurve">
  9570. </member>
  9571. <member name="LocZ" type="BezierCurve">
  9572. </member>
  9573. <member name="position" type="Vector3">
  9574. </member>
  9575. <member name="scale" type="Vector3">
  9576. </member>
  9577. <member name="boneQuat" type="Quaternion">
  9578. </member>
  9579. <member name="quatCurve" type="QuaternionCurve">
  9580. </member>
  9581. <member name="weight" type="Number">
  9582. </member>
  9583. </members>
  9584. <methods>
  9585. <method name="BoneTrack" return_type="nil">
  9586. <params>
  9587. <param name="bone" type="Bone">
  9588. </param>
  9589. <param name="length" type="Number">
  9590. </param>
  9591. </params>
  9592. </method>
  9593. <method name="Play" return_type="nil">
  9594. <params>
  9595. <param name="once" type="Boolean">
  9596. </param>
  9597. </params>
  9598. </method>
  9599. <method name="Stop" return_type="nil">
  9600. </method>
  9601. <method name="Update" return_type="nil">
  9602. <params>
  9603. <param name="elapsed" type="Number">
  9604. </param>
  9605. </params>
  9606. </method>
  9607. <method name="Reset" return_type="nil">
  9608. </method>
  9609. <method name="setSpeed" return_type="nil">
  9610. <params>
  9611. <param name="speed" type="Number">
  9612. </param>
  9613. </params>
  9614. </method>
  9615. </methods>
  9616. </class>
  9617. <class name="Sound">
  9618. <desc><![CDATA[ Loads and plays a sound. This class can load and play an OGG or WAV sound file.]]></desc>
  9619. <static_members>
  9620. </static_members>
  9621. <members>
  9622. </members>
  9623. <methods>
  9624. <method name="Sound" return_type="nil">
  9625. <desc><![CDATA[ Constructor. ]]></desc>
  9626. <params>
  9627. <param name="fileName" type="String">
  9628. <desc><![CDATA[Path to an OGG or WAV file to load.]]></desc>
  9629. </param>
  9630. </params>
  9631. </method>
  9632. <method name="getSampleAsNumber" return_type="Number">
  9633. <params>
  9634. <param name="offset" type="Integer">
  9635. </param>
  9636. <param name="channel" type="Integer">
  9637. </param>
  9638. </params>
  9639. </method>
  9640. <method name="loadFile" return_type="nil">
  9641. <params>
  9642. <param name="fileName" type="String">
  9643. </param>
  9644. </params>
  9645. </method>
  9646. <method name="Play" return_type="nil">
  9647. <desc><![CDATA[ Play the sound once or in a loop. ]]></desc>
  9648. <params>
  9649. <param name="loop" type="Boolean">
  9650. <desc><![CDATA[If this is true, play it once, otherwise, loop.]]></desc>
  9651. </param>
  9652. <param name="restartSound" type="Boolean">
  9653. </param>
  9654. </params>
  9655. </method>
  9656. <method name="Stop" return_type="nil">
  9657. <desc><![CDATA[ Stop the sound playback.]]></desc>
  9658. </method>
  9659. <method name="setVolume" return_type="nil">
  9660. <desc><![CDATA[ Sets the volume of this sound. ]]></desc>
  9661. <params>
  9662. <param name="newVolume" type="Number">
  9663. <desc><![CDATA[A Number 0-1, where 0 is no sound and 1 is the loudest.]]></desc>
  9664. </param>
  9665. </params>
  9666. </method>
  9667. <method name="getVolume" return_type="Number">
  9668. </method>
  9669. <method name="setPitch" return_type="nil">
  9670. <desc><![CDATA[ Sets the pitch of this sound. ]]></desc>
  9671. <params>
  9672. <param name="newPitch" type="Number">
  9673. <desc><![CDATA[A Number 0-1.]]></desc>
  9674. </param>
  9675. </params>
  9676. </method>
  9677. <method name="getPitch" return_type="Number">
  9678. </method>
  9679. <method name="isPlaying" return_type="Boolean">
  9680. <desc><![CDATA[ Returns true if the sound is playing. ]]></desc>
  9681. </method>
  9682. <method name="isLooped" return_type="Boolean">
  9683. </method>
  9684. <method name="setIsPositional" return_type="nil">
  9685. <params>
  9686. <param name="isPositional" type="Boolean">
  9687. </param>
  9688. </params>
  9689. </method>
  9690. <method name="setSoundPosition" return_type="nil">
  9691. <params>
  9692. <param name="position" type="Vector3">
  9693. </param>
  9694. </params>
  9695. </method>
  9696. <method name="setSoundVelocity" return_type="nil">
  9697. <params>
  9698. <param name="velocity" type="Vector3">
  9699. </param>
  9700. </params>
  9701. </method>
  9702. <method name="setSoundDirection" return_type="nil">
  9703. <params>
  9704. <param name="direction" type="Vector3">
  9705. </param>
  9706. </params>
  9707. </method>
  9708. <method name="setOffset" return_type="nil">
  9709. <desc><![CDATA[ Sets the current sample offset of this sound. ]]></desc>
  9710. <params>
  9711. <param name="offset" type="Integer">
  9712. <desc><![CDATA[A number 0 <= off < sound sample length]]></desc>
  9713. </param>
  9714. </params>
  9715. </method>
  9716. <method name="getFileName" return_type="String">
  9717. </method>
  9718. <method name="getPlaybackDuration" return_type="Number">
  9719. </method>
  9720. <method name="getPlaybackTime" return_type="Number">
  9721. </method>
  9722. <method name="seekTo" return_type="nil">
  9723. <params>
  9724. <param name="time" type="Number">
  9725. </param>
  9726. </params>
  9727. </method>
  9728. <method name="getOffset" return_type="Integer">
  9729. <desc><![CDATA[ Returns the current sample offset (playback progress) of this sound. ]]></desc>
  9730. </method>
  9731. <method name="getSampleLength" return_type="Integer">
  9732. <desc><![CDATA[ Returns the number of samples in the sound. ]]></desc>
  9733. </method>
  9734. <method name="getFrequency" return_type="Integer">
  9735. </method>
  9736. <method name="setPositionalProperties" return_type="nil">
  9737. <params>
  9738. <param name="referenceDistance" type="Number">
  9739. </param>
  9740. <param name="maxDistance" type="Number">
  9741. </param>
  9742. </params>
  9743. </method>
  9744. <method name="setReferenceDistance" return_type="nil">
  9745. <params>
  9746. <param name="referenceDistance" type="Number">
  9747. </param>
  9748. </params>
  9749. </method>
  9750. <method name="setMaxDistance" return_type="nil">
  9751. <params>
  9752. <param name="maxDistance" type="Number">
  9753. </param>
  9754. </params>
  9755. </method>
  9756. <method name="getReferenceDistance" return_type="Number">
  9757. </method>
  9758. <method name="getMaxDistance" return_type="Number">
  9759. </method>
  9760. <method name="loadBytes" return_type="Boolean">
  9761. <params>
  9762. <param name="data" type="char">
  9763. </param>
  9764. <param name="size" type="Integer">
  9765. </param>
  9766. <param name="channels" type="Integer">
  9767. </param>
  9768. <param name="freq" type="Integer">
  9769. </param>
  9770. <param name="format" type="SoundFormat">
  9771. </param>
  9772. </params>
  9773. </method>
  9774. <method name="loadWAV" return_type="Boolean">
  9775. <params>
  9776. <param name="fileName" type="String">
  9777. </param>
  9778. </params>
  9779. </method>
  9780. <method name="loadOGG" return_type="Boolean">
  9781. <params>
  9782. <param name="fileName" type="String">
  9783. </param>
  9784. </params>
  9785. </method>
  9786. <method name="soundCheck" return_type="nil">
  9787. <params>
  9788. <param name="result" type="Boolean">
  9789. </param>
  9790. <param name="err" type="String">
  9791. </param>
  9792. </params>
  9793. </method>
  9794. <method name="updateStream" return_type="nil">
  9795. <params>
  9796. <param name="streamCount" type="Integer">
  9797. </param>
  9798. </params>
  9799. </method>
  9800. </methods>
  9801. </class>
  9802. <class name="AudioStreamingSource">
  9803. <static_members>
  9804. </static_members>
  9805. <members>
  9806. </members>
  9807. <methods>
  9808. <method name="AudioStreamingSource" return_type="nil">
  9809. <params>
  9810. <param name="channels" type="Integer">
  9811. </param>
  9812. <param name="freq" type="Integer">
  9813. </param>
  9814. </params>
  9815. </method>
  9816. <method name="getNumChannels" return_type="Integer">
  9817. </method>
  9818. <method name="getFrequency" return_type="Integer">
  9819. </method>
  9820. </methods>
  9821. </class>
  9822. <class name="AudioMixer">
  9823. <static_members>
  9824. </static_members>
  9825. <members>
  9826. <member name="globalVolume" type="Number">
  9827. </member>
  9828. <member name="mixerMutex" type="CoreMutex">
  9829. </member>
  9830. </members>
  9831. <methods>
  9832. <method name="AudioMixer" return_type="nil">
  9833. </method>
  9834. <method name="mixIntoBuffer" return_type="nil">
  9835. <params>
  9836. <param name="buffer" type="Integer16_t">
  9837. </param>
  9838. <param name="numSamples" type="Integer">
  9839. </param>
  9840. </params>
  9841. </method>
  9842. </methods>
  9843. </class>
  9844. <class name="SoundManager">
  9845. <desc><![CDATA[ Controls global sound settings.]]></desc>
  9846. <static_members>
  9847. </static_members>
  9848. <members>
  9849. </members>
  9850. <methods>
  9851. <method name="SoundManager" return_type="nil">
  9852. </method>
  9853. <method name="setListenerPosition" return_type="nil">
  9854. <params>
  9855. <param name="position" type="Vector3">
  9856. </param>
  9857. </params>
  9858. </method>
  9859. <method name="setListenerOrientation" return_type="nil">
  9860. <params>
  9861. <param name="orientation" type="Vector3">
  9862. </param>
  9863. <param name="upVector" type="Vector3">
  9864. </param>
  9865. </params>
  9866. </method>
  9867. <method name="recordSound" return_type="Boolean">
  9868. <params>
  9869. <param name="rate" type="Integer">
  9870. </param>
  9871. <param name="sampleSize" type="Integer">
  9872. </param>
  9873. </params>
  9874. </method>
  9875. <method name="stopRecording" return_type="Sound">
  9876. <params>
  9877. <param name="generateFloatBuffer" type="Boolean">
  9878. </param>
  9879. </params>
  9880. </method>
  9881. <method name="setAudioInterface" return_type="nil">
  9882. <params>
  9883. <param name="audioInterface" type="AudioInterface">
  9884. </param>
  9885. </params>
  9886. </method>
  9887. <method name="Update" return_type="nil">
  9888. </method>
  9889. <method name="setGlobalVolume" return_type="nil">
  9890. <desc><![CDATA[ Sets the global sound volume.]]></desc>
  9891. <params>
  9892. <param name="globalVolume" type="Number">
  9893. </param>
  9894. </params>
  9895. </method>
  9896. <method name="registerSound" return_type="nil">
  9897. <params>
  9898. <param name="sound" type="Sound">
  9899. </param>
  9900. </params>
  9901. </method>
  9902. <method name="unregisterSound" return_type="nil">
  9903. <params>
  9904. <param name="sound" type="Sound">
  9905. </param>
  9906. </params>
  9907. </method>
  9908. </methods>
  9909. </class>
  9910. <class name="String">
  9911. <desc><![CDATA[ Unicode-friendly string. The Polycode String class wraps around STL wstring to support Unicode text in the engine. You can request data from it in different encodings (currently only UTF-8) or plain char data. It is mostly just a wrapper around STL created for easier Unicode support, LUA bindings and convenience methods.]]></desc>
  9912. <static_members>
  9913. <static_member name="ENCODING_UTF8" type="Integer" value="0">
  9914. <desc><![CDATA[ UTF-8 encoding.]]></desc>
  9915. </static_member>
  9916. </static_members>
  9917. <members>
  9918. <member name="contents" type="string">
  9919. <desc><![CDATA[ STL string version of the string.]]></desc>
  9920. </member>
  9921. <member name="w_contents" type="wstring">
  9922. <desc><![CDATA[ STL string version of the string.]]></desc>
  9923. </member>
  9924. </members>
  9925. <methods>
  9926. <method name="String" return_type="nil">
  9927. <desc><![CDATA[ Default constructor]]></desc>
  9928. </method>
  9929. <method name="size" return_type="size_t">
  9930. <desc><![CDATA[ Return the length of the string.]]></desc>
  9931. </method>
  9932. <method name="length" return_type="size_t">
  9933. <desc><![CDATA[ Return the length of the string.]]></desc>
  9934. </method>
  9935. <method name="substr" return_type="String">
  9936. <desc><![CDATA[ Returns the substring of the string. ]]></desc>
  9937. <params>
  9938. <param name="pos" type="size_t">
  9939. <desc><![CDATA[Position of a character in the current string object to be used as starting character for the substring.]]></desc>
  9940. </param>
  9941. <param name="n" type="size_t">
  9942. <desc><![CDATA[Length of the substring.]]></desc>
  9943. </param>
  9944. </params>
  9945. </method>
  9946. <method name="rfind" return_type="size_t">
  9947. <desc><![CDATA[ Find last occurrence of content in string. ]]></desc>
  9948. <params>
  9949. <param name="str" type="String">
  9950. <desc><![CDATA[String to be searched for in the object.]]></desc>
  9951. </param>
  9952. <param name="pos" type="size_t">
  9953. <desc><![CDATA[Position of the last character in the string to be taken into consideration for possible matches. The default value indicates that the entire string is searched.]]></desc>
  9954. </param>
  9955. </params>
  9956. </method>
  9957. <method name="find" return_type="size_t">
  9958. <desc><![CDATA[ Find content in string. ]]></desc>
  9959. <params>
  9960. <param name="str" type="String">
  9961. <desc><![CDATA[String to be searched for in the object.]]></desc>
  9962. </param>
  9963. <param name="pos" type="size_t">
  9964. <desc><![CDATA[Position of the first character in the string to be taken into consideration for possible matches. The default value indicates that the entire string is searched.]]></desc>
  9965. </param>
  9966. </params>
  9967. </method>
  9968. <method name="find_last_of" return_type="size_t">
  9969. <desc><![CDATA[ Find character in string from the end. Searches the string from the end for any of the characters that are part of the passed string. ]]></desc>
  9970. <params>
  9971. <param name="str" type="String">
  9972. <desc><![CDATA[String containing the characters to search for.]]></desc>
  9973. </param>
  9974. <param name="pos" type="size_t">
  9975. <desc><![CDATA[Position of the last character in the string to be taken into consideration for possible matches. The default value indicates that the entire string is searched.]]></desc>
  9976. </param>
  9977. </params>
  9978. </method>
  9979. <method name="find_first_of" return_type="size_t">
  9980. <desc><![CDATA[ Find character in string from the beginning. Searches the string from the beginnign for any of the characters that are part of the passed string. ]]></desc>
  9981. <params>
  9982. <param name="str" type="String">
  9983. <desc><![CDATA[String containing the characters to search for.]]></desc>
  9984. </param>
  9985. <param name="pos" type="size_t">
  9986. <desc><![CDATA[Position of the first character in the string to be taken into consideration for possible matches. The default value indicates that the entire string is searched.]]></desc>
  9987. </param>
  9988. </params>
  9989. </method>
  9990. <method name="toLowerCase" return_type="String">
  9991. <desc><![CDATA[ Returns the lowercase version of the string. ]]></desc>
  9992. </method>
  9993. <method name="toUpperCase" return_type="String">
  9994. <desc><![CDATA[ Returns the uppercase version of the string. ]]></desc>
  9995. </method>
  9996. <method name="split" return_array="true" return_type="String">
  9997. <desc><![CDATA[ Splits the string by the specified delimeter ]]></desc>
  9998. <params>
  9999. <param name="delim" type="String">
  10000. <desc><![CDATA[The delimeter to split by.]]></desc>
  10001. </param>
  10002. </params>
  10003. </method>
  10004. <method name="replace" return_type="String">
  10005. <desc><![CDATA[ Replaces parts of the string with another string. ]]></desc>
  10006. <params>
  10007. <param name="what" type="String">
  10008. <desc><![CDATA[Ocurrences of which string to replace in this string.]]></desc>
  10009. </param>
  10010. <param name="withWhat" type="String">
  10011. <desc><![CDATA[What to replace them with.]]></desc>
  10012. </param>
  10013. </params>
  10014. </method>
  10015. <method name="NumberToString" return_type="String" static="true">
  10016. <desc><![CDATA[ Convert a Number to a String. ]]></desc>
  10017. <params>
  10018. <param name="value" type="Number">
  10019. <desc><![CDATA[Number to convert.]]></desc>
  10020. </param>
  10021. <param name="precision" type="Integer">
  10022. </param>
  10023. </params>
  10024. </method>
  10025. <method name="toNumber" return_type="Number">
  10026. </method>
  10027. <method name="toInteger" return_type="Integer">
  10028. </method>
  10029. <method name="IntToString" return_type="String" static="true">
  10030. <desc><![CDATA[ Convert an integer to a String. ]]></desc>
  10031. <params>
  10032. <param name="value" type="Integer">
  10033. <desc><![CDATA[Integer to convert.]]></desc>
  10034. </param>
  10035. </params>
  10036. </method>
  10037. <method name="c_str" return_type="char">
  10038. <desc><![CDATA[ Pointer to char data. ]]></desc>
  10039. </method>
  10040. <method name="getDataWithEncoding" return_type="char">
  10041. <desc><![CDATA[ Returns data with the specified encoding. Currently the only supported encoding is String.ENCODING_UTF8 ]]></desc>
  10042. <params>
  10043. <param name="encoding" type="Integer">
  10044. <desc><![CDATA[The encoding to use.]]></desc>
  10045. </param>
  10046. </params>
  10047. </method>
  10048. <method name="getWDataWithEncoding" return_type="wchar_t">
  10049. <desc><![CDATA[ Returns wide character data with the specified encoding. Currently the only supported encoding is String.ENCODING_UTF8 ]]></desc>
  10050. <params>
  10051. <param name="encoding" type="Integer">
  10052. <desc><![CDATA[The encoding to use.]]></desc>
  10053. </param>
  10054. </params>
  10055. </method>
  10056. <method name="append" return_type="nil">
  10057. <desc><![CDATA[ Returns the size of the data with the specified encoding. Currently the only supported encoding is String.ENCODING_UTF8 ]]></desc>
  10058. <params>
  10059. <param name="c" type="char">
  10060. <desc><![CDATA[The encoding to use.]]></desc>
  10061. </param>
  10062. </params>
  10063. </method>
  10064. <method name="getDataSizeWithEncoding" return_type="size_t">
  10065. <params>
  10066. <param name="encoding" type="Integer">
  10067. </param>
  10068. </params>
  10069. </method>
  10070. <method name="setDataWithEncoding" return_type="nil">
  10071. <desc><![CDATA[ Sets the data for the string ]]></desc>
  10072. <params>
  10073. <param name="data" type="char">
  10074. <desc><![CDATA[Data to set the string with.]]></desc>
  10075. </param>
  10076. <param name="encoding" type="Integer">
  10077. <desc><![CDATA[The encoding to use.]]></desc>
  10078. </param>
  10079. </params>
  10080. </method>
  10081. <method name="isNumber" return_type="Boolean">
  10082. <desc><![CDATA[ Checks if the string is a number ]]></desc>
  10083. </method>
  10084. </methods>
  10085. </class>
  10086. <class name="RenderBuffer">
  10087. <static_members>
  10088. </static_members>
  10089. <members>
  10090. <member name="colorTexture" type="Texture">
  10091. </member>
  10092. <member name="depthTexture" type="Texture">
  10093. </member>
  10094. <member name="platformData" type="nil">
  10095. </member>
  10096. <member name="depthBufferPlatformData" type="nil">
  10097. </member>
  10098. </members>
  10099. <methods>
  10100. <method name="RenderBuffer" return_type="nil">
  10101. <params>
  10102. <param name="width" type="Integer">
  10103. </param>
  10104. <param name="height" type="Integer">
  10105. </param>
  10106. <param name="attachDepthBuffer" type="Boolean">
  10107. </param>
  10108. <param name="floatingPoint" type="Boolean">
  10109. </param>
  10110. </params>
  10111. </method>
  10112. <method name="getWidth" return_type="Integer">
  10113. </method>
  10114. <method name="getHeight" return_type="Integer">
  10115. </method>
  10116. </methods>
  10117. </class>
  10118. <class name="Texture" extends="Resource">
  10119. <class_notes>NOTE: Texture instances are not automatically garbage collected.</class_notes>
  10120. <static_members>
  10121. <static_member name="FILTERING_NEAREST" type="Integer" value="0">
  10122. </static_member>
  10123. <static_member name="FILTERING_LINEAR" type="Integer" value="1">
  10124. </static_member>
  10125. </static_members>
  10126. <members>
  10127. <member name="clamp" type="Boolean">
  10128. </member>
  10129. <member name="textureData" type="char">
  10130. </member>
  10131. <member name="type" type="Integer">
  10132. </member>
  10133. <member name="filteringMode" type="Integer">
  10134. </member>
  10135. <member name="createMipmaps" type="Boolean">
  10136. </member>
  10137. <member name="anisotropy" type="Integer">
  10138. </member>
  10139. <member name="framebufferTexture" type="Boolean">
  10140. </member>
  10141. <member name="depthTexture" type="Boolean">
  10142. </member>
  10143. </members>
  10144. <methods>
  10145. <method name="reloadResource" return_type="nil">
  10146. </method>
  10147. <method name="setImageData" return_type="nil">
  10148. <params>
  10149. <param name="data" type="Image">
  10150. </param>
  10151. </params>
  10152. </method>
  10153. <method name="getTextureData" return_type="char">
  10154. </method>
  10155. <method name="getWidth" return_type="Integer">
  10156. </method>
  10157. <method name="getHeight" return_type="Integer">
  10158. </method>
  10159. <method name="setCreateMipmaps" return_type="nil">
  10160. <params>
  10161. <param name="createMipmapsIn" type="Boolean">
  10162. </param>
  10163. </params>
  10164. </method>
  10165. <method name="getCreateMipmaps" return_type="Boolean">
  10166. </method>
  10167. </methods>
  10168. </class>
  10169. <class name="Timer" extends="EventDispatcher">
  10170. <desc><![CDATA[ A timer that dispatches trigger events.]]></desc>
  10171. <static_members>
  10172. <static_member name="EVENT_TRIGGER" type="Integer" value="0">
  10173. </static_member>
  10174. </static_members>
  10175. <members>
  10176. </members>
  10177. <methods>
  10178. <method name="Timer" return_type="nil">
  10179. <desc><![CDATA[ Creates a new timer. ]]></desc>
  10180. <params>
  10181. <param name="triggerMode" type="Boolean">
  10182. <desc><![CDATA[If true, will dispatch an event at the specified frequency, otherwise it will simply count time. You normally want this to be true.]]></desc>
  10183. </param>
  10184. <param name="msecs" type="Integer">
  10185. <desc><![CDATA[Timer frequency in milliseconds.]]></desc>
  10186. </param>
  10187. </params>
  10188. </method>
  10189. <method name="Pause" return_type="nil">
  10190. <desc><![CDATA[ Pauses and resumes the timer. ]]></desc>
  10191. <params>
  10192. <param name="paused" type="Boolean">
  10193. <desc><![CDATA[If true, pauses the timer, otherwise resumes it.]]></desc>
  10194. </param>
  10195. </params>
  10196. </method>
  10197. <method name="isPaused" return_type="Boolean">
  10198. <desc><![CDATA[ Returns true if the timer is paused.]]></desc>
  10199. </method>
  10200. <method name="getTicks" return_type="Integer">
  10201. </method>
  10202. <method name="Update" return_type="nil">
  10203. <params>
  10204. <param name="ticks" type="Integer">
  10205. </param>
  10206. </params>
  10207. </method>
  10208. <method name="Reset" return_type="nil">
  10209. <desc><![CDATA[ Resets the timer.]]></desc>
  10210. </method>
  10211. <method name="hasElapsed" return_type="Boolean">
  10212. </method>
  10213. <method name="getElapsedf" return_type="Number">
  10214. <desc><![CDATA[ Returns the time elapsed in floating point microseconds.]]></desc>
  10215. </method>
  10216. <method name="setTimerInterval" return_type="nil">
  10217. <params>
  10218. <param name="msecs" type="Integer">
  10219. </param>
  10220. </params>
  10221. </method>
  10222. </methods>
  10223. </class>
  10224. <class name="TimerManager">
  10225. <static_members>
  10226. </static_members>
  10227. <members>
  10228. </members>
  10229. <methods>
  10230. <method name="TimerManager" return_type="nil">
  10231. </method>
  10232. <method name="removeTimer" return_type="nil">
  10233. <params>
  10234. <param name="timer" type="Timer">
  10235. </param>
  10236. </params>
  10237. </method>
  10238. <method name="addTimer" return_type="nil">
  10239. <params>
  10240. <param name="timer" type="Timer">
  10241. </param>
  10242. </params>
  10243. </method>
  10244. <method name="Update" return_type="nil">
  10245. </method>
  10246. </methods>
  10247. </class>
  10248. <class name="Vector2">
  10249. <desc><![CDATA[ 2D Vector (convenience wrapper around Vector3). ]]></desc>
  10250. <static_members>
  10251. </static_members>
  10252. <members>
  10253. <member name="x" type="Number">
  10254. <desc><![CDATA[ X coordinate.]]></desc>
  10255. </member>
  10256. <member name="y" type="Number">
  10257. <desc><![CDATA[ Y coordinate.]]></desc>
  10258. </member>
  10259. </members>
  10260. <methods>
  10261. <method name="Vector2" return_type="nil">
  10262. <desc><![CDATA[ Create from x,y,z coordinates. ]]></desc>
  10263. <params>
  10264. <param name="x" type="Number">
  10265. <desc><![CDATA[X coordinate.]]></desc>
  10266. </param>
  10267. <param name="y" type="Number">
  10268. <desc><![CDATA[Y coordinate.]]></desc>
  10269. </param>
  10270. </params>
  10271. </method>
  10272. <method name="set" return_type="nil">
  10273. <desc><![CDATA[ Sets the vector from x,y,z coordinates. ]]></desc>
  10274. <params>
  10275. <param name="x" type="Number">
  10276. <desc><![CDATA[X coordinate.]]></desc>
  10277. </param>
  10278. <param name="y" type="Number">
  10279. <desc><![CDATA[Y coordinate.]]></desc>
  10280. </param>
  10281. </params>
  10282. </method>
  10283. <method name="distance" return_type="Number">
  10284. <desc><![CDATA[ Returns the distance from this vector to another one. ]]></desc>
  10285. <params>
  10286. <param name="vec2" type="Vector2">
  10287. <desc><![CDATA[Second vector.]]></desc>
  10288. </param>
  10289. </params>
  10290. </method>
  10291. <method name="length" return_type="Number">
  10292. <desc><![CDATA[ Returns the vector length. ]]></desc>
  10293. </method>
  10294. <method name="dot" return_type="Number">
  10295. <desc><![CDATA[ Returns the dot product with another vector. ]]></desc>
  10296. <params>
  10297. <param name="u" type="Vector2">
  10298. </param>
  10299. </params>
  10300. </method>
  10301. <method name="crossProduct" return_type="Number">
  10302. <desc><![CDATA[ Returns the cross product with another vector. ]]></desc>
  10303. <params>
  10304. <param name="vec2" type="Vector2">
  10305. <desc><![CDATA[Second vector.]]></desc>
  10306. </param>
  10307. </params>
  10308. </method>
  10309. <method name="angle" return_type="Number">
  10310. <params>
  10311. <param name="vec2" type="Vector2">
  10312. </param>
  10313. </params>
  10314. </method>
  10315. <method name="Normalize" return_type="nil">
  10316. <desc><![CDATA[ Normalizes the vector.]]></desc>
  10317. </method>
  10318. </methods>
  10319. </class>
  10320. <class name="Vector3">
  10321. <desc><![CDATA[ 3D Vector class. ]]></desc>
  10322. <static_members>
  10323. </static_members>
  10324. <members>
  10325. <member name="x" type="Number">
  10326. <desc><![CDATA[ X coordinate.]]></desc>
  10327. </member>
  10328. <member name="y" type="Number">
  10329. <desc><![CDATA[ Y coordinate.]]></desc>
  10330. </member>
  10331. <member name="z" type="Number">
  10332. <desc><![CDATA[ Z coordinate.]]></desc>
  10333. </member>
  10334. </members>
  10335. <methods>
  10336. <method name="Vector3" return_type="nil">
  10337. <desc><![CDATA[ Create from x,y,z coordinates. ]]></desc>
  10338. <params>
  10339. <param name="x" type="Number">
  10340. <desc><![CDATA[X coordinate.]]></desc>
  10341. </param>
  10342. <param name="y" type="Number">
  10343. <desc><![CDATA[Y coordinate.]]></desc>
  10344. </param>
  10345. <param name="z" type="Number">
  10346. <desc><![CDATA[Z coordinate.]]></desc>
  10347. </param>
  10348. </params>
  10349. </method>
  10350. <method name="set" return_type="nil">
  10351. <desc><![CDATA[ Sets the vector from x,y,z coordinates. ]]></desc>
  10352. <params>
  10353. <param name="x" type="Number">
  10354. <desc><![CDATA[X coordinate.]]></desc>
  10355. </param>
  10356. <param name="y" type="Number">
  10357. <desc><![CDATA[Y coordinate.]]></desc>
  10358. </param>
  10359. <param name="z" type="Number">
  10360. <desc><![CDATA[Z coordinate.]]></desc>
  10361. </param>
  10362. </params>
  10363. </method>
  10364. <method name="distance" return_type="Number">
  10365. <desc><![CDATA[ Returns the distance from this vector to another one. ]]></desc>
  10366. <params>
  10367. <param name="vec2" type="Vector3">
  10368. <desc><![CDATA[Second vector.]]></desc>
  10369. </param>
  10370. </params>
  10371. </method>
  10372. <method name="angleBetween" return_type="Number">
  10373. <desc><![CDATA[ Returns the angle between this and the specified vectors. ]]></desc>
  10374. <params>
  10375. <param name="dest" type="Vector3">
  10376. </param>
  10377. </params>
  10378. </method>
  10379. <method name="length" return_type="Number">
  10380. <desc><![CDATA[ Returns the vector length. ]]></desc>
  10381. </method>
  10382. <method name="lengthSquared" return_type="Number">
  10383. <desc><![CDATA[ Returns square of the length of the vector. Cheaper to execute than length(), for use when you're just e.g. comparing vector lengths. ]]></desc>
  10384. </method>
  10385. <method name="setLength" return_type="Vector3">
  10386. <params>
  10387. <param name="newLength" type="Number">
  10388. </param>
  10389. </params>
  10390. </method>
  10391. <method name="dot" return_type="Number">
  10392. <desc><![CDATA[ Returns the dot product with another vector. ]]></desc>
  10393. <params>
  10394. <param name="u" type="Vector3">
  10395. </param>
  10396. </params>
  10397. </method>
  10398. <method name="crossProduct" return_type="Vector3">
  10399. <desc><![CDATA[ Returns the cross product with another vector. ]]></desc>
  10400. <params>
  10401. <param name="vec2" type="Vector3">
  10402. <desc><![CDATA[Second vector.]]></desc>
  10403. </param>
  10404. </params>
  10405. </method>
  10406. <method name="Normalize" return_type="nil">
  10407. <desc><![CDATA[ Normalizes the vector.]]></desc>
  10408. </method>
  10409. </methods>
  10410. </class>
  10411. <class name="Vector4">
  10412. <desc><![CDATA[ 4D Vector class.]]></desc>
  10413. <static_members>
  10414. </static_members>
  10415. <members>
  10416. <member name="x" type="Number">
  10417. <desc><![CDATA[ X coordinate.]]></desc>
  10418. </member>
  10419. <member name="y" type="Number">
  10420. <desc><![CDATA[ Y coordinate.]]></desc>
  10421. </member>
  10422. <member name="z" type="Number">
  10423. <desc><![CDATA[ Z coordinate.]]></desc>
  10424. </member>
  10425. <member name="w" type="Number">
  10426. <desc><![CDATA[ W coordinate.]]></desc>
  10427. </member>
  10428. </members>
  10429. <methods>
  10430. <method name="Vector4" return_type="nil">
  10431. <desc><![CDATA[ Create from x,y,z coordinates. ]]></desc>
  10432. <params>
  10433. <param name="x" type="Number">
  10434. <desc><![CDATA[X coordinate.]]></desc>
  10435. </param>
  10436. <param name="y" type="Number">
  10437. <desc><![CDATA[Y coordinate.]]></desc>
  10438. </param>
  10439. <param name="z" type="Number">
  10440. <desc><![CDATA[Z coordinate.]]></desc>
  10441. </param>
  10442. <param name="w" type="Number">
  10443. <desc><![CDATA[W coordinate.]]></desc>
  10444. </param>
  10445. </params>
  10446. </method>
  10447. <method name="set" return_type="nil">
  10448. <desc><![CDATA[ Sets the vector from x,y,z coordinates. ]]></desc>
  10449. <params>
  10450. <param name="x" type="Number">
  10451. <desc><![CDATA[X coordinate.]]></desc>
  10452. </param>
  10453. <param name="y" type="Number">
  10454. <desc><![CDATA[Y coordinate.]]></desc>
  10455. </param>
  10456. <param name="z" type="Number">
  10457. <desc><![CDATA[Z coordinate.]]></desc>
  10458. </param>
  10459. <param name="w" type="Number">
  10460. <desc><![CDATA[W coordinate]]></desc>
  10461. </param>
  10462. </params>
  10463. </method>
  10464. <method name="dot" return_type="Number">
  10465. <desc><![CDATA[ Returns the dot product with another vector. ]]></desc>
  10466. <params>
  10467. <param name="u" type="Vector4">
  10468. </param>
  10469. </params>
  10470. </method>
  10471. </methods>
  10472. </class>
  10473. </classes>
  10474. </docs>