LuaScriptAPI.dox 250 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822
  1. namespace Urho3D
  2. {
  3. /**
  4. \page LuaScriptAPI Lua scripting API
  5. \section LuaScriptAPI_TableOfContents Table of contents
  6. \ref LuaScriptAPI_ClassList "Class list"<br>
  7. \ref LuaScriptAPI_Classes "Classes"<br>
  8. \ref LuaScriptAPI_Enums "Enumerations"<br>
  9. \ref LuaScriptAPI_toluaFunctions "tolua functions"<br>
  10. \ref LuaScriptAPI_GlobalFunctions "Global functions"<br>
  11. \ref LuaScriptAPI_GlobalProperties "Global properties"<br>
  12. \ref LuaScriptAPI_GlobalConstants "Global constants"<br>
  13. \section LuaScriptAPI_ClassList Class list
  14. <a href="#Class_Animatable"><b>Animatable</b></a>
  15. <a href="#Class_AnimatedModel"><b>AnimatedModel</b></a>
  16. <a href="#Class_AnimatedSprite2D"><b>AnimatedSprite2D</b></a>
  17. <a href="#Class_Animation"><b>Animation</b></a>
  18. <a href="#Class_AnimationControl"><b>AnimationControl</b></a>
  19. <a href="#Class_AnimationController"><b>AnimationController</b></a>
  20. <a href="#Class_AnimationKeyFrame"><b>AnimationKeyFrame</b></a>
  21. <a href="#Class_AnimationSet2D"><b>AnimationSet2D</b></a>
  22. <a href="#Class_AnimationState"><b>AnimationState</b></a>
  23. <a href="#Class_AnimationTrack"><b>AnimationTrack</b></a>
  24. <a href="#Class_AnimationTriggerPoint"><b>AnimationTriggerPoint</b></a>
  25. <a href="#Class_Audio"><b>Audio</b></a>
  26. <a href="#Class_BiasParameters"><b>BiasParameters</b></a>
  27. <a href="#Class_Billboard"><b>Billboard</b></a>
  28. <a href="#Class_BillboardSet"><b>BillboardSet</b></a>
  29. <a href="#Class_Bone"><b>Bone</b></a>
  30. <a href="#Class_BorderImage"><b>BorderImage</b></a>
  31. <a href="#Class_BoundingBox"><b>BoundingBox</b></a>
  32. <a href="#Class_Button"><b>Button</b></a>
  33. <a href="#Class_Camera"><b>Camera</b></a>
  34. <a href="#Class_CascadeParameters"><b>CascadeParameters</b></a>
  35. <a href="#Class_CheckBox"><b>CheckBox</b></a>
  36. <a href="#Class_CollisionBox2D"><b>CollisionBox2D</b></a>
  37. <a href="#Class_CollisionChain2D"><b>CollisionChain2D</b></a>
  38. <a href="#Class_CollisionCircle2D"><b>CollisionCircle2D</b></a>
  39. <a href="#Class_CollisionEdge2D"><b>CollisionEdge2D</b></a>
  40. <a href="#Class_CollisionPolygon2D"><b>CollisionPolygon2D</b></a>
  41. <a href="#Class_CollisionShape"><b>CollisionShape</b></a>
  42. <a href="#Class_CollisionShape2D"><b>CollisionShape2D</b></a>
  43. <a href="#Class_Color"><b>Color</b></a>
  44. <a href="#Class_ColorFrame"><b>ColorFrame</b></a>
  45. <a href="#Class_Component"><b>Component</b></a>
  46. <a href="#Class_Connection"><b>Connection</b></a>
  47. <a href="#Class_Console"><b>Console</b></a>
  48. <a href="#Class_Constraint"><b>Constraint</b></a>
  49. <a href="#Class_Constraint2D"><b>Constraint2D</b></a>
  50. <a href="#Class_ConstraintDistance2D"><b>ConstraintDistance2D</b></a>
  51. <a href="#Class_ConstraintFriction2D"><b>ConstraintFriction2D</b></a>
  52. <a href="#Class_ConstraintGear2D"><b>ConstraintGear2D</b></a>
  53. <a href="#Class_ConstraintMotor2D"><b>ConstraintMotor2D</b></a>
  54. <a href="#Class_ConstraintMouse2D"><b>ConstraintMouse2D</b></a>
  55. <a href="#Class_ConstraintPrismatic2D"><b>ConstraintPrismatic2D</b></a>
  56. <a href="#Class_ConstraintPulley2D"><b>ConstraintPulley2D</b></a>
  57. <a href="#Class_ConstraintRevolute2D"><b>ConstraintRevolute2D</b></a>
  58. <a href="#Class_ConstraintRope2D"><b>ConstraintRope2D</b></a>
  59. <a href="#Class_ConstraintWeld2D"><b>ConstraintWeld2D</b></a>
  60. <a href="#Class_ConstraintWheel2D"><b>ConstraintWheel2D</b></a>
  61. <a href="#Class_Context"><b>Context</b></a>
  62. <a href="#Class_Controls"><b>Controls</b></a>
  63. <a href="#Class_CrowdAgent"><b>CrowdAgent</b></a>
  64. <a href="#Class_CrowdManager"><b>CrowdManager</b></a>
  65. <a href="#Class_Cursor"><b>Cursor</b></a>
  66. <a href="#Class_CustomGeometry"><b>CustomGeometry</b></a>
  67. <a href="#Class_CustomGeometryVertex"><b>CustomGeometryVertex</b></a>
  68. <a href="#Class_Database"><b>Database</b></a>
  69. <a href="#Class_DbConnection"><b>DbConnection</b></a>
  70. <a href="#Class_DbResult"><b>DbResult</b></a>
  71. <a href="#Class_DebugHud"><b>DebugHud</b></a>
  72. <a href="#Class_DebugRenderer"><b>DebugRenderer</b></a>
  73. <a href="#Class_DecalSet"><b>DecalSet</b></a>
  74. <a href="#Class_Deserializer"><b>Deserializer</b></a>
  75. <a href="#Class_Drawable"><b>Drawable</b></a>
  76. <a href="#Class_Drawable2D"><b>Drawable2D</b></a>
  77. <a href="#Class_DropDownList"><b>DropDownList</b></a>
  78. <a href="#Class_DynamicNavigationMesh"><b>DynamicNavigationMesh</b></a>
  79. <a href="#Class_Engine"><b>Engine</b></a>
  80. <a href="#Class_File"><b>File</b></a>
  81. <a href="#Class_FileSelector"><b>FileSelector</b></a>
  82. <a href="#Class_FileSelectorEntry"><b>FileSelectorEntry</b></a>
  83. <a href="#Class_FileSystem"><b>FileSystem</b></a>
  84. <a href="#Class_FocusParameters"><b>FocusParameters</b></a>
  85. <a href="#Class_Font"><b>Font</b></a>
  86. <a href="#Class_Frustum"><b>Frustum</b></a>
  87. <a href="#Class_Geometry"><b>Geometry</b></a>
  88. <a href="#Class_Graphics"><b>Graphics</b></a>
  89. <a href="#Class_HierarchyContainer"><b>HierarchyContainer</b></a>
  90. <a href="#Class_HttpRequest"><b>HttpRequest</b></a>
  91. <a href="#Class_Image"><b>Image</b></a>
  92. <a href="#Class_IndexBuffer"><b>IndexBuffer</b></a>
  93. <a href="#Class_Input"><b>Input</b></a>
  94. <a href="#Class_IntRect"><b>IntRect</b></a>
  95. <a href="#Class_IntVector2"><b>IntVector2</b></a>
  96. <a href="#Class_JSONFile"><b>JSONFile</b></a>
  97. <a href="#Class_JSONValue"><b>JSONValue</b></a>
  98. <a href="#Class_JoystickState"><b>JoystickState</b></a>
  99. <a href="#Class_Light"><b>Light</b></a>
  100. <a href="#Class_LineEdit"><b>LineEdit</b></a>
  101. <a href="#Class_ListView"><b>ListView</b></a>
  102. <a href="#Class_Localization"><b>Localization</b></a>
  103. <a href="#Class_Log"><b>Log</b></a>
  104. <a href="#Class_LuaScriptInstance"><b>LuaScriptInstance</b></a>
  105. <a href="#Class_Material"><b>Material</b></a>
  106. <a href="#Class_Matrix3"><b>Matrix3</b></a>
  107. <a href="#Class_Matrix3x4"><b>Matrix3x4</b></a>
  108. <a href="#Class_Matrix4"><b>Matrix4</b></a>
  109. <a href="#Class_Menu"><b>Menu</b></a>
  110. <a href="#Class_MessageBox"><b>MessageBox</b></a>
  111. <a href="#Class_Model"><b>Model</b></a>
  112. <a href="#Class_NamedPipe"><b>NamedPipe</b></a>
  113. <a href="#Class_NavArea"><b>NavArea</b></a>
  114. <a href="#Class_Navigable"><b>Navigable</b></a>
  115. <a href="#Class_NavigationGeometryInfo"><b>NavigationGeometryInfo</b></a>
  116. <a href="#Class_NavigationMesh"><b>NavigationMesh</b></a>
  117. <a href="#Class_Network"><b>Network</b></a>
  118. <a href="#Class_NetworkPriority"><b>NetworkPriority</b></a>
  119. <a href="#Class_Node"><b>Node</b></a>
  120. <a href="#Class_Object"><b>Object</b></a>
  121. <a href="#Class_ObjectAnimation"><b>ObjectAnimation</b></a>
  122. <a href="#Class_Obstacle"><b>Obstacle</b></a>
  123. <a href="#Class_Octree"><b>Octree</b></a>
  124. <a href="#Class_OctreeQueryResult"><b>OctreeQueryResult</b></a>
  125. <a href="#Class_OffMeshConnection"><b>OffMeshConnection</b></a>
  126. <a href="#Class_PackageEntry"><b>PackageEntry</b></a>
  127. <a href="#Class_PackageFile"><b>PackageFile</b></a>
  128. <a href="#Class_ParticleEffect"><b>ParticleEffect</b></a>
  129. <a href="#Class_ParticleEffect2D"><b>ParticleEffect2D</b></a>
  130. <a href="#Class_ParticleEmitter"><b>ParticleEmitter</b></a>
  131. <a href="#Class_ParticleEmitter2D"><b>ParticleEmitter2D</b></a>
  132. <a href="#Class_Pass"><b>Pass</b></a>
  133. <a href="#Class_PhysicsRaycastResult"><b>PhysicsRaycastResult</b></a>
  134. <a href="#Class_PhysicsRaycastResult2D"><b>PhysicsRaycastResult2D</b></a>
  135. <a href="#Class_PhysicsWorld"><b>PhysicsWorld</b></a>
  136. <a href="#Class_PhysicsWorld2D"><b>PhysicsWorld2D</b></a>
  137. <a href="#Class_Plane"><b>Plane</b></a>
  138. <a href="#Class_Polyhedron"><b>Polyhedron</b></a>
  139. <a href="#Class_PropertySet2D"><b>PropertySet2D</b></a>
  140. <a href="#Class_Quaternion"><b>Quaternion</b></a>
  141. <a href="#Class_Ray"><b>Ray</b></a>
  142. <a href="#Class_RayQueryResult"><b>RayQueryResult</b></a>
  143. <a href="#Class_Rect"><b>Rect</b></a>
  144. <a href="#Class_RemoteEvent"><b>RemoteEvent</b></a>
  145. <a href="#Class_RenderPath"><b>RenderPath</b></a>
  146. <a href="#Class_RenderPathCommand"><b>RenderPathCommand</b></a>
  147. <a href="#Class_RenderSurface"><b>RenderSurface</b></a>
  148. <a href="#Class_RenderTargetInfo"><b>RenderTargetInfo</b></a>
  149. <a href="#Class_Renderer"><b>Renderer</b></a>
  150. <a href="#Class_Resource"><b>Resource</b></a>
  151. <a href="#Class_ResourceCache"><b>ResourceCache</b></a>
  152. <a href="#Class_ResourceRef"><b>ResourceRef</b></a>
  153. <a href="#Class_ResourceRefList"><b>ResourceRefList</b></a>
  154. <a href="#Class_RibbonTrail"><b>RibbonTrail</b></a>
  155. <a href="#Class_RigidBody"><b>RigidBody</b></a>
  156. <a href="#Class_RigidBody2D"><b>RigidBody2D</b></a>
  157. <a href="#Class_Scene"><b>Scene</b></a>
  158. <a href="#Class_ScrollBar"><b>ScrollBar</b></a>
  159. <a href="#Class_ScrollView"><b>ScrollView</b></a>
  160. <a href="#Class_Serializable"><b>Serializable</b></a>
  161. <a href="#Class_Serializer"><b>Serializer</b></a>
  162. <a href="#Class_Skeleton"><b>Skeleton</b></a>
  163. <a href="#Class_Skybox"><b>Skybox</b></a>
  164. <a href="#Class_Slider"><b>Slider</b></a>
  165. <a href="#Class_Sound"><b>Sound</b></a>
  166. <a href="#Class_SoundListener"><b>SoundListener</b></a>
  167. <a href="#Class_SoundSource"><b>SoundSource</b></a>
  168. <a href="#Class_SoundSource3D"><b>SoundSource3D</b></a>
  169. <a href="#Class_Sphere"><b>Sphere</b></a>
  170. <a href="#Class_Spline"><b>Spline</b></a>
  171. <a href="#Class_SplinePath"><b>SplinePath</b></a>
  172. <a href="#Class_Sprite"><b>Sprite</b></a>
  173. <a href="#Class_Sprite2D"><b>Sprite2D</b></a>
  174. <a href="#Class_SpriteSheet2D"><b>SpriteSheet2D</b></a>
  175. <a href="#Class_StaticModel"><b>StaticModel</b></a>
  176. <a href="#Class_StaticModelGroup"><b>StaticModelGroup</b></a>
  177. <a href="#Class_StaticSprite2D"><b>StaticSprite2D</b></a>
  178. <a href="#Class_StringHash"><b>StringHash</b></a>
  179. <a href="#Class_Technique"><b>Technique</b></a>
  180. <a href="#Class_Terrain"><b>Terrain</b></a>
  181. <a href="#Class_TerrainPatch"><b>TerrainPatch</b></a>
  182. <a href="#Class_Text"><b>Text</b></a>
  183. <a href="#Class_Text3D"><b>Text3D</b></a>
  184. <a href="#Class_Texture"><b>Texture</b></a>
  185. <a href="#Class_Texture2D"><b>Texture2D</b></a>
  186. <a href="#Class_Texture2DArray"><b>Texture2DArray</b></a>
  187. <a href="#Class_Texture3D"><b>Texture3D</b></a>
  188. <a href="#Class_TextureCube"><b>TextureCube</b></a>
  189. <a href="#Class_TextureFrame"><b>TextureFrame</b></a>
  190. <a href="#Class_Tile2D"><b>Tile2D</b></a>
  191. <a href="#Class_TileMap2D"><b>TileMap2D</b></a>
  192. <a href="#Class_TileMapInfo2D"><b>TileMapInfo2D</b></a>
  193. <a href="#Class_TileMapLayer2D"><b>TileMapLayer2D</b></a>
  194. <a href="#Class_TileMapObject2D"><b>TileMapObject2D</b></a>
  195. <a href="#Class_Time"><b>Time</b></a>
  196. <a href="#Class_TmxFile2D"><b>TmxFile2D</b></a>
  197. <a href="#Class_ToolTip"><b>ToolTip</b></a>
  198. <a href="#Class_TouchState"><b>TouchState</b></a>
  199. <a href="#Class_UI"><b>UI</b></a>
  200. <a href="#Class_UIElement"><b>UIElement</b></a>
  201. <a href="#Class_ValueAnimation"><b>ValueAnimation</b></a>
  202. <a href="#Class_Variant"><b>Variant</b></a>
  203. <a href="#Class_VariantMap"><b>VariantMap</b></a>
  204. <a href="#Class_Vector2"><b>Vector2</b></a>
  205. <a href="#Class_Vector3"><b>Vector3</b></a>
  206. <a href="#Class_Vector4"><b>Vector4</b></a>
  207. <a href="#Class_VectorBuffer"><b>VectorBuffer</b></a>
  208. <a href="#Class_VertexBuffer"><b>VertexBuffer</b></a>
  209. <a href="#Class_VertexElement"><b>VertexElement</b></a>
  210. <a href="#Class_View3D"><b>View3D</b></a>
  211. <a href="#Class_Viewport"><b>Viewport</b></a>
  212. <a href="#Class_Window"><b>Window</b></a>
  213. <a href="#Class_XMLElement"><b>XMLElement</b></a>
  214. <a href="#Class_XMLFile"><b>XMLFile</b></a>
  215. <a href="#Class_Zone"><b>Zone</b></a>
  216. \section LuaScriptAPI_Classes Classes
  217. <a name="Class_Animatable"></a>
  218. ### Animatable : Serializable
  219. Methods:
  220. - void SetAnimationEnabled(bool enable)
  221. - void SetAnimationTime(float time)
  222. - void SetObjectAnimation(ObjectAnimation* objectAnimation)
  223. - void SetAttributeAnimation(const String name, ValueAnimation* attributeAnimation, WrapMode wrapMode = WM_LOOP, float speed = 1.0f)
  224. - void SetAttributeAnimationWrapMode(const String name, WrapMode wrapMode)
  225. - void SetAttributeAnimationSpeed(const String name, float speed)
  226. - void SetAttributeAnimationTime(const String name, float time)
  227. - void RemoveObjectAnimation()
  228. - void RemoveAttributeAnimation(const String name)
  229. - bool GetAnimationEnabled() const
  230. - ObjectAnimation* GetObjectAnimation() const
  231. - ValueAnimation* GetAttributeAnimation(const String name) const
  232. - WrapMode GetAttributeAnimationWrapMode(const String name) const
  233. - float GetAttributeAnimationSpeed(const String name) const
  234. - float GetAttributeAnimationTime(const String name) const
  235. Properties:
  236. - bool animationEnabled
  237. - ObjectAnimation* objectAnimation
  238. <a name="Class_AnimatedModel"></a>
  239. ### AnimatedModel : StaticModel
  240. Methods:
  241. - void SetModel(Model* model)
  242. - AnimationState* AddAnimationState(Animation* animation)
  243. - void RemoveAnimationState(Animation* animation)
  244. - void RemoveAnimationState(const String animationName)
  245. - void RemoveAnimationState(StringHash animationNameHash)
  246. - void RemoveAnimationState(AnimationState* state)
  247. - void RemoveAnimationState(unsigned index)
  248. - void RemoveAllAnimationStates()
  249. - void SetAnimationLodBias(float bias)
  250. - void SetUpdateInvisible(bool enable)
  251. - void SetMorphWeight(const String name, float weight)
  252. - void SetMorphWeight(StringHash nameHash, float weight)
  253. - void SetMorphWeight(unsigned index, float weight)
  254. - void ResetMorphWeights()
  255. - Skeleton& GetSkeleton()
  256. - unsigned GetNumAnimationStates() const
  257. - AnimationState* GetAnimationState(Animation* animation) const
  258. - AnimationState* GetAnimationState(const String animationName) const
  259. - AnimationState* GetAnimationState(const StringHash animationNameHash) const
  260. - AnimationState* GetAnimationState(unsigned index) const
  261. - float GetAnimationLodBias() const
  262. - bool GetUpdateInvisible() const
  263. - unsigned GetNumMorphs() const
  264. - float GetMorphWeight(const String name) const
  265. - float GetMorphWeight(StringHash nameHash) const
  266. - float GetMorphWeight(unsigned index) const
  267. - bool IsMaster() const
  268. - void UpdateBoneBoundingBox()
  269. Properties:
  270. - Model* model
  271. - Skeleton& skeleton (readonly)
  272. - unsigned numAnimationStates (readonly)
  273. - float animationLodBias
  274. - bool updateInvisible
  275. - unsigned numMorphs (readonly)
  276. - bool master (readonly)
  277. <a name="Class_AnimatedSprite2D"></a>
  278. ### AnimatedSprite2D : StaticSprite2D
  279. Methods:
  280. - void SetAnimationSet(AnimationSet2D* animationSet)
  281. - void SetEntity(const String entity)
  282. - void SetAnimation(const String name, LoopMode2D loopMode = LM_DEFAULT)
  283. - void SetLoopMode(LoopMode2D loopMode)
  284. - void SetSpeed(float speed)
  285. - AnimationSet2D* GetAnimationSet() const
  286. - const String GetEntity() const
  287. - const String GetAnimation() const
  288. - LoopMode2D GetLoopMode() const
  289. - float GetSpeed() const
  290. Properties:
  291. - float speed
  292. - String entity
  293. - String animation
  294. - AnimationSet2D* animationSet
  295. - LoopMode2D loopMode
  296. <a name="Class_Animation"></a>
  297. ### Animation : Resource
  298. Methods:
  299. - Animation() (GC)
  300. - Animation* new()
  301. - void delete()
  302. - void SetAnimationName(const String name)
  303. - void SetLength(float length)
  304. - AnimationTrack* CreateTrack(const String name)
  305. - bool RemoveTrack(const String name)
  306. - void RemoveAllTracks()
  307. - void SetTrigger(unsigned index, const AnimationTriggerPoint& trigger)
  308. - void AddTrigger(const AnimationTriggerPoint& trigger)
  309. - void AddTrigger(float time, bool timeIsNormalized, const Variant& data)
  310. - void RemoveTrigger(unsigned index)
  311. - void RemoveAllTriggers()
  312. - Animation* Clone(const String cloneName = String::EMPTY) const
  313. - const String GetAnimationName() const
  314. - float GetLength() const
  315. - unsigned GetNumTracks() const
  316. - AnimationTrack* GetTrack(const String name)
  317. - AnimationTrack* GetTrack(StringHash nameHash)
  318. - unsigned GetNumTriggers() const
  319. - AnimationTriggerPoint* GetTrigger(unsigned index)
  320. Properties:
  321. - String animationName
  322. - float length
  323. - unsigned numTracks (readonly)
  324. - unsigned numTriggers (readonly)
  325. <a name="Class_AnimationControl"></a>
  326. ### AnimationControl
  327. Methods:
  328. - AnimationControl() (GC)
  329. - AnimationControl* new()
  330. - void delete()
  331. Properties:
  332. - StringHash hash_
  333. - float speed_
  334. - float targetWeight_
  335. - float fadeTime_
  336. - float autoFadeTime_
  337. - float setTimeTtl_
  338. - float setWeightTtl_
  339. - short setTime_
  340. - char setWeight_
  341. - char setTimeRev_
  342. - char setWeightRev_
  343. <a name="Class_AnimationController"></a>
  344. ### AnimationController : Component
  345. Methods:
  346. - bool Play(const String name, char layer, bool looped, float fadeInTime = 0.0f)
  347. - bool PlayExclusive(const String name, char layer, bool looped, float fadeTime = 0.0f)
  348. - bool Stop(const String name, float fadeOutTime = 0.0f)
  349. - void StopLayer(char layer, float fadeOutTime = 0.0f)
  350. - void StopAll(float fadeTime = 0.0f)
  351. - bool Fade(const String name, float targetWeight, float fadeTime)
  352. - bool FadeOthers(const String name, float targetWeight, float fadeTime)
  353. - bool SetLayer(const String name, char layer)
  354. - bool SetStartBone(const String name, const String startBoneName)
  355. - bool SetTime(const String name, float time)
  356. - bool SetWeight(const String name, float weight)
  357. - bool SetLooped(const String name, bool enable)
  358. - bool SetBlendMode(const String name, AnimationBlendMode mode)
  359. - bool SetSpeed(const String name, float speed)
  360. - bool SetAutoFade(const String name, float fadeOutTime)
  361. - bool SetRemoveOnCompletion(const String name, bool removeOnCompletion)
  362. - bool IsPlaying(const String name) const
  363. - bool IsFadingIn(const String name) const
  364. - bool IsFadingOut(const String name) const
  365. - bool IsAtEnd(const String name) const
  366. - char GetLayer(const String name) const
  367. - Bone* GetStartBone(const String name) const
  368. - const String GetStartBoneName(const String name) const
  369. - float GetTime(const String name) const
  370. - float GetWeight(const String name) const
  371. - bool IsLooped(const String name) const
  372. - AnimationBlendMode GetBlendMode(const String name) const
  373. - float GetLength(const String name) const
  374. - float GetSpeed(const String name) const
  375. - float GetFadeTarget(const String name) const
  376. - float GetFadeTime(const String name) const
  377. - float GetAutoFade(const String name) const
  378. - bool GetRemoveOnCompletion(const String name) const
  379. - AnimationState* GetAnimationState(const String name) const
  380. - AnimationState* GetAnimationState(StringHash nameHash) const
  381. <a name="Class_AnimationKeyFrame"></a>
  382. ### AnimationKeyFrame
  383. Properties:
  384. - float time
  385. - Vector3 position
  386. - Quaternion rotation
  387. - Vector3 scale
  388. <a name="Class_AnimationSet2D"></a>
  389. ### AnimationSet2D : Resource
  390. Methods:
  391. - unsigned GetNumAnimations() const
  392. - String GetAnimation(unsigned index) const
  393. Properties:
  394. - unsigned numAnimations (readonly)
  395. <a name="Class_AnimationState"></a>
  396. ### AnimationState
  397. Methods:
  398. - AnimationState(AnimatedModel* model, Animation* animation) (GC)
  399. - AnimationState* new(AnimatedModel* model, Animation* animation)
  400. - AnimationState(Node* node, Animation* animation) (GC)
  401. - AnimationState* new(Node* node, Animation* animation)
  402. - void delete()
  403. - void SetStartBone(Bone* bone)
  404. - void SetLooped(bool looped)
  405. - void SetWeight(float weight)
  406. - void SetTime(float time)
  407. - void SetBoneWeight(const String name, float weight, bool recursive = false)
  408. - void SetBoneWeight(StringHash nameHash, float weight, bool recursive = false)
  409. - void SetBoneWeight(unsigned index, float weight, bool recursive = false)
  410. - void AddWeight(float delta)
  411. - void AddTime(float delta)
  412. - void SetLayer(char layer)
  413. - void SetBlendMode(AnimationBlendMode mode)
  414. - Animation* GetAnimation() const
  415. - Bone* GetStartBone() const
  416. - float GetBoneWeight(const String name) const
  417. - float GetBoneWeight(StringHash nameHash) const
  418. - float GetBoneWeight(unsigned index) const
  419. - unsigned GetTrackIndex(const String name) const
  420. - unsigned GetTrackIndex(StringHash nameHash) const
  421. - bool IsEnabled() const
  422. - bool IsLooped() const
  423. - float GetWeight() const
  424. - float GetTime() const
  425. - float GetLength() const
  426. - char GetLayer() const
  427. - AnimationBlendMode GetBlendMode() const
  428. Properties:
  429. - Animation* animation (readonly)
  430. - Bone* startBone
  431. - bool enabled (readonly)
  432. - bool looped
  433. - float weight
  434. - float time
  435. - float length (readonly)
  436. - char layer
  437. - AnimationBlendMode blendMode
  438. <a name="Class_AnimationTrack"></a>
  439. ### AnimationTrack
  440. Methods:
  441. - void SetKeyFrame(unsigned index, const AnimationKeyFrame& keyFrame)
  442. - void AddKeyFrame(const AnimationKeyFrame& keyFrame)
  443. - void InsertKeyFrame(unsigned index, const AnimationKeyFrame& keyFrame)
  444. - void RemoveKeyFrame(unsigned index)
  445. - void RemoveAllKeyFrames()
  446. - AnimationKeyFrame* GetKeyFrame(unsigned index)
  447. - unsigned GetNumKeyFrames() const
  448. Properties:
  449. - const String name
  450. - const StringHash nameHash
  451. - char channelMask
  452. - Vector<AnimationKeyFrame> keyFrames
  453. - unsigned numKeyFrames (readonly)
  454. <a name="Class_AnimationTriggerPoint"></a>
  455. ### AnimationTriggerPoint
  456. Methods:
  457. - AnimationTriggerPoint() (GC)
  458. - AnimationTriggerPoint* new()
  459. Properties:
  460. - float time
  461. - Variant data
  462. <a name="Class_Audio"></a>
  463. ### Audio : Object
  464. Methods:
  465. - bool SetMode(int bufferLengthMSec, int mixRate, bool stereo, bool interpolation = true)
  466. - bool Play()
  467. - void Stop()
  468. - void SetMasterGain(const String type, float gain)
  469. - void PauseSoundType(const String type)
  470. - void ResumeSoundType(const String type)
  471. - void ResumeAll()
  472. - void SetListener(SoundListener* listener)
  473. - void StopSound(Sound* sound)
  474. - unsigned GetSampleSize() const
  475. - int GetMixRate() const
  476. - bool GetInterpolation() const
  477. - bool IsStereo() const
  478. - bool IsPlaying() const
  479. - bool IsInitialized() const
  480. - bool HasMasterGain(const String type) const
  481. - float GetMasterGain(const String type) const
  482. - bool IsSoundTypePaused(const String type) const
  483. - SoundListener* GetListener() const
  484. - const PODVector<SoundSource*>& GetSoundSources() const
  485. - void AddSoundSource(SoundSource* soundSource)
  486. - void RemoveSoundSource(SoundSource* soundSource)
  487. - void MixOutput(void* dest, unsigned samples)
  488. Properties:
  489. - unsigned sampleSize (readonly)
  490. - int mixRate (readonly)
  491. - bool interpolation (readonly)
  492. - bool stereo (readonly)
  493. - bool playing (readonly)
  494. - bool initialized (readonly)
  495. - SoundListener* listener
  496. <a name="Class_BiasParameters"></a>
  497. ### BiasParameters
  498. Methods:
  499. - BiasParameters() (GC)
  500. - BiasParameters* new()
  501. - BiasParameters(float constantBias, float slopeScaledBias, float normalOffset = 0.0f) (GC)
  502. - BiasParameters* new(float constantBias, float slopeScaledBias, float normalOffset = 0.0f)
  503. - void delete()
  504. Properties:
  505. - float constantBias
  506. - float slopeScaledBias
  507. - float normalOffset
  508. <a name="Class_Billboard"></a>
  509. ### Billboard
  510. Properties:
  511. - Vector3 position
  512. - Vector2 size
  513. - Rect uv
  514. - Color color
  515. - float rotation
  516. - bool enabled
  517. <a name="Class_BillboardSet"></a>
  518. ### BillboardSet : Drawable
  519. Methods:
  520. - void SetMaterial(Material* material)
  521. - void SetNumBillboards(unsigned num)
  522. - void SetRelative(bool enable)
  523. - void SetScaled(bool enable)
  524. - void SetSorted(bool enable)
  525. - void SetFixedScreenSize(bool enable)
  526. - void SetFaceCameraMode(FaceCameraMode mode)
  527. - void SetAnimationLodBias(float bias)
  528. - void Commit()
  529. - Material* GetMaterial() const
  530. - unsigned GetNumBillboards() const
  531. - Billboard* GetBillboard(unsigned index)
  532. - bool IsRelative() const
  533. - bool IsScaled() const
  534. - bool IsSorted() const
  535. - bool IsFixedScreenSize() const
  536. - FaceCameraMode GetFaceCameraMode() const
  537. - float GetAnimationLodBias() const
  538. Properties:
  539. - Material* material
  540. - unsigned numBillboards
  541. - bool relative
  542. - bool scaled
  543. - bool sorted
  544. - bool fixedScreenSize
  545. - FaceCameraMode faceCameraMode
  546. - float animationLodBias
  547. <a name="Class_Bone"></a>
  548. ### Bone
  549. Methods:
  550. - Bone() (GC)
  551. - Bone* new()
  552. - void delete()
  553. Properties:
  554. - String name
  555. - StringHash nameHash
  556. - unsigned parentIndex
  557. - Vector3 initialPosition
  558. - Quaternion initialRotation
  559. - Vector3 initialScale
  560. - Matrix3x4 offsetMatrix
  561. - bool animated
  562. - char collisionMask
  563. - float radius
  564. - BoundingBox boundingBox
  565. - Node* node
  566. <a name="Class_BorderImage"></a>
  567. ### BorderImage : UIElement
  568. Methods:
  569. - BorderImage() (GC)
  570. - BorderImage* new()
  571. - void delete()
  572. - void SetTexture(Texture* texture)
  573. - void SetImageRect(const IntRect& rect)
  574. - void SetFullImageRect()
  575. - void SetBorder(const IntRect& rect)
  576. - void SetImageBorder(const IntRect& rect)
  577. - void SetHoverOffset(const IntVector2& offset)
  578. - void SetHoverOffset(int x, int y)
  579. - void SetBlendMode(BlendMode mode)
  580. - void SetTiled(bool enable)
  581. - Texture* GetTexture() const
  582. - const IntRect& GetImageRect() const
  583. - const IntRect& GetBorder() const
  584. - const IntRect& GetImageBorder() const
  585. - const IntVector2& GetHoverOffset() const
  586. - BlendMode GetBlendMode() const
  587. - bool IsTiled() const
  588. Properties:
  589. - Texture* texture
  590. - IntRect& imageRect
  591. - IntRect& border
  592. - IntRect& imageBorder
  593. - IntVector2& hoverOffset
  594. - BlendMode blendMode
  595. - bool tiled
  596. <a name="Class_BoundingBox"></a>
  597. ### BoundingBox
  598. Methods:
  599. - BoundingBox() (GC)
  600. - BoundingBox* new()
  601. - BoundingBox(const BoundingBox& box) (GC)
  602. - BoundingBox* new(const BoundingBox& box)
  603. - BoundingBox(const Rect& rect) (GC)
  604. - BoundingBox* new(const Rect& rect)
  605. - BoundingBox(const Vector3& min, const Vector3& max) (GC)
  606. - BoundingBox* new(const Vector3& min, const Vector3& max)
  607. - BoundingBox(float min, float max) (GC)
  608. - BoundingBox* new(float min, float max)
  609. - BoundingBox(const Frustum& frustum) (GC)
  610. - BoundingBox* new(const Frustum& frustum)
  611. - BoundingBox(const Polyhedron& poly) (GC)
  612. - BoundingBox* new(const Polyhedron& poly)
  613. - BoundingBox(const Sphere& sphere) (GC)
  614. - BoundingBox* new(const Sphere& sphere)
  615. - void delete()
  616. - bool operator==(const BoundingBox& rhs) const
  617. - void Define(const BoundingBox& box)
  618. - void Define(const Rect& rect)
  619. - void Define(const Vector3& min, const Vector3& max)
  620. - void Define(float min, float max)
  621. - void Define(const Vector3& point)
  622. - void Define(const Frustum& frustum)
  623. - void Define(const Polyhedron& poly)
  624. - void Define(const Sphere& sphere)
  625. - void Merge(const Vector3& point)
  626. - void Merge(const BoundingBox& box)
  627. - void Merge(const Frustum& frustum)
  628. - void Merge(const Polyhedron& poly)
  629. - void Merge(const Sphere& sphere)
  630. - void Clip(const BoundingBox& box)
  631. - void Transform(const Matrix3& transform)
  632. - void Transform(const Matrix3x4& transform)
  633. - void Clear()
  634. - bool Defined() const
  635. - Vector3 Center() const
  636. - Vector3 Size() const
  637. - Vector3 HalfSize() const
  638. - BoundingBox Transformed(const Matrix3& transform) const
  639. - BoundingBox Transformed(const Matrix3x4& transform) const
  640. - Rect Projected(const Matrix4& projection) const
  641. - Intersection IsInside(const Vector3& point) const
  642. - Intersection IsInside(const BoundingBox& box) const
  643. - Intersection IsInsideFast(const BoundingBox& box) const
  644. - Intersection IsInside(const Sphere& sphere) const
  645. - Intersection IsInsideFast(const Sphere& sphere) const
  646. - String ToString() const
  647. Properties:
  648. - Vector3 min
  649. - Vector3 max
  650. - Vector3 center (readonly)
  651. - Vector3 size (readonly)
  652. - Vector3 halfSize (readonly)
  653. <a name="Class_Button"></a>
  654. ### Button : BorderImage
  655. Methods:
  656. - Button() (GC)
  657. - Button* new()
  658. - void delete()
  659. - void SetPressedOffset(const IntVector2& offset)
  660. - void SetPressedOffset(int x, int y)
  661. - void SetPressedChildOffset(const IntVector2& offset)
  662. - void SetPressedChildOffset(int x, int y)
  663. - void SetRepeat(float delay, float rate)
  664. - void SetRepeatDelay(float delay)
  665. - void SetRepeatRate(float rate)
  666. - const IntVector2& GetPressedOffset() const
  667. - const IntVector2& GetPressedChildOffset() const
  668. - float GetRepeatDelay() const
  669. - float GetRepeatRate() const
  670. - bool IsPressed() const
  671. Properties:
  672. - IntVector2& pressedOffset
  673. - IntVector2& pressedChildOffset
  674. - float repeatDelay
  675. - float repeatRate
  676. - bool pressed (readonly)
  677. <a name="Class_Camera"></a>
  678. ### Camera : Component
  679. Methods:
  680. - void SetNearClip(float nearClip)
  681. - void SetFarClip(float farClip)
  682. - void SetFov(float fov)
  683. - void SetOrthoSize(float orthoSize)
  684. - void SetOrthoSize(const Vector2& orthoSize)
  685. - void SetAspectRatio(float aspectRatio)
  686. - void SetFillMode(FillMode mode)
  687. - void SetZoom(float zoom)
  688. - void SetLodBias(float bias)
  689. - void SetViewMask(unsigned mask)
  690. - void SetViewOverrideFlags(unsigned flags)
  691. - void SetOrthographic(bool enable)
  692. - void SetAutoAspectRatio(bool enable)
  693. - void SetProjectionOffset(const Vector2& offset)
  694. - void SetUseReflection(bool enable)
  695. - void SetReflectionPlane(const Plane& reflectionPlane)
  696. - void SetUseClipping(bool enable)
  697. - void SetClipPlane(const Plane& clipPlane)
  698. - void SetProjection(const Matrix4& projection)
  699. - float GetFarClip() const
  700. - float GetNearClip() const
  701. - float GetFov() const
  702. - float GetOrthoSize() const
  703. - float GetAspectRatio() const
  704. - float GetZoom() const
  705. - float GetLodBias() const
  706. - unsigned GetViewMask() const
  707. - unsigned GetViewOverrideFlags() const
  708. - FillMode GetFillMode() const
  709. - bool IsOrthographic() const
  710. - bool GetAutoAspectRatio() const
  711. - const Frustum& GetFrustum() const
  712. - Matrix4 GetProjection() const
  713. - Matrix4 GetGPUProjection() const
  714. - const Matrix3x4& GetView() const
  715. - void GetFrustumSize(Vector3& near, Vector3& far) const
  716. - float GetHalfViewSize() const
  717. - Frustum GetSplitFrustum(float nearClip, float farClip) const
  718. - Frustum GetViewSpaceFrustum() const
  719. - Frustum GetViewSpaceSplitFrustum(float nearClip, float farClip) const
  720. - Ray GetScreenRay(float x, float y) const
  721. - Vector2 WorldToScreenPoint(const Vector3& worldPos) const
  722. - Vector3 ScreenToWorldPoint(const Vector3& screenPos) const
  723. - const Vector2& GetProjectionOffset() const
  724. - bool GetUseReflection() const
  725. - const Plane& GetReflectionPlane() const
  726. - bool GetUseClipping() const
  727. - const Plane& GetClipPlane() const
  728. - float GetDistance(const Vector3& worldPos) const
  729. - float GetDistanceSquared(const Vector3& worldPos) const
  730. - float GetLodDistance(float distance, float scale, float bias) const
  731. - bool IsProjectionValid() const
  732. - Matrix3x4 GetEffectiveWorldTransform() const
  733. Properties:
  734. - float farClip
  735. - float nearClip
  736. - float fov
  737. - float orthoSize
  738. - float aspectRatio
  739. - float zoom
  740. - float lodBias
  741. - unsigned viewMask
  742. - unsigned viewOverrideFlags
  743. - FillMode fillMode
  744. - bool orthographic
  745. - bool autoAspectRatio
  746. - Frustum& frustum (readonly)
  747. - Matrix4 projection (readonly)
  748. - Matrix4 GPUProjection (readonly)
  749. - Matrix3x4& view (readonly)
  750. - float halfViewSize (readonly)
  751. - Frustum viewSpaceFrustum (readonly)
  752. - Vector2& projectionOffset
  753. - bool useReflection
  754. - Plane& reflectionPlane
  755. - bool useClipping
  756. - Plane& clipPlane
  757. - bool projectionValid (readonly)
  758. - Matrix3x4 effectiveWorldTransform (readonly)
  759. <a name="Class_CascadeParameters"></a>
  760. ### CascadeParameters
  761. Methods:
  762. - CascadeParameters() (GC)
  763. - CascadeParameters* new()
  764. - CascadeParameters(float split1, float split2, float split3, float split4, float fadeStart, float biasAutoAdjust = 1.0f) (GC)
  765. - CascadeParameters* new(float split1, float split2, float split3, float split4, float fadeStart, float biasAutoAdjust = 1.0f)
  766. - void delete()
  767. Properties:
  768. - float fadeStart
  769. - float biasAutoAdjust
  770. <a name="Class_CheckBox"></a>
  771. ### CheckBox : BorderImage
  772. Methods:
  773. - CheckBox() (GC)
  774. - CheckBox* new()
  775. - void delete()
  776. - void SetChecked(bool enable)
  777. - void SetCheckedOffset(const IntVector2& rect)
  778. - void SetCheckedOffset(int x, int y)
  779. - bool IsChecked() const
  780. - const IntVector2& GetCheckedOffset() const
  781. Properties:
  782. - bool checked
  783. - IntVector2& checkedOffset
  784. <a name="Class_CollisionBox2D"></a>
  785. ### CollisionBox2D : CollisionShape2D
  786. Methods:
  787. - void SetSize(const Vector2& size)
  788. - void SetSize(float width, float height)
  789. - void SetCenter(const Vector2& center)
  790. - void SetCenter(float x, float y)
  791. - void SetAngle(float angle)
  792. - const Vector2& GetSize() const
  793. - const Vector2& GetCenter() const
  794. - float GetAngle() const
  795. Properties:
  796. - Vector2& size
  797. - Vector2& center
  798. - float angle
  799. <a name="Class_CollisionChain2D"></a>
  800. ### CollisionChain2D : CollisionShape2D
  801. Methods:
  802. - void SetLoop(bool loop)
  803. - void SetVertexCount(unsigned count)
  804. - void SetVertex(unsigned index, const Vector2& vertex)
  805. - void SetVertices(const PODVector<Vector2>& vertices)
  806. - bool GetLoop() const
  807. - unsigned GetVertexCount() const
  808. - const Vector2& GetVertex(unsigned index) const
  809. Properties:
  810. - bool loop
  811. - unsigned vertexCount
  812. <a name="Class_CollisionCircle2D"></a>
  813. ### CollisionCircle2D : CollisionShape2D
  814. Methods:
  815. - void SetRadius(float radius)
  816. - void SetCenter(const Vector2& center)
  817. - void SetCenter(float x, float y)
  818. - float GetRadius() const
  819. - const Vector2& GetCenter() const
  820. Properties:
  821. - float radius
  822. - Vector2& center
  823. <a name="Class_CollisionEdge2D"></a>
  824. ### CollisionEdge2D : CollisionShape2D
  825. Methods:
  826. - void SetVertex1(const Vector2& vertex)
  827. - void SetVertex2(const Vector2& vertex)
  828. - void SetVertices(const Vector2& vertex1, const Vector2& vertex2)
  829. - const Vector2& GetVertex1() const
  830. - const Vector2& GetVertex2() const
  831. Properties:
  832. - Vector2& vertex1
  833. - Vector2& vertex2
  834. <a name="Class_CollisionPolygon2D"></a>
  835. ### CollisionPolygon2D : CollisionShape2D
  836. Methods:
  837. - void SetVertexCount(unsigned count)
  838. - void SetVertex(unsigned index, const Vector2& vertex)
  839. - void SetVertices(const PODVector<Vector2>& vertices)
  840. - unsigned GetVertexCount() const
  841. - const Vector2& GetVertex(unsigned index) const
  842. Properties:
  843. - unsigned vertexCount
  844. <a name="Class_CollisionShape"></a>
  845. ### CollisionShape : Component
  846. Methods:
  847. - void SetBox(const Vector3& size)
  848. - void SetBox(const Vector3& size, const Vector3& position)
  849. - void SetBox(const Vector3& size, const Vector3& position, const Quaternion& rotation)
  850. - void SetSphere(float diameter)
  851. - void SetSphere(float diameter, const Vector3& position)
  852. - void SetSphere(float diameter, const Vector3& position, const Quaternion& rotation)
  853. - void SetStaticPlane()
  854. - void SetStaticPlane(const Vector3& position)
  855. - void SetStaticPlane(const Vector3& position, const Quaternion& rotation)
  856. - void SetCylinder(float diameter, float height)
  857. - void SetCylinder(float diameter, float height, const Vector3& position)
  858. - void SetCylinder(float diameter, float height, const Vector3& position, const Quaternion& rotation)
  859. - void SetCapsule(float diameter, float height)
  860. - void SetCapsule(float diameter, float height, const Vector3& position)
  861. - void SetCapsule(float diameter, float height, const Vector3& position, const Quaternion& rotation)
  862. - void SetCone(float diameter, float height)
  863. - void SetCone(float diameter, float height, const Vector3& position)
  864. - void SetCone(float diameter, float height, const Vector3& position, const Quaternion& rotation)
  865. - void SetTriangleMesh(Model* model, unsigned lodLevel = 0)
  866. - void SetTriangleMesh(Model* model, unsigned lodLevel, const Vector3& scale)
  867. - void SetTriangleMesh(Model* model, unsigned lodLevel, const Vector3& scale, const Vector3& position)
  868. - void SetTriangleMesh(Model* model, unsigned lodLevel, const Vector3& scale, const Vector3& position, const Quaternion& rotation)
  869. - void SetCustomTriangleMesh(CustomGeometry* custom)
  870. - void SetCustomTriangleMesh(CustomGeometry* custom, const Vector3& scale)
  871. - void SetCustomTriangleMesh(CustomGeometry* custom, const Vector3& scale, const Vector3& position)
  872. - void SetCustomTriangleMesh(CustomGeometry* custom, const Vector3& scale, const Vector3& position, const Quaternion& rotation)
  873. - void SetConvexHull(Model* model, unsigned lodLevel = 0)
  874. - void SetConvexHull(Model* model, unsigned lodLevel, const Vector3& scale)
  875. - void SetConvexHull(Model* model, unsigned lodLevel, const Vector3& scale, const Vector3& position)
  876. - void SetConvexHull(Model* model, unsigned lodLevel, const Vector3& scale, const Vector3& position, const Quaternion& rotation)
  877. - void SetCustomConvexHull(CustomGeometry* custom)
  878. - void SetCustomConvexHull(CustomGeometry* custom, const Vector3& scale)
  879. - void SetCustomConvexHull(CustomGeometry* custom, const Vector3& scale, const Vector3& position)
  880. - void SetCustomConvexHull(CustomGeometry* custom, const Vector3& scale, const Vector3& position, const Quaternion& rotation)
  881. - void SetTerrain(unsigned lodLevel = 0)
  882. - void SetShapeType(ShapeType type)
  883. - void SetSize(const Vector3& size)
  884. - void SetPosition(const Vector3& position)
  885. - void SetRotation(const Quaternion& rotation)
  886. - void SetTransform(const Vector3& position, const Quaternion& rotation)
  887. - void SetMargin(float margin)
  888. - void SetModel(Model* model)
  889. - void SetLodLevel(unsigned lodLevel)
  890. - PhysicsWorld* GetPhysicsWorld() const
  891. - ShapeType GetShapeType() const
  892. - const Vector3& GetSize() const
  893. - const Vector3& GetPosition() const
  894. - const Quaternion& GetRotation() const
  895. - float GetMargin() const
  896. - Model* GetModel() const
  897. - unsigned GetLodLevel() const
  898. - BoundingBox GetWorldBoundingBox() const
  899. Properties:
  900. - PhysicsWorld* physicsWorld (readonly)
  901. - ShapeType shapeType
  902. - Vector3& size
  903. - Vector3& position
  904. - Quaternion& rotation
  905. - float margin
  906. - Model* model
  907. - unsigned lodLevel
  908. - BoundingBox worldBoundingBox (readonly)
  909. - ResourceRef modelAttr
  910. <a name="Class_CollisionShape2D"></a>
  911. ### CollisionShape2D : Component
  912. Methods:
  913. - void SetTrigger(bool trigger)
  914. - void SetCategoryBits(int categoryBits)
  915. - void SetMaskBits(int maskBits)
  916. - void SetGroupIndex(int groupIndex)
  917. - void SetDensity(float density)
  918. - void SetFriction(float friction)
  919. - void SetRestitution(float restitution)
  920. - bool IsTrigger() const
  921. - int GetCategoryBits() const
  922. - int GetMaskBits() const
  923. - int GetGroupIndex() const
  924. - float GetDensity() const
  925. - float GetFriction() const
  926. - float GetRestitution() const
  927. - float GetMass() const
  928. - float GetInertia() const
  929. - Vector2 GetMassCenter() const
  930. Properties:
  931. - bool trigger
  932. - int categoryBits
  933. - int maskBits
  934. - int groupIndex
  935. - float density
  936. - float friction
  937. - float restitution
  938. - float mass (readonly)
  939. - float inertia (readonly)
  940. - Vector2 massCenter (readonly)
  941. <a name="Class_Color"></a>
  942. ### Color
  943. Methods:
  944. - Color() (GC)
  945. - Color* new()
  946. - Color(const Color& color) (GC)
  947. - Color* new(const Color& color)
  948. - Color(const Color& color, float a) (GC)
  949. - Color* new(const Color& color, float a)
  950. - Color(float r, float g, float b) (GC)
  951. - Color* new(float r, float g, float b)
  952. - Color(float r, float g, float b, float a) (GC)
  953. - Color* new(float r, float g, float b, float a)
  954. - void delete()
  955. - bool operator==(const Color& rhs) const
  956. - Color operator*(float rhs) const
  957. - Color operator+(const Color& rhs)
  958. - unsigned ToUInt() const
  959. - Vector3 ToHSL() const
  960. - Vector3 ToHSV() const
  961. - void FromHSL(float h, float s, float l, float a)
  962. - void FromHSV(float h, float s, float v, float a)
  963. - Vector3 ToVector3() const
  964. - Vector4 ToVector4() const
  965. - float SumRGB() const
  966. - float Average() const
  967. - float Luma() const
  968. - float Chroma() const
  969. - float Hue() const
  970. - float SaturationHSL() const
  971. - float SaturationHSV() const
  972. - float Value() const
  973. - float Lightness() const
  974. - float MaxRGB() const
  975. - float MinRGB() const
  976. - float Range() const
  977. - void Clip(bool clipAlpha = false)
  978. - void Invert(bool invertAlpha = false)
  979. - Color Lerp(const Color& rhs, float t) const
  980. - Color Abs() const
  981. - bool Equals(const Color& rhs) const
  982. - String ToString() const
  983. Properties:
  984. - float r
  985. - float g
  986. - float b
  987. - float a
  988. - const Color WHITE
  989. - const Color GRAY
  990. - const Color BLACK
  991. - const Color RED
  992. - const Color GREEN
  993. - const Color BLUE
  994. - const Color CYAN
  995. - const Color MAGENTA
  996. - const Color YELLOW
  997. - const Color TRANSPARENT
  998. <a name="Class_ColorFrame"></a>
  999. ### ColorFrame
  1000. Methods:
  1001. - ColorFrame() (GC)
  1002. - ColorFrame* new()
  1003. - ColorFrame(const Color& color) (GC)
  1004. - ColorFrame* new(const Color& color)
  1005. - ColorFrame(const Color& color, float time) (GC)
  1006. - ColorFrame* new(const Color& color, float time)
  1007. - void delete()
  1008. - Color Interpolate(const ColorFrame& next, float time)
  1009. Properties:
  1010. - Color color
  1011. - float time
  1012. <a name="Class_Component"></a>
  1013. ### Component : Animatable
  1014. Methods:
  1015. - void SetEnabled(bool enable)
  1016. - void Remove()
  1017. - void DrawDebugGeometry(DebugRenderer* debug, bool depthTest)
  1018. - unsigned GetID() const
  1019. - Node* GetNode() const
  1020. - Scene* GetScene() const
  1021. - bool IsEnabled() const
  1022. - bool IsEnabledEffective() const
  1023. - Component* GetComponent(StringHash type) const
  1024. - Component* GetComponent(const String type) const
  1025. Properties:
  1026. - unsigned ID (readonly)
  1027. - bool enabled
  1028. - bool enabledEffective (readonly)
  1029. - Node* node (readonly)
  1030. - Scene* scene (readonly)
  1031. <a name="Class_Connection"></a>
  1032. ### Connection : Object
  1033. Methods:
  1034. - void SendMessage(int msgID, bool reliable, bool inOrder, const VectorBuffer& msg, unsigned contentID = 0)
  1035. - void SendRemoteEvent(StringHash eventType, bool inOrder)
  1036. - void SendRemoteEvent(StringHash eventType, bool inOrder, const VariantMap& eventData)
  1037. - void SendRemoteEvent(const String eventType, bool inOrder)
  1038. - void SendRemoteEvent(const String eventType, bool inOrder, const VariantMap& eventData)
  1039. - void SendRemoteEvent(Node* node, StringHash eventType, bool inOrder)
  1040. - void SendRemoteEvent(Node* node, StringHash eventType, bool inOrder, const VariantMap& eventData)
  1041. - void SendRemoteEvent(Node* node, const String eventType, bool inOrder)
  1042. - void SendRemoteEvent(Node* node, const String eventType, bool inOrder, const VariantMap& eventData)
  1043. - void SetScene(Scene* newScene)
  1044. - void SetIdentity(const VariantMap& identity)
  1045. - void SetControls(const Controls& newControls)
  1046. - void SetPosition(const Vector3& position)
  1047. - void SetRotation(const Quaternion& rotation)
  1048. - void SetConnectPending(bool connectPending)
  1049. - void SetLogStatistics(bool enable)
  1050. - void Disconnect(int waitMSec = 0)
  1051. - void SendPackageToClient(PackageFile* package)
  1052. - VariantMap& GetIdentity()
  1053. - Scene* GetScene() const
  1054. - const Controls& GetControls() const
  1055. - char GetTimeStamp() const
  1056. - const Vector3& GetPosition() const
  1057. - const Quaternion& GetRotation() const
  1058. - bool IsClient() const
  1059. - bool IsConnected() const
  1060. - bool IsConnectPending() const
  1061. - bool IsSceneLoaded() const
  1062. - bool GetLogStatistics() const
  1063. - String GetAddress() const
  1064. - short GetPort() const
  1065. - float GetRoundTripTime() const
  1066. - float GetLastHeardTime() const
  1067. - float GetBytesInPerSec() const
  1068. - float GetBytesOutPerSec() const
  1069. - float GetPacketsInPerSec() const
  1070. - float GetPacketsOutPerSec() const
  1071. - String ToString() const
  1072. - unsigned GetNumDownloads() const
  1073. - const String GetDownloadName() const
  1074. - float GetDownloadProgress() const
  1075. Properties:
  1076. - VariantMap& identity
  1077. - Scene* scene
  1078. - Controls& controls
  1079. - char timeStamp (readonly)
  1080. - Vector3& position
  1081. - Quaternion& rotation
  1082. - bool client (readonly)
  1083. - bool connected (readonly)
  1084. - bool connectPending
  1085. - bool sceneLoaded (readonly)
  1086. - bool logStatistics
  1087. - String address (readonly)
  1088. - short port (readonly)
  1089. - float roundTripTime (readonly)
  1090. - float lastHeardTime (readonly)
  1091. - float bytesInPerSec (readonly)
  1092. - float bytesOutPerSec (readonly)
  1093. - float packetsInPerSec (readonly)
  1094. - float packetsOutPerSec (readonly)
  1095. - unsigned numDownloads (readonly)
  1096. - String downloadName (readonly)
  1097. - float downloadProgress (readonly)
  1098. <a name="Class_Console"></a>
  1099. ### Console : Object
  1100. Methods:
  1101. - void SetDefaultStyle(XMLFile* style)
  1102. - void SetVisible(bool enable)
  1103. - void Toggle()
  1104. - void SetAutoVisibleOnError(bool enable)
  1105. - void SetCommandInterpreter(const String interpreter)
  1106. - void SetNumBufferedRows(unsigned rows)
  1107. - void SetNumRows(unsigned rows)
  1108. - void SetNumHistoryRows(unsigned rows)
  1109. - void SetFocusOnShow(bool enable)
  1110. - void UpdateElements()
  1111. - XMLFile* GetDefaultStyle() const
  1112. - BorderImage* GetBackground() const
  1113. - LineEdit* GetLineEdit() const
  1114. - Button* GetCloseButton() const
  1115. - bool IsVisible() const
  1116. - bool IsAutoVisibleOnError() const
  1117. - const String GetCommandInterpreter() const
  1118. - unsigned GetNumBufferedRows() const
  1119. - unsigned GetNumRows() const
  1120. - void CopySelectedRows() const
  1121. - unsigned GetNumHistoryRows() const
  1122. - unsigned GetHistoryPosition() const
  1123. - const String GetHistoryRow(unsigned index) const
  1124. - bool GetFocusOnShow() const
  1125. Properties:
  1126. - XMLFile* defaultStyle
  1127. - BorderImage* background (readonly)
  1128. - LineEdit* lineEdit (readonly)
  1129. - Button* closeButton (readonly)
  1130. - bool visible
  1131. - bool autoVisibleOnError
  1132. - String commandInterpreter
  1133. - unsigned numBufferedRows
  1134. - unsigned numRows
  1135. - unsigned numHistoryRows
  1136. - unsigned historyPosition (readonly)
  1137. - bool focusOnShow
  1138. <a name="Class_Constraint"></a>
  1139. ### Constraint : Component
  1140. Methods:
  1141. - void SetConstraintType(ConstraintType type)
  1142. - void SetOtherBody(RigidBody* body)
  1143. - void SetPosition(const Vector3& position)
  1144. - void SetRotation(const Quaternion& rotation)
  1145. - void SetAxis(const Vector3& axis)
  1146. - void SetOtherPosition(const Vector3& position)
  1147. - void SetOtherRotation(const Quaternion& rotation)
  1148. - void SetOtherAxis(const Vector3& axis)
  1149. - void SetWorldPosition(const Vector3& position)
  1150. - void SetHighLimit(const Vector2& limit)
  1151. - void SetLowLimit(const Vector2& limit)
  1152. - void SetERP(float erp)
  1153. - void SetCFM(float cfm)
  1154. - void SetDisableCollision(bool disable)
  1155. - PhysicsWorld* GetPhysicsWorld() const
  1156. - ConstraintType GetConstraintType() const
  1157. - RigidBody* GetOwnBody() const
  1158. - RigidBody* GetOtherBody() const
  1159. - const Vector3& GetPosition() const
  1160. - const Quaternion& GetRotation() const
  1161. - const Vector3& GetOtherPosition() const
  1162. - const Quaternion& GetOtherRotation() const
  1163. - Vector3 GetWorldPosition() const
  1164. - const Vector2& GetHighLimit() const
  1165. - const Vector2& GetLowLimit() const
  1166. - float GetERP() const
  1167. - float GetCFM() const
  1168. - bool GetDisableCollision() const
  1169. Properties:
  1170. - PhysicsWorld* physicsWorld (readonly)
  1171. - ConstraintType constraintType
  1172. - RigidBody* ownBody (readonly)
  1173. - RigidBody* otherBody
  1174. - Vector3& position
  1175. - Quaternion& rotation
  1176. - Vector3& axis
  1177. - Vector3& otherPosition
  1178. - Quaternion& otherRotation
  1179. - Vector3& otherAxis
  1180. - Vector3 worldPosition
  1181. - Vector2& highLimit
  1182. - Vector2& lowLimit
  1183. - float ERP
  1184. - float CFM
  1185. - bool disableCollision
  1186. <a name="Class_Constraint2D"></a>
  1187. ### Constraint2D : Component
  1188. Methods:
  1189. - void SetOtherBody(RigidBody2D* body)
  1190. - void SetCollideConnected(bool collideConnected)
  1191. - RigidBody2D* GetOwnerBody() const
  1192. - RigidBody2D* GetOtherBody() const
  1193. - bool GetCollideConnected() const
  1194. Properties:
  1195. - RigidBody2D* ownerBody (readonly)
  1196. - RigidBody2D* otherBody
  1197. - bool collideConnected
  1198. <a name="Class_ConstraintDistance2D"></a>
  1199. ### ConstraintDistance2D : Constraint2D
  1200. Methods:
  1201. - void SetOwnerBodyAnchor(const Vector2& anchor)
  1202. - void SetOtherBodyAnchor(const Vector2& anchor)
  1203. - void SetFrequencyHz(float frequencyHz)
  1204. - void SetDampingRatio(float dampingRatio)
  1205. - const Vector2& GetOwnerBodyAnchor() const
  1206. - const Vector2& GetOtherBodyAnchor() const
  1207. - float GetFrequencyHz() const
  1208. - float GetDampingRatio() const
  1209. Properties:
  1210. - Vector2& ownerBodyAnchor
  1211. - Vector2& otherBodyAnchor
  1212. - float frequencyHz
  1213. - float dampingRatio
  1214. <a name="Class_ConstraintFriction2D"></a>
  1215. ### ConstraintFriction2D : Constraint2D
  1216. Methods:
  1217. - void SetAnchor(const Vector2& anchor)
  1218. - void SetMaxForce(float maxForce)
  1219. - void SetMaxTorque(float maxTorque)
  1220. - const Vector2& GetAnchor() const
  1221. - float GetMaxForce() const
  1222. - float GetMaxTorque() const
  1223. Properties:
  1224. - Vector2& anchor
  1225. - float maxForce
  1226. - float maxTorque
  1227. <a name="Class_ConstraintGear2D"></a>
  1228. ### ConstraintGear2D : Constraint2D
  1229. Methods:
  1230. - void SetOwnerConstraint(Constraint2D* constraint)
  1231. - void SetOtherConstraint(Constraint2D* constraint)
  1232. - void SetRatio(float ratio)
  1233. - Constraint2D* GetOwnerConstraint() const
  1234. - Constraint2D* GetOtherConstraint() const
  1235. - float GetRatio() const
  1236. Properties:
  1237. - Constraint2D* ownerConstraint
  1238. - Constraint2D* otherConstraint
  1239. - float ratio
  1240. <a name="Class_ConstraintMotor2D"></a>
  1241. ### ConstraintMotor2D : Constraint2D
  1242. Methods:
  1243. - void SetLinearOffset(const Vector2& linearOffset)
  1244. - void SetAngularOffset(float angularOffset)
  1245. - void SetMaxForce(float maxForce)
  1246. - void SetMaxTorque(float maxTorque)
  1247. - void SetCorrectionFactor(float correctionFactor)
  1248. - const Vector2& GetLinearOffset() const
  1249. - float GetAngularOffset() const
  1250. - float GetMaxForce() const
  1251. - float GetMaxTorque() const
  1252. - float GetCorrectionFactor() const
  1253. Properties:
  1254. - Vector2& linearOffset
  1255. - float angularOffset
  1256. - float maxForce
  1257. - float maxTorque
  1258. - float correctionFactor
  1259. <a name="Class_ConstraintMouse2D"></a>
  1260. ### ConstraintMouse2D : Constraint2D
  1261. Methods:
  1262. - void SetTarget(const Vector2& target)
  1263. - void SetMaxForce(float maxForce)
  1264. - void SetFrequencyHz(float frequencyHz)
  1265. - void SetDampingRatio(float dampingRatio)
  1266. - const Vector2& GetTarget() const
  1267. - float GetMaxForce() const
  1268. - float GetFrequencyHz() const
  1269. - float GetDampingRatio() const
  1270. Properties:
  1271. - Vector2& target
  1272. - float maxForce
  1273. - float frequencyHz
  1274. - float dampingRatio
  1275. <a name="Class_ConstraintPrismatic2D"></a>
  1276. ### ConstraintPrismatic2D : Constraint2D
  1277. Methods:
  1278. - void SetAnchor(const Vector2& anchor)
  1279. - void SetAxis(const Vector2& axis)
  1280. - void SetEnableLimit(bool enableLimit)
  1281. - void SetLowerTranslation(float lowerTranslation)
  1282. - void SetUpperTranslation(float upperTranslation)
  1283. - void SetEnableMotor(bool enableMotor)
  1284. - void SetMaxMotorForce(float maxMotorForce)
  1285. - void SetMotorSpeed(float motorSpeed)
  1286. - const Vector2& GetAnchor() const
  1287. - const Vector2& GetAxis() const
  1288. - bool GetEnableLimit() const
  1289. - float GetLowerTranslation() const
  1290. - float GetUpperTranslation() const
  1291. - bool GetEnableMotor() const
  1292. - float GetMaxMotorForce() const
  1293. - float GetMotorSpeed() const
  1294. Properties:
  1295. - Vector2& anchor
  1296. - Vector2& axis
  1297. - bool enableLimit
  1298. - float lowerTranslation
  1299. - float upperTranslation
  1300. - bool enableMotor
  1301. - float maxMotorForce
  1302. - float motorSpeed
  1303. <a name="Class_ConstraintPulley2D"></a>
  1304. ### ConstraintPulley2D : Constraint2D
  1305. Methods:
  1306. - void SetOwnerBodyGroundAnchor(const Vector2& groundAnchor)
  1307. - void SetOtherBodyGroundAnchor(const Vector2& groundAnchor)
  1308. - void SetOwnerBodyAnchor(const Vector2& anchor)
  1309. - void SetOtherBodyAnchor(const Vector2& anchor)
  1310. - void SetRatio(float ratio)
  1311. - const Vector2& GetOwnerBodyGroundAnchor() const
  1312. - const Vector2& GetOtherBodyGroundAnchor() const
  1313. - const Vector2& GetOwnerBodyAnchor() const
  1314. - const Vector2& GetOtherBodyAnchor() const
  1315. - float GetRatio() const
  1316. Properties:
  1317. - Vector2& ownerBodyGroundAnchor
  1318. - Vector2& otherBodyGroundAnchor
  1319. - Vector2& ownerBodyAnchor
  1320. - Vector2& otherBodyAnchor
  1321. - float ratio
  1322. <a name="Class_ConstraintRevolute2D"></a>
  1323. ### ConstraintRevolute2D : Constraint2D
  1324. Methods:
  1325. - void SetAnchor(const Vector2& anchor)
  1326. - void SetEnableLimit(bool enableLimit)
  1327. - void SetLowerAngle(float lowerAngle)
  1328. - void SetUpperAngle(float upperAngle)
  1329. - void SetEnableMotor(bool enableMotor)
  1330. - void SetMotorSpeed(float motorSpeed)
  1331. - void SetMaxMotorTorque(float maxMotorTorque)
  1332. - const Vector2& GetAnchor() const
  1333. - bool GetEnableLimit() const
  1334. - float GetLowerAngle() const
  1335. - float GetUpperAngle() const
  1336. - bool GetEnableMotor() const
  1337. - float GetMotorSpeed() const
  1338. - float GetMaxMotorTorque() const
  1339. Properties:
  1340. - Vector2& anchor
  1341. - bool enableLimit
  1342. - float lowerAngle
  1343. - float upperAngle
  1344. - bool enableMotor
  1345. - float motorSpeed
  1346. - float maxMotorTorque
  1347. <a name="Class_ConstraintRope2D"></a>
  1348. ### ConstraintRope2D : Constraint2D
  1349. Methods:
  1350. - void SetOwnerBodyAnchor(const Vector2& anchor)
  1351. - void SetOtherBodyAnchor(const Vector2& anchor)
  1352. - void SetMaxLength(float maxLength)
  1353. - const Vector2& GetOwnerBodyAnchor() const
  1354. - const Vector2& GetOtherBodyAnchor() const
  1355. - float GetMaxLength() const
  1356. Properties:
  1357. - Vector2& ownerBodyAnchor
  1358. - Vector2& otherBodyAnchor
  1359. - float maxLength
  1360. <a name="Class_ConstraintWeld2D"></a>
  1361. ### ConstraintWeld2D : Constraint2D
  1362. Methods:
  1363. - void SetAnchor(const Vector2& anchor)
  1364. - void SetFrequencyHz(float frequencyHz)
  1365. - void SetDampingRatio(float dampingRatio)
  1366. - const Vector2& GetAnchor() const
  1367. - float GetFrequencyHz() const
  1368. - float GetDampingRatio() const
  1369. Properties:
  1370. - Vector2& anchor
  1371. - float frequencyHz
  1372. - float dampingRatio
  1373. <a name="Class_ConstraintWheel2D"></a>
  1374. ### ConstraintWheel2D : Constraint2D
  1375. Methods:
  1376. - void SetAnchor(const Vector2& anchor)
  1377. - void SetAxis(const Vector2& axis)
  1378. - void SetEnableMotor(bool enableMotor)
  1379. - void SetMaxMotorTorque(float maxMotorTorque)
  1380. - void SetMotorSpeed(float motorSpeed)
  1381. - void SetFrequencyHz(float frequencyHz)
  1382. - void SetDampingRatio(float dampingRatio)
  1383. - const Vector2& GetAnchor() const
  1384. - const Vector2& GetAxis() const
  1385. - bool GetEnableMotor() const
  1386. - float GetMaxMotorTorque() const
  1387. - float GetMotorSpeed() const
  1388. - float GetFrequencyHz() const
  1389. - float GetDampingRatio() const
  1390. Properties:
  1391. - Vector2& anchor
  1392. - Vector2& axis
  1393. - bool enableMotor
  1394. - float maxMotorTorque
  1395. - float motorSpeed
  1396. - float frequencyHz
  1397. - float dampingRatio
  1398. <a name="Class_Context"></a>
  1399. ### Context
  1400. Methods:
  1401. - Object* GetEventSender() const
  1402. - EventHandler* GetEventHandler() const
  1403. - const String GetTypeName(StringHash objectType) const
  1404. <a name="Class_Controls"></a>
  1405. ### Controls
  1406. Methods:
  1407. - Controls() (GC)
  1408. - Controls* new()
  1409. - void delete()
  1410. - void Reset()
  1411. - void Set(unsigned buttons, bool down = true)
  1412. - bool IsDown(unsigned button) const
  1413. - bool IsPressed(unsigned button, const Controls& previousControls) const
  1414. Properties:
  1415. - unsigned buttons
  1416. - float yaw
  1417. - float pitch
  1418. - VariantMap extraData
  1419. <a name="Class_CrowdAgent"></a>
  1420. ### CrowdAgent : Component
  1421. Methods:
  1422. - void DrawDebugGeometry(bool depthTest)
  1423. - void SetTargetPosition(const Vector3& position)
  1424. - void SetTargetVelocity(const Vector3& velocity)
  1425. - void ResetTarget()
  1426. - void SetUpdateNodePosition(bool unodepos)
  1427. - void SetMaxAccel(float maxAccel)
  1428. - void SetMaxSpeed(float maxSpeed)
  1429. - void SetRadius(float radius)
  1430. - void SetHeight(float height)
  1431. - void SetQueryFilterType(unsigned queryFilterType)
  1432. - void SetObstacleAvoidanceType(unsigned obstacleOvoidanceType)
  1433. - void SetNavigationQuality(NavigationQuality val)
  1434. - void SetNavigationPushiness(NavigationPushiness val)
  1435. - Vector3 GetPosition() const
  1436. - Vector3 GetDesiredVelocity() const
  1437. - Vector3 GetActualVelocity() const
  1438. - const Vector3& GetTargetPosition() const
  1439. - const Vector3& GetTargetVelocity() const
  1440. - CrowdAgentRequestedTarget GetRequestedTargetType() const
  1441. - CrowdAgentState GetAgentState() const
  1442. - CrowdAgentTargetState GetTargetState() const
  1443. - bool GetUpdateNodePosition() const
  1444. - float GetMaxAccel() const
  1445. - float GetMaxSpeed() const
  1446. - float GetRadius() const
  1447. - float GetHeight() const
  1448. - unsigned GetQueryFilterType() const
  1449. - unsigned GetObstacleAvoidanceType() const
  1450. - NavigationQuality GetNavigationQuality() const
  1451. - NavigationPushiness GetNavigationPushiness() const
  1452. - bool HasRequestedTarget() const
  1453. - bool HasArrived() const
  1454. - bool IsInCrowd() const
  1455. Properties:
  1456. - Vector3 targetPosition
  1457. - Vector3 targetVelocity
  1458. - bool updateNodePosition
  1459. - float maxAccel
  1460. - float maxSpeed
  1461. - float radius
  1462. - float height
  1463. - unsigned queryFilterType
  1464. - unsigned obstacleAvoidanceType
  1465. - NavigationQuality navigationQuality
  1466. - NavigationPushiness navigationPushiness
  1467. - Vector3 position (readonly)
  1468. - Vector3 desiredVelocity (readonly)
  1469. - Vector3 actualVelocity (readonly)
  1470. - CrowdAgentRequestedTarget requestedTargetType (readonly)
  1471. - CrowdAgentState agentState (readonly)
  1472. - CrowdAgentTargetState targetState (readonly)
  1473. - bool requestedTarget (readonly)
  1474. - bool arrived (readonly)
  1475. - bool inCrowd (readonly)
  1476. <a name="Class_CrowdManager"></a>
  1477. ### CrowdManager : Component
  1478. Methods:
  1479. - void DrawDebugGeometry(bool depthTest)
  1480. - void SetCrowdTarget(const Vector3& position, Node* node = 0)
  1481. - void SetCrowdVelocity(const Vector3& velocity, Node* node = 0)
  1482. - void ResetCrowdTarget(Node* node = 0)
  1483. - void SetMaxAgents(unsigned agentCt)
  1484. - void SetMaxAgentRadius(float maxAgentRadius)
  1485. - void SetNavigationMesh(NavigationMesh* navMesh)
  1486. - void SetIncludeFlags(unsigned queryFilterType, short flags)
  1487. - void SetExcludeFlags(unsigned queryFilterType, short flags)
  1488. - void SetAreaCost(unsigned queryFilterType, unsigned areaID, float cost)
  1489. - void SetObstacleAvoidanceParams(unsigned obstacleAvoidanceType, const CrowdObstacleAvoidanceParams& params)
  1490. - PODVector<CrowdAgent*> GetAgents(Node* node = 0, bool inCrowdFilter = true) const
  1491. - Vector3 FindNearestPoint(const Vector3& point, int queryFilterType)
  1492. - Vector3 MoveAlongSurface(const Vector3& start, const Vector3& end, int queryFilterType, int maxVisited = 3)
  1493. - const PODVector<Vector3>& FindPath(const Vector3& start, const Vector3& end, int queryFilterType)
  1494. - Vector3 GetRandomPoint(int queryFilterType)
  1495. - Vector3 GetRandomPointInCircle(const Vector3& center, float radius, int queryFilterType)
  1496. - float GetDistanceToWall(const Vector3& point, float radius, int queryFilterType, Vector3* hitPos = 0, Vector3* hitNormal = 0)
  1497. - Vector3 Raycast(const Vector3& start, const Vector3& end, int queryFilterType, Vector3* hitNormal = 0)
  1498. - unsigned GetMaxAgents() const
  1499. - float GetMaxAgentRadius() const
  1500. - NavigationMesh* GetNavigationMesh() const
  1501. - unsigned GetNumQueryFilterTypes() const
  1502. - unsigned GetNumAreas(unsigned queryFilterType) const
  1503. - short GetIncludeFlags(unsigned queryFilterType) const
  1504. - short GetExcludeFlags(unsigned queryFilterType) const
  1505. - float GetAreaCost(unsigned queryFilterType, unsigned areaID) const
  1506. - unsigned GetNumObstacleAvoidanceTypes() const
  1507. - const CrowdObstacleAvoidanceParams& GetObstacleAvoidanceParams(unsigned obstacleAvoidanceType) const
  1508. Properties:
  1509. - int maxAgents
  1510. - float maxAgentRadius
  1511. - NavigationMesh* navigationMesh
  1512. <a name="Class_Cursor"></a>
  1513. ### Cursor : BorderImage
  1514. Methods:
  1515. - Cursor() (GC)
  1516. - Cursor* new()
  1517. - void delete()
  1518. - void DefineShape(const String shape, Image* image, const IntRect& imageRect, const IntVector2& hotSpot)
  1519. - void DefineShape(CursorShape shape, Image* image, const IntRect& imageRect, const IntVector2& hotSpot)
  1520. - void SetShape(CursorShape shape)
  1521. - void SetShape(const String shape)
  1522. - void SetUseSystemShapes(bool enable)
  1523. - String GetShape() const
  1524. - bool GetUseSystemShapes() const
  1525. Properties:
  1526. - String shape
  1527. - bool useSystemShapes
  1528. <a name="Class_CustomGeometry"></a>
  1529. ### CustomGeometry : Drawable
  1530. Methods:
  1531. - void Clear()
  1532. - void SetNumGeometries(unsigned num)
  1533. - void SetDynamic(bool enable)
  1534. - void BeginGeometry(unsigned index, PrimitiveType type)
  1535. - void DefineVertex(const Vector3& position)
  1536. - void DefineNormal(const Vector3& normal)
  1537. - void DefineTangent(const Vector4& tangent)
  1538. - void DefineColor(const Color& color)
  1539. - void DefineTexCoord(const Vector2& texCoord)
  1540. - void DefineGeometry(unsigned index, PrimitiveType type, unsigned numVertices, bool hasNormals, bool hasColors, bool hasTexCoords, bool hasTangents)
  1541. - void Commit()
  1542. - void SetMaterial(Material* material)
  1543. - bool SetMaterial(unsigned index, Material* material)
  1544. - unsigned GetNumGeometries() const
  1545. - unsigned GetNumVertices(unsigned index) const
  1546. - bool IsDynamic() const
  1547. - Material* GetMaterial(unsigned index = 0)
  1548. - CustomGeometryVertex* GetVertex(unsigned geometryIndex, unsigned vertexNum)
  1549. Properties:
  1550. - Material* material
  1551. - unsigned numGeometries
  1552. - bool dynamic
  1553. <a name="Class_CustomGeometryVertex"></a>
  1554. ### CustomGeometryVertex
  1555. Properties:
  1556. - Vector3 position
  1557. - Vector3 normal
  1558. - unsigned color
  1559. - Vector2 texCoord
  1560. - Vector4 tangent
  1561. <a name="Class_Database"></a>
  1562. ### Database : Object
  1563. Methods:
  1564. - DbConnection* Connect(const String connectionString)
  1565. - void Disconnect(DbConnection* connection)
  1566. - bool IsPooling() const
  1567. - unsigned GetPoolSize() const
  1568. - void SetPoolSize(unsigned poolSize)
  1569. Properties:
  1570. - bool pooling (readonly)
  1571. - unsigned poolSize
  1572. <a name="Class_DbConnection"></a>
  1573. ### DbConnection : Object
  1574. Methods:
  1575. - void Finalize()
  1576. - DbResult Execute(const String sql, bool useCursorEvent = false)
  1577. - const String GetConnectionString() const
  1578. - bool IsConnected() const
  1579. Properties:
  1580. - const String connectionString (readonly)
  1581. - bool connected (readonly)
  1582. <a name="Class_DbResult"></a>
  1583. ### DbResult
  1584. Methods:
  1585. - unsigned GetNumColumns() const
  1586. - unsigned GetNumRows() const
  1587. - long GetNumAffectedRows() const
  1588. Properties:
  1589. - unsigned numColumns (readonly)
  1590. - unsigned numRows (readonly)
  1591. - long numAffectedRows (readonly)
  1592. <a name="Class_DebugHud"></a>
  1593. ### DebugHud : Object
  1594. Methods:
  1595. - void Update()
  1596. - void SetDefaultStyle(XMLFile* style)
  1597. - void SetMode(unsigned mode)
  1598. - void SetProfilerMaxDepth(unsigned depth)
  1599. - void SetProfilerInterval(float interval)
  1600. - void SetUseRendererStats(bool enable)
  1601. - void Toggle(unsigned mode)
  1602. - void ToggleAll()
  1603. - XMLFile* GetDefaultStyle() const
  1604. - Text* GetStatsText() const
  1605. - Text* GetModeText() const
  1606. - Text* GetProfilerText() const
  1607. - unsigned GetMode() const
  1608. - unsigned GetProfilerMaxDepth() const
  1609. - float GetProfilerInterval() const
  1610. - bool GetUseRendererStats() const
  1611. - void SetAppStats(const String label, const Variant stats)
  1612. - void SetAppStats(const String label, const String stats)
  1613. - bool ResetAppStats(const String label)
  1614. - void ClearAppStats()
  1615. Properties:
  1616. - XMLFile* defaultStyle
  1617. - Text* statsText (readonly)
  1618. - Text* modeText (readonly)
  1619. - Text* profilerText (readonly)
  1620. - unsigned mode
  1621. - unsigned profilerMaxDepth
  1622. - float profilerInterval
  1623. - bool useRendererStats
  1624. <a name="Class_DebugRenderer"></a>
  1625. ### DebugRenderer : Component
  1626. Methods:
  1627. - void SetView(Camera* camera)
  1628. - void AddLine(const Vector3& start, const Vector3& end, const Color& color, bool depthTest = true)
  1629. - void AddLine(const Vector3& start, const Vector3& end, unsigned color, bool depthTest = true)
  1630. - void AddTriangle(const Vector3& v1, const Vector3& v2, const Vector3& v3, const Color& color, bool depthTest = true)
  1631. - void AddTriangle(const Vector3& v1, const Vector3& v2, const Vector3& v3, unsigned color, bool depthTest = true)
  1632. - void AddNode(Node* node, float scale = 1.0f, bool depthTest = true)
  1633. - void AddBoundingBox(const BoundingBox& box, const Color& color, bool depthTest = true)
  1634. - void AddBoundingBox(const BoundingBox& box, const Matrix3x4& transform, const Color& color, bool depthTest = true)
  1635. - void AddFrustum(const Frustum& frustum, const Color& color, bool depthTest = true)
  1636. - void AddPolyhedron(const Polyhedron& poly, const Color& color, bool depthTest = true)
  1637. - void AddSphere(const Sphere& sphere, const Color& color, bool depthTest = true)
  1638. - void AddSkeleton(const Skeleton& skeleton, const Color& color, bool depthTest = true)
  1639. - void AddTriangleMesh(const void* vertexData, unsigned vertexSize, const void* indexData, unsigned indexSize, unsigned indexStart, unsigned indexCount, const Matrix3x4& transform, const Color& color, bool depthTest = true)
  1640. - void AddCircle(const Vector3& center, const Vector3& normal, float radius, const Color& color, int steps = 64, bool depthTest = true)
  1641. - void AddCross(const Vector3& center, float size, const Color& color, bool depthTest = true)
  1642. - void AddQuad(const Vector3& center, float width, float height, const Color& color, bool depthTest = true)
  1643. - void Render()
  1644. - const Matrix3x4& GetView() const
  1645. - const Matrix4& GetProjection() const
  1646. - const Frustum& GetFrustum() const
  1647. - bool IsInside(const BoundingBox& box) const
  1648. Properties:
  1649. - Matrix3x4& view (readonly)
  1650. - Matrix4& projection (readonly)
  1651. - Frustum& frustum (readonly)
  1652. <a name="Class_DecalSet"></a>
  1653. ### DecalSet : Drawable
  1654. Methods:
  1655. - void SetMaterial(Material* material)
  1656. - void SetMaxVertices(unsigned num)
  1657. - void SetMaxIndices(unsigned num)
  1658. - bool AddDecal(Drawable* target, const Vector3& worldPosition, const Quaternion& worldRotation, float size, float aspectRatio, float depth, const Vector2& topLeftUV, const Vector2& bottomRightUV, float timeToLive = 0.0f, float normalCutoff = 0.1f, unsigned subGeometry = M_MAX_UNSIGNED)
  1659. - void RemoveDecals(unsigned num)
  1660. - void RemoveAllDecals()
  1661. - Material* GetMaterial() const
  1662. - unsigned GetNumDecals() const
  1663. - unsigned GetNumVertices() const
  1664. - unsigned GetNumIndices() const
  1665. - unsigned GetMaxVertices() const
  1666. - unsigned GetMaxIndices() const
  1667. Properties:
  1668. - Material* material
  1669. - unsigned numDecals (readonly)
  1670. - unsigned numVertices (readonly)
  1671. - unsigned numIndices (readonly)
  1672. - unsigned maxVertices
  1673. - unsigned maxIndices
  1674. <a name="Class_Deserializer"></a>
  1675. ### Deserializer
  1676. Methods:
  1677. - VectorBuffer Read(unsigned size)
  1678. - unsigned Seek(unsigned position)
  1679. - const String GetName() const
  1680. - unsigned GetChecksum()
  1681. - unsigned GetPosition() const
  1682. - unsigned GetSize() const
  1683. - bool IsEof() const
  1684. - int ReadInt()
  1685. - long ReadInt64()
  1686. - short ReadShort()
  1687. - char ReadByte()
  1688. - unsigned ReadUInt()
  1689. - long ReadUInt64()
  1690. - short ReadUShort()
  1691. - char ReadUByte()
  1692. - bool ReadBool()
  1693. - float ReadFloat()
  1694. - double ReadDouble()
  1695. - IntRect ReadIntRect()
  1696. - IntVector2 ReadIntVector2()
  1697. - Rect ReadRect()
  1698. - Vector2 ReadVector2()
  1699. - Vector3 ReadVector3()
  1700. - Vector3 ReadPackedVector3(float maxAbsCoord)
  1701. - Vector4 ReadVector4()
  1702. - Quaternion ReadQuaternion()
  1703. - Quaternion ReadPackedQuaternion()
  1704. - Matrix3 ReadMatrix3()
  1705. - Matrix3x4 ReadMatrix3x4()
  1706. - Matrix4 ReadMatrix4()
  1707. - Color ReadColor()
  1708. - BoundingBox ReadBoundingBox()
  1709. - String ReadString()
  1710. - String ReadFileID()
  1711. - StringHash ReadStringHash()
  1712. - VectorBuffer ReadBuffer()
  1713. - ResourceRef ReadResourceRef()
  1714. - ResourceRefList ReadResourceRefList()
  1715. - Variant ReadVariant()
  1716. - Variant ReadVariant(VariantType type)
  1717. - VariantVector ReadVariantVector()
  1718. - VariantMap ReadVariantMap()
  1719. - unsigned ReadVLE()
  1720. - unsigned ReadNetID()
  1721. - String ReadLine()
  1722. Properties:
  1723. - String name (readonly)
  1724. - unsigned checksum (readonly)
  1725. - unsigned position (readonly)
  1726. - unsigned size (readonly)
  1727. - bool eof (readonly)
  1728. <a name="Class_Drawable"></a>
  1729. ### Drawable : Component
  1730. Methods:
  1731. - void SetDrawDistance(float distance)
  1732. - void SetShadowDistance(float distance)
  1733. - void SetLodBias(float bias)
  1734. - void SetViewMask(unsigned mask)
  1735. - void SetLightMask(unsigned mask)
  1736. - void SetShadowMask(unsigned mask)
  1737. - void SetZoneMask(unsigned mask)
  1738. - void SetMaxLights(unsigned num)
  1739. - void SetCastShadows(bool enable)
  1740. - void SetOccluder(bool enable)
  1741. - void SetOccludee(bool enable)
  1742. - void MarkForUpdate()
  1743. - const BoundingBox& GetBoundingBox() const
  1744. - const BoundingBox& GetWorldBoundingBox()
  1745. - char GetDrawableFlags() const
  1746. - float GetDrawDistance() const
  1747. - float GetShadowDistance() const
  1748. - float GetLodBias() const
  1749. - unsigned GetViewMask() const
  1750. - unsigned GetLightMask() const
  1751. - unsigned GetShadowMask() const
  1752. - unsigned GetZoneMask() const
  1753. - unsigned GetMaxLights() const
  1754. - bool GetCastShadows() const
  1755. - bool IsOccluder() const
  1756. - bool IsOccludee() const
  1757. - bool IsInView() const
  1758. - bool IsInView(Camera* tolua_var_2) const
  1759. - Zone* GetZone() const
  1760. Properties:
  1761. - BoundingBox& worldBoundingBox (readonly)
  1762. - char drawableFlags (readonly)
  1763. - float drawDistance
  1764. - float shadowDistance
  1765. - float lodBias
  1766. - unsigned viewMask
  1767. - unsigned lightMask
  1768. - unsigned shadowMask
  1769. - unsigned zoneMask
  1770. - unsigned maxLights
  1771. - bool castShadows
  1772. - bool occluder
  1773. - bool occludee
  1774. - bool inView (readonly)
  1775. - Zone* zone (readonly)
  1776. <a name="Class_Drawable2D"></a>
  1777. ### Drawable2D : Drawable
  1778. Methods:
  1779. - void SetLayer(int layer)
  1780. - void SetOrderInLayer(int orderInLayer)
  1781. - int GetLayer() const
  1782. - int GetOrderInLayer() const
  1783. Properties:
  1784. - int layer
  1785. - int orderInLayer
  1786. <a name="Class_DropDownList"></a>
  1787. ### DropDownList : Menu
  1788. Methods:
  1789. - DropDownList() (GC)
  1790. - DropDownList* new()
  1791. - void delete()
  1792. - void AddItem(UIElement* item)
  1793. - void InsertItem(unsigned index, UIElement* item)
  1794. - void RemoveItem(UIElement* item)
  1795. - void RemoveItem(unsigned index)
  1796. - void RemoveAllItems()
  1797. - void SetSelection(unsigned index)
  1798. - void SetPlaceholderText(const String text)
  1799. - void SetResizePopup(bool enable)
  1800. - unsigned GetNumItems() const
  1801. - UIElement* GetItem(unsigned index) const
  1802. - const PODVector<UIElement*>& GetItems() const
  1803. - unsigned GetSelection() const
  1804. - UIElement* GetSelectedItem() const
  1805. - ListView* GetListView() const
  1806. - UIElement* GetPlaceholder() const
  1807. - const String GetPlaceholderText() const
  1808. - bool GetResizePopup() const
  1809. Properties:
  1810. - unsigned numItems (readonly)
  1811. - unsigned selection
  1812. - UIElement* selectedItem (readonly)
  1813. - ListView* listView (readonly)
  1814. - UIElement* placeholder (readonly)
  1815. - String placeholderText
  1816. - bool resizePopup
  1817. <a name="Class_DynamicNavigationMesh"></a>
  1818. ### DynamicNavigationMesh : NavigationMesh
  1819. Methods:
  1820. - void SetDrawObstacles(bool enable)
  1821. - void SetMaxLayers(unsigned maxLayers)
  1822. - void SetMaxObstacles(unsigned maxObstacles)
  1823. - bool GetDrawObstacles() const
  1824. - unsigned GetMaxLayers() const
  1825. - unsigned GetMaxObstacles() const
  1826. Properties:
  1827. - bool drawObstacles
  1828. - int maxObstacles
  1829. - unsigned maxLayers
  1830. <a name="Class_Engine"></a>
  1831. ### Engine : Object
  1832. Methods:
  1833. - void RunFrame()
  1834. - Console* CreateConsole()
  1835. - DebugHud* CreateDebugHud()
  1836. - void SetMinFps(int fps)
  1837. - void SetMaxFps(int fps)
  1838. - void SetMaxInactiveFps(int fps)
  1839. - void SetTimeStepSmoothing(int frames)
  1840. - void SetPauseMinimized(bool enable)
  1841. - void SetAutoExit(bool enable)
  1842. - void Exit()
  1843. - void DumpProfiler()
  1844. - void DumpResources(bool dumpFileName = false)
  1845. - void DumpMemory()
  1846. - int GetMinFps() const
  1847. - int GetMaxFps() const
  1848. - int GetMaxInactiveFps() const
  1849. - int GetTimeStepSmoothing() const
  1850. - bool GetPauseMinimized() const
  1851. - bool GetAutoExit() const
  1852. - bool IsInitialized() const
  1853. - bool IsExiting() const
  1854. - bool IsHeadless() const
  1855. Properties:
  1856. - int minFps
  1857. - int maxFps
  1858. - int maxInactiveFps
  1859. - int timeStepSmoothing
  1860. - bool pauseMinimized
  1861. - bool autoExit
  1862. - bool initialized (readonly)
  1863. - bool exiting (readonly)
  1864. - bool headless (readonly)
  1865. <a name="Class_File"></a>
  1866. ### File : Object
  1867. Methods:
  1868. - File() (GC)
  1869. - File* new()
  1870. - File(const String fileName, FileMode mode = FILE_READ) (GC)
  1871. - File* new(const String fileName, FileMode mode = FILE_READ)
  1872. - File(PackageFile* package, const String fileName) (GC)
  1873. - File* new(PackageFile* package, const String fileName)
  1874. - void delete()
  1875. - bool Open(const String fileName, FileMode mode = FILE_READ)
  1876. - bool Open(PackageFile* package, const String fileName)
  1877. - void Close()
  1878. - void Flush()
  1879. - void SetName(const String name)
  1880. - FileMode GetMode() const
  1881. - bool IsOpen() const
  1882. - void* GetHandle() const
  1883. - bool IsPackaged() const
  1884. - VectorBuffer Read(unsigned size)
  1885. - unsigned Seek(unsigned position)
  1886. - const String GetName() const
  1887. - unsigned GetChecksum()
  1888. - unsigned GetPosition() const
  1889. - unsigned GetSize() const
  1890. - bool IsEof() const
  1891. - int ReadInt()
  1892. - long ReadInt64()
  1893. - short ReadShort()
  1894. - char ReadByte()
  1895. - unsigned ReadUInt()
  1896. - long ReadUInt64()
  1897. - short ReadUShort()
  1898. - char ReadUByte()
  1899. - bool ReadBool()
  1900. - float ReadFloat()
  1901. - double ReadDouble()
  1902. - IntRect ReadIntRect()
  1903. - IntVector2 ReadIntVector2()
  1904. - Rect ReadRect()
  1905. - Vector2 ReadVector2()
  1906. - Vector3 ReadVector3()
  1907. - Vector3 ReadPackedVector3(float maxAbsCoord)
  1908. - Vector4 ReadVector4()
  1909. - Quaternion ReadQuaternion()
  1910. - Quaternion ReadPackedQuaternion()
  1911. - Matrix3 ReadMatrix3()
  1912. - Matrix3x4 ReadMatrix3x4()
  1913. - Matrix4 ReadMatrix4()
  1914. - Color ReadColor()
  1915. - BoundingBox ReadBoundingBox()
  1916. - String ReadString()
  1917. - String ReadFileID()
  1918. - StringHash ReadStringHash()
  1919. - VectorBuffer ReadBuffer()
  1920. - ResourceRef ReadResourceRef()
  1921. - ResourceRefList ReadResourceRefList()
  1922. - Variant ReadVariant()
  1923. - Variant ReadVariant(VariantType type)
  1924. - VariantVector ReadVariantVector()
  1925. - VariantMap ReadVariantMap()
  1926. - unsigned ReadVLE()
  1927. - unsigned ReadNetID()
  1928. - String ReadLine()
  1929. - unsigned Write(const VectorBuffer& buffer)
  1930. - bool WriteInt(int value)
  1931. - bool WriteInt64(long value)
  1932. - bool WriteShort(short value)
  1933. - bool WriteByte(char value)
  1934. - bool WriteUInt(unsigned value)
  1935. - bool WriteUInt64(long value)
  1936. - bool WriteUShort(short value)
  1937. - bool WriteUByte(char value)
  1938. - bool WriteBool(bool value)
  1939. - bool WriteFloat(float value)
  1940. - bool WriteDouble(double value)
  1941. - bool WriteIntRect(const IntRect& value)
  1942. - bool WriteIntVector2(const IntVector2& value)
  1943. - bool WriteRect(const Rect& value)
  1944. - bool WriteVector2(const Vector2& value)
  1945. - bool WriteVector3(const Vector3& value)
  1946. - bool WritePackedVector3(const Vector3& value, float maxAbsCoord)
  1947. - bool WriteVector4(const Vector4& value)
  1948. - bool WriteQuaternion(const Quaternion& value)
  1949. - bool WritePackedQuaternion(const Quaternion& value)
  1950. - bool WriteMatrix3(const Matrix3& value)
  1951. - bool WriteMatrix3x4(const Matrix3x4& value)
  1952. - bool WriteMatrix4(const Matrix4& value)
  1953. - bool WriteColor(const Color& value)
  1954. - bool WriteBoundingBox(const BoundingBox& value)
  1955. - bool WriteString(const String value)
  1956. - bool WriteFileID(const String value)
  1957. - bool WriteStringHash(const StringHash& value)
  1958. - bool WriteBuffer(const VectorBuffer& buffer)
  1959. - bool WriteResourceRef(const ResourceRef& value)
  1960. - bool WriteResourceRefList(const ResourceRefList& value)
  1961. - bool WriteVariant(const Variant& value)
  1962. - bool WriteVariantData(const Variant& value)
  1963. - bool WriteVariantVector(const VariantVector& value)
  1964. - bool WriteVariantMap(const VariantMap& value)
  1965. - bool WriteVLE(unsigned value)
  1966. - bool WriteNetID(unsigned value)
  1967. - bool WriteLine(const String value)
  1968. Properties:
  1969. - FileMode mode (readonly)
  1970. - bool open (readonly)
  1971. - bool packaged (readonly)
  1972. - String name (readonly)
  1973. - unsigned checksum (readonly)
  1974. - unsigned position (readonly)
  1975. - unsigned size (readonly)
  1976. - bool eof (readonly)
  1977. <a name="Class_FileSelector"></a>
  1978. ### FileSelector : Object
  1979. Methods:
  1980. - FileSelector() (GC)
  1981. - FileSelector* new()
  1982. - void delete()
  1983. - void SetDefaultStyle(XMLFile* style)
  1984. - void SetTitle(const String text)
  1985. - void SetButtonTexts(const String okText, const String cancelText)
  1986. - void SetPath(const String path)
  1987. - void SetFileName(const String fileName)
  1988. - void SetFilters(const Vector<String>& filters, unsigned defaultIndex)
  1989. - void SetDirectoryMode(bool enable)
  1990. - void UpdateElements()
  1991. - XMLFile* GetDefaultStyle() const
  1992. - Window* GetWindow() const
  1993. - Text* GetTitleText() const
  1994. - ListView* GetFileList() const
  1995. - LineEdit* GetPathEdit() const
  1996. - LineEdit* GetFileNameEdit() const
  1997. - DropDownList* GetFilterList() const
  1998. - Button* GetOKButton() const
  1999. - Button* GetCancelButton() const
  2000. - Button* GetCloseButton() const
  2001. - const String GetTitle() const
  2002. - const String GetPath() const
  2003. - const String GetFileName() const
  2004. - const String GetFilter() const
  2005. - unsigned GetFilterIndex() const
  2006. - bool GetDirectoryMode() const
  2007. Properties:
  2008. - XMLFile* defaultStyle
  2009. - Window* window (readonly)
  2010. - Text* titleText (readonly)
  2011. - ListView* fileList (readonly)
  2012. - LineEdit* pathEdit (readonly)
  2013. - LineEdit* fileNameEdit (readonly)
  2014. - DropDownList* filterList (readonly)
  2015. - Button* OKButton (readonly)
  2016. - Button* cancelButton (readonly)
  2017. - Button* closeButton (readonly)
  2018. - String title
  2019. - String path
  2020. - String fileName
  2021. - String filter (readonly)
  2022. - unsigned filterIndex (readonly)
  2023. - bool directoryMode
  2024. <a name="Class_FileSelectorEntry"></a>
  2025. ### FileSelectorEntry
  2026. Properties:
  2027. - String name
  2028. - bool directory
  2029. <a name="Class_FileSystem"></a>
  2030. ### FileSystem : Object
  2031. Methods:
  2032. - bool SetCurrentDir(const String pathName)
  2033. - bool CreateDir(const String pathName)
  2034. - void SetExecuteConsoleCommands(bool enable)
  2035. - int SystemCommand(const String commandLine, bool redirectStdOutToLog = false)
  2036. - int SystemRun(const String fileName, const Vector<String>& arguments)
  2037. - unsigned SystemCommandAsync(const String commandLine)
  2038. - unsigned SystemRunAsync(const String fileName, const Vector<String>& arguments)
  2039. - bool SystemOpen(const String fileName, const String mode = String::EMPTY)
  2040. - bool Copy(const String srcFileName, const String destFileName)
  2041. - bool Rename(const String srcFileName, const String destFileName)
  2042. - bool Delete(const String fileName)
  2043. - bool SetLastModifiedTime(const String fileName, unsigned newTime)
  2044. - String GetCurrentDir() const
  2045. - bool GetExecuteConsoleCommands() const
  2046. - bool HasRegisteredPaths() const
  2047. - bool CheckAccess(const String pathName) const
  2048. - unsigned GetLastModifiedTime(const String fileName) const
  2049. - bool FileExists(const String fileName) const
  2050. - bool DirExists(const String pathName) const
  2051. - const Vector<String>& ScanDir(const String pathName, const String filter, unsigned flags, bool recursive) const
  2052. - String GetProgramDir() const
  2053. - String GetUserDocumentsDir() const
  2054. - String GetAppPreferencesDir(const String org, const String app) const
  2055. <a name="Class_FocusParameters"></a>
  2056. ### FocusParameters
  2057. Methods:
  2058. - FocusParameters() (GC)
  2059. - FocusParameters* new()
  2060. - FocusParameters(bool focus, bool nonUniform, bool autoSize, float quantize, float minView) (GC)
  2061. - FocusParameters* new(bool focus, bool nonUniform, bool autoSize, float quantize, float minView)
  2062. - void delete()
  2063. Properties:
  2064. - bool focus
  2065. - bool nonUniform
  2066. - bool autoSize
  2067. - float quantize
  2068. - float minView
  2069. <a name="Class_Font"></a>
  2070. ### Font : Resource
  2071. Methods:
  2072. - void SetAbsoluteGlyphOffset(const IntVector2& offset)
  2073. - void SetScaledGlyphOffset(const Vector2& offset)
  2074. - const IntVector2& GetAbsoluteGlyphOffset() const
  2075. - const Vector2& GetScaledGlyphOffset() const
  2076. - IntVector2 GetTotalGlyphOffset(int pointSize) const
  2077. - bool IsSDFFont() const
  2078. Properties:
  2079. - IntVector2 absoluteGlyphOffset
  2080. - Vector2 scaledGlyphOffset
  2081. <a name="Class_Frustum"></a>
  2082. ### Frustum
  2083. Methods:
  2084. - Frustum() (GC)
  2085. - Frustum* new()
  2086. - Frustum(const Frustum& frustum) (GC)
  2087. - Frustum* new(const Frustum& frustum)
  2088. - void delete()
  2089. - void Define(float fov, float aspectRatio, float zoom, float nearZ, float farZ)
  2090. - void Define(float fov, float aspectRatio, float zoom, float nearZ, float farZ, const Matrix3x4& transform)
  2091. - void Define(const Vector3& near, const Vector3& far)
  2092. - void Define(const Vector3& near, const Vector3& far, const Matrix3x4& transform)
  2093. - void Define(const BoundingBox& box)
  2094. - void Define(const BoundingBox& box, const Matrix3x4& transform)
  2095. - void Define(const Matrix4& projection)
  2096. - void DefineOrtho(float orthoSize, float aspectRatio, float zoom, float nearZ, float farZ)
  2097. - void DefineOrtho(float orthoSize, float aspectRatio, float zoom, float nearZ, float farZ, const Matrix3x4& transform)
  2098. - void DefineSplit(const Matrix4& projection, float near, float far)
  2099. - void Transform(const Matrix3& transform)
  2100. - void Transform(const Matrix3x4& transform)
  2101. - Intersection IsInside(const Vector3& point) const
  2102. - Intersection IsInside(const Sphere& sphere) const
  2103. - Intersection IsInsideFast(const Sphere& sphere) const
  2104. - Intersection IsInside(const BoundingBox& box) const
  2105. - Intersection IsInsideFast(const BoundingBox& box) const
  2106. - float Distance(const Vector3& point) const
  2107. - Frustum Transformed(const Matrix3& transform) const
  2108. - Frustum Transformed(const Matrix3x4& transform) const
  2109. - Rect Projected(const Matrix4& transform) const
  2110. - void UpdatePlanes()
  2111. <a name="Class_Geometry"></a>
  2112. ### Geometry : Object
  2113. Methods:
  2114. - Geometry() (GC)
  2115. - Geometry* new()
  2116. - void delete()
  2117. - bool SetNumVertexBuffers(unsigned num)
  2118. - bool SetVertexBuffer(unsigned index, VertexBuffer* buffer)
  2119. - void SetIndexBuffer(IndexBuffer* buffer)
  2120. - bool SetDrawRange(PrimitiveType type, unsigned indexStart, unsigned indexCount, bool getUsedVertexRange = true)
  2121. - bool SetDrawRange(PrimitiveType type, unsigned indexStart, unsigned indexCount, unsigned vertexStart, unsigned vertexCount, bool checkIllegal = true)
  2122. - void SetLodDistance(float distance)
  2123. - unsigned GetNumVertexBuffers() const
  2124. - VertexBuffer* GetVertexBuffer(unsigned index) const
  2125. - IndexBuffer* GetIndexBuffer() const
  2126. - PrimitiveType GetPrimitiveType() const
  2127. - unsigned GetIndexStart() const
  2128. - unsigned GetIndexCount() const
  2129. - unsigned GetVertexStart() const
  2130. - unsigned GetVertexCount() const
  2131. - float GetLodDistance()
  2132. - bool IsEmpty() const
  2133. Properties:
  2134. - unsigned numVertexBuffers
  2135. - IndexBuffer* indexBuffer
  2136. - PrimitiveType primitiveType (readonly)
  2137. - unsigned indexStart (readonly)
  2138. - unsigned indexCount (readonly)
  2139. - unsigned vertexStart (readonly)
  2140. - unsigned vertexCount (readonly)
  2141. - float lodDistance
  2142. - bool empty (readonly)
  2143. <a name="Class_Graphics"></a>
  2144. ### Graphics : Object
  2145. Methods:
  2146. - void SetWindowTitle(const String windowTitle)
  2147. - void SetWindowIcon(Image* windowIcon)
  2148. - void SetWindowPosition(const IntVector2& position)
  2149. - void SetWindowPosition(int x, int y)
  2150. - bool SetMode(int width, int height, bool fullscreen, bool borderless, bool resizable, bool highDPI, bool vsync, bool tripleBuffer, int multiSample)
  2151. - bool SetMode(int width, int height)
  2152. - void SetSRGB(bool enable)
  2153. - void SetDither(bool enable)
  2154. - void SetFlushGPU(bool enable)
  2155. - void SetOrientations(const String orientations)
  2156. - bool ToggleFullscreen()
  2157. - void Maximize()
  2158. - void Minimize()
  2159. - void Close()
  2160. - bool TakeScreenShot(Image& destImage)
  2161. - void BeginDumpShaders(const String fileName)
  2162. - void EndDumpShaders()
  2163. - void PrecacheShaders(Deserializer& source)
  2164. - void PrecacheShaders(const String fileName)
  2165. - bool IsInitialized() const
  2166. - void* GetExternalWindow() const
  2167. - const String GetWindowTitle() const
  2168. - const String GetApiName() const
  2169. - IntVector2 GetWindowPosition() const
  2170. - int GetWidth() const
  2171. - int GetHeight() const
  2172. - int GetMultiSample() const
  2173. - bool GetFullscreen() const
  2174. - bool GetResizable() const
  2175. - bool GetBorderless() const
  2176. - bool GetVSync() const
  2177. - bool GetTripleBuffer() const
  2178. - bool GetSRGB() const
  2179. - bool GetDither() const
  2180. - bool GetFlushGPU() const
  2181. - const String GetOrientations() const
  2182. - bool IsDeviceLost() const
  2183. - unsigned GetNumPrimitives() const
  2184. - unsigned GetNumBatches() const
  2185. - unsigned GetDummyColorFormat() const
  2186. - unsigned GetShadowMapFormat() const
  2187. - unsigned GetHiresShadowMapFormat() const
  2188. - bool GetInstancingSupport() const
  2189. - bool GetLightPrepassSupport() const
  2190. - bool GetDeferredSupport() const
  2191. - bool GetHardwareShadowSupport() const
  2192. - bool GetReadableDepthSupport() const
  2193. - bool GetSRGBSupport() const
  2194. - bool GetSRGBWriteSupport() const
  2195. - IntVector2 GetDesktopResolution() const
  2196. - unsigned GetAlphaFormat()
  2197. - unsigned GetLuminanceFormat()
  2198. - unsigned GetLuminanceAlphaFormat()
  2199. - unsigned GetRGBFormat()
  2200. - unsigned GetRGBAFormat()
  2201. - unsigned GetRGBA16Format()
  2202. - unsigned GetRGBAFloat16Format()
  2203. - unsigned GetRGBAFloat32Format()
  2204. - unsigned GetRG16Format()
  2205. - unsigned GetRGFloat16Format()
  2206. - unsigned GetRGFloat32Format()
  2207. - unsigned GetFloat16Format()
  2208. - unsigned GetFloat32Format()
  2209. - unsigned GetLinearDepthFormat()
  2210. - unsigned GetDepthStencilFormat()
  2211. - unsigned GetReadableDepthFormat()
  2212. - unsigned GetFormat(const String formatName)
  2213. - unsigned GetMaxBones()
  2214. Properties:
  2215. - bool initialized (readonly)
  2216. - String windowTitle
  2217. - String apiName (readonly)
  2218. - IntVector2 windowPosition
  2219. - int width (readonly)
  2220. - int height (readonly)
  2221. - int multiSample (readonly)
  2222. - bool fullscreen (readonly)
  2223. - bool resizable (readonly)
  2224. - bool borderless (readonly)
  2225. - bool vSync (readonly)
  2226. - bool tripleBuffer (readonly)
  2227. - bool sRGB
  2228. - bool dither
  2229. - bool flushGPU
  2230. - String orientations
  2231. - bool deviceLost (readonly)
  2232. - unsigned numPrimitives (readonly)
  2233. - unsigned numBatches (readonly)
  2234. - unsigned dummyColorFormat (readonly)
  2235. - unsigned shadowMapFormat (readonly)
  2236. - unsigned hiresShadowMapFormat (readonly)
  2237. - bool instancingSupport (readonly)
  2238. - bool lightPrepassSupport (readonly)
  2239. - bool deferredSupport (readonly)
  2240. - bool hardwareShadowSupport (readonly)
  2241. - bool readableDepthSupport (readonly)
  2242. - bool sRGBSupport (readonly)
  2243. - bool sRGBWriteSupport (readonly)
  2244. - IntVector2 desktopResolution (readonly)
  2245. <a name="Class_HierarchyContainer"></a>
  2246. ### HierarchyContainer : UIElement
  2247. <a name="Class_HttpRequest"></a>
  2248. ### HttpRequest
  2249. Methods:
  2250. - const String GetURL() const
  2251. - const String GetVerb() const
  2252. - String GetError() const
  2253. - HttpRequestState GetState() const
  2254. - unsigned GetAvailableSize() const
  2255. - bool IsOpen() const
  2256. - VectorBuffer Read(unsigned size)
  2257. - bool IsEof() const
  2258. - int ReadInt()
  2259. - short ReadShort()
  2260. - char ReadByte()
  2261. - unsigned ReadUInt()
  2262. - short ReadUShort()
  2263. - char ReadUByte()
  2264. - bool ReadBool()
  2265. - float ReadFloat()
  2266. - double ReadDouble()
  2267. - IntRect ReadIntRect()
  2268. - IntVector2 ReadIntVector2()
  2269. - Rect ReadRect()
  2270. - Vector2 ReadVector2()
  2271. - Vector3 ReadVector3()
  2272. - Vector3 ReadPackedVector3(float maxAbsCoord)
  2273. - Vector4 ReadVector4()
  2274. - Quaternion ReadQuaternion()
  2275. - Quaternion ReadPackedQuaternion()
  2276. - Matrix3 ReadMatrix3()
  2277. - Matrix3x4 ReadMatrix3x4()
  2278. - Matrix4 ReadMatrix4()
  2279. - Color ReadColor()
  2280. - BoundingBox ReadBoundingBox()
  2281. - String ReadString()
  2282. - String ReadFileID()
  2283. - StringHash ReadStringHash()
  2284. - VectorBuffer ReadBuffer()
  2285. - ResourceRef ReadResourceRef()
  2286. - ResourceRefList ReadResourceRefList()
  2287. - Variant ReadVariant()
  2288. - Variant ReadVariant(VariantType type)
  2289. - VariantVector ReadVariantVector()
  2290. - VariantMap ReadVariantMap()
  2291. - unsigned ReadVLE()
  2292. - unsigned ReadNetID()
  2293. - String ReadLine()
  2294. Properties:
  2295. - String URL (readonly)
  2296. - String verb (readonly)
  2297. - String error (readonly)
  2298. - HttpRequestState state (readonly)
  2299. - unsigned availableSize (readonly)
  2300. - bool open (readonly)
  2301. <a name="Class_Image"></a>
  2302. ### Image : Resource
  2303. Methods:
  2304. - Image() (GC)
  2305. - Image* new()
  2306. - void delete()
  2307. - bool SetSize(int width, int height, unsigned components)
  2308. - bool SetSize(int width, int height, int depth, unsigned components)
  2309. - void SetPixel(int x, int y, const Color& color)
  2310. - void SetPixel(int x, int y, int z, const Color& color)
  2311. - void SetPixelInt(int x, int y, unsigned uintColor)
  2312. - void SetPixelInt(int x, int y, int z, unsigned uintColor)
  2313. - bool LoadColorLUT(Deserializer& source)
  2314. - bool LoadColorLUT(const String fileName)
  2315. - bool FlipHorizontal()
  2316. - bool FlipVertical()
  2317. - bool Resize(int width, int height)
  2318. - void Clear(const Color& color)
  2319. - void ClearInt(unsigned uintColor)
  2320. - bool SaveBMP(const String fileName) const
  2321. - bool SavePNG(const String fileName) const
  2322. - bool SaveTGA(const String fileName) const
  2323. - bool SaveJPG(const String fileName, int quality) const
  2324. - Color GetPixel(int x, int y) const
  2325. - Color GetPixel(int x, int y, int z) const
  2326. - unsigned GetPixelInt(int x, int y) const
  2327. - unsigned GetPixelInt(int x, int y, int z) const
  2328. - Color GetPixelBilinear(float x, float y) const
  2329. - Color GetPixelTrilinear(float x, float y, float z) const
  2330. - int GetWidth() const
  2331. - int GetHeight() const
  2332. - int GetDepth() const
  2333. - unsigned GetComponents() const
  2334. - bool IsCompressed() const
  2335. - CompressedFormat GetCompressedFormat() const
  2336. - unsigned GetNumCompressedLevels() const
  2337. - Image* GetSubimage(const IntRect& rect) const
  2338. - bool IsCubemap() const
  2339. - bool IsArray() const
  2340. - bool IsSRGB() const
  2341. Properties:
  2342. - int width (readonly)
  2343. - int height (readonly)
  2344. - int depth (readonly)
  2345. - unsigned components (readonly)
  2346. - bool compressed (readonly)
  2347. - CompressedFormat compressedFormat (readonly)
  2348. - unsigned numCompressedLevels (readonly)
  2349. - bool cubemap (readonly)
  2350. - bool array (readonly)
  2351. - bool sRGB (readonly)
  2352. <a name="Class_IndexBuffer"></a>
  2353. ### IndexBuffer : Object
  2354. Methods:
  2355. - IndexBuffer() (GC)
  2356. - IndexBuffer* new()
  2357. - void delete()
  2358. - void SetShadowed(bool enable)
  2359. - bool SetSize(unsigned indexCount, bool largeIndices, bool dynamic = false)
  2360. - bool SetData(VectorBuffer& data)
  2361. - bool SetDataRange(VectorBuffer& data, unsigned start, unsigned count, bool discard = false)
  2362. - VectorBuffer GetData()
  2363. - bool IsShadowed() const
  2364. - bool IsDynamic() const
  2365. - unsigned GetIndexCount() const
  2366. - unsigned GetIndexSize() const
  2367. Properties:
  2368. - bool shadowed
  2369. - bool dynamic (readonly)
  2370. - unsigned indexCount (readonly)
  2371. - unsigned indexSize (readonly)
  2372. <a name="Class_Input"></a>
  2373. ### Input : Object
  2374. Methods:
  2375. - void SetToggleFullscreen(bool enable)
  2376. - void SetMouseVisible(bool enable, bool suppressEvent = false)
  2377. - void SetMouseGrabbed(bool grab, bool suppressEvent = false)
  2378. - void SetMouseMode(MouseMode mode, bool suppressEvent = false)
  2379. - bool IsMouseLocked()
  2380. - int AddScreenJoystick(XMLFile* layoutFile = 0, XMLFile* styleFile = 0)
  2381. - bool RemoveScreenJoystick(int id)
  2382. - void SetScreenJoystickVisible(int id, bool enable)
  2383. - void SetScreenKeyboardVisible(bool enable)
  2384. - void SetTouchEmulation(bool enable)
  2385. - bool RecordGesture()
  2386. - bool SaveGestures(File* dest)
  2387. - bool SaveGesture(File* dest, unsigned gestureID)
  2388. - unsigned LoadGestures(File* source)
  2389. - bool SaveGestures(const String fileName)
  2390. - bool SaveGesture(const String fileName, unsigned gestureID)
  2391. - unsigned LoadGestures(const String fileName)
  2392. - bool RemoveGesture(unsigned gestureID)
  2393. - void RemoveAllGestures()
  2394. - int GetKeyFromName(const String name) const
  2395. - int GetKeyFromScancode(int scancode) const
  2396. - String GetKeyName(int key) const
  2397. - int GetScancodeFromKey(int key) const
  2398. - int GetScancodeFromName(const String name) const
  2399. - String GetScancodeName(int scancode) const
  2400. - bool GetKeyDown(int key) const
  2401. - bool GetKeyPress(int key) const
  2402. - bool GetScancodeDown(int scancode) const
  2403. - bool GetScancodePress(int scancode) const
  2404. - bool GetMouseButtonDown(int button) const
  2405. - bool GetMouseButtonPress(int button) const
  2406. - bool GetQualifierDown(int qualifier) const
  2407. - bool GetQualifierPress(int qualifier) const
  2408. - int GetQualifiers() const
  2409. - IntVector2 GetMousePosition() const
  2410. - const IntVector2& GetMouseMove() const
  2411. - int GetMouseMoveX() const
  2412. - int GetMouseMoveY() const
  2413. - int GetMouseMoveWheel() const
  2414. - unsigned GetNumTouches() const
  2415. - TouchState* GetTouch(unsigned index) const
  2416. - unsigned GetNumJoysticks() const
  2417. - JoystickState* GetJoystick(int id)
  2418. - JoystickState* GetJoystickByIndex(unsigned index)
  2419. - JoystickState* GetJoystickByName(const String name)
  2420. - bool GetToggleFullscreen() const
  2421. - bool GetScreenKeyboardSupport() const
  2422. - bool IsScreenJoystickVisible(int id) const
  2423. - bool IsScreenKeyboardVisible() const
  2424. - bool GetTouchEmulation() const
  2425. - bool IsMouseVisible() const
  2426. - bool IsMouseGrabbed() const
  2427. - MouseMode GetMouseMode() const
  2428. - bool HasFocus()
  2429. - bool IsMinimized() const
  2430. Properties:
  2431. - int qualifiers (readonly)
  2432. - IntVector2 mousePosition (readonly)
  2433. - IntVector2& mouseMove (readonly)
  2434. - int mouseMoveX (readonly)
  2435. - int mouseMoveY (readonly)
  2436. - int mouseMoveWheel (readonly)
  2437. - unsigned numTouches (readonly)
  2438. - unsigned numJoysticks (readonly)
  2439. - bool toggleFullscreen (readonly)
  2440. - bool screenKeyboardSupport (readonly)
  2441. - MouseMode mouseMode
  2442. - bool screenKeyboardVisible
  2443. - bool touchEmulation
  2444. - bool mouseVisible
  2445. - bool mouseGrabbed
  2446. - bool mouseLocked (readonly)
  2447. - bool focus (readonly)
  2448. - bool minimized (readonly)
  2449. <a name="Class_IntRect"></a>
  2450. ### IntRect
  2451. Methods:
  2452. - IntRect() (GC)
  2453. - IntRect* new()
  2454. - IntRect(int left, int top, int right, int bottom) (GC)
  2455. - IntRect* new(int left, int top, int right, int bottom)
  2456. - void delete()
  2457. - bool operator==(const IntRect& rhs) const
  2458. - IntVector2 Size() const
  2459. - int Width() const
  2460. - int Height() const
  2461. - Intersection IsInside(const IntVector2& point) const
  2462. Properties:
  2463. - int left
  2464. - int top
  2465. - int right
  2466. - int bottom
  2467. - const IntRect ZERO
  2468. - IntVector2 size (readonly)
  2469. - int width (readonly)
  2470. - int height (readonly)
  2471. <a name="Class_IntVector2"></a>
  2472. ### IntVector2
  2473. Methods:
  2474. - IntVector2() (GC)
  2475. - IntVector2* new()
  2476. - IntVector2(int x, int y) (GC)
  2477. - IntVector2* new(int x, int y)
  2478. - IntVector2(const IntVector2& rhs) (GC)
  2479. - IntVector2* new(const IntVector2& rhs)
  2480. - void delete()
  2481. - bool operator==(const IntVector2& rhs) const
  2482. - IntVector2 operator+(const IntVector2& rhs) const
  2483. - IntVector2 operator-() const
  2484. - IntVector2 operator-(const IntVector2& rhs) const
  2485. - IntVector2 operator*(int rhs) const
  2486. - IntVector2 operator/(int rhs) const
  2487. - String ToString() const
  2488. Properties:
  2489. - int x
  2490. - int y
  2491. - const IntVector2 ZERO
  2492. <a name="Class_JSONFile"></a>
  2493. ### JSONFile : Resource
  2494. Methods:
  2495. - JSONFile() (GC)
  2496. - JSONFile* new()
  2497. - void delete()
  2498. - bool FromString(const String source)
  2499. - const JSONValue& GetRoot() const
  2500. - bool Save(const String fileName, const String indentation = "\t") const
  2501. <a name="Class_JSONValue"></a>
  2502. ### JSONValue
  2503. Methods:
  2504. - JSONValue() (GC)
  2505. - JSONValue* new()
  2506. - JSONValue(bool value) (GC)
  2507. - JSONValue* new(bool value)
  2508. - JSONValue(const char* value) (GC)
  2509. - JSONValue* new(const char* value)
  2510. - JSONValue(double value) (GC)
  2511. - JSONValue* new(double value)
  2512. - JSONValue(const JSONArray& value) (GC)
  2513. - JSONValue* new(const JSONArray& value)
  2514. - JSONValue(const JSONObject& value) (GC)
  2515. - JSONValue* new(const JSONObject& value)
  2516. - JSONValue(const JSONValue& value) (GC)
  2517. - JSONValue* new(const JSONValue& value)
  2518. - void delete()
  2519. - void SetBool(bool value)
  2520. - void SetInt(int value)
  2521. - void SetUint(unsigned value)
  2522. - void SetFloat(float value)
  2523. - void SetDouble(double value)
  2524. - void SetString(const String value)
  2525. - void SetArray(const JSONArray& value)
  2526. - void SetObject(const JSONObject& value)
  2527. - JSONValueType GetValueType() const
  2528. - JSONNumberType GetNumberType() const
  2529. - String GetValueTypeName() const
  2530. - String GetNumberTypeName() const
  2531. - bool IsNull() const
  2532. - bool IsBool() const
  2533. - bool IsNumber() const
  2534. - bool IsString() const
  2535. - bool IsArray() const
  2536. - bool IsObject() const
  2537. - bool GetBool() const
  2538. - int GetInt() const
  2539. - unsigned GetUInt() const
  2540. - float GetFloat() const
  2541. - double GetDouble() const
  2542. - const String GetString() const
  2543. - const JSONArray& GetArray() const
  2544. - const JSONObject& GetObject() const
  2545. - JSONValue operator&[](unsigned index, JSONValue tolua_value)
  2546. - JSONValue operator[](unsigned index)
  2547. - const JSONValue operator[](unsigned index) const
  2548. - void Push(const JSONValue& value)
  2549. - void Pop()
  2550. - void Insert(unsigned pos, const JSONValue& value)
  2551. - void Erase(unsigned pos, unsigned length = 1)
  2552. - void Resize(unsigned newSize)
  2553. - unsigned Size() const
  2554. - void Set(const String key, const JSONValue& value)
  2555. - const JSONValue& Get(const String key) const
  2556. - bool Erase(const String key)
  2557. - bool Contains(const String key) const
  2558. - void Clear()
  2559. Properties:
  2560. - const JSONValue EMPTY
  2561. - const JSONArray emptyArray
  2562. - const JSONObject emptyObject
  2563. - bool null (readonly)
  2564. - JSONValueType valueType (readonly)
  2565. - JSONNumberType numberType (readonly)
  2566. - String valueTypeName (readonly)
  2567. - String numberTypeName (readonly)
  2568. <a name="Class_JoystickState"></a>
  2569. ### JoystickState
  2570. Methods:
  2571. - bool IsController() const
  2572. - unsigned GetNumButtons() const
  2573. - unsigned GetNumAxes() const
  2574. - unsigned GetNumHats() const
  2575. - bool GetButtonDown(unsigned index) const
  2576. - bool GetButtonPress(unsigned index) const
  2577. - float GetAxisPosition(unsigned index) const
  2578. - int GetHatPosition(unsigned index) const
  2579. Properties:
  2580. - const String name
  2581. - const int joystickID
  2582. - bool controller (readonly)
  2583. - unsigned numButtons (readonly)
  2584. - unsigned numAxes (readonly)
  2585. - unsigned numHats (readonly)
  2586. <a name="Class_Light"></a>
  2587. ### Light : Drawable
  2588. Methods:
  2589. - void SetLightType(LightType type)
  2590. - void SetPerVertex(bool enable)
  2591. - void SetColor(const Color& color)
  2592. - void SetTemperature(float temperature)
  2593. - void SetUsePhysicalValues(bool enable)
  2594. - void SetSpecularIntensity(float intensity)
  2595. - void SetBrightness(float brightness)
  2596. - void SetRange(float range)
  2597. - void SetFov(float fov)
  2598. - void SetAspectRatio(float aspectRatio)
  2599. - void SetFadeDistance(float distance)
  2600. - void SetShadowFadeDistance(float distance)
  2601. - void SetShadowBias(const BiasParameters& parameters)
  2602. - void SetShadowCascade(const CascadeParameters& parameters)
  2603. - void SetShadowFocus(const FocusParameters& parameters)
  2604. - void SetShadowIntensity(float intensity)
  2605. - void SetShadowResolution(float resolution)
  2606. - void SetShadowNearFarRatio(float nearFarRatio)
  2607. - void SetRampTexture(Texture* texture)
  2608. - void SetShapeTexture(Texture* texture)
  2609. - LightType GetLightType() const
  2610. - bool GetPerVertex() const
  2611. - const Color& GetColor() const
  2612. - float GetTemperature() const
  2613. - float GetSpecularIntensity() const
  2614. - float GetBrightness() const
  2615. - Color GetEffectiveColor() const
  2616. - Color GetColorFromTemperature() const
  2617. - bool GetUsePhysicalValues() const
  2618. - float GetEffectiveSpecularIntensity() const
  2619. - float GetRange() const
  2620. - float GetFov() const
  2621. - float GetAspectRatio() const
  2622. - float GetFadeDistance() const
  2623. - float GetShadowFadeDistance() const
  2624. - const BiasParameters& GetShadowBias() const
  2625. - const CascadeParameters& GetShadowCascade() const
  2626. - const FocusParameters& GetShadowFocus() const
  2627. - float GetShadowIntensity() const
  2628. - float GetShadowResolution() const
  2629. - float GetShadowNearFarRatio() const
  2630. - Texture* GetRampTexture() const
  2631. - Texture* GetShapeTexture() const
  2632. - Frustum GetFrustum() const
  2633. - int GetNumShadowSplits() const
  2634. - bool IsNegative() const
  2635. Properties:
  2636. - LightType lightType
  2637. - bool perVertex
  2638. - Color& color
  2639. - float temperature
  2640. - bool usePhysicalValues
  2641. - float specularIntensity
  2642. - float brightness
  2643. - float range
  2644. - float fov
  2645. - float aspectRatio
  2646. - float fadeDistance
  2647. - float shadowFadeDistance
  2648. - BiasParameters& shadowBias
  2649. - CascadeParameters& shadowCascade
  2650. - FocusParameters& shadowFocus
  2651. - float shadowIntensity
  2652. - float shadowResolution
  2653. - float shadowNearFarRatio
  2654. - Texture* rampTexture
  2655. - Texture* shapeTexture
  2656. - Frustum frustum (readonly)
  2657. - int numShadowSplits (readonly)
  2658. - bool negative (readonly)
  2659. - Color effectiveColor (readonly)
  2660. - float effectiveSpecularIntensity (readonly)
  2661. <a name="Class_LineEdit"></a>
  2662. ### LineEdit : BorderImage
  2663. Methods:
  2664. - LineEdit() (GC)
  2665. - LineEdit* new()
  2666. - void delete()
  2667. - void SetText(const String text)
  2668. - void SetCursorPosition(unsigned position)
  2669. - void SetCursorBlinkRate(float rate)
  2670. - void SetMaxLength(unsigned length)
  2671. - void SetEchoCharacter(unsigned c)
  2672. - void SetCursorMovable(bool enable)
  2673. - void SetTextSelectable(bool enable)
  2674. - void SetTextCopyable(bool enable)
  2675. - const String GetText() const
  2676. - unsigned GetCursorPosition() const
  2677. - float GetCursorBlinkRate() const
  2678. - unsigned GetMaxLength() const
  2679. - unsigned GetEchoCharacter() const
  2680. - bool IsCursorMovable() const
  2681. - bool IsTextSelectable() const
  2682. - bool IsTextCopyable() const
  2683. - Text* GetTextElement() const
  2684. - BorderImage* GetCursor() const
  2685. Properties:
  2686. - String text
  2687. - unsigned cursorPosition
  2688. - float cursorBlinkRate
  2689. - unsigned maxLength
  2690. - unsigned echoCharacter
  2691. - bool cursorMovable
  2692. - bool textSelectable
  2693. - bool textCopyable
  2694. - Text* textElement (readonly)
  2695. - BorderImage* cursor (readonly)
  2696. <a name="Class_ListView"></a>
  2697. ### ListView : ScrollView
  2698. Methods:
  2699. - ListView() (GC)
  2700. - ListView* new()
  2701. - void delete()
  2702. - void AddItem(UIElement* item)
  2703. - void InsertItem(unsigned index, UIElement* item, UIElement* parentItem = 0)
  2704. - void RemoveItem(UIElement* item, unsigned index = 0)
  2705. - void RemoveItem(unsigned index)
  2706. - void RemoveAllItems()
  2707. - void SetSelection(unsigned index)
  2708. - void SetSelections(const PODVector<unsigned>& indices)
  2709. - void AddSelection(unsigned index)
  2710. - void RemoveSelection(unsigned index)
  2711. - void ToggleSelection(unsigned index)
  2712. - void ChangeSelection(int delta, bool additive = false)
  2713. - void ClearSelection()
  2714. - void SetHighlightMode(HighlightMode mode)
  2715. - void SetMultiselect(bool enable)
  2716. - void SetHierarchyMode(bool enable)
  2717. - void SetBaseIndent(int baseIndent)
  2718. - void SetClearSelectionOnDefocus(bool enable)
  2719. - void SetSelectOnClickEnd(bool enable)
  2720. - void Expand(unsigned index, bool enable, bool recursive = false)
  2721. - void ToggleExpand(unsigned index, bool recursive = false)
  2722. - unsigned GetNumItems() const
  2723. - UIElement* GetItem(unsigned index) const
  2724. - const PODVector<UIElement*>& GetItems() const
  2725. - unsigned FindItem(UIElement* item) const
  2726. - unsigned GetSelection() const
  2727. - const PODVector<unsigned>& GetSelections() const
  2728. - void CopySelectedItemsToClipboard() const
  2729. - UIElement* GetSelectedItem() const
  2730. - const PODVector<UIElement*>& GetSelectedItems() const
  2731. - bool IsSelected(unsigned index) const
  2732. - bool IsExpanded(unsigned index) const
  2733. - HighlightMode GetHighlightMode() const
  2734. - bool GetMultiselect() const
  2735. - bool GetClearSelectionOnDefocus() const
  2736. - bool GetSelectOnClickEnd() const
  2737. - bool GetHierarchyMode() const
  2738. - int GetBaseIndent() const
  2739. Properties:
  2740. - unsigned numItems (readonly)
  2741. - unsigned selection
  2742. - UIElement* selectedItem (readonly)
  2743. - HighlightMode highlightMode
  2744. - bool multiselect
  2745. - bool clearSelectionOnDefocus
  2746. - bool selectOnClickEnd
  2747. - bool hierarchyMode
  2748. - int baseIndent
  2749. <a name="Class_Localization"></a>
  2750. ### Localization : Object
  2751. Methods:
  2752. - int GetNumLanguages() const
  2753. - int GetLanguageIndex() const
  2754. - int GetLanguageIndex(const String language)
  2755. - String GetLanguage()
  2756. - String GetLanguage(int index)
  2757. - void SetLanguage(const String language)
  2758. - void SetLanguage(int index)
  2759. - String Get(const String id)
  2760. - void Reset()
  2761. - void LoadJSON(const JSONValue& source)
  2762. - void LoadJSONFile(const String name)
  2763. Properties:
  2764. - int numLanguages (readonly)
  2765. - int languageIndex (readonly)
  2766. - String language (readonly)
  2767. <a name="Class_Log"></a>
  2768. ### Log : Object
  2769. Methods:
  2770. - void Open(const String fileName)
  2771. - void Close()
  2772. - void SetLevel(int level)
  2773. - void SetTimeStamp(bool enable)
  2774. - void SetQuiet(bool quiet)
  2775. - int GetLevel() const
  2776. - bool GetTimeStamp() const
  2777. - String GetLastMessage() const
  2778. - bool IsQuiet() const
  2779. - void Write(int level, const String message)
  2780. - void WriteRaw(const String message, bool error = false)
  2781. Properties:
  2782. - int level
  2783. - bool timeStamp
  2784. - bool quiet
  2785. <a name="Class_LuaScriptInstance"></a>
  2786. ### LuaScriptInstance : Component
  2787. Methods:
  2788. - bool CreateObject(const String scriptObjectType)
  2789. - bool CreateObject(LuaFile* scriptFile, const String scriptObjectType)
  2790. - void SetScriptFile(LuaFile* scriptFile)
  2791. - void SetScriptObjectType(const String scriptObjectType)
  2792. - void SubscribeToEvent(const String eventName, void* functionOrFunctionName)
  2793. - void SubscribeToEvent(void* sender, const String eventName, void* functionOrFunctionName)
  2794. - void UnsubscribeFromEvent(const String eventName)
  2795. - void UnsubscribeFromEvent(Object* sender, const String eventName)
  2796. - void UnsubscribeFromEvents(Object* sender)
  2797. - void UnsubscribeFromAllEvents()
  2798. - void UnsubscribeFromAllEventsExcept(const Vector<String>& exceptionNames)
  2799. - bool HasSubscribedToEvent(const String eventName)
  2800. - bool HasSubscribedToEvent(Object* sender, const String eventName)
  2801. - LuaFile* GetScriptFile() const
  2802. - const String GetScriptObjectType() const
  2803. Properties:
  2804. - const LuaFile* scriptFile
  2805. - const String scriptObjectType
  2806. <a name="Class_Material"></a>
  2807. ### Material : Resource
  2808. Methods:
  2809. - Material() (GC)
  2810. - Material* new()
  2811. - void delete()
  2812. - void SetNumTechniques(unsigned num)
  2813. - void SetTechnique(unsigned index, Technique* tech, unsigned qualityLevel = 0, float lodDistance = 0.0f)
  2814. - void SetShaderParameter(const String name, const Variant& value)
  2815. - void SetShaderParameterAnimation(const String name, ValueAnimation* animation, WrapMode wrapMode = WM_LOOP, float speed = 1.0f)
  2816. - void SetShaderParameterAnimationWrapMode(const String name, WrapMode wrapMode)
  2817. - void SetShaderParameterAnimationSpeed(const String name, float speed)
  2818. - void SetTexture(TextureUnit unit, Texture* texture)
  2819. - void SetUVTransform(const Vector2& offset, float rotation, const Vector2& repeat)
  2820. - void SetUVTransform(const Vector2& offset, float rotation, float repeat)
  2821. - void SetCullMode(CullMode mode)
  2822. - void SetShadowCullMode(CullMode mode)
  2823. - void SetFillMode(FillMode mode)
  2824. - void SetDepthBias(const BiasParameters& parameters)
  2825. - void SetRenderOrder(char renderOrder)
  2826. - void SetScene(Scene* scene)
  2827. - void RemoveShaderParameter(const String name)
  2828. - void ReleaseShaders()
  2829. - Material* Clone(const String cloneName = String::EMPTY) const
  2830. - void SortTechniques()
  2831. - void MarkForAuxView(unsigned frameNumber)
  2832. - unsigned GetNumTechniques() const
  2833. - Technique* GetTechnique(unsigned index) const
  2834. - Pass* GetPass(unsigned index, const String passName) const
  2835. - Texture* GetTexture(TextureUnit unit) const
  2836. - ValueAnimation* GetShaderParameterAnimation(const String name) const
  2837. - WrapMode GetShaderParameterAnimationWrapMode(const String name) const
  2838. - float GetShaderParameterAnimationSpeed(const String name) const
  2839. - CullMode GetCullMode() const
  2840. - CullMode GetShadowCullMode() const
  2841. - FillMode GetFillMode() const
  2842. - const BiasParameters& GetDepthBias() const
  2843. - char GetRenderOrder() const
  2844. - bool GetOcclusion() const
  2845. - bool GetSpecular() const
  2846. - Scene* GetScene() const
  2847. Properties:
  2848. - CullMode cullMode
  2849. - CullMode shadowCullMode
  2850. - FillMode fillMode
  2851. - BiasParameters depthBias
  2852. - char renderOrder
  2853. - bool occlusion (readonly)
  2854. - bool specular (readonly)
  2855. - Scene* scene
  2856. <a name="Class_Matrix3"></a>
  2857. ### Matrix3
  2858. Methods:
  2859. - Matrix3() (GC)
  2860. - Matrix3* new()
  2861. - Matrix3(const Matrix3& matrix) (GC)
  2862. - Matrix3* new(const Matrix3& matrix)
  2863. - Matrix3(float v00, float v01, float v02, float v10, float v11, float v12, float v20, float v21, float v22) (GC)
  2864. - Matrix3* new(float v00, float v01, float v02, float v10, float v11, float v12, float v20, float v21, float v22)
  2865. - void delete()
  2866. - bool operator==(const Matrix3& rhs) const
  2867. - Vector3 operator*(const Vector3& rhs) const
  2868. - Matrix3 operator+(const Matrix3& rhs) const
  2869. - Matrix3 operator-(const Matrix3& rhs) const
  2870. - Matrix3 operator*(float rhs) const
  2871. - Matrix3 operator*(const Matrix3& rhs) const
  2872. - void SetScale(const Vector3& scale)
  2873. - void SetScale(float scale)
  2874. - Vector3 Scale() const
  2875. - Matrix3 Transpose() const
  2876. - Matrix3 Scaled(const Vector3& scale) const
  2877. - bool Equals(const Matrix3& rhs) const
  2878. - Matrix3 Inverse() const
  2879. - String ToString() const
  2880. Properties:
  2881. - float m00
  2882. - float m01
  2883. - float m02
  2884. - float m10
  2885. - float m11
  2886. - float m12
  2887. - float m20
  2888. - float m21
  2889. - float m22
  2890. - const Matrix3 ZERO
  2891. - const Matrix3 IDENTITY
  2892. <a name="Class_Matrix3x4"></a>
  2893. ### Matrix3x4
  2894. Methods:
  2895. - Matrix3x4() (GC)
  2896. - Matrix3x4* new()
  2897. - Matrix3x4(const Matrix3x4& matrix) (GC)
  2898. - Matrix3x4* new(const Matrix3x4& matrix)
  2899. - Matrix3x4(const Matrix3& matrix) (GC)
  2900. - Matrix3x4* new(const Matrix3& matrix)
  2901. - Matrix3x4(const Matrix4& matrix) (GC)
  2902. - Matrix3x4* new(const Matrix4& matrix)
  2903. - Matrix3x4(float v00, float v01, float v02, float v03, float v10, float v11, float v12, float v13, float v20, float v21, float v22, float v23) (GC)
  2904. - Matrix3x4* new(float v00, float v01, float v02, float v03, float v10, float v11, float v12, float v13, float v20, float v21, float v22, float v23)
  2905. - Matrix3x4(const Vector3& translation, const Quaternion& rotation, float scale) (GC)
  2906. - Matrix3x4* new(const Vector3& translation, const Quaternion& rotation, float scale)
  2907. - Matrix3x4(const Vector3& translation, const Quaternion& rotation, const Vector3& scale) (GC)
  2908. - Matrix3x4* new(const Vector3& translation, const Quaternion& rotation, const Vector3& scale)
  2909. - void delete()
  2910. - bool operator==(const Matrix3x4& rhs) const
  2911. - Vector3 operator*(const Vector3& rhs) const
  2912. - Vector3 operator*(const Vector4& rhs) const
  2913. - Matrix3x4 operator+(const Matrix3x4& rhs) const
  2914. - Matrix3x4 operator-(const Matrix3x4& rhs) const
  2915. - Matrix3x4 operator*(float rhs) const
  2916. - Matrix3x4 operator*(const Matrix3x4& rhs) const
  2917. - Matrix4 operator*(const Matrix4& rhs) const
  2918. - void SetTranslation(const Vector3& translation)
  2919. - void SetRotation(const Matrix3& rotation)
  2920. - void SetScale(const Vector3& scale)
  2921. - void SetScale(float scale)
  2922. - Matrix3 ToMatrix3() const
  2923. - Matrix4 ToMatrix4() const
  2924. - Matrix3 RotationMatrix() const
  2925. - Vector3 Translation() const
  2926. - Quaternion Rotation() const
  2927. - Vector3 Scale() const
  2928. - bool Equals(const Matrix3x4& rhs) const
  2929. - void Decompose(Vector3& translation, Quaternion& rotation, Vector3& scale) const
  2930. - Matrix3x4 Inverse() const
  2931. - String ToString() const
  2932. Properties:
  2933. - float m00
  2934. - float m01
  2935. - float m02
  2936. - float m03
  2937. - float m10
  2938. - float m11
  2939. - float m12
  2940. - float m13
  2941. - float m20
  2942. - float m21
  2943. - float m22
  2944. - float m23
  2945. - const Matrix3x4 ZERO
  2946. - const Matrix3x4 IDENTITY
  2947. <a name="Class_Matrix4"></a>
  2948. ### Matrix4
  2949. Methods:
  2950. - Matrix4() (GC)
  2951. - Matrix4* new()
  2952. - Matrix4(const Matrix4& matrix) (GC)
  2953. - Matrix4* new(const Matrix4& matrix)
  2954. - Matrix4(const Matrix3& matrix) (GC)
  2955. - Matrix4* new(const Matrix3& matrix)
  2956. - Matrix4(float v00, float v01, float v02, float v03, float v10, float v11, float v12, float v13, float v20, float v21, float v22, float v23, float v30, float v31, float v32, float v33) (GC)
  2957. - Matrix4* new(float v00, float v01, float v02, float v03, float v10, float v11, float v12, float v13, float v20, float v21, float v22, float v23, float v30, float v31, float v32, float v33)
  2958. - void delete()
  2959. - bool operator==(const Matrix4& rhs) const
  2960. - Vector3 operator*(const Vector3& rhs) const
  2961. - Vector4 operator*(const Vector4& rhs) const
  2962. - Matrix4 operator+(const Matrix4& rhs) const
  2963. - Matrix4 operator-(const Matrix4& rhs) const
  2964. - Matrix4 operator*(float rhs) const
  2965. - Matrix4 operator*(const Matrix4& rhs) const
  2966. - Matrix4 operator*(const Matrix3x4& rhs) const
  2967. - void SetTranslation(const Vector3& translation)
  2968. - void SetRotation(const Matrix3& rotation)
  2969. - void SetScale(const Vector3& scale)
  2970. - void SetScale(float scale)
  2971. - Matrix3 ToMatrix3() const
  2972. - Matrix3 RotationMatrix() const
  2973. - Vector3 Translation() const
  2974. - Quaternion Rotation() const
  2975. - Vector3 Scale() const
  2976. - Matrix4 Transpose() const
  2977. - bool Equals(const Matrix4& rhs) const
  2978. - void Decompose(Vector3& translation, Quaternion& rotation, Vector3& scale) const
  2979. - Matrix4 Inverse() const
  2980. - String ToString() const
  2981. Properties:
  2982. - float m00
  2983. - float m01
  2984. - float m02
  2985. - float m03
  2986. - float m10
  2987. - float m11
  2988. - float m12
  2989. - float m13
  2990. - float m20
  2991. - float m21
  2992. - float m22
  2993. - float m23
  2994. - float m30
  2995. - float m31
  2996. - float m32
  2997. - float m33
  2998. - const Matrix4 ZERO
  2999. - const Matrix4 IDENTITY
  3000. <a name="Class_Menu"></a>
  3001. ### Menu : Button
  3002. Methods:
  3003. - Menu() (GC)
  3004. - Menu* new()
  3005. - void delete()
  3006. - void SetPopup(UIElement* element)
  3007. - void SetPopupOffset(const IntVector2& offset)
  3008. - void SetPopupOffset(int x, int y)
  3009. - void ShowPopup(bool enable)
  3010. - void SetAccelerator(int key, int qualifiers)
  3011. - UIElement* GetPopup() const
  3012. - const IntVector2& GetPopupOffset() const
  3013. - bool GetShowPopup() const
  3014. - int GetAcceleratorKey() const
  3015. - int GetAcceleratorQualifiers() const
  3016. Properties:
  3017. - UIElement* popup
  3018. - IntVector2& popupOffset
  3019. - bool showPopup
  3020. - int acceleratorKey (readonly)
  3021. - int acceleratorQualifiers (readonly)
  3022. <a name="Class_MessageBox"></a>
  3023. ### MessageBox : Object
  3024. Methods:
  3025. - MessageBox(const String messageString = String::EMPTY, const String titleString = String::EMPTY, XMLFile* layoutFile = 0, XMLFile* styleFile = 0) (GC)
  3026. - MessageBox* new(const String messageString = String::EMPTY, const String titleString = String::EMPTY, XMLFile* layoutFile = 0, XMLFile* styleFile = 0)
  3027. - void delete()
  3028. - void SetTitle(const String text)
  3029. - void SetMessage(const String text)
  3030. - const String GetTitle() const
  3031. - const String GetMessage() const
  3032. - UIElement* GetWindow() const
  3033. Properties:
  3034. - String title
  3035. - String message
  3036. - UIElement* window (readonly)
  3037. <a name="Class_Model"></a>
  3038. ### Model : Resource
  3039. Methods:
  3040. - Model() (GC)
  3041. - Model* new()
  3042. - void delete()
  3043. - Model* Clone(const String cloneName = String::EMPTY) const
  3044. - void SetBoundingBox(const BoundingBox& box)
  3045. - void SetNumGeometries(unsigned num)
  3046. - bool SetNumGeometryLodLevels(unsigned index, unsigned num)
  3047. - bool SetGeometry(unsigned index, unsigned lodLevel, Geometry* geometry)
  3048. - bool SetGeometryCenter(unsigned index, const Vector3& center)
  3049. - const BoundingBox& GetBoundingBox() const
  3050. - Skeleton& GetSkeleton()
  3051. - unsigned GetNumGeometries() const
  3052. - unsigned GetNumGeometryLodLevels(unsigned index) const
  3053. - Geometry* GetGeometry(unsigned index, unsigned lodLevel) const
  3054. - const Vector3& GetGeometryCenter(unsigned index) const
  3055. - unsigned GetNumMorphs() const
  3056. - const ModelMorph* GetMorph(const String name) const
  3057. - const ModelMorph* GetMorph(StringHash nameHash) const
  3058. - const ModelMorph* GetMorph(unsigned index) const
  3059. - unsigned GetMorphRangeStart(unsigned bufferIndex) const
  3060. - unsigned GetMorphRangeCount(unsigned bufferIndex) const
  3061. Properties:
  3062. - BoundingBox& boundingBox
  3063. - Skeleton skeleton (readonly)
  3064. - unsigned numGeometries
  3065. - unsigned numMorphs (readonly)
  3066. <a name="Class_NamedPipe"></a>
  3067. ### NamedPipe : Object
  3068. Methods:
  3069. - NamedPipe() (GC)
  3070. - NamedPipe* new()
  3071. - NamedPipe(const String pipeName, bool isServer) (GC)
  3072. - NamedPipe* new(const String pipeName, bool isServer)
  3073. - void delete()
  3074. - bool Open(const String pipeName, bool isServer)
  3075. - void Close()
  3076. - bool IsOpen() const
  3077. - VectorBuffer Read(unsigned size)
  3078. - const String GetName() const
  3079. - bool IsEof() const
  3080. - int ReadInt()
  3081. - short ReadShort()
  3082. - char ReadByte()
  3083. - unsigned ReadUInt()
  3084. - short ReadUShort()
  3085. - char ReadUByte()
  3086. - bool ReadBool()
  3087. - float ReadFloat()
  3088. - double ReadDouble()
  3089. - IntRect ReadIntRect()
  3090. - IntVector2 ReadIntVector2()
  3091. - Rect ReadRect()
  3092. - Vector2 ReadVector2()
  3093. - Vector3 ReadVector3()
  3094. - Vector3 ReadPackedVector3(float maxAbsCoord)
  3095. - Vector4 ReadVector4()
  3096. - Quaternion ReadQuaternion()
  3097. - Quaternion ReadPackedQuaternion()
  3098. - Matrix3 ReadMatrix3()
  3099. - Matrix3x4 ReadMatrix3x4()
  3100. - Matrix4 ReadMatrix4()
  3101. - Color ReadColor()
  3102. - BoundingBox ReadBoundingBox()
  3103. - String ReadString()
  3104. - String ReadFileID()
  3105. - StringHash ReadStringHash()
  3106. - VectorBuffer ReadBuffer()
  3107. - ResourceRef ReadResourceRef()
  3108. - ResourceRefList ReadResourceRefList()
  3109. - Variant ReadVariant()
  3110. - Variant ReadVariant(VariantType type)
  3111. - VariantVector ReadVariantVector()
  3112. - VariantMap ReadVariantMap()
  3113. - unsigned ReadVLE()
  3114. - unsigned ReadNetID()
  3115. - String ReadLine()
  3116. - unsigned Write(const VectorBuffer& buffer)
  3117. - bool WriteInt(int value)
  3118. - bool WriteShort(short value)
  3119. - bool WriteByte(char value)
  3120. - bool WriteUInt(unsigned value)
  3121. - bool WriteUShort(short value)
  3122. - bool WriteUByte(char value)
  3123. - bool WriteBool(bool value)
  3124. - bool WriteFloat(float value)
  3125. - bool WriteDouble(double value)
  3126. - bool WriteIntRect(const IntRect& value)
  3127. - bool WriteIntVector2(const IntVector2& value)
  3128. - bool WriteRect(const Rect& value)
  3129. - bool WriteVector2(const Vector2& value)
  3130. - bool WriteVector3(const Vector3& value)
  3131. - bool WritePackedVector3(const Vector3& value, float maxAbsCoord)
  3132. - bool WriteVector4(const Vector4& value)
  3133. - bool WriteQuaternion(const Quaternion& value)
  3134. - bool WritePackedQuaternion(const Quaternion& value)
  3135. - bool WriteMatrix3(const Matrix3& value)
  3136. - bool WriteMatrix3x4(const Matrix3x4& value)
  3137. - bool WriteMatrix4(const Matrix4& value)
  3138. - bool WriteColor(const Color& value)
  3139. - bool WriteBoundingBox(const BoundingBox& value)
  3140. - bool WriteString(const String value)
  3141. - bool WriteFileID(const String value)
  3142. - bool WriteStringHash(const StringHash& value)
  3143. - bool WriteBuffer(const VectorBuffer& buffer)
  3144. - bool WriteResourceRef(const ResourceRef& value)
  3145. - bool WriteResourceRefList(const ResourceRefList& value)
  3146. - bool WriteVariant(const Variant& value)
  3147. - bool WriteVariantData(const Variant& value)
  3148. - bool WriteVariantVector(const VariantVector& value)
  3149. - bool WriteVariantMap(const VariantMap& value)
  3150. - bool WriteVLE(unsigned value)
  3151. - bool WriteNetID(unsigned value)
  3152. - bool WriteLine(const String value)
  3153. Properties:
  3154. - String name (readonly)
  3155. - bool eof (readonly)
  3156. - bool open (readonly)
  3157. <a name="Class_NavArea"></a>
  3158. ### NavArea : Component
  3159. Methods:
  3160. - unsigned GetAreaID() const
  3161. - void SetAreaID(unsigned tolua_var_3)
  3162. - BoundingBox GetBoundingBox()
  3163. - void SetBoundingBox(const BoundingBox& bnds)
  3164. - BoundingBox GetWorldBoundingBox() const
  3165. Properties:
  3166. - unsigned areaID
  3167. - BoundingBox boundingBox
  3168. - BoundingBox worldBoundingBox (readonly)
  3169. <a name="Class_Navigable"></a>
  3170. ### Navigable : Component
  3171. Methods:
  3172. - void SetRecursive(bool enable)
  3173. - bool IsRecursive() const
  3174. Properties:
  3175. - bool recursive
  3176. <a name="Class_NavigationGeometryInfo"></a>
  3177. ### NavigationGeometryInfo
  3178. Properties:
  3179. - Component* component
  3180. - unsigned lodLevel
  3181. - Matrix3x4 transform
  3182. - BoundingBox boundingBox
  3183. <a name="Class_NavigationMesh"></a>
  3184. ### NavigationMesh : Component
  3185. Methods:
  3186. - void SetTileSize(int size)
  3187. - void SetCellSize(float size)
  3188. - void SetCellHeight(float height)
  3189. - void SetAgentHeight(float height)
  3190. - void SetAgentRadius(float radius)
  3191. - void SetAgentMaxClimb(float maxClimb)
  3192. - void SetAgentMaxSlope(float maxSlope)
  3193. - void SetRegionMinSize(float size)
  3194. - void SetRegionMergeSize(float size)
  3195. - void SetEdgeMaxLength(float length)
  3196. - void SetEdgeMaxError(float error)
  3197. - void SetDetailSampleDistance(float distance)
  3198. - void SetDetailSampleMaxError(float error)
  3199. - void SetPadding(const Vector3& padding)
  3200. - void SetAreaCost(unsigned areaID, float cost)
  3201. - bool Build()
  3202. - bool Build(const BoundingBox& boundingBox)
  3203. - void SetPartitionType(NavmeshPartitionType aType)
  3204. - void SetDrawOffMeshConnections(bool enable)
  3205. - void SetDrawNavAreas(bool enable)
  3206. - Vector3 FindNearestPoint(const Vector3& point)
  3207. - Vector3 FindNearestPoint(const Vector3& point, const Vector3& extents)
  3208. - Vector3 MoveAlongSurface(const Vector3& start, const Vector3& end)
  3209. - Vector3 MoveAlongSurface(const Vector3& start, const Vector3& end, const Vector3& extents, int maxVisited = 3)
  3210. - const PODVector<Vector3>& FindPath(const Vector3& start, const Vector3& end)
  3211. - const PODVector<Vector3>& FindPath(const Vector3& start, const Vector3& end, const Vector3& extents)
  3212. - Vector3 GetRandomPoint()
  3213. - Vector3 GetRandomPointInCircle(const Vector3& center, float radius)
  3214. - Vector3 GetRandomPointInCircle(const Vector3& center, float radius, const Vector3& extents)
  3215. - float GetDistanceToWall(const Vector3& point, float radius)
  3216. - float GetDistanceToWall(const Vector3& point, float radius, const Vector3& extents)
  3217. - Vector3 Raycast(const Vector3& start, const Vector3& end)
  3218. - Vector3 Raycast(const Vector3& start, const Vector3& end, const Vector3& extents)
  3219. - void DrawDebugGeometry(bool depthTest)
  3220. - int GetTileSize() const
  3221. - float GetCellSize() const
  3222. - float GetCellHeight() const
  3223. - float GetAgentHeight() const
  3224. - float GetAgentRadius() const
  3225. - float GetAgentMaxClimb() const
  3226. - float GetAgentMaxSlope() const
  3227. - float GetRegionMinSize() const
  3228. - float GetRegionMergeSize() const
  3229. - float GetEdgeMaxLength() const
  3230. - float GetEdgeMaxError() const
  3231. - float GetDetailSampleDistance() const
  3232. - float GetDetailSampleMaxError() const
  3233. - const Vector3& GetPadding() const
  3234. - float GetAreaCost(unsigned areaID) const
  3235. - bool IsInitialized() const
  3236. - const BoundingBox& GetBoundingBox() const
  3237. - BoundingBox GetWorldBoundingBox() const
  3238. - IntVector2 GetNumTiles() const
  3239. - NavmeshPartitionType GetPartitionType()
  3240. - bool GetDrawOffMeshConnections() const
  3241. - bool GetDrawNavAreas() const
  3242. Properties:
  3243. - int tileSize
  3244. - float cellSize
  3245. - float cellHeight
  3246. - float agentHeight
  3247. - float agentRadius
  3248. - float agentMaxClimb
  3249. - float agentMaxSlope
  3250. - float regionMinSize
  3251. - float regionMergeSize
  3252. - float edgeMaxLength
  3253. - float edgeMaxError
  3254. - float detailSampleDistance
  3255. - float detailSampleMaxError
  3256. - Vector3& padding
  3257. - NavmeshPartitionType partitionType
  3258. - bool drawOffMeshConnections
  3259. - bool drawNavAreas
  3260. - bool initialized (readonly)
  3261. - BoundingBox& boundingBox (readonly)
  3262. - BoundingBox worldBoundingBox (readonly)
  3263. - IntVector2 numTiles (readonly)
  3264. <a name="Class_Network"></a>
  3265. ### Network
  3266. Methods:
  3267. - bool Connect(const String address, short port, Scene* scene)
  3268. - bool Connect(const String address, short port, Scene* scene, const VariantMap& identity)
  3269. - void Disconnect(int waitMSec = 0)
  3270. - bool StartServer(short port)
  3271. - void StopServer()
  3272. - void BroadcastMessage(int msgID, bool reliable, bool inOrder, const VectorBuffer& msg, unsigned contentID = 0)
  3273. - void BroadcastRemoteEvent(StringHash eventType, bool inOrder)
  3274. - void BroadcastRemoteEvent(StringHash eventType, bool inOrder, const VariantMap& eventData)
  3275. - void BroadcastRemoteEvent(const String eventType, bool inOrder)
  3276. - void BroadcastRemoteEvent(const String eventType, bool inOrder, const VariantMap& eventData)
  3277. - void BroadcastRemoteEvent(Scene* scene, StringHash eventType, bool inOrder)
  3278. - void BroadcastRemoteEvent(Scene* scene, StringHash eventType, bool inOrder, const VariantMap& eventData)
  3279. - void BroadcastRemoteEvent(Scene* scene, const String eventType, bool inOrder)
  3280. - void BroadcastRemoteEvent(Scene* scene, const String eventType, bool inOrder, const VariantMap& eventData)
  3281. - void BroadcastRemoteEvent(Node* node, StringHash eventType, bool inOrder)
  3282. - void BroadcastRemoteEvent(Node* node, StringHash eventType, bool inOrder, const VariantMap& eventData)
  3283. - void BroadcastRemoteEvent(Node* node, const String eventType, bool inOrder)
  3284. - void BroadcastRemoteEvent(Node* node, const String eventType, bool inOrder, const VariantMap& eventData)
  3285. - void SetUpdateFps(int fps)
  3286. - void SetSimulatedLatency(int ms)
  3287. - void SetSimulatedPacketLoss(float loss)
  3288. - void RegisterRemoteEvent(StringHash eventType)
  3289. - void RegisterRemoteEvent(const String eventType)
  3290. - void UnregisterRemoteEvent(StringHash eventType)
  3291. - void UnregisterRemoteEvent(const String eventType)
  3292. - void UnregisterAllRemoteEvents()
  3293. - void SetPackageCacheDir(const String path)
  3294. - void SendPackageToClients(Scene* scene, PackageFile* package)
  3295. - HttpRequest* MakeHttpRequest(const String url, const String verb = String::EMPTY)
  3296. - HttpRequest* MakeHttpRequest(const String url, const String verb, const Vector<String>& headers, const String postData = String::EMPTY)
  3297. - int GetUpdateFps() const
  3298. - int GetSimulatedLatency() const
  3299. - float GetSimulatedPacketLoss() const
  3300. - Connection* GetServerConnection() const
  3301. - bool IsServerRunning() const
  3302. - bool CheckRemoteEvent(StringHash eventType) const
  3303. - const String GetPackageCacheDir() const
  3304. Properties:
  3305. - int updateFps
  3306. - int simulatedLatency
  3307. - float simulatedPacketLoss
  3308. - Connection* serverConnection (readonly)
  3309. - bool serverRunning (readonly)
  3310. - String packageCacheDir
  3311. <a name="Class_NetworkPriority"></a>
  3312. ### NetworkPriority : Component
  3313. Methods:
  3314. - void SetBasePriority(float priority)
  3315. - void SetDistanceFactor(float factor)
  3316. - void SetMinPriority(float priority)
  3317. - void SetAlwaysUpdateOwner(bool enable)
  3318. - float GetBasePriority() const
  3319. - float GetDistanceFactor() const
  3320. - float GetMinPriority() const
  3321. - bool GetAlwaysUpdateOwner() const
  3322. - bool CheckUpdate(float distance, float accumulator)
  3323. Properties:
  3324. - float basePriority
  3325. - float distanceFactor
  3326. - float minPriority
  3327. - bool alwaysUpdateOwner
  3328. <a name="Class_Node"></a>
  3329. ### Node : Animatable
  3330. Methods:
  3331. - Node() (GC)
  3332. - Node* new()
  3333. - void delete()
  3334. - bool SaveXML(File* dest, const String indentation = "\t") const
  3335. - bool SaveJSON(File* dest, const String indentation = "\t") const
  3336. - void SetName(const String name)
  3337. - void AddTag(const String tag)
  3338. - void AddTags(const String tags, char separator)
  3339. - bool RemoveTag(const String tag)
  3340. - void RemoveAllTags()
  3341. - void SetPosition(const Vector3& position)
  3342. - void SetPosition2D(const Vector2& position)
  3343. - void SetPosition2D(float x, float y)
  3344. - void SetRotation(const Quaternion& rotation)
  3345. - void SetRotation2D(float rotation)
  3346. - void SetDirection(const Vector3& direction)
  3347. - void SetScale(float scale)
  3348. - void SetScale(const Vector3& scale)
  3349. - void SetScale2D(const Vector2& scale)
  3350. - void SetScale2D(float x, float y)
  3351. - void SetTransform(const Vector3& position, const Quaternion& rotation)
  3352. - void SetTransform(const Vector3& position, const Quaternion& rotation, const Vector3& scale)
  3353. - void SetTransform(const Vector3& position, const Quaternion& rotation, float scale)
  3354. - void SetTransform2D(const Vector2& position, float rotation)
  3355. - void SetTransform2D(const Vector2& position, float rotation, const Vector2& scale)
  3356. - void SetTransform2D(const Vector2& position, float rotation, float scale)
  3357. - void SetWorldPosition(const Vector3& position)
  3358. - void SetWorldPosition2D(const Vector2& position)
  3359. - void SetWorldPosition2D(float x, float y)
  3360. - void SetWorldRotation(const Quaternion& rotation)
  3361. - void SetWorldRotation2D(float rotation)
  3362. - void SetWorldDirection(const Vector3& direction)
  3363. - void SetWorldScale(float scale)
  3364. - void SetWorldScale(const Vector3& scale)
  3365. - void SetWorldScale2D(const Vector2& scale)
  3366. - void SetWorldScale2D(float x, float y)
  3367. - void SetWorldTransform(const Vector3& position, const Quaternion& rotation)
  3368. - void SetWorldTransform(const Vector3& position, const Quaternion& rotation, const Vector3& scale)
  3369. - void SetWorldTransform(const Vector3& position, const Quaternion& rotation, float scale)
  3370. - void SetWorldTransform2D(const Vector2& position, float rotation)
  3371. - void SetWorldTransform2D(const Vector2& position, float rotation, const Vector2& scale)
  3372. - void SetWorldTransform2D(const Vector2& position, float rotation, float scale)
  3373. - void Translate(const Vector3& delta, TransformSpace space = TS_LOCAL)
  3374. - void Translate2D(const Vector2& delta, TransformSpace space = TS_LOCAL)
  3375. - void Rotate(const Quaternion& delta, TransformSpace space = TS_LOCAL)
  3376. - void Rotate2D(float delta, TransformSpace space = TS_LOCAL)
  3377. - void RotateAround(const Vector3& point, const Quaternion& delta, TransformSpace space = TS_LOCAL)
  3378. - void RotateAround2D(const Vector2& point, float delta, TransformSpace space = TS_LOCAL)
  3379. - void Pitch(float angle, TransformSpace space = TS_LOCAL)
  3380. - void Yaw(float angle, TransformSpace space = TS_LOCAL)
  3381. - void Roll(float angle, TransformSpace space = TS_LOCAL)
  3382. - bool LookAt(const Vector3& target)
  3383. - bool LookAt(const Vector3& target, const Vector3& upAxis, TransformSpace space = TS_WORLD)
  3384. - void Scale(float scale)
  3385. - void Scale(const Vector3& scale)
  3386. - void Scale2D(const Vector2& scale)
  3387. - void SetEnabled(bool enable)
  3388. - void SetDeepEnabled(bool enable)
  3389. - void ResetDeepEnabled()
  3390. - void SetEnabledRecursive(bool enable)
  3391. - void SetOwner(Connection* owner)
  3392. - void MarkDirty()
  3393. - Node* CreateChild(const String name = String::EMPTY, CreateMode mode = REPLICATED, unsigned id = 0)
  3394. - void AddChild(Node* node, unsigned index = M_MAX_UNSIGNED)
  3395. - void RemoveChild(Node* node)
  3396. - void RemoveAllChildren()
  3397. - void RemoveChildren(bool removeReplicated, bool removeLocal, bool recursive)
  3398. - void RemoveComponent(Component* component)
  3399. - void RemoveComponent(StringHash type)
  3400. - void RemoveComponent(const String type)
  3401. - void RemoveComponents(bool removeReplicated, bool removeLocal)
  3402. - void RemoveComponents(const String type)
  3403. - void RemoveAllComponents()
  3404. - void ReorderComponent(Component* component, unsigned index)
  3405. - Node* Clone(CreateMode mode = REPLICATED)
  3406. - void Remove()
  3407. - void SetParent(Node* parent)
  3408. - void SetVar(StringHash key, const Variant& value)
  3409. - void AddListener(Component* component)
  3410. - void RemoveListener(Component* component)
  3411. - Component* CreateComponent(const String type, CreateMode mode = REPLICATED, unsigned id = 0)
  3412. - Component* GetOrCreateComponent(const String type, CreateMode mode = REPLICATED, unsigned id = 0)
  3413. - Component* CloneComponent(Component* component, unsigned id = 0)
  3414. - Component* CloneComponent(Component* component, CreateMode mode, unsigned id = 0)
  3415. - int CreateScriptObject(const String scriptObjectType)
  3416. - int CreateScriptObject(const String fileName, const String scriptObjectType)
  3417. - int GetScriptObject() const
  3418. - int GetScriptObject(const String scriptObjectType) const
  3419. - unsigned GetID() const
  3420. - const String GetName() const
  3421. - StringHash GetNameHash() const
  3422. - Node* GetParent() const
  3423. - Scene* GetScene() const
  3424. - bool IsEnabled() const
  3425. - bool IsEnabledSelf() const
  3426. - Connection* GetOwner() const
  3427. - const Vector3& GetPosition() const
  3428. - Vector2 GetPosition2D() const
  3429. - const Quaternion& GetRotation() const
  3430. - float GetRotation2D() const
  3431. - Vector3 GetDirection() const
  3432. - Vector3 GetUp() const
  3433. - Vector3 GetRight() const
  3434. - const Vector3& GetScale() const
  3435. - Vector2 GetScale2D() const
  3436. - Matrix3x4 GetTransform() const
  3437. - Vector3 GetWorldPosition() const
  3438. - Vector2 GetWorldPosition2D() const
  3439. - Quaternion GetWorldRotation() const
  3440. - float GetWorldRotation2D() const
  3441. - Vector3 GetWorldDirection() const
  3442. - Vector3 GetWorldUp() const
  3443. - Vector3 GetWorldRight() const
  3444. - Vector3 GetWorldScale() const
  3445. - Vector2 GetWorldScale2D() const
  3446. - const Matrix3x4& GetWorldTransform() const
  3447. - Vector3 LocalToWorld(const Vector3& position) const
  3448. - Vector3 LocalToWorld(const Vector4& vector) const
  3449. - Vector2 LocalToWorld2D(const Vector2& vector) const
  3450. - Vector3 WorldToLocal(const Vector3& position) const
  3451. - Vector3 WorldToLocal(const Vector4& vector) const
  3452. - Vector2 WorldToLocal2D(const Vector2& vector) const
  3453. - bool IsDirty() const
  3454. - unsigned GetNumChildren(bool recursive = false) const
  3455. - Node* GetChild(const String name, bool recursive = false) const
  3456. - Node* GetChild(StringHash nameHash, bool recursive = false) const
  3457. - Node* GetChild(unsigned index) const
  3458. - unsigned GetNumComponents() const
  3459. - unsigned GetNumNetworkComponents() const
  3460. - bool HasComponent(StringHash type) const
  3461. - bool HasComponent(const String type) const
  3462. - const Variant& GetVar(StringHash key) const
  3463. - const VariantMap& GetVars() const
  3464. - Component* GetComponent(const String type, bool recursive = false) const
  3465. - Component* GetParentComponent(const String type, bool recursive = false) const
  3466. - const PODVector<Component*>& GetComponents(const String type, bool recursive = false)
  3467. - const PODVector<Node*>& GetChildren(bool recursive = false)
  3468. - const PODVector<Node*>& GetChildrenWithComponent(const String type, bool recursive = false)
  3469. - bool Load(Deserializer& source, SceneResolver& resolver, bool loadChildren = true, bool rewriteIDs = false, CreateMode mode = REPLICATED)
  3470. - bool LoadXML(const XMLElement& source, SceneResolver& resolver, bool loadChildren = true, bool rewriteIDs = false, CreateMode mode = REPLICATED)
  3471. - bool LoadJSON(const JSONValue& source, SceneResolver& resolver, bool loadChildren = true, bool rewriteIDs = false, CreateMode mode = REPLICATED)
  3472. - Node* CreateChild(unsigned id, CreateMode mode)
  3473. - void AddComponent(Component* component, unsigned id, CreateMode mode)
  3474. - bool HasTag(const String tag) const
  3475. - const StringVector& GetTags() const
  3476. - const PODVector<Node*>& GetChildrenWithTag(const String tag, bool recursive = false) const
  3477. - void SetID(unsigned id)
  3478. Properties:
  3479. - unsigned ID (readonly)
  3480. - String name
  3481. - StringHash nameHash (readonly)
  3482. - Node* parent
  3483. - Scene* scene (readonly)
  3484. - bool enabled
  3485. - bool enabledSelf (readonly)
  3486. - Connection* owner
  3487. - Vector3& position
  3488. - Vector2 position2D
  3489. - Quaternion& rotation
  3490. - float rotation2D
  3491. - Vector3 direction
  3492. - Vector3 up (readonly)
  3493. - Vector3 right (readonly)
  3494. - Vector3& scale
  3495. - Vector2 scale2D
  3496. - Matrix3x4 transform (readonly)
  3497. - Vector3 worldPosition
  3498. - Vector2 worldPosition2D
  3499. - Quaternion worldRotation
  3500. - float worldRotation2D
  3501. - Vector3 worldDirection
  3502. - Vector3 worldUp (readonly)
  3503. - Vector3 worldRight (readonly)
  3504. - Vector3 worldScale
  3505. - Vector2 worldScale2D
  3506. - Matrix3x4& worldTransform (readonly)
  3507. - bool dirty (readonly)
  3508. - unsigned numComponents (readonly)
  3509. - unsigned numNetworkComponents (readonly)
  3510. <a name="Class_Object"></a>
  3511. ### Object : RefCounted
  3512. Methods:
  3513. - StringHash GetType() const
  3514. - const String GetTypeName() const
  3515. - const String GetCategory() const
  3516. - void SendEvent(const String eventName, VariantMap* eventData = 0)
  3517. - bool HasSubscribedToEvent(const String eventName) const
  3518. - bool HasSubscribedToEvent(Object* sender, const String eventName) const
  3519. Properties:
  3520. - StringHash type (readonly)
  3521. - const String typeName (readonly)
  3522. - const String category (readonly)
  3523. <a name="Class_ObjectAnimation"></a>
  3524. ### ObjectAnimation : Resource
  3525. Methods:
  3526. - ObjectAnimation() (GC)
  3527. - ObjectAnimation* new()
  3528. - void delete()
  3529. - void AddAttributeAnimation(const String name, ValueAnimation* attributeAnimation, WrapMode wrapMode = WM_LOOP, float speed = 1.0f)
  3530. - void RemoveAttributeAnimation(const String name)
  3531. - void RemoveAttributeAnimation(ValueAnimation* attributeAnimation)
  3532. - ValueAnimation* GetAttributeAnimation(const String name) const
  3533. - WrapMode GetAttributeAnimationWrapMode(const String name) const
  3534. - float GetAttributeAnimationSpeed(const String name) const
  3535. <a name="Class_Obstacle"></a>
  3536. ### Obstacle : Component
  3537. Methods:
  3538. - void DrawDebugGeometry(bool depthTest)
  3539. - void SetRadius(float radius)
  3540. - void SetHeight(float height)
  3541. - float GetRadius() const
  3542. - float GetHeight() const
  3543. Properties:
  3544. - float radius
  3545. - float height
  3546. <a name="Class_Octree"></a>
  3547. ### Octree : Component
  3548. Methods:
  3549. - void SetSize(const BoundingBox& box, unsigned numLevels)
  3550. - void Update(const FrameInfo& frame)
  3551. - void AddManualDrawable(Drawable* drawable)
  3552. - void RemoveManualDrawable(Drawable* drawable)
  3553. - const PODVector<OctreeQueryResult>& GetDrawables(const Vector3& point, char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3554. - const PODVector<OctreeQueryResult>& GetDrawables(const BoundingBox& box, char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3555. - const PODVector<OctreeQueryResult>& GetDrawables(const Frustum& frustum, char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3556. - const PODVector<OctreeQueryResult>& GetDrawables(const Sphere& sphere, char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3557. - const PODVector<OctreeQueryResult>& GetAllDrawables(char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3558. - const PODVector<RayQueryResult>& Raycast(const Ray& ray, RayQueryLevel level, float maxDistance, char drawableFlags, unsigned viewMask = DEFAULT_VIEWMASK) const
  3559. - RayQueryResult RaycastSingle(const Ray& ray, RayQueryLevel level, float maxDistance, char drawableFlags, unsigned viewMask = DEFAULT_VIEWMASK) const
  3560. - unsigned GetNumLevels() const
  3561. - void QueueUpdate(Drawable* drawable)
  3562. - void DrawDebugGeometry(bool depthTest)
  3563. Properties:
  3564. - unsigned numLevels (readonly)
  3565. <a name="Class_OctreeQueryResult"></a>
  3566. ### OctreeQueryResult
  3567. Methods:
  3568. - OctreeQueryResult() (GC)
  3569. - OctreeQueryResult* new()
  3570. - void delete()
  3571. Properties:
  3572. - Drawable* drawable
  3573. - Node* node
  3574. <a name="Class_OffMeshConnection"></a>
  3575. ### OffMeshConnection : Component
  3576. Methods:
  3577. - void SetEndPoint(Node* node)
  3578. - void SetRadius(float radius)
  3579. - void SetBidirectional(bool enabled)
  3580. - void SetMask(unsigned newMask)
  3581. - void SetAreaID(unsigned newAreaID)
  3582. - Node* GetEndPoint() const
  3583. - float GetRadius() const
  3584. - bool IsBidirectional() const
  3585. - unsigned GetMask() const
  3586. - unsigned GetAreaID() const
  3587. Properties:
  3588. - Node* endPoint
  3589. - float radius
  3590. - bool bidirectional
  3591. - unsigned mask
  3592. - unsigned areaID
  3593. <a name="Class_PackageEntry"></a>
  3594. ### PackageEntry
  3595. Properties:
  3596. - unsigned offset
  3597. - unsigned size
  3598. - unsigned checksum
  3599. <a name="Class_PackageFile"></a>
  3600. ### PackageFile : Object
  3601. Methods:
  3602. - PackageFile() (GC)
  3603. - PackageFile* new()
  3604. - PackageFile(const String fileName, unsigned startOffset = 0) (GC)
  3605. - PackageFile* new(const String fileName, unsigned startOffset = 0)
  3606. - void delete()
  3607. - bool Open(const String fileName, unsigned startOffset = 0)
  3608. - bool Exists(const String fileName) const
  3609. - const PackageEntry* GetEntry(const String fileName) const
  3610. - const HashMap<String,PackageEntry>& GetEntries() const
  3611. - const String GetName() const
  3612. - StringHash GetNameHash() const
  3613. - unsigned GetNumFiles() const
  3614. - unsigned GetTotalSize() const
  3615. - unsigned GetTotalDataSize() const
  3616. - unsigned GetChecksum() const
  3617. - bool IsCompressed() const
  3618. Properties:
  3619. - String name (readonly)
  3620. - StringHash nameHash (readonly)
  3621. - unsigned numFiles (readonly)
  3622. - unsigned totalSize (readonly)
  3623. - unsigned totalDataSize (readonly)
  3624. - unsigned checksum (readonly)
  3625. - bool compressed (readonly)
  3626. <a name="Class_ParticleEffect"></a>
  3627. ### ParticleEffect : Resource
  3628. Methods:
  3629. - ParticleEffect() (GC)
  3630. - ParticleEffect* new()
  3631. - void delete()
  3632. - void SetMaterial(Material* material)
  3633. - void SetNumParticles(unsigned num)
  3634. - void SetUpdateInvisible(bool enable)
  3635. - void SetRelative(bool enable)
  3636. - void SetScaled(bool enable)
  3637. - void SetSorted(bool enable)
  3638. - void SetFixedScreenSize(bool enable)
  3639. - void SetAnimationLodBias(float lodBias)
  3640. - void SetEmitterType(EmitterType type)
  3641. - void SetEmitterSize(const Vector3& size)
  3642. - void SetMinDirection(const Vector3& direction)
  3643. - void SetMaxDirection(const Vector3& direction)
  3644. - void SetConstantForce(const Vector3& force)
  3645. - void SetDampingForce(float force)
  3646. - void SetActiveTime(float time)
  3647. - void SetInactiveTime(float time)
  3648. - void SetMinEmissionRate(float rate)
  3649. - void SetMaxEmissionRate(float rate)
  3650. - void SetMinParticleSize(const Vector2& size)
  3651. - void SetMaxParticleSize(const Vector2& size)
  3652. - void SetMinTimeToLive(float time)
  3653. - void SetMaxTimeToLive(float time)
  3654. - void SetMinVelocity(float velocity)
  3655. - void SetMaxVelocity(float velocity)
  3656. - void SetMinRotation(float rotation)
  3657. - void SetMaxRotation(float rotation)
  3658. - void SetMinRotationSpeed(float speed)
  3659. - void SetMaxRotationSpeed(float speed)
  3660. - void SetSizeAdd(float sizeAdd)
  3661. - void SetSizeMul(float sizeMul)
  3662. - void AddColorTime(const Color& color, const float time)
  3663. - void AddColorFrame(const ColorFrame& colorFrame)
  3664. - void RemoveColorFrame(unsigned index)
  3665. - void SetColorFrame(unsigned index, const ColorFrame& colorFrame)
  3666. - void SetNumColorFrames(unsigned number)
  3667. - void SortColorFrames()
  3668. - void AddTextureTime(const Rect& uv, const float time)
  3669. - void AddTextureFrame(const TextureFrame& textureFrame)
  3670. - void RemoveTextureFrame(unsigned index)
  3671. - void SetTextureFrame(unsigned index, const TextureFrame& textureFrame)
  3672. - void SetNumTextureFrames(unsigned number)
  3673. - void SortTextureFrames()
  3674. - ParticleEffect* Clone(const String cloneName = String::EMPTY) const
  3675. - Material* GetMaterial() const
  3676. - unsigned GetNumParticles() const
  3677. - bool GetUpdateInvisible() const
  3678. - bool IsRelative() const
  3679. - bool IsScaled() const
  3680. - bool IsSorted() const
  3681. - bool IsFixedScreenSize() const
  3682. - float GetAnimationLodBias() const
  3683. - EmitterType GetEmitterType() const
  3684. - const Vector3& GetEmitterSize() const
  3685. - const Vector3& GetMinDirection() const
  3686. - const Vector3& GetMaxDirection() const
  3687. - const Vector3& GetConstantForce() const
  3688. - float GetDampingForce() const
  3689. - float GetActiveTime() const
  3690. - float GetInactiveTime() const
  3691. - float GetMinEmissionRate() const
  3692. - float GetMaxEmissionRate() const
  3693. - const Vector2& GetMinParticleSize() const
  3694. - const Vector2& GetMaxParticleSize() const
  3695. - float GetMinTimeToLive() const
  3696. - float GetMaxTimeToLive() const
  3697. - float GetMinVelocity() const
  3698. - float GetMaxVelocity() const
  3699. - float GetMinRotation() const
  3700. - float GetMaxRotation() const
  3701. - float GetMinRotationSpeed() const
  3702. - float GetMaxRotationSpeed() const
  3703. - float GetSizeAdd() const
  3704. - float GetSizeMul() const
  3705. - unsigned GetNumColorFrames() const
  3706. - const ColorFrame* GetColorFrame(unsigned index) const
  3707. - unsigned GetNumTextureFrames() const
  3708. - const TextureFrame* GetTextureFrame(unsigned index) const
  3709. Properties:
  3710. - Material* material
  3711. - unsigned numParticles
  3712. - bool updateInvisible
  3713. - bool relative
  3714. - bool scaled
  3715. - bool sorted
  3716. - bool fixedScreenSize
  3717. - float animationLodBias
  3718. - EmitterType emitterType
  3719. - const Vector3& emitterSize
  3720. - const Vector3& minDirection
  3721. - const Vector3& maxDirection
  3722. - const Vector3& constantForce
  3723. - float dampingForce
  3724. - float activeTime
  3725. - float inactiveTime
  3726. - float minEmissionRate
  3727. - float maxEmissionRate
  3728. - const Vector2& minParticleSize
  3729. - const Vector2& maxParticleSize
  3730. - float minTimeToLive
  3731. - float maxTimeToLive
  3732. - float minVelocity
  3733. - float maxVelocity
  3734. - float minRotation
  3735. - float maxRotation
  3736. - float minRotationSpeed
  3737. - float maxRotationSpeed
  3738. - float sizeAdd
  3739. - float sizeMul
  3740. - unsigned numColorFrames
  3741. - unsigned numTextureFrames
  3742. <a name="Class_ParticleEffect2D"></a>
  3743. ### ParticleEffect2D : Resource
  3744. Methods:
  3745. - ParticleEffect2D* Clone(const String cloneName = String::EMPTY) const
  3746. <a name="Class_ParticleEmitter"></a>
  3747. ### ParticleEmitter : BillboardSet
  3748. Methods:
  3749. - void SetEffect(ParticleEffect* effect)
  3750. - void SetNumParticles(unsigned num)
  3751. - void SetEmitting(bool enable)
  3752. - void SetSerializeParticles(bool enable)
  3753. - void SetAutoRemoveMode(AutoRemoveMode mode)
  3754. - void ResetEmissionTimer()
  3755. - void RemoveAllParticles()
  3756. - void Reset()
  3757. - void ApplyEffect()
  3758. - ParticleEffect* GetEffect() const
  3759. - unsigned GetNumParticles() const
  3760. - bool IsEmitting() const
  3761. - bool GetSerializeParticles() const
  3762. - AutoRemoveMode GetAutoRemoveMode() const
  3763. Properties:
  3764. - ParticleEffect* effect
  3765. - unsigned numParticles
  3766. - bool emitting
  3767. - bool serializeParticles
  3768. - AutoRemoveMode autoRemoveMode
  3769. <a name="Class_ParticleEmitter2D"></a>
  3770. ### ParticleEmitter2D : Drawable2D
  3771. Methods:
  3772. - void SetEffect(ParticleEffect2D* effect)
  3773. - void SetSprite(Sprite2D* sprite)
  3774. - void SetBlendMode(BlendMode blendMode)
  3775. - ParticleEffect2D* GetEffect() const
  3776. - Sprite2D* GetSprite() const
  3777. - BlendMode GetBlendMode() const
  3778. Properties:
  3779. - ParticleEffect2D* effect
  3780. - Sprite2D* sprite
  3781. - BlendMode blendMode
  3782. <a name="Class_Pass"></a>
  3783. ### Pass : RefCounted
  3784. Methods:
  3785. - void SetBlendMode(BlendMode mode)
  3786. - void SetCullMode(CullMode mode)
  3787. - void SetDepthTestMode(CompareMode mode)
  3788. - void SetLightingMode(PassLightingMode mode)
  3789. - void SetDepthWrite(bool enable)
  3790. - void SetAlphaMask(bool enable)
  3791. - void SetIsDesktop(bool enable)
  3792. - void SetVertexShader(const String name)
  3793. - void SetPixelShader(const String name)
  3794. - void SetVertexShaderDefines(const String defines)
  3795. - void SetPixelShaderDefines(const String defines)
  3796. - void ReleaseShaders()
  3797. - const String GetName() const
  3798. - unsigned GetIndex() const
  3799. - CullMode GetCullMode() const
  3800. - BlendMode GetBlendMode() const
  3801. - CompareMode GetDepthTestMode() const
  3802. - PassLightingMode GetLightingMode() const
  3803. - bool GetDepthWrite() const
  3804. - bool GetAlphaMask() const
  3805. - bool IsDesktop() const
  3806. - const String GetVertexShader() const
  3807. - const String GetPixelShader() const
  3808. - const String GetVertexShaderDefines() const
  3809. - const String GetPixelShaderDefines() const
  3810. Properties:
  3811. - String name (readonly)
  3812. - unsigned index (readonly)
  3813. - BlendMode blendMode
  3814. - CullMode cullMode
  3815. - CompareMode depthTestMode
  3816. - PassLightingMode lightingMode
  3817. - bool depthWrite
  3818. - bool alphaMask
  3819. - bool desktop (readonly)
  3820. - String vertexShader
  3821. - String pixelShader
  3822. - String vertexShaderDefines
  3823. - String pixelShaderDefines
  3824. <a name="Class_PhysicsRaycastResult"></a>
  3825. ### PhysicsRaycastResult
  3826. Methods:
  3827. - PhysicsRaycastResult() (GC)
  3828. - PhysicsRaycastResult* new()
  3829. - void delete()
  3830. Properties:
  3831. - Vector3 position
  3832. - Vector3 normal
  3833. - float distance
  3834. - float hitFraction
  3835. - RigidBody* body
  3836. <a name="Class_PhysicsRaycastResult2D"></a>
  3837. ### PhysicsRaycastResult2D
  3838. Methods:
  3839. - PhysicsRaycastResult2D() (GC)
  3840. - PhysicsRaycastResult2D* new()
  3841. - void delete()
  3842. Properties:
  3843. - Vector2 position
  3844. - Vector2 normal
  3845. - float distance
  3846. - RigidBody2D* body
  3847. <a name="Class_PhysicsWorld"></a>
  3848. ### PhysicsWorld : Component
  3849. Methods:
  3850. - void Update(float timeStep)
  3851. - void UpdateCollisions()
  3852. - void SetFps(int fps)
  3853. - void SetGravity(const Vector3& gravity)
  3854. - void SetMaxSubSteps(int num)
  3855. - void SetNumIterations(int num)
  3856. - void SetUpdateEnabled(bool enable)
  3857. - void SetInterpolation(bool enable)
  3858. - void SetInternalEdge(bool enable)
  3859. - void SetSplitImpulse(bool enable)
  3860. - void SetMaxNetworkAngularVelocity(float velocity)
  3861. - const PODVector<PhysicsRaycastResult>& Raycast(const Ray& ray, float maxDistance, unsigned collisionMask = M_MAX_UNSIGNED)
  3862. - PhysicsRaycastResult RaycastSingle(const Ray& ray, float maxDistance, unsigned collisionMask = M_MAX_UNSIGNED)
  3863. - PhysicsRaycastResult RaycastSingleSegmented(const Ray& ray, float maxDistance, float segmentDistance, unsigned collisionMask = M_MAX_UNSIGNED)
  3864. - PhysicsRaycastResult SphereCast(const Ray& ray, float radius, float maxDistance, unsigned collisionMask = M_MAX_UNSIGNED)
  3865. - PhysicsRaycastResult ConvexCast(CollisionShape* shape, const Vector3& startPos, const Quaternion& startRot, const Vector3& endPos, const Quaternion& endRot, unsigned collisionMask = M_MAX_UNSIGNED)
  3866. - const PODVector<RigidBody*>& GetRigidBodies(const Sphere& sphere, unsigned collisionMask = M_MAX_UNSIGNED)
  3867. - const PODVector<RigidBody*>& GetRigidBodies(const BoundingBox& box, unsigned collisionMask = M_MAX_UNSIGNED)
  3868. - const PODVector<RigidBody*>& GetRigidBodies(const RigidBody* body)
  3869. - const PODVector<RigidBody*>& GetCollidingBodies(const RigidBody* body)
  3870. - void DrawDebugGeometry(bool depthTest)
  3871. - void RemoveCachedGeometry(Model* model)
  3872. - Vector3 GetGravity() const
  3873. - int GetMaxSubSteps() const
  3874. - int GetNumIterations() const
  3875. - bool IsUpdateEnabled() const
  3876. - bool GetInterpolation() const
  3877. - bool GetInternalEdge() const
  3878. - bool GetSplitImpulse() const
  3879. - int GetFps() const
  3880. - float GetMaxNetworkAngularVelocity() const
  3881. Properties:
  3882. - Vector3 gravity
  3883. - int maxSubSteps
  3884. - int numIterations
  3885. - bool updateEnabled
  3886. - bool interpolation
  3887. - bool internalEdge
  3888. - bool splitImpulse
  3889. - int fps
  3890. - float maxNetworkAngularVelocity
  3891. <a name="Class_PhysicsWorld2D"></a>
  3892. ### PhysicsWorld2D : Component
  3893. Methods:
  3894. - void DrawDebugGeometry()
  3895. - void SetUpdateEnabled(bool enable)
  3896. - void SetDrawShape(bool drawShape)
  3897. - void SetDrawJoint(bool drawJoint)
  3898. - void SetDrawAabb(bool drawAabb)
  3899. - void SetDrawPair(bool drawPair)
  3900. - void SetDrawCenterOfMass(bool drawCenterOfMass)
  3901. - void SetAllowSleeping(bool enable)
  3902. - void SetWarmStarting(bool enable)
  3903. - void SetContinuousPhysics(bool enable)
  3904. - void SetSubStepping(bool enable)
  3905. - void SetGravity(const Vector2& gravity)
  3906. - void SetAutoClearForces(bool enable)
  3907. - void SetVelocityIterations(int velocityIterations)
  3908. - void SetPositionIterations(int positionIterations)
  3909. - const PODVector<PhysicsRaycastResult2D>& Raycast(const Vector2& startPoint, const Vector2& endPoint, unsigned collisionMask = M_MAX_UNSIGNED)
  3910. - PhysicsRaycastResult2D RaycastSingle(const Vector2& startPoint, const Vector2& endPoint, unsigned collisionMask = M_MAX_UNSIGNED)
  3911. - RigidBody2D* GetRigidBody(const Vector2& point, unsigned collisionMask = M_MAX_UNSIGNED)
  3912. - RigidBody2D* GetRigidBody(int screenX, int screenY, unsigned collisionMask = M_MAX_UNSIGNED)
  3913. - const PODVector<RigidBody2D*>& GetRigidBodies(const Rect& aabb, unsigned collisionMask = M_MAX_UNSIGNED)
  3914. - bool IsUpdateEnabled() const
  3915. - bool GetDrawShape() const
  3916. - bool GetDrawJoint() const
  3917. - bool GetDrawAabb() const
  3918. - bool GetDrawPair() const
  3919. - bool GetDrawCenterOfMass() const
  3920. - bool GetAllowSleeping() const
  3921. - bool GetWarmStarting() const
  3922. - bool GetContinuousPhysics() const
  3923. - bool GetSubStepping() const
  3924. - bool GetAutoClearForces() const
  3925. - const Vector2& GetGravity() const
  3926. - int GetVelocityIterations() const
  3927. - int GetPositionIterations() const
  3928. Properties:
  3929. - bool updateEnabled
  3930. - bool drawShape
  3931. - bool drawJoint
  3932. - bool drawAabb
  3933. - bool drawPair
  3934. - bool drawCenterOfMass
  3935. - bool allowSleeping
  3936. - bool warmStarting
  3937. - bool continuousPhysics
  3938. - bool subStepping
  3939. - bool autoClearForces
  3940. - Vector2& gravity
  3941. - int velocityIterations
  3942. - int positionIterations
  3943. <a name="Class_Plane"></a>
  3944. ### Plane
  3945. Methods:
  3946. - Plane() (GC)
  3947. - Plane* new()
  3948. - Plane(const Plane& plane) (GC)
  3949. - Plane* new(const Plane& plane)
  3950. - Plane(const Vector3& v0, const Vector3& v1, const Vector3& v2) (GC)
  3951. - Plane* new(const Vector3& v0, const Vector3& v1, const Vector3& v2)
  3952. - Plane(const Vector3& normal, const Vector3& point) (GC)
  3953. - Plane* new(const Vector3& normal, const Vector3& point)
  3954. - Plane(const Vector4& plane) (GC)
  3955. - Plane* new(const Vector4& plane)
  3956. - void delete()
  3957. - void Define(const Vector3& v0, const Vector3& v1, const Vector3& v2)
  3958. - void Define(const Vector3& normal, const Vector3& point)
  3959. - void Define(const Vector4& plane)
  3960. - void Transform(const Matrix3& transform)
  3961. - void Transform(const Matrix3x4& transform)
  3962. - void Transform(const Matrix4& transform)
  3963. - Vector3 Project(const Vector3& point) const
  3964. - float Distance(const Vector3& point) const
  3965. - Vector3 Reflect(const Vector3& direction) const
  3966. - Matrix3x4 ReflectionMatrix() const
  3967. - Plane Transformed(const Matrix3& transform) const
  3968. - Plane Transformed(const Matrix3x4& transform) const
  3969. - Plane Transformed(const Matrix4& transform) const
  3970. - Vector4 ToVector4() const
  3971. Properties:
  3972. - Vector3 normal
  3973. - Vector3 absNormal
  3974. - float d
  3975. - const Plane UP
  3976. <a name="Class_Polyhedron"></a>
  3977. ### Polyhedron
  3978. Methods:
  3979. - Polyhedron() (GC)
  3980. - Polyhedron* new()
  3981. - Polyhedron(const Polyhedron& polyhedron) (GC)
  3982. - Polyhedron* new(const Polyhedron& polyhedron)
  3983. - Polyhedron(const BoundingBox& box) (GC)
  3984. - Polyhedron* new(const BoundingBox& box)
  3985. - Polyhedron(const Frustum& frustum) (GC)
  3986. - Polyhedron* new(const Frustum& frustum)
  3987. - void delete()
  3988. - void Define(const BoundingBox& box)
  3989. - void Define(const Frustum& frustum)
  3990. - void AddFace(const Vector3& v0, const Vector3& v1, const Vector3& v2)
  3991. - void AddFace(const Vector3& v0, const Vector3& v1, const Vector3& v2, const Vector3& v3)
  3992. - void Clip(const Plane& plane)
  3993. - void Clip(const BoundingBox& box)
  3994. - void Clip(const Frustum& box)
  3995. - void Clear()
  3996. - void Transform(const Matrix3& transform)
  3997. - void Transform(const Matrix3x4& transform)
  3998. - Polyhedron Transformed(const Matrix3& transform) const
  3999. - Polyhedron Transformed(const Matrix3x4& transform) const
  4000. - bool Empty() const
  4001. Properties:
  4002. - bool empty (readonly)
  4003. <a name="Class_PropertySet2D"></a>
  4004. ### PropertySet2D
  4005. Methods:
  4006. - bool HasProperty(const String name) const
  4007. - const String GetProperty(const String name) const
  4008. <a name="Class_Quaternion"></a>
  4009. ### Quaternion
  4010. Methods:
  4011. - Quaternion() (GC)
  4012. - Quaternion* new()
  4013. - Quaternion(const Quaternion& quat) (GC)
  4014. - Quaternion* new(const Quaternion& quat)
  4015. - Quaternion(float w, float x, float y, float z) (GC)
  4016. - Quaternion* new(float w, float x, float y, float z)
  4017. - Quaternion(float angle, const Vector3& axis) (GC)
  4018. - Quaternion* new(float angle, const Vector3& axis)
  4019. - Quaternion(float angle) (GC)
  4020. - Quaternion* new(float angle)
  4021. - Quaternion(float x, float y, float z) (GC)
  4022. - Quaternion* new(float x, float y, float z)
  4023. - Quaternion(const Vector3& start, const Vector3& end) (GC)
  4024. - Quaternion* new(const Vector3& start, const Vector3& end)
  4025. - Quaternion(const Vector3& xAxis, const Vector3& yAxis, const Vector3& zAxis) (GC)
  4026. - Quaternion* new(const Vector3& xAxis, const Vector3& yAxis, const Vector3& zAxis)
  4027. - Quaternion(const Matrix3& matrix) (GC)
  4028. - Quaternion* new(const Matrix3& matrix)
  4029. - void delete()
  4030. - bool operator==(const Quaternion& rhs) const
  4031. - Quaternion operator*(float rhs) const
  4032. - Quaternion operator-() const
  4033. - bool operator==(const Quaternion& rhs) const
  4034. - Quaternion operator*(float rhs) const
  4035. - Quaternion operator-() const
  4036. - Quaternion operator+(const Quaternion& rhs) const
  4037. - Quaternion operator-(const Quaternion& rhs) const
  4038. - Quaternion operator*(const Quaternion& rhs) const
  4039. - Vector3 operator*(const Vector3& rhs) const
  4040. - void FromAngleAxis(float angle, const Vector3& axis)
  4041. - void FromEulerAngles(float x, float y, float z)
  4042. - void FromRotationTo(const Vector3& start, const Vector3& end)
  4043. - void FromAxes(const Vector3& xAxis, const Vector3& yAxis, const Vector3& zAxis)
  4044. - void FromRotationMatrix(const Matrix3& matrix)
  4045. - bool FromLookRotation(const Vector3& direction, const Vector3& up)
  4046. - void Normalize()
  4047. - Quaternion Normalized() const
  4048. - Quaternion Inverse() const
  4049. - float LengthSquared() const
  4050. - float DotProduct(const Quaternion& rhs) const
  4051. - bool Equals(const Quaternion& rhs) const
  4052. - bool IsNaN() const
  4053. - Quaternion Conjugate() const
  4054. - Vector3 EulerAngles() const
  4055. - float YawAngle() const
  4056. - float PitchAngle() const
  4057. - float RollAngle() const
  4058. - Matrix3 RotationMatrix() const
  4059. - Quaternion Slerp(Quaternion rhs, float t) const
  4060. - Quaternion Nlerp(Quaternion rhs, float t, bool shortestPath) const
  4061. - String ToString() const
  4062. Properties:
  4063. - float w
  4064. - float x
  4065. - float y
  4066. - float z
  4067. - const Quaternion IDENTITY
  4068. <a name="Class_Ray"></a>
  4069. ### Ray
  4070. Methods:
  4071. - Ray() (GC)
  4072. - Ray* new()
  4073. - Ray(const Vector3& origin, const Vector3& direction) (GC)
  4074. - Ray* new(const Vector3& origin, const Vector3& direction)
  4075. - Ray(const Ray& ray) (GC)
  4076. - Ray* new(const Ray& ray)
  4077. - void delete()
  4078. - bool operator==(const Ray& rhs) const
  4079. - void Define(const Vector3& origin, const Vector3& direction)
  4080. - Vector3 Project(const Vector3& point) const
  4081. - float Distance(const Vector3& point) const
  4082. - Vector3 ClosestPoint(const Ray& ray) const
  4083. - float HitDistance(const Plane& plane) const
  4084. - float HitDistance(const BoundingBox& box) const
  4085. - float HitDistance(const Frustum& frustum, bool solidInside = true) const
  4086. - float HitDistance(const Sphere& sphere) const
  4087. - float HitDistance(const Vector3& v0, const Vector3& v1, const Vector3& v2) const
  4088. - Ray Transformed(const Matrix3x4& transform) const
  4089. Properties:
  4090. - Vector3 origin
  4091. - Vector3 direction
  4092. <a name="Class_RayQueryResult"></a>
  4093. ### RayQueryResult
  4094. Methods:
  4095. - RayQueryResult() (GC)
  4096. - RayQueryResult* new()
  4097. - void delete()
  4098. Properties:
  4099. - Vector3 position
  4100. - Vector3 normal
  4101. - Vector2 textureUV
  4102. - float distance
  4103. - Drawable* drawable
  4104. - Node* node
  4105. - unsigned subObject
  4106. <a name="Class_Rect"></a>
  4107. ### Rect
  4108. Methods:
  4109. - Rect() (GC)
  4110. - Rect* new()
  4111. - Rect(const Rect& rect) (GC)
  4112. - Rect* new(const Rect& rect)
  4113. - Rect(const Vector2& min, const Vector2& max) (GC)
  4114. - Rect* new(const Vector2& min, const Vector2& max)
  4115. - Rect(float left, float top, float right, float bottom) (GC)
  4116. - Rect* new(float left, float top, float right, float bottom)
  4117. - Rect(const Vector4& vector) (GC)
  4118. - Rect* new(const Vector4& vector)
  4119. - void delete()
  4120. - bool operator==(const Rect& rhs) const
  4121. - void Define(const Rect& rect)
  4122. - void Define(const Vector2& min, const Vector2& max)
  4123. - void Define(const Vector2& point)
  4124. - void Merge(const Vector2& point)
  4125. - void Merge(const Rect& rect)
  4126. - void Clear()
  4127. - void Clip(const Rect& rect)
  4128. - bool Defined() const
  4129. - Vector2 Center() const
  4130. - Vector2 Size() const
  4131. - Vector2 HalfSize() const
  4132. - bool Equals(const Rect& rhs) const
  4133. - Intersection IsInside(const Vector2& point) const
  4134. - Vector4 ToVector4() const
  4135. - String ToString() const
  4136. Properties:
  4137. - Vector2 min
  4138. - Vector2 max
  4139. - const Rect FULL
  4140. - const Rect POSITIVE
  4141. - const Rect ZERO
  4142. - Vector2 center (readonly)
  4143. - Vector2 size (readonly)
  4144. - Vector2 halfSize (readonly)
  4145. <a name="Class_RemoteEvent"></a>
  4146. ### RemoteEvent
  4147. Properties:
  4148. - unsigned senderID
  4149. - StringHash eventType
  4150. - VariantMap eventData
  4151. - bool inOrder
  4152. <a name="Class_RenderPath"></a>
  4153. ### RenderPath
  4154. Methods:
  4155. - RenderPath* Clone()
  4156. - bool Load(XMLFile* file)
  4157. - bool Append(XMLFile* file)
  4158. - void SetEnabled(const String tag, bool active)
  4159. - void ToggleEnabled(const String tag)
  4160. - void SetRenderTarget(unsigned index, const RenderTargetInfo& info)
  4161. - void AddRenderTarget(const RenderTargetInfo& info)
  4162. - void RemoveRenderTarget(const String name)
  4163. - void RemoveRenderTarget(unsigned index)
  4164. - void RemoveRenderTargets(const String tag)
  4165. - void SetCommand(unsigned index, const RenderPathCommand& command)
  4166. - void AddCommand(const RenderPathCommand& command)
  4167. - void InsertCommand(unsigned index, const RenderPathCommand& command)
  4168. - void RemoveCommand(unsigned index)
  4169. - void RemoveCommands(const String tag)
  4170. - void SetShaderParameter(const String name, const Variant& value)
  4171. - unsigned GetNumRenderTargets() const
  4172. - unsigned GetNumCommands() const
  4173. - RenderPathCommand* GetCommand(unsigned index)
  4174. - const Variant& GetShaderParameter(const String name) const
  4175. <a name="Class_RenderPathCommand"></a>
  4176. ### RenderPathCommand
  4177. Methods:
  4178. - RenderPathCommand() (GC)
  4179. - RenderPathCommand* new()
  4180. - void Load(const XMLElement& element)
  4181. - void SetTextureName(TextureUnit unit, const String name)
  4182. - void SetShaderParameter(const String name, const Variant& value)
  4183. - void RemoveShaderParameter(const String name)
  4184. - void SetNumOutputs(unsigned num)
  4185. - void SetOutput(unsigned index, const String name, CubeMapFace face)
  4186. - void SetOutputName(unsigned index, const String name)
  4187. - void SetOutputFace(unsigned index, CubeMapFace face)
  4188. - void SetDepthStencilName(const String name)
  4189. - const String GetTextureName(TextureUnit unit) const
  4190. - const Variant& GetShaderParameter(const String name) const
  4191. - unsigned GetNumOutputs() const
  4192. - const String GetOutputName(unsigned index) const
  4193. - CubeMapFace GetOutputFace(unsigned index) const
  4194. - const String GetDepthStencilName() const
  4195. Properties:
  4196. - String tag
  4197. - RenderCommandType type
  4198. - RenderCommandSortMode sortMode
  4199. - String pass
  4200. - String metadata
  4201. - String vertexShaderName
  4202. - String pixelShaderName
  4203. - String vertexShaderDefines
  4204. - String pixelShaderDefines
  4205. - unsigned clearFlags
  4206. - Color clearColor
  4207. - float clearDepth
  4208. - unsigned clearStencil
  4209. - BlendMode blendMode
  4210. - bool enabled
  4211. - bool useFogColor
  4212. - bool markToStencil
  4213. - bool useLitBase
  4214. - bool vertexLights
  4215. - String eventName
  4216. <a name="Class_RenderSurface"></a>
  4217. ### RenderSurface
  4218. Methods:
  4219. - RenderSurface(Texture* parentTexture) (GC)
  4220. - RenderSurface* new(Texture* parentTexture)
  4221. - void delete()
  4222. - void SetNumViewports(unsigned num)
  4223. - void SetViewport(unsigned index, Viewport* viewport)
  4224. - void SetUpdateMode(RenderSurfaceUpdateMode mode)
  4225. - void SetLinkedRenderTarget(RenderSurface* renderTarget)
  4226. - void SetLinkedDepthStencil(RenderSurface* depthStencil)
  4227. - void QueueUpdate()
  4228. - void Release()
  4229. - Texture* GetParentTexture() const
  4230. - int GetWidth() const
  4231. - int GetHeight() const
  4232. - TextureUsage GetUsage() const
  4233. - unsigned GetNumViewports() const
  4234. - Viewport* GetViewport(unsigned index) const
  4235. - RenderSurfaceUpdateMode GetUpdateMode() const
  4236. - RenderSurface* GetLinkedRenderTarget() const
  4237. - RenderSurface* GetLinkedDepthStencil() const
  4238. Properties:
  4239. - Texture* parentTexture (readonly)
  4240. - int width (readonly)
  4241. - int height (readonly)
  4242. - TextureUsage usage (readonly)
  4243. - unsigned numViewports
  4244. - RenderSurfaceUpdateMode updateMode
  4245. - RenderSurface* linkedRenderTarget
  4246. - RenderSurface* linkedDepthStencil
  4247. <a name="Class_RenderTargetInfo"></a>
  4248. ### RenderTargetInfo
  4249. Methods:
  4250. - RenderTargetInfo() (GC)
  4251. - RenderTargetInfo* new()
  4252. - void Load(const XMLElement& element)
  4253. Properties:
  4254. - String name
  4255. - String tag
  4256. - unsigned format
  4257. - Vector2 size
  4258. - RenderTargetSizeMode sizeMode
  4259. - bool enabled
  4260. - bool cubemap
  4261. - bool filtered
  4262. - bool sRGB
  4263. - bool persistent
  4264. <a name="Class_Renderer"></a>
  4265. ### Renderer
  4266. Methods:
  4267. - void SetNumViewports(unsigned num)
  4268. - void SetViewport(unsigned index, Viewport* viewport)
  4269. - void SetDefaultRenderPath(RenderPath* renderPath)
  4270. - void SetDefaultRenderPath(XMLFile* file)
  4271. - void SetDefaultTechnique(Technique* technique)
  4272. - void SetHDRRendering(bool enable)
  4273. - void SetSpecularLighting(bool enable)
  4274. - void SetTextureAnisotropy(int level)
  4275. - void SetTextureFilterMode(TextureFilterMode mode)
  4276. - void SetTextureQuality(int quality)
  4277. - void SetMaterialQuality(int quality)
  4278. - void SetDrawShadows(bool enable)
  4279. - void SetShadowMapSize(int size)
  4280. - void SetShadowQuality(ShadowQuality quality)
  4281. - void SetShadowSoftness(float shadowSoftness)
  4282. - void SetVSMShadowParameters(float minVariance, float lightBleedingReduction)
  4283. - void SetReuseShadowMaps(bool enable)
  4284. - void SetMaxShadowMaps(int shadowMaps)
  4285. - void SetDynamicInstancing(bool enable)
  4286. - void SetNumExtraInstancingBufferElements(int elements)
  4287. - void SetMinInstances(int instances)
  4288. - void SetMaxSortedInstances(int instances)
  4289. - void SetMaxOccluderTriangles(int triangles)
  4290. - void SetOcclusionBufferSize(int size)
  4291. - void SetOccluderSizeThreshold(float screenSize)
  4292. - void SetThreadedOcclusion(bool enable)
  4293. - void SetMobileShadowBiasMul(float mul)
  4294. - void SetMobileShadowBiasAdd(float add)
  4295. - void SetMobileNormalOffsetMul(float mul)
  4296. - void ReloadShaders()
  4297. - unsigned GetNumViewports() const
  4298. - Viewport* GetViewport(unsigned index) const
  4299. - RenderPath* GetDefaultRenderPath() const
  4300. - Technique* GetDefaultTechnique() const
  4301. - bool GetHDRRendering() const
  4302. - bool GetSpecularLighting() const
  4303. - bool GetDrawShadows() const
  4304. - int GetTextureAnisotropy() const
  4305. - TextureFilterMode GetTextureFilterMode() const
  4306. - int GetTextureQuality() const
  4307. - int GetMaterialQuality() const
  4308. - int GetShadowMapSize() const
  4309. - ShadowQuality GetShadowQuality() const
  4310. - float GetShadowSoftness() const
  4311. - Vector2 GetVSMShadowParameters() const
  4312. - bool GetReuseShadowMaps() const
  4313. - int GetMaxShadowMaps() const
  4314. - bool GetDynamicInstancing() const
  4315. - int GetNumExtraInstancingBufferElements() const
  4316. - int GetMinInstances() const
  4317. - int GetMaxSortedInstances() const
  4318. - int GetMaxOccluderTriangles() const
  4319. - int GetOcclusionBufferSize() const
  4320. - float GetOccluderSizeThreshold() const
  4321. - bool GetThreadedOcclusion() const
  4322. - float GetMobileShadowBiasMul() const
  4323. - float GetMobileShadowBiasAdd() const
  4324. - float GetMobileNormalOffsetMul() const
  4325. - unsigned GetNumViews() const
  4326. - unsigned GetNumPrimitives() const
  4327. - unsigned GetNumBatches() const
  4328. - unsigned GetNumGeometries(bool allViews = false) const
  4329. - unsigned GetNumLights(bool allViews = false) const
  4330. - unsigned GetNumShadowMaps(bool allViews = false) const
  4331. - unsigned GetNumOccluders(bool allViews = false) const
  4332. - Zone* GetDefaultZone() const
  4333. - Material* GetDefaultMaterial() const
  4334. - Texture2D* GetDefaultLightRamp() const
  4335. - Texture2D* GetDefaultLightSpot() const
  4336. - void DrawDebugGeometry(bool depthTest)
  4337. Properties:
  4338. - unsigned numViewports
  4339. - RenderPath* defaultRenderPath
  4340. - Technique* defaultTechnique
  4341. - bool HDRRendering
  4342. - bool specularLighting
  4343. - bool drawShadows
  4344. - int textureAnisotropy
  4345. - TextureFilterMode textureFilterMode
  4346. - int textureQuality
  4347. - int materialQuality
  4348. - int shadowMapSize
  4349. - ShadowQuality shadowQuality
  4350. - float shadowSoftness
  4351. - bool reuseShadowMaps
  4352. - int maxShadowMaps
  4353. - bool dynamicInstancing
  4354. - int numExtraInstancingBufferElements
  4355. - int minInstances
  4356. - int maxSortedInstances
  4357. - int maxOccluderTriangles
  4358. - int occlusionBufferSize
  4359. - float occluderSizeThreshold
  4360. - bool threadedOcclusion
  4361. - float mobileShadowBiasMul
  4362. - float mobileShadowBiasAdd
  4363. - float mobileNormalOffsetMul
  4364. - unsigned numViews (readonly)
  4365. - unsigned numPrimitives (readonly)
  4366. - unsigned numBatches (readonly)
  4367. - Zone* defaultZone (readonly)
  4368. - Material* defaultMaterial (readonly)
  4369. - Texture2D* defaultLightRamp (readonly)
  4370. - Texture2D* defaultLightSpot (readonly)
  4371. <a name="Class_Resource"></a>
  4372. ### Resource
  4373. Methods:
  4374. - bool Load(Deserializer& source)
  4375. - bool Save(Serializer& dest) const
  4376. - bool Load(const String fileName)
  4377. - bool Save(const String fileName) const
  4378. - const String GetName() const
  4379. - StringHash GetNameHash() const
  4380. - unsigned GetMemoryUse() const
  4381. Properties:
  4382. - String name (readonly)
  4383. - StringHash nameHash (readonly)
  4384. - unsigned memoryUse (readonly)
  4385. <a name="Class_ResourceCache"></a>
  4386. ### ResourceCache
  4387. Methods:
  4388. - void ReleaseAllResources(bool force = false)
  4389. - bool ReloadResource(Resource* resource)
  4390. - void ReloadResourceWithDependencies(const String fileName)
  4391. - void SetMemoryBudget(StringHash type, long budget)
  4392. - void SetMemoryBudget(const String type, long budget)
  4393. - void SetAutoReloadResources(bool enable)
  4394. - void SetReturnFailedResources(bool enable)
  4395. - void SetSearchPackagesFirst(bool value)
  4396. - void SetFinishBackgroundResourcesMs(int ms)
  4397. - File* GetFile(const String name)
  4398. - Resource* GetResource(const String type, const String name, bool sendEventOnFailure = true)
  4399. - Resource* GetExistingResource(const String type, const String name)
  4400. - bool BackgroundLoadResource(const String type, const String name, bool sendEventOnFailure = true)
  4401. - unsigned GetNumBackgroundLoadResources() const
  4402. - const Vector<String>& GetResourceDirs() const
  4403. - bool Exists(const String name) const
  4404. - long GetMemoryBudget(StringHash type) const
  4405. - long GetMemoryUse(StringHash type) const
  4406. - long GetTotalMemoryUse() const
  4407. - String GetResourceFileName(const String name) const
  4408. - bool GetAutoReloadResources() const
  4409. - bool GetReturnFailedResources() const
  4410. - bool GetSearchPackagesFirst() const
  4411. - int GetFinishBackgroundResourcesMs() const
  4412. - String GetPreferredResourceDir(const String path) const
  4413. - String SanitateResourceName(const String name) const
  4414. - String SanitateResourceDirName(const String name) const
  4415. Properties:
  4416. - long totalMemoryUse (readonly)
  4417. - bool autoReloadResources
  4418. - bool returnFailedResources
  4419. - bool searchPackagesFirst
  4420. - unsigned numBackgroundLoadResources (readonly)
  4421. - Vector<String>& resourceDirs (readonly)
  4422. - int finishBackgroundResourcesMs
  4423. <a name="Class_ResourceRef"></a>
  4424. ### ResourceRef
  4425. Methods:
  4426. - ResourceRef() (GC)
  4427. - ResourceRef* new()
  4428. - ResourceRef(StringHash type) (GC)
  4429. - ResourceRef* new(StringHash type)
  4430. - ResourceRef(StringHash type, String name) (GC)
  4431. - ResourceRef* new(StringHash type, String name)
  4432. - ResourceRef(String type, String name) (GC)
  4433. - ResourceRef* new(String type, String name)
  4434. - ResourceRef(const ResourceRef& rhs) (GC)
  4435. - ResourceRef* new(const ResourceRef& rhs)
  4436. - void delete()
  4437. - bool operator==(const ResourceRef& rhs) const
  4438. Properties:
  4439. - StringHash type
  4440. - String name
  4441. <a name="Class_ResourceRefList"></a>
  4442. ### ResourceRefList
  4443. Methods:
  4444. - ResourceRefList() (GC)
  4445. - ResourceRefList* new()
  4446. - ResourceRefList(StringHash type) (GC)
  4447. - ResourceRefList* new(StringHash type)
  4448. - void delete()
  4449. - bool operator==(const ResourceRefList& rhs) const
  4450. Properties:
  4451. - StringHash type
  4452. <a name="Class_RibbonTrail"></a>
  4453. ### RibbonTrail : Drawable
  4454. Methods:
  4455. - void SetMaterial(Material* material)
  4456. - void SetVertexDistance(float length)
  4457. - void SetWidth(float width)
  4458. - void SetStartColor(const Color& c)
  4459. - void SetEndColor(const Color& c)
  4460. - void SetStartScale(float startScale)
  4461. - void SetEndScale(float endScale)
  4462. - void SetTrailType(TrailType type)
  4463. - void SetSorted(bool enable)
  4464. - void SetLifetime(float time)
  4465. - void SetEmitting(bool emitting)
  4466. - void SetUpdateInvisible(bool updateInvisible)
  4467. - void SetTailColumn(unsigned tailColumn)
  4468. - void SetAnimationLodBias(float bias)
  4469. - void Commit()
  4470. - Material* GetMaterial() const
  4471. - float GetVertexDistance() const
  4472. - float GetWidth() const
  4473. - const Color& GetStartColor() const
  4474. - const Color& GetEndColor() const
  4475. - float GetStartScale() const
  4476. - float GetEndScale() const
  4477. - TrailType GetTrailType() const
  4478. - bool IsSorted() const
  4479. - float GetLifetime() const
  4480. - unsigned GetTailColumn() const
  4481. - bool IsEmitting() const
  4482. - bool GetUpdateInvisible() const
  4483. - float GetAnimationLodBias() const
  4484. Properties:
  4485. - Material* material
  4486. - float vertexDistance
  4487. - float width
  4488. - Color& startColor
  4489. - Color& endColor
  4490. - float startScale
  4491. - float endScale
  4492. - TrailType trailType
  4493. - bool sorted
  4494. - float lifetime
  4495. - unsigned tailColumn
  4496. - bool emitting
  4497. - bool updateInvisible
  4498. - float animationLodBias
  4499. <a name="Class_RigidBody"></a>
  4500. ### RigidBody : Component
  4501. Methods:
  4502. - void SetMass(float mass)
  4503. - void SetPosition(const Vector3& position)
  4504. - void SetRotation(const Quaternion& rotation)
  4505. - void SetTransform(const Vector3& position, const Quaternion& rotation)
  4506. - void SetLinearVelocity(const Vector3& velocity)
  4507. - void SetLinearFactor(const Vector3& factor)
  4508. - void SetLinearRestThreshold(float threshold)
  4509. - void SetLinearDamping(float damping)
  4510. - void SetAngularVelocity(const Vector3& angularVelocity)
  4511. - void SetAngularFactor(const Vector3& factor)
  4512. - void SetAngularRestThreshold(float threshold)
  4513. - void SetAngularDamping(float factor)
  4514. - void SetFriction(float friction)
  4515. - void SetAnisotropicFriction(const Vector3& friction)
  4516. - void SetRollingFriction(float friction)
  4517. - void SetRestitution(float restitution)
  4518. - void SetContactProcessingThreshold(float threshold)
  4519. - void SetCcdRadius(float radius)
  4520. - void SetCcdMotionThreshold(float threshold)
  4521. - void SetUseGravity(bool enable)
  4522. - void SetGravityOverride(const Vector3& gravity)
  4523. - void SetKinematic(bool enable)
  4524. - void SetTrigger(bool enable)
  4525. - void SetCollisionLayer(unsigned layer)
  4526. - void SetCollisionMask(unsigned mask)
  4527. - void SetCollisionLayerAndMask(unsigned layer, unsigned mask)
  4528. - void SetCollisionEventMode(CollisionEventMode mode)
  4529. - void DisableMassUpdate()
  4530. - void EnableMassUpdate()
  4531. - void ApplyForce(const Vector3& force)
  4532. - void ApplyForce(const Vector3& force, const Vector3& position)
  4533. - void ApplyTorque(const Vector3& torque)
  4534. - void ApplyImpulse(const Vector3& impulse)
  4535. - void ApplyImpulse(const Vector3& impulse, const Vector3& position)
  4536. - void ApplyTorqueImpulse(const Vector3& torque)
  4537. - void ResetForces()
  4538. - void Activate()
  4539. - void ReAddBodyToWorld()
  4540. - PhysicsWorld* GetPhysicsWorld() const
  4541. - float GetMass() const
  4542. - Vector3 GetPosition() const
  4543. - Quaternion GetRotation() const
  4544. - Vector3 GetLinearVelocity() const
  4545. - Vector3 GetLinearFactor() const
  4546. - Vector3 GetVelocityAtPoint(const Vector3& position) const
  4547. - float GetLinearRestThreshold() const
  4548. - float GetLinearDamping() const
  4549. - Vector3 GetAngularVelocity() const
  4550. - Vector3 GetAngularFactor() const
  4551. - float GetAngularRestThreshold() const
  4552. - float GetAngularDamping() const
  4553. - float GetFriction() const
  4554. - Vector3 GetAnisotropicFriction() const
  4555. - float GetRollingFriction() const
  4556. - float GetRestitution() const
  4557. - float GetContactProcessingThreshold() const
  4558. - float GetCcdRadius() const
  4559. - float GetCcdMotionThreshold() const
  4560. - bool GetUseGravity() const
  4561. - const Vector3& GetGravityOverride() const
  4562. - const Vector3& GetCenterOfMass() const
  4563. - bool IsKinematic() const
  4564. - bool IsTrigger() const
  4565. - bool IsActive() const
  4566. - unsigned GetCollisionLayer() const
  4567. - unsigned GetCollisionMask() const
  4568. - CollisionEventMode GetCollisionEventMode() const
  4569. Properties:
  4570. - PhysicsWorld* physicsWorld (readonly)
  4571. - float mass
  4572. - Vector3 position
  4573. - Quaternion rotation
  4574. - Vector3 linearVelocity
  4575. - Vector3 linearFactor
  4576. - float linearRestThreshold
  4577. - float linearDamping
  4578. - Vector3 angularVelocity
  4579. - Vector3 angularFactor
  4580. - float angularRestThreshold
  4581. - float angularDamping
  4582. - float friction
  4583. - Vector3 anisotropicFriction
  4584. - float rollingFriction
  4585. - float restitution
  4586. - float contactProcessingThreshold
  4587. - float ccdRadius
  4588. - float ccdMotionThreshold
  4589. - bool useGravity
  4590. - Vector3& gravityOverride
  4591. - Vector3& centerOfMass (readonly)
  4592. - bool kinematic
  4593. - bool trigger
  4594. - bool active (readonly)
  4595. - unsigned collisionLayer
  4596. - unsigned collisionMask
  4597. - CollisionEventMode collisionEventMode
  4598. <a name="Class_RigidBody2D"></a>
  4599. ### RigidBody2D : Component
  4600. Methods:
  4601. - void SetBodyType(BodyType2D bodyType)
  4602. - void SetMass(float mass)
  4603. - void SetInertia(float inertia)
  4604. - void SetMassCenter(const Vector2& center)
  4605. - void SetUseFixtureMass(bool useFixtureMass)
  4606. - void SetLinearDamping(float linearDamping)
  4607. - void SetAngularDamping(float angularDamping)
  4608. - void SetAllowSleep(bool allowSleep)
  4609. - void SetFixedRotation(bool fixedRotation)
  4610. - void SetBullet(bool bullet)
  4611. - void SetGravityScale(float gravityScale)
  4612. - void SetAwake(bool awake)
  4613. - void SetLinearVelocity(const Vector2& linearVelocity)
  4614. - void SetAngularVelocity(float angularVelocity)
  4615. - void ApplyForce(const Vector2& force, const Vector2& point, bool wake)
  4616. - void ApplyForceToCenter(const Vector2& force, bool wake)
  4617. - void ApplyTorque(float torque, bool wake)
  4618. - void ApplyLinearImpulse(const Vector2& impulse, const Vector2& point, bool wake)
  4619. - void ApplyAngularImpulse(float impulse, bool wake)
  4620. - BodyType2D GetBodyType() const
  4621. - float GetMass() const
  4622. - float GetInertia() const
  4623. - Vector2 GetMassCenter() const
  4624. - bool GetUseFixtureMass() const
  4625. - float GetLinearDamping() const
  4626. - float GetAngularDamping() const
  4627. - bool IsAllowSleep() const
  4628. - bool IsFixedRotation() const
  4629. - bool IsBullet() const
  4630. - float GetGravityScale() const
  4631. - bool IsAwake() const
  4632. - Vector2 GetLinearVelocity() const
  4633. - float GetAngularVelocity() const
  4634. Properties:
  4635. - BodyType2D bodyType
  4636. - float mass
  4637. - float inertia
  4638. - Vector2 massCenter
  4639. - bool useFixtureMass
  4640. - float linearDamping
  4641. - float angularDamping
  4642. - bool allowSleep
  4643. - bool fixedRotation
  4644. - bool bullet
  4645. - float gravityScale
  4646. - bool awake
  4647. - Vector2 linearVelocity
  4648. - float angularVelocity
  4649. <a name="Class_Scene"></a>
  4650. ### Scene : Node
  4651. Methods:
  4652. - Scene() (GC)
  4653. - Scene* new()
  4654. - void delete()
  4655. - bool Load(File* source)
  4656. - bool Save(File* dest) const
  4657. - bool Load(const String fileName)
  4658. - bool Save(const String fileName) const
  4659. - bool LoadXML(File* source)
  4660. - bool SaveXML(File* dest, const String indentation = "\t") const
  4661. - bool LoadXML(const String fileName)
  4662. - bool SaveXML(const String fileName, const String indentation = "\t") const
  4663. - bool LoadJSON(File* source)
  4664. - bool SaveJSON(File* dest, const String indentation = "\t") const
  4665. - bool LoadJSON(const String fileName)
  4666. - bool SaveJSON(const String fileName, const String indentation = "\t") const
  4667. - Node* Instantiate(File* source, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
  4668. - Node* Instantiate(const String fileName, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
  4669. - Node* InstantiateXML(File* source, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
  4670. - Node* InstantiateXML(const String fileName, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
  4671. - bool LoadAsync(File* file, LoadMode mode = LOAD_SCENE_AND_RESOURCES)
  4672. - bool LoadAsyncXML(File* file, LoadMode mode = LOAD_SCENE_AND_RESOURCES)
  4673. - bool LoadAsync(const String fileName, LoadMode mode = LOAD_SCENE_AND_RESOURCES)
  4674. - bool LoadAsyncXML(const String fileName, LoadMode mode = LOAD_SCENE_AND_RESOURCES)
  4675. - void StopAsyncLoading()
  4676. - void Clear(bool clearReplicated = true, bool clearLocal = true)
  4677. - void SetUpdateEnabled(bool enable)
  4678. - void SetTimeScale(float scale)
  4679. - void SetElapsedTime(float time)
  4680. - void SetSmoothingConstant(float constant)
  4681. - void SetSnapThreshold(float threshold)
  4682. - void SetAsyncLoadingMs(int ms)
  4683. - Node* GetNode(unsigned id) const
  4684. - bool IsUpdateEnabled() const
  4685. - bool IsAsyncLoading() const
  4686. - float GetAsyncProgress() const
  4687. - LoadMode GetAsyncLoadMode() const
  4688. - const String GetFileName() const
  4689. - unsigned GetChecksum() const
  4690. - float GetTimeScale() const
  4691. - float GetElapsedTime() const
  4692. - float GetSmoothingConstant() const
  4693. - float GetSnapThreshold() const
  4694. - int GetAsyncLoadingMs() const
  4695. - const String GetVarName(StringHash hash) const
  4696. - void Update(float timeStep)
  4697. - void BeginThreadedUpdate()
  4698. - void EndThreadedUpdate()
  4699. - void DelayedMarkedDirty(Component* component)
  4700. - bool IsThreadedUpdate() const
  4701. - unsigned GetFreeNodeID(CreateMode mode)
  4702. - unsigned GetFreeComponentID(CreateMode mode)
  4703. - void NodeAdded(Node* node)
  4704. - void NodeRemoved(Node* node)
  4705. - void ComponentAdded(Component* component)
  4706. - void ComponentRemoved(Component* component)
  4707. - void SetVarNamesAttr(const String value)
  4708. - String GetVarNamesAttr() const
  4709. - void PrepareNetworkUpdate()
  4710. - void CleanupConnection(Connection* connection)
  4711. - void MarkNetworkUpdate(Node* node)
  4712. - void MarkNetworkUpdate(Component* component)
  4713. - void MarkReplicationDirty(Node* node)
  4714. - const PODVector<Node*>& GetNodesWithTag(const String tag) const
  4715. Properties:
  4716. - bool updateEnabled
  4717. - bool asyncLoading (readonly)
  4718. - float asyncProgress (readonly)
  4719. - LoadMode asyncLoadMode (readonly)
  4720. - const String fileName
  4721. - unsigned checksum (readonly)
  4722. - float timeScale
  4723. - float elapsedTime
  4724. - float smoothingConstant
  4725. - float snapThreshold
  4726. - int asyncLoadingMs
  4727. - bool threadedUpdate (readonly)
  4728. - String varNamesAttr
  4729. <a name="Class_ScrollBar"></a>
  4730. ### ScrollBar : BorderImage
  4731. Methods:
  4732. - ScrollBar() (GC)
  4733. - ScrollBar* new()
  4734. - void delete()
  4735. - void SetOrientation(Orientation orientation)
  4736. - void SetRange(float range)
  4737. - void SetValue(float value)
  4738. - void ChangeValue(float delta)
  4739. - void SetScrollStep(float step)
  4740. - void SetStepFactor(float factor)
  4741. - void StepBack()
  4742. - void StepForward()
  4743. - Orientation GetOrientation() const
  4744. - float GetRange() const
  4745. - float GetValue() const
  4746. - float GetScrollStep() const
  4747. - float GetStepFactor() const
  4748. - float GetEffectiveScrollStep() const
  4749. - Button* GetBackButton() const
  4750. - Button* GetForwardButton() const
  4751. - Slider* GetSlider() const
  4752. Properties:
  4753. - Orientation orientation
  4754. - float range
  4755. - float value
  4756. - float scrollStep
  4757. - float stepFactor
  4758. - float effectiveScrollStep (readonly)
  4759. - Button* backButton (readonly)
  4760. - Button* forwardButton (readonly)
  4761. - Slider* slider (readonly)
  4762. <a name="Class_ScrollView"></a>
  4763. ### ScrollView : UIElement
  4764. Methods:
  4765. - ScrollView() (GC)
  4766. - ScrollView* new()
  4767. - void delete()
  4768. - void SetContentElement(UIElement* element)
  4769. - void SetViewPosition(const IntVector2& position)
  4770. - void SetViewPosition(int x, int y)
  4771. - void SetScrollBarsVisible(bool horizontal, bool vertical)
  4772. - void SetScrollBarsAutoVisible(bool enable)
  4773. - void SetScrollStep(float step)
  4774. - void SetPageStep(float step)
  4775. - void SetScrollDeceleration(float deceleration)
  4776. - void SetScrollSnapEpsilon(float snap)
  4777. - void SetAutoDisableChildren(bool disable)
  4778. - void SetAutoDisableThreshold(float amount)
  4779. - const IntVector2& GetViewPosition() const
  4780. - UIElement* GetContentElement() const
  4781. - ScrollBar* GetHorizontalScrollBar() const
  4782. - ScrollBar* GetVerticalScrollBar() const
  4783. - BorderImage* GetScrollPanel() const
  4784. - bool GetScrollBarsAutoVisible() const
  4785. - float GetScrollStep() const
  4786. - float GetPageStep() const
  4787. - float GetScrollDeceleration() const
  4788. - float GetScrollSnapEpsilon() const
  4789. - bool GetAutoDisableChildren() const
  4790. - float GetAutoDisableThreshold() const
  4791. Properties:
  4792. - IntVector2& viewPosition
  4793. - UIElement* contentElement
  4794. - ScrollBar* horizontalScrollBar (readonly)
  4795. - ScrollBar* verticalScrollBar (readonly)
  4796. - BorderImage* scrollPanel (readonly)
  4797. - bool scrollBarsAutoVisible
  4798. - float scrollStep
  4799. - float pageStep
  4800. - float scrollDeceleration
  4801. - float scrollSnapEpsilon
  4802. <a name="Class_Serializable"></a>
  4803. ### Serializable : Object
  4804. Methods:
  4805. - void SetTemporary(bool enable)
  4806. - bool IsTemporary() const
  4807. - void SetInterceptNetworkUpdate(const String attributeName, bool enable)
  4808. - bool GetInterceptNetworkUpdate(const String attributeName)
  4809. Properties:
  4810. - bool temporary
  4811. <a name="Class_Serializer"></a>
  4812. ### Serializer
  4813. Methods:
  4814. - unsigned Write(const VectorBuffer& buffer)
  4815. - bool WriteInt(int value)
  4816. - bool WriteInt64(long value)
  4817. - bool WriteShort(short value)
  4818. - bool WriteByte(char value)
  4819. - bool WriteUInt(unsigned value)
  4820. - bool WriteUInt64(long value)
  4821. - bool WriteUShort(short value)
  4822. - bool WriteUByte(char value)
  4823. - bool WriteBool(bool value)
  4824. - bool WriteFloat(float value)
  4825. - bool WriteDouble(double value)
  4826. - bool WriteIntRect(const IntRect& value)
  4827. - bool WriteIntVector2(const IntVector2& value)
  4828. - bool WriteRect(const Rect& value)
  4829. - bool WriteVector2(const Vector2& value)
  4830. - bool WriteVector3(const Vector3& value)
  4831. - bool WritePackedVector3(const Vector3& value, float maxAbsCoord)
  4832. - bool WriteVector4(const Vector4& value)
  4833. - bool WriteQuaternion(const Quaternion& value)
  4834. - bool WritePackedQuaternion(const Quaternion& value)
  4835. - bool WriteMatrix3(const Matrix3& value)
  4836. - bool WriteMatrix3x4(const Matrix3x4& value)
  4837. - bool WriteMatrix4(const Matrix4& value)
  4838. - bool WriteColor(const Color& value)
  4839. - bool WriteBoundingBox(const BoundingBox& value)
  4840. - bool WriteString(const String value)
  4841. - bool WriteFileID(const String value)
  4842. - bool WriteStringHash(const StringHash& value)
  4843. - bool WriteBuffer(const VectorBuffer& buffer)
  4844. - bool WriteResourceRef(const ResourceRef& value)
  4845. - bool WriteResourceRefList(const ResourceRefList& value)
  4846. - bool WriteVariant(const Variant& value)
  4847. - bool WriteVariantData(const Variant& value)
  4848. - bool WriteVariantVector(const VariantVector& value)
  4849. - bool WriteVariantMap(const VariantMap& value)
  4850. - bool WriteVLE(unsigned value)
  4851. - bool WriteNetID(unsigned value)
  4852. - bool WriteLine(const String value)
  4853. <a name="Class_Skeleton"></a>
  4854. ### Skeleton
  4855. Methods:
  4856. - unsigned GetNumBones() const
  4857. - Bone* GetRootBone()
  4858. - Bone* GetBone(const String name)
  4859. - Bone* GetBone(unsigned index)
  4860. Properties:
  4861. - unsigned numBones (readonly)
  4862. - Bone* rootBone (readonly)
  4863. <a name="Class_Skybox"></a>
  4864. ### Skybox : StaticModel
  4865. <a name="Class_Slider"></a>
  4866. ### Slider : BorderImage
  4867. Methods:
  4868. - Slider() (GC)
  4869. - Slider* new()
  4870. - void delete()
  4871. - void SetOrientation(Orientation orientation)
  4872. - void SetRange(float range)
  4873. - void SetValue(float value)
  4874. - void ChangeValue(float delta)
  4875. - void SetRepeatRate(float rate)
  4876. - Orientation GetOrientation() const
  4877. - float GetRange() const
  4878. - float GetValue() const
  4879. - BorderImage* GetKnob() const
  4880. - float GetRepeatRate() const
  4881. Properties:
  4882. - Orientation orientation
  4883. - float range
  4884. - float value
  4885. - BorderImage* knob (readonly)
  4886. - float repeatRate
  4887. <a name="Class_Sound"></a>
  4888. ### Sound : Resource
  4889. Methods:
  4890. - Sound() (GC)
  4891. - Sound* new()
  4892. - void delete()
  4893. - bool LoadRaw(Deserializer& source)
  4894. - bool LoadWav(Deserializer& source)
  4895. - bool LoadOggVorbis(Deserializer& source)
  4896. - bool LoadRaw(const String fileName)
  4897. - bool LoadWav(const String fileName)
  4898. - bool LoadOggVorbis(const String fileName)
  4899. - void SetSize(unsigned dataSize)
  4900. - void SetData(const void* data, unsigned dataSize)
  4901. - void SetFormat(unsigned frequency, bool sixteenBit, bool stereo)
  4902. - void SetLooped(bool enable)
  4903. - void SetLoop(unsigned repeatOffset, unsigned endOffset)
  4904. - void FixInterpolation()
  4905. - float GetLength() const
  4906. - unsigned GetDataSize() const
  4907. - unsigned GetSampleSize() const
  4908. - float GetFrequency() const
  4909. - unsigned GetIntFrequency() const
  4910. - bool IsLooped() const
  4911. - bool IsSixteenBit() const
  4912. - bool IsStereo() const
  4913. - bool IsCompressed() const
  4914. Properties:
  4915. - float length (readonly)
  4916. - unsigned dataSize (readonly)
  4917. - unsigned sampleSize (readonly)
  4918. - float frequency (readonly)
  4919. - int intFrequency (readonly)
  4920. - bool looped
  4921. - bool sixteenBit (readonly)
  4922. - bool stereo (readonly)
  4923. - bool compressed (readonly)
  4924. <a name="Class_SoundListener"></a>
  4925. ### SoundListener : Component
  4926. <a name="Class_SoundSource"></a>
  4927. ### SoundSource : Component
  4928. Methods:
  4929. - void Play(Sound* sound)
  4930. - void Play(Sound* sound, float frequency)
  4931. - void Play(Sound* sound, float frequency, float gain)
  4932. - void Play(Sound* sound, float frequency, float gain, float panning)
  4933. - void Stop()
  4934. - void SetSoundType(const String type)
  4935. - void SetFrequency(float frequency)
  4936. - void SetGain(float gain)
  4937. - void SetAttenuation(float attenuation)
  4938. - void SetPanning(float panning)
  4939. - void SetAutoRemoveMode(AutoRemoveMode mode)
  4940. - Sound* GetSound() const
  4941. - String GetSoundType() const
  4942. - float GetTimePosition() const
  4943. - float GetFrequency() const
  4944. - float GetGain() const
  4945. - float GetAttenuation() const
  4946. - float GetPanning() const
  4947. - AutoRemoveMode GetAutoRemoveMode() const
  4948. - bool IsPlaying() const
  4949. Properties:
  4950. - Sound* sound (readonly)
  4951. - String soundType
  4952. - float timePosition (readonly)
  4953. - float frequency
  4954. - float gain
  4955. - float attenuation
  4956. - float panning
  4957. - AutoRemoveMode autoRemoveMode
  4958. - bool playing (readonly)
  4959. <a name="Class_SoundSource3D"></a>
  4960. ### SoundSource3D : SoundSource
  4961. Methods:
  4962. - void SetDistanceAttenuation(float nearDistance, float farDistance, float rolloffFactor)
  4963. - void SetAngleAttenuation(float innerAngle, float outerAngle)
  4964. - void SetNearDistance(float distance)
  4965. - void SetFarDistance(float distance)
  4966. - void SetInnerAngle(float angle)
  4967. - void SetOuterAngle(float angle)
  4968. - void SetRolloffFactor(float factor)
  4969. - void CalculateAttenuation()
  4970. - float GetNearDistance() const
  4971. - float GetFarDistance() const
  4972. - float GetInnerAngle() const
  4973. - float GetOuterAngle() const
  4974. - float RollAngleoffFactor() const
  4975. Properties:
  4976. - float nearDistance
  4977. - float farDistance
  4978. - float innerAngle
  4979. - float outerAngle
  4980. - float rolloffFactor
  4981. <a name="Class_Sphere"></a>
  4982. ### Sphere
  4983. Methods:
  4984. - Sphere() (GC)
  4985. - Sphere* new()
  4986. - Sphere(const Sphere& sphere) (GC)
  4987. - Sphere* new(const Sphere& sphere)
  4988. - Sphere(const Vector3& center, float radius) (GC)
  4989. - Sphere* new(const Vector3& center, float radius)
  4990. - Sphere(const BoundingBox& box) (GC)
  4991. - Sphere* new(const BoundingBox& box)
  4992. - Sphere(const Frustum& frustum) (GC)
  4993. - Sphere* new(const Frustum& frustum)
  4994. - Sphere(const Polyhedron& poly) (GC)
  4995. - Sphere* new(const Polyhedron& poly)
  4996. - void delete()
  4997. - bool operator==(const Sphere& rhs) const
  4998. - void Define(const Sphere& sphere)
  4999. - void Define(const Vector3& center, float radius)
  5000. - void Define(const BoundingBox& box)
  5001. - void Define(const Frustum& frustum)
  5002. - void Define(const Polyhedron& poly)
  5003. - void Merge(const Vector3& point)
  5004. - void Merge(const BoundingBox& box)
  5005. - void Merge(const Frustum& frustum)
  5006. - void Merge(const Polyhedron& poly)
  5007. - void Merge(const Sphere& sphere)
  5008. - void Clear()
  5009. - bool Defined() const
  5010. - Intersection IsInside(const Vector3& point) const
  5011. - Intersection IsInside(const Sphere& sphere) const
  5012. - Intersection IsInsideFast(const Sphere& sphere) const
  5013. - Intersection IsInside(const BoundingBox& box) const
  5014. - Intersection IsInsideFast(const BoundingBox& box) const
  5015. - float Distance(const Vector3& point) const
  5016. Properties:
  5017. - Vector3 center
  5018. - float radius
  5019. <a name="Class_Spline"></a>
  5020. ### Spline
  5021. Methods:
  5022. - Spline() (GC)
  5023. - Spline* new()
  5024. - Spline(InterpolationMode mode) (GC)
  5025. - Spline* new(InterpolationMode mode)
  5026. - Spline(const Spline& rhs) (GC)
  5027. - Spline* new(const Spline& rhs)
  5028. - void delete()
  5029. - bool operator==(const Spline& rhs) const
  5030. - Variant GetPoint(float f) const
  5031. - Variant GetKnot(unsigned index) const
  5032. - void SetKnot(const Variant& knot, unsigned tolua_var_1)
  5033. - void AddKnot(const Variant& knot)
  5034. - void AddKnot(const Variant& knot, unsigned index)
  5035. - void RemoveKnot()
  5036. - void RemoveKnot(unsigned index)
  5037. - void Clear()
  5038. Properties:
  5039. - InterpolationMode interpolationMode
  5040. <a name="Class_SplinePath"></a>
  5041. ### SplinePath : Component
  5042. Methods:
  5043. - void AddControlPoint(Node* point, unsigned index = M_MAX_UNSIGNED)
  5044. - void RemoveControlPoint(Node* point)
  5045. - void ClearControlPoints()
  5046. - void SetInterpolationMode(InterpolationMode mode)
  5047. - void SetPosition(float factor)
  5048. - void SetControlledNode(Node* controlled)
  5049. - InterpolationMode GetInterpolationMode() const
  5050. - float GetSpeed() const
  5051. - float GetLength() const
  5052. - Vector3 GetPosition() const
  5053. - Node* GetControlledNode() const
  5054. - Vector3 GetPoint(float factor) const
  5055. - void Move(float timeStep)
  5056. - void Reset()
  5057. - bool IsFinished() const
  5058. Properties:
  5059. - InterpolationMode interpolationMode
  5060. - float speed
  5061. - float length (readonly)
  5062. - Node* controlledNode
  5063. <a name="Class_Sprite"></a>
  5064. ### Sprite : UIElement
  5065. Methods:
  5066. - Sprite() (GC)
  5067. - Sprite* new()
  5068. - void delete()
  5069. - void SetPosition(const Vector2& position)
  5070. - void SetPosition(float x, float y)
  5071. - void SetHotSpot(const IntVector2& hotSpot)
  5072. - void SetHotSpot(int x, int y)
  5073. - void SetScale(const Vector2& scale)
  5074. - void SetScale(float x, float y)
  5075. - void SetScale(float scale)
  5076. - void SetRotation(float angle)
  5077. - void SetTexture(Texture* texture)
  5078. - void SetImageRect(const IntRect& rect)
  5079. - void SetFullImageRect()
  5080. - void SetBlendMode(BlendMode mode)
  5081. - const Vector2& GetPosition() const
  5082. - const IntVector2& GetHotSpot() const
  5083. - const Vector2& GetScale() const
  5084. - float GetRotation() const
  5085. - Texture* GetTexture() const
  5086. - const IntRect& GetImageRect() const
  5087. - BlendMode GetBlendMode() const
  5088. - const Matrix3x4& GetTransform() const
  5089. Properties:
  5090. - Vector2& position
  5091. - IntVector2& hotSpot
  5092. - Vector2& scale
  5093. - float rotation
  5094. - Texture* texture
  5095. - IntRect& imageRect
  5096. - BlendMode blendMode
  5097. - Matrix3x4& transform (readonly)
  5098. <a name="Class_Sprite2D"></a>
  5099. ### Sprite2D : Resource
  5100. Methods:
  5101. - void SetTexture(Texture2D* texture)
  5102. - void SetRectangle(const IntRect& rectangle)
  5103. - void SetHotSpot(const Vector2& hotSpot)
  5104. - void SetOffset(const IntVector2& offset)
  5105. - void SetTextureEdgeOffset(float offset)
  5106. - void SetSpriteSheet(SpriteSheet2D* spriteSheet)
  5107. - Texture2D* GetTexture() const
  5108. - const IntRect& GetRectangle() const
  5109. - const Vector2& GetHotSpot() const
  5110. - const IntVector2& GetOffset() const
  5111. - float GetTextureEdgeOffset() const
  5112. - SpriteSheet2D* GetSpriteSheet() const
  5113. Properties:
  5114. - Texture2D* texture
  5115. - IntRect rectangle
  5116. - Vector2 hotSpot
  5117. - IntVector2 offset
  5118. - float textureEdgeOffset
  5119. - SpriteSheet2D* spriteSheet
  5120. <a name="Class_SpriteSheet2D"></a>
  5121. ### SpriteSheet2D : Resource
  5122. Methods:
  5123. - void SetTexture(Texture2D* texture)
  5124. - Texture2D* GetTexture() const
  5125. - Sprite2D* GetSprite(const String name) const
  5126. - void DefineSprite(const String name, const IntRect& rectangle)
  5127. - void DefineSprite(const String name, const IntRect& rectangle, const Vector2& hotSpot)
  5128. - void DefineSprite(const String name, const IntRect& rectangle, const Vector2& hotSpot, const IntVector2& originSize)
  5129. Properties:
  5130. - Texture2D* texture
  5131. <a name="Class_StaticModel"></a>
  5132. ### StaticModel : Drawable
  5133. Methods:
  5134. - void SetModel(Model* model)
  5135. - void SetMaterial(Material* material)
  5136. - bool SetMaterial(unsigned index, Material* material)
  5137. - void SetOcclusionLodLevel(unsigned level)
  5138. - void ApplyMaterialList(const String fileName = String::EMPTY)
  5139. - Model* GetModel() const
  5140. - unsigned GetNumGeometries() const
  5141. - Material* GetMaterial(unsigned index = 0) const
  5142. - unsigned GetOcclusionLodLevel() const
  5143. - bool IsInside(const Vector3& point) const
  5144. - bool IsInsideLocal(const Vector3& point) const
  5145. Properties:
  5146. - Model* model
  5147. - Material* material
  5148. - BoundingBox& boundingBox (readonly)
  5149. - unsigned numGeometries (readonly)
  5150. - unsigned occlusionLodLevel
  5151. <a name="Class_StaticModelGroup"></a>
  5152. ### StaticModelGroup : StaticModel
  5153. Methods:
  5154. - void AddInstanceNode(Node* node)
  5155. - void RemoveInstanceNode(Node* node)
  5156. - void RemoveAllInstanceNodes()
  5157. - unsigned GetNumInstanceNodes() const
  5158. - Node* GetInstanceNode(unsigned index) const
  5159. Properties:
  5160. - unsigned numInstanceNodes (readonly)
  5161. <a name="Class_StaticSprite2D"></a>
  5162. ### StaticSprite2D : Drawable2D
  5163. Methods:
  5164. - void SetSprite(Sprite2D* sprite)
  5165. - void SetBlendMode(BlendMode mode)
  5166. - void SetFlip(bool flipX, bool flipY)
  5167. - void SetFlipX(bool flipX)
  5168. - void SetFlipY(bool flipY)
  5169. - void SetColor(const Color& color)
  5170. - void SetAlpha(float alpha)
  5171. - void SetUseHotSpot(bool useHotSpot)
  5172. - void SetHotSpot(const Vector2& hotspot)
  5173. - void SetCustomMaterial(Material* customMaterial)
  5174. - Sprite2D* GetSprite() const
  5175. - BlendMode GetBlendMode() const
  5176. - bool GetFlipX() const
  5177. - bool GetFlipY() const
  5178. - const Color& GetColor() const
  5179. - float GetAlpha() const
  5180. - bool GetUseHotSpot() const
  5181. - const Vector2& GetHotSpot() const
  5182. - Material* GetCustomMaterial() const
  5183. Properties:
  5184. - Sprite2D* sprite
  5185. - BlendMode blendMode
  5186. - bool flipX
  5187. - bool flipY
  5188. - Color& color
  5189. - float alpha
  5190. - bool useHotSpot
  5191. - Vector2 hotSpot
  5192. - Material* customMaterial
  5193. <a name="Class_StringHash"></a>
  5194. ### StringHash
  5195. Methods:
  5196. - StringHash() (GC)
  5197. - StringHash* new()
  5198. - StringHash(const StringHash& rhs) (GC)
  5199. - StringHash* new(const StringHash& rhs)
  5200. - StringHash(const char* str) (GC)
  5201. - StringHash* new(const char* str)
  5202. - StringHash(unsigned value) (GC)
  5203. - StringHash* new(unsigned value)
  5204. - void delete()
  5205. - StringHash operator+(const StringHash& rhs) const
  5206. - bool operator==(const StringHash& rhs) const
  5207. - bool operator<(const StringHash& rhs) const
  5208. - bool operatorbool() const
  5209. - unsigned Value() const
  5210. - String ToString() const
  5211. - unsigned ToHash() const
  5212. - unsigned Calculate(const char* str)
  5213. Properties:
  5214. - const StringHash ZERO
  5215. - unsigned value (readonly)
  5216. <a name="Class_Technique"></a>
  5217. ### Technique : Resource
  5218. Methods:
  5219. - void SetIsDesktop(bool enable)
  5220. - Pass* CreatePass(const String passName)
  5221. - void RemovePass(const String passName)
  5222. - void ReleaseShaders()
  5223. - Technique* Clone(const String cloneName = String::EMPTY) const
  5224. - bool HasPass(const String type) const
  5225. - Pass* GetPass(const String type) const
  5226. - Pass* GetSupportedPass(const String type) const
  5227. - bool IsSupported() const
  5228. - bool IsDesktop() const
  5229. - unsigned GetNumPasses() const
  5230. - const Vector<String>& GetPassTypes() const
  5231. - const PODVector<Pass*>& GetPasses() const
  5232. Properties:
  5233. - bool supported (readonly)
  5234. - bool desktop (readonly)
  5235. - unsigned numPasses (readonly)
  5236. <a name="Class_Terrain"></a>
  5237. ### Terrain : Component
  5238. Methods:
  5239. - void SetPatchSize(int size)
  5240. - void SetSpacing(const Vector3& spacing)
  5241. - void SetMaxLodLevels(unsigned levels)
  5242. - void SetOcclusionLodLevel(unsigned level)
  5243. - void SetSmoothing(bool enable)
  5244. - bool SetHeightMap(Image* image)
  5245. - void SetMaterial(Material* material)
  5246. - void SetNorthNeighbor(Terrain* north)
  5247. - void SetSouthNeighbor(Terrain* south)
  5248. - void SetWestNeighbor(Terrain* west)
  5249. - void SetEastNeighbor(Terrain* east)
  5250. - void SetNeighbors(Terrain* north, Terrain* south, Terrain* west, Terrain* east)
  5251. - void SetDrawDistance(float distance)
  5252. - void SetShadowDistance(float distance)
  5253. - void SetLodBias(float bias)
  5254. - void SetViewMask(unsigned mask)
  5255. - void SetLightMask(unsigned mask)
  5256. - void SetShadowMask(unsigned mask)
  5257. - void SetZoneMask(unsigned mask)
  5258. - void SetMaxLights(unsigned num)
  5259. - void SetCastShadows(bool enable)
  5260. - void SetOccluder(bool enable)
  5261. - void SetOccludee(bool enable)
  5262. - void ApplyHeightMap()
  5263. - int GetPatchSize() const
  5264. - const Vector3& GetSpacing() const
  5265. - const IntVector2& GetNumVertices() const
  5266. - const IntVector2& GetNumPatches() const
  5267. - unsigned GetMaxLodLevels() const
  5268. - unsigned GetOcclusionLodLevel() const
  5269. - bool GetSmoothing() const
  5270. - Image* GetHeightMap() const
  5271. - Material* GetMaterial() const
  5272. - Terrain* GetNorthNeighbor() const
  5273. - Terrain* GetSouthNeighbor() const
  5274. - Terrain* GetWestNeighbor() const
  5275. - Terrain* GetEastNeighbor() const
  5276. - TerrainPatch* GetPatch(unsigned index) const
  5277. - TerrainPatch* GetPatch(int x, int z) const
  5278. - TerrainPatch* GetNeighborPatch(int x, int z) const
  5279. - float GetHeight(const Vector3& worldPosition) const
  5280. - Vector3 GetNormal(const Vector3& worldPosition) const
  5281. - IntVector2 WorldToHeightMap(const Vector3& worldPosition) const
  5282. - SharedArrayPtr<float> GetHeightData() const
  5283. - float GetDrawDistance() const
  5284. - float GetShadowDistance() const
  5285. - float GetLodBias() const
  5286. - unsigned GetViewMask() const
  5287. - unsigned GetLightMask() const
  5288. - unsigned GetShadowMask() const
  5289. - unsigned GetZoneMask() const
  5290. - unsigned GetMaxLights() const
  5291. - bool IsVisible() const
  5292. - bool GetCastShadows() const
  5293. - bool IsOccluder() const
  5294. - bool IsOccludee() const
  5295. Properties:
  5296. - int patchSize
  5297. - Vector3& spacing
  5298. - IntVector2& numVertices (readonly)
  5299. - IntVector2& numPatches (readonly)
  5300. - unsigned maxLodLevels
  5301. - unsigned occlusionLodLevel
  5302. - bool smoothing
  5303. - Image* heightMap
  5304. - Material* material
  5305. - Terrain* northNeighbor
  5306. - Terrain* southNeighbor
  5307. - Terrain* westNeighbor
  5308. - Terrain* eastNeighbor
  5309. - float drawDistance
  5310. - float shadowDistance
  5311. - float lodBias
  5312. - unsigned viewMask
  5313. - unsigned lightMask
  5314. - unsigned shadowMask
  5315. - unsigned zoneMask
  5316. - unsigned maxLights
  5317. - bool visible (readonly)
  5318. - bool castShadows
  5319. - bool occluder
  5320. - bool occludee
  5321. <a name="Class_TerrainPatch"></a>
  5322. ### TerrainPatch : Drawable
  5323. Methods:
  5324. - void SetOwner(Terrain* terrain)
  5325. - void SetNeighbors(TerrainPatch* north, TerrainPatch* south, TerrainPatch* west, TerrainPatch* east)
  5326. - void SetMaterial(Material* material)
  5327. - void SetBoundingBox(const BoundingBox& box)
  5328. - void SetCoordinates(const IntVector2& coordinates)
  5329. - void ResetLod()
  5330. - Geometry* GetGeometry() const
  5331. - Geometry* GetMaxLodGeometry() const
  5332. - Geometry* GetOcclusionGeometry() const
  5333. - VertexBuffer* GetVertexBuffer() const
  5334. - Terrain* GetOwner() const
  5335. - TerrainPatch* GetNorthPatch() const
  5336. - TerrainPatch* GetSouthPatch() const
  5337. - TerrainPatch* GetWestPatch() const
  5338. - TerrainPatch* GetEastPatch() const
  5339. - const IntVector2& GetCoordinates() const
  5340. - unsigned GetLodLevel() const
  5341. Properties:
  5342. - Geometry* geometry (readonly)
  5343. - Geometry* maxLodGeometry (readonly)
  5344. - Geometry* occlusionGeometry (readonly)
  5345. - VertexBuffer* vertexBuffer (readonly)
  5346. - Terrain* owner
  5347. - TerrainPatch* northPatch (readonly)
  5348. - TerrainPatch* southPatch (readonly)
  5349. - TerrainPatch* westPatch (readonly)
  5350. - TerrainPatch* eastPatch (readonly)
  5351. - BoundingBox& boundingBox
  5352. - IntVector2& coordinates
  5353. - unsigned lodLevel (readonly)
  5354. <a name="Class_Text"></a>
  5355. ### Text : UIElement
  5356. Methods:
  5357. - Text() (GC)
  5358. - Text* new()
  5359. - void delete()
  5360. - bool SetFont(const String fontName, int size = DEFAULT_FONT_SIZE)
  5361. - bool SetFont(Font* font, int size = DEFAULT_FONT_SIZE)
  5362. - bool SetFontSize(int size)
  5363. - void SetText(const String text)
  5364. - void SetTextAlignment(HorizontalAlignment align)
  5365. - void SetRowSpacing(float spacing)
  5366. - void SetWordwrap(bool enable)
  5367. - void SetSelection(unsigned start, unsigned length = M_MAX_UNSIGNED)
  5368. - void ClearSelection()
  5369. - void SetSelectionColor(const Color& color)
  5370. - void SetHoverColor(const Color& color)
  5371. - void SetTextEffect(TextEffect textEffect)
  5372. - void SetEffectShadowOffset(const IntVector2& offset)
  5373. - void SetEffectStrokeThickness(int thickness)
  5374. - void SetEffectRoundStroke(bool roundStroke)
  5375. - void SetEffectColor(const Color& effectColor)
  5376. - bool GetAutoLocalizable() const
  5377. - void SetAutoLocalizable(bool enable)
  5378. - Font* GetFont() const
  5379. - int GetFontSize() const
  5380. - const String GetText() const
  5381. - HorizontalAlignment GetTextAlignment() const
  5382. - float GetRowSpacing() const
  5383. - bool GetWordwrap() const
  5384. - unsigned GetSelectionStart() const
  5385. - unsigned GetSelectionLength() const
  5386. - const Color& GetSelectionColor() const
  5387. - const Color& GetHoverColor() const
  5388. - TextEffect GetTextEffect() const
  5389. - const IntVector2& GetEffectShadowOffset() const
  5390. - int GetEffectStrokeThickness() const
  5391. - bool GetEffectRoundStroke() const
  5392. - const Color& GetEffectColor() const
  5393. - int GetRowHeight() const
  5394. - unsigned GetNumRows() const
  5395. - unsigned GetNumChars() const
  5396. - int GetRowWidth(unsigned index) const
  5397. - IntVector2 GetCharPosition(unsigned index)
  5398. - IntVector2 GetCharSize(unsigned index)
  5399. - void SetEffectDepthBias(float bias)
  5400. - float GetEffectDepthBias() const
  5401. Properties:
  5402. - Font* font
  5403. - int fontSize
  5404. - String text
  5405. - HorizontalAlignment textAlignment
  5406. - float rowSpacing
  5407. - bool wordwrap
  5408. - bool autoLocalizable
  5409. - unsigned selectionStart (readonly)
  5410. - unsigned selectionLength (readonly)
  5411. - Color& selectionColor
  5412. - Color& hoverColor
  5413. - TextEffect textEffect
  5414. - IntVector2& effectShadowOffset
  5415. - int effectStrokeThickness
  5416. - bool effectRoundStroke
  5417. - Color& effectColor
  5418. - int rowHeight (readonly)
  5419. - unsigned numRows (readonly)
  5420. - unsigned numChars (readonly)
  5421. <a name="Class_Text3D"></a>
  5422. ### Text3D : Drawable
  5423. Methods:
  5424. - Text3D() (GC)
  5425. - Text3D* new()
  5426. - void delete()
  5427. - bool SetFont(const String fontName, int size = DEFAULT_FONT_SIZE)
  5428. - bool SetFont(Font* font, int size = DEFAULT_FONT_SIZE)
  5429. - bool SetFontSize(int size)
  5430. - void SetMaterial(Material* material)
  5431. - void SetText(const String text)
  5432. - void SetAlignment(HorizontalAlignment hAlign, VerticalAlignment vAlign)
  5433. - void SetHorizontalAlignment(HorizontalAlignment align)
  5434. - void SetVerticalAlignment(VerticalAlignment align)
  5435. - void SetTextAlignment(HorizontalAlignment align)
  5436. - void SetRowSpacing(float spacing)
  5437. - void SetWordwrap(bool enable)
  5438. - void SetTextEffect(TextEffect textEffect)
  5439. - void SetEffectShadowOffset(const IntVector2& offset)
  5440. - void SetEffectStrokeThickness(int thickness)
  5441. - void SetEffectRoundStroke(bool roundStroke)
  5442. - void SetEffectColor(const Color& effectColor)
  5443. - void SetEffectDepthBias(float bias)
  5444. - void SetWidth(int width)
  5445. - void SetColor(const Color& color)
  5446. - void SetColor(Corner corner, const Color& color)
  5447. - void SetOpacity(float opacity)
  5448. - void SetFixedScreenSize(bool enable)
  5449. - void SetFaceCameraMode(FaceCameraMode mode)
  5450. - Font* GetFont() const
  5451. - Material* GetMaterial() const
  5452. - int GetFontSize() const
  5453. - const String GetText() const
  5454. - HorizontalAlignment GetTextAlignment() const
  5455. - HorizontalAlignment GetHorizontalAlignment() const
  5456. - VerticalAlignment GetVerticalAlignment() const
  5457. - float GetRowSpacing() const
  5458. - bool GetWordwrap() const
  5459. - TextEffect GetTextEffect() const
  5460. - const IntVector2& GetEffectShadowOffset() const
  5461. - int GetEffectStrokeThickness() const
  5462. - bool GetEffectRoundStroke() const
  5463. - const Color& GetEffectColor() const
  5464. - float GetEffectDepthBias() const
  5465. - int GetWidth() const
  5466. - int GetRowHeight() const
  5467. - unsigned GetNumRows() const
  5468. - unsigned GetNumChars() const
  5469. - int GetRowWidth(unsigned index) const
  5470. - IntVector2 GetCharPosition(unsigned index)
  5471. - IntVector2 GetCharSize(unsigned index)
  5472. - const Color& GetColor(Corner corner) const
  5473. - float GetOpacity() const
  5474. - bool IsFixedScreenSize() const
  5475. - FaceCameraMode GetFaceCameraMode() const
  5476. Properties:
  5477. - Font* font
  5478. - Material* material
  5479. - int fontSize
  5480. - String text
  5481. - HorizontalAlignment textAlignment
  5482. - HorizontalAlignment horizontalAlignment
  5483. - VerticalAlignment verticalAlignment
  5484. - float rowSpacing
  5485. - bool wordwrap
  5486. - TextEffect textEffect
  5487. - IntVector2& effectShadowOffset
  5488. - int effectStrokeThickness
  5489. - bool effectRoundStroke
  5490. - Color& effectColor
  5491. - float effectDepthBias
  5492. - int width
  5493. - Color& color
  5494. - int rowHeight (readonly)
  5495. - unsigned numRows (readonly)
  5496. - unsigned numChars (readonly)
  5497. - float opacity
  5498. - bool fixedScreenSize
  5499. - FaceCameraMode faceCameraMode
  5500. <a name="Class_Texture"></a>
  5501. ### Texture : Resource
  5502. Methods:
  5503. - void SetNumLevels(unsigned levels)
  5504. - void SetFilterMode(TextureFilterMode filter)
  5505. - void SetAddressMode(TextureCoordinate coord, TextureAddressMode address)
  5506. - void SetBorderColor(const Color& color)
  5507. - void SetSRGB(bool enable)
  5508. - void SetBackupTexture(Texture* texture)
  5509. - void SetMipsToSkip(int quality, int toSkip)
  5510. - unsigned GetFormat() const
  5511. - bool IsCompressed() const
  5512. - unsigned GetLevels() const
  5513. - int GetWidth() const
  5514. - int GetHeight() const
  5515. - TextureFilterMode GetFilterMode() const
  5516. - TextureAddressMode GetAddressMode(TextureCoordinate coord) const
  5517. - const Color& GetBorderColor() const
  5518. - bool GetSRGB() const
  5519. - Texture* GetBackupTexture() const
  5520. - int GetMipsToSkip(int quality) const
  5521. - int GetLevelWidth(unsigned level) const
  5522. - int GetLevelHeight(unsigned level) const
  5523. - TextureUsage GetUsage() const
  5524. - unsigned GetDataSize(int width, int height) const
  5525. - unsigned GetRowDataSize(int width) const
  5526. - unsigned GetComponents() const
  5527. Properties:
  5528. - unsigned format (readonly)
  5529. - bool compressed (readonly)
  5530. - unsigned levels (readonly)
  5531. - int width (readonly)
  5532. - int height (readonly)
  5533. - unsigned components (readonly)
  5534. - TextureFilterMode filterMode
  5535. - Color& borderColor
  5536. - bool sRGB
  5537. - Texture* backupTexture
  5538. - TextureUsage usage (readonly)
  5539. <a name="Class_Texture2D"></a>
  5540. ### Texture2D : Texture
  5541. Methods:
  5542. - Texture2D() (GC)
  5543. - Texture2D* new()
  5544. - void delete()
  5545. - bool SetSize(int width, int height, unsigned format, TextureUsage usage = TEXTURE_STATIC)
  5546. - bool SetData(Image* image, bool useAlpha = false)
  5547. - RenderSurface* GetRenderSurface() const
  5548. Properties:
  5549. - RenderSurface* renderSurface (readonly)
  5550. <a name="Class_Texture2DArray"></a>
  5551. ### Texture2DArray : Texture
  5552. Methods:
  5553. - Texture2DArray() (GC)
  5554. - Texture2DArray* new()
  5555. - void delete()
  5556. - void SetLayers(unsigned layers)
  5557. - bool SetSize(unsigned layers, int width, int height, unsigned format, TextureUsage usage = TEXTURE_STATIC)
  5558. - bool SetData(unsigned layer, Image* image, bool useAlpha = false)
  5559. - unsigned GetLayers() const
  5560. - RenderSurface* GetRenderSurface() const
  5561. Properties:
  5562. - unsigned layers
  5563. - RenderSurface* renderSurface (readonly)
  5564. <a name="Class_Texture3D"></a>
  5565. ### Texture3D : Texture
  5566. Methods:
  5567. - Texture3D() (GC)
  5568. - Texture3D* new()
  5569. - void delete()
  5570. - bool SetSize(int width, int height, int depth, unsigned format, TextureUsage usage = TEXTURE_STATIC)
  5571. - bool SetData(Image* image, bool useAlpha = false)
  5572. <a name="Class_TextureCube"></a>
  5573. ### TextureCube : Texture
  5574. Methods:
  5575. - TextureCube() (GC)
  5576. - TextureCube* new()
  5577. - void delete()
  5578. - bool SetSize(int size, unsigned format, TextureUsage usage = TEXTURE_STATIC)
  5579. - bool SetData(CubeMapFace face, Image* image, bool useAlpha = false)
  5580. - RenderSurface* GetRenderSurface(CubeMapFace face) const
  5581. <a name="Class_TextureFrame"></a>
  5582. ### TextureFrame
  5583. Methods:
  5584. - TextureFrame() (GC)
  5585. - TextureFrame* new()
  5586. - void delete()
  5587. Properties:
  5588. - Rect uv
  5589. - float time
  5590. <a name="Class_Tile2D"></a>
  5591. ### Tile2D
  5592. Methods:
  5593. - int GetGid() const
  5594. - Sprite2D* GetSprite() const
  5595. - bool HasProperty(const String name) const
  5596. - const String GetProperty(const String name) const
  5597. Properties:
  5598. - int gid (readonly)
  5599. - Sprite2D* sprite (readonly)
  5600. <a name="Class_TileMap2D"></a>
  5601. ### TileMap2D : Component
  5602. Methods:
  5603. - void SetTmxFile(TmxFile2D* tmxFile)
  5604. - TmxFile2D* GetTmxFile() const
  5605. - const TileMapInfo2D& GetInfo() const
  5606. - unsigned GetNumLayers() const
  5607. - TileMapLayer2D* GetLayer(unsigned index) const
  5608. - Vector2 TileIndexToPosition(int x, int y) const
  5609. - bool PositionToTileIndex(const Vector2& position, int x = 0, int y = 0) const
  5610. Properties:
  5611. - TmxFile2D* tmxFile
  5612. - TileMapInfo2D& info (readonly)
  5613. - unsigned numLayers (readonly)
  5614. <a name="Class_TileMapInfo2D"></a>
  5615. ### TileMapInfo2D
  5616. Methods:
  5617. - float GetMapWidth() const
  5618. - float GetMapHeight() const
  5619. Properties:
  5620. - Orientation2D orientation
  5621. - int width
  5622. - int height
  5623. - float tileWidth
  5624. - float tileHeight
  5625. - float mapWidth (readonly)
  5626. - float mapHeight (readonly)
  5627. <a name="Class_TileMapLayer2D"></a>
  5628. ### TileMapLayer2D : Component
  5629. Methods:
  5630. - void SetDrawOrder(int drawOrder)
  5631. - void SetVisible(bool visible)
  5632. - int GetDrawOrder() const
  5633. - bool IsVisible() const
  5634. - bool HasProperty(const String name) const
  5635. - const String GetProperty(const String name) const
  5636. - TileMapLayerType2D GetLayerType() const
  5637. - int GetWidth() const
  5638. - int GetHeight() const
  5639. - Node* GetTileNode(int x, int y) const
  5640. - Tile2D* GetTile(int x, int y) const
  5641. - unsigned GetNumObjects() const
  5642. - TileMapObject2D* GetObject(unsigned index) const
  5643. - Node* GetObjectNode(unsigned index) const
  5644. - Node* GetImageNode() const
  5645. Properties:
  5646. - int drawOrder (readonly)
  5647. - bool visible (readonly)
  5648. - TileMapLayerType2D layerType (readonly)
  5649. - int width (readonly)
  5650. - int height (readonly)
  5651. - unsigned numObjects (readonly)
  5652. - Node* imageNode (readonly)
  5653. <a name="Class_TileMapObject2D"></a>
  5654. ### TileMapObject2D
  5655. Methods:
  5656. - TileMapObjectType2D GetObjectType() const
  5657. - const String GetName() const
  5658. - const String GetType() const
  5659. - const Vector2& GetPosition() const
  5660. - const Vector2& GetSize() const
  5661. - unsigned GetNumPoints() const
  5662. - const Vector2& GetPoint(unsigned index) const
  5663. - int GetTileGid() const
  5664. - Sprite2D* GetTileSprite() const
  5665. - bool HasProperty(const String name) const
  5666. - const String GetProperty(const String name) const
  5667. Properties:
  5668. - TileMapObjectType2D objectType (readonly)
  5669. - String name (readonly)
  5670. - String type (readonly)
  5671. - Vector2 position (readonly)
  5672. - Vector2 size (readonly)
  5673. - unsigned numPoints (readonly)
  5674. - int tileGid (readonly)
  5675. - Sprite2D* tileSprite (readonly)
  5676. <a name="Class_Time"></a>
  5677. ### Time : Object
  5678. Methods:
  5679. - unsigned GetFrameNumber() const
  5680. - float GetTimeStep() const
  5681. - unsigned GetTimerPeriod() const
  5682. - float GetElapsedTime()
  5683. - unsigned GetSystemTime()
  5684. - unsigned GetTimeSinceEpoch()
  5685. - String GetTimeStamp()
  5686. - void Sleep(unsigned mSec)
  5687. Properties:
  5688. - unsigned frameNumber (readonly)
  5689. - float timeStep (readonly)
  5690. - unsigned timerPeriod (readonly)
  5691. - float elapsedTime (readonly)
  5692. <a name="Class_TmxFile2D"></a>
  5693. ### TmxFile2D : Resource
  5694. <a name="Class_ToolTip"></a>
  5695. ### ToolTip : UIElement
  5696. Methods:
  5697. - ToolTip() (GC)
  5698. - ToolTip* new()
  5699. - void delete()
  5700. - void SetDelay(float delay)
  5701. - float GetDelay() const
  5702. Properties:
  5703. - float delay
  5704. <a name="Class_TouchState"></a>
  5705. ### TouchState
  5706. Methods:
  5707. - UIElement* GetTouchedElement()
  5708. Properties:
  5709. - int touchID
  5710. - IntVector2 position
  5711. - IntVector2 lastPosition
  5712. - IntVector2 delta
  5713. - float pressure
  5714. - UIElement* touchedElement (readonly)
  5715. <a name="Class_UI"></a>
  5716. ### UI : Object
  5717. Methods:
  5718. - void SetCursor(Cursor* cursor)
  5719. - void SetFocusElement(UIElement* element, bool byKey = false)
  5720. - bool SetModalElement(UIElement* modalElement, bool enable)
  5721. - void Clear()
  5722. - void DebugDraw(UIElement* element)
  5723. - UIElement* LoadLayout(File* source, XMLFile* styleFile = 0)
  5724. - UIElement* LoadLayout(const String fileName, XMLFile* styleFile = 0)
  5725. - UIElement* LoadLayout(XMLFile* file, XMLFile* styleFile = 0)
  5726. - bool SaveLayout(Serializer& dest, UIElement* element)
  5727. - void SetClipboardText(const String text)
  5728. - void SetDoubleClickInterval(float interval)
  5729. - void SetDragBeginInterval(float interval)
  5730. - void SetDragBeginDistance(int pixels)
  5731. - void SetDefaultToolTipDelay(float delay)
  5732. - void SetMaxFontTextureSize(int size)
  5733. - void SetNonFocusedMouseWheel(bool nonFocusedMouseWheel)
  5734. - void SetUseSystemClipboard(bool enable)
  5735. - void SetUseScreenKeyboard(bool enable)
  5736. - void SetUseMutableGlyphs(bool enable)
  5737. - void SetForceAutoHint(bool enable)
  5738. - void SetScale(float scale)
  5739. - void SetWidth(float width)
  5740. - void SetHeight(float height)
  5741. - void SetCustomSize(const IntVector2& size)
  5742. - void SetCustomSize(int width, int height)
  5743. - UIElement* GetRoot() const
  5744. - UIElement* GetRootModalElement() const
  5745. - Cursor* GetCursor() const
  5746. - IntVector2 GetCursorPosition() const
  5747. - UIElement* GetElementAt(const IntVector2& position, bool enabledOnly = true)
  5748. - UIElement* GetElementAt(int x, int y, bool enabledOnly = true)
  5749. - UIElement* GetFocusElement() const
  5750. - UIElement* GetFrontElement() const
  5751. - UIElement* GetDragElement(unsigned index)
  5752. - const String GetClipboardText() const
  5753. - float GetDoubleClickInterval() const
  5754. - float GetDragBeginInterval() const
  5755. - int GetDragBeginDistance() const
  5756. - float GetDefaultToolTipDelay() const
  5757. - int GetMaxFontTextureSize() const
  5758. - bool IsNonFocusedMouseWheel() const
  5759. - bool GetUseSystemClipboard() const
  5760. - bool GetUseScreenKeyboard() const
  5761. - bool GetUseMutableGlyphs() const
  5762. - bool GetForceAutoHint() const
  5763. - bool HasModalElement() const
  5764. - bool IsDragging() const
  5765. - float GetScale() const
  5766. - const IntVector2& GetCustomSize() const
  5767. Properties:
  5768. - UIElement* root (readonly)
  5769. - UIElement* rootModalElement (readonly)
  5770. - Cursor* cursor
  5771. - IntVector2 cursorPosition (readonly)
  5772. - UIElement* focusElement (readonly)
  5773. - UIElement* frontElement (readonly)
  5774. - String clipboardText
  5775. - float doubleClickInterval
  5776. - float dragBeginInterval
  5777. - int dragBeginDistance
  5778. - float defaultToolTipDelay
  5779. - int maxFontTextureSize
  5780. - bool nonFocusedMouseWheel
  5781. - bool useSystemClipboard
  5782. - bool useScreenKeyboard
  5783. - bool useMutableGlyphs
  5784. - bool forceAutoHint
  5785. - bool modalElement (readonly)
  5786. - float scale
  5787. - IntVector2& customSize
  5788. <a name="Class_UIElement"></a>
  5789. ### UIElement : Animatable
  5790. Methods:
  5791. - UIElement() (GC)
  5792. - UIElement* new()
  5793. - void delete()
  5794. - const IntVector2& GetScreenPosition() const
  5795. - bool LoadXML(Deserializer& source)
  5796. - bool SaveXML(Serializer& dest, const String indentation = "\t") const
  5797. - bool LoadXML(const String fileName)
  5798. - bool SaveXML(const String fileName, const String indentation = "\t") const
  5799. - bool FilterAttributes(XMLElement& dest) const
  5800. - void SetName(const String name)
  5801. - void SetPosition(const IntVector2& position)
  5802. - void SetPosition(int x, int y)
  5803. - void SetSize(const IntVector2& size)
  5804. - void SetSize(int width, int height)
  5805. - void SetWidth(int width)
  5806. - void SetHeight(int height)
  5807. - void SetMinSize(const IntVector2& minSize)
  5808. - void SetMinSize(int width, int height)
  5809. - void SetMinWidth(int width)
  5810. - void SetMinHeight(int height)
  5811. - void SetMaxSize(const IntVector2& maxSize)
  5812. - void SetMaxSize(int width, int height)
  5813. - void SetMaxWidth(int width)
  5814. - void SetMaxHeight(int height)
  5815. - void SetFixedSize(const IntVector2& size)
  5816. - void SetFixedSize(int width, int height)
  5817. - void SetFixedWidth(int width)
  5818. - void SetFixedHeight(int height)
  5819. - void SetAlignment(HorizontalAlignment hAlign, VerticalAlignment vAlign)
  5820. - void SetHorizontalAlignment(HorizontalAlignment align)
  5821. - void SetVerticalAlignment(VerticalAlignment align)
  5822. - void SetClipBorder(const IntRect& rect)
  5823. - void SetColor(const Color& color)
  5824. - void SetColor(Corner corner, const Color& color)
  5825. - void SetPriority(int priority)
  5826. - void SetOpacity(float opacity)
  5827. - void SetBringToFront(bool enable)
  5828. - void SetBringToBack(bool enable)
  5829. - void SetClipChildren(bool enable)
  5830. - void SetSortChildren(bool enable)
  5831. - void SetUseDerivedOpacity(bool enable)
  5832. - void SetEnabled(bool enable)
  5833. - void SetDeepEnabled(bool enable)
  5834. - void ResetDeepEnabled()
  5835. - void SetEnabledRecursive(bool enable)
  5836. - void SetEditable(bool enable)
  5837. - void SetFocus(bool enable)
  5838. - void SetSelected(bool enable)
  5839. - void SetVisible(bool enable)
  5840. - void SetFocusMode(FocusMode mode)
  5841. - void SetDragDropMode(unsigned mode)
  5842. - bool SetStyle(const String styleName, XMLFile* file = 0)
  5843. - bool SetStyle(const XMLElement& element)
  5844. - bool SetStyleAuto(XMLFile* file = 0)
  5845. - void SetDefaultStyle(XMLFile* style)
  5846. - void SetLayout(LayoutMode mode, int spacing = 0)
  5847. - void SetLayout(LayoutMode mode, int spacing, const IntRect& border)
  5848. - void SetLayoutMode(LayoutMode mode)
  5849. - void SetLayoutSpacing(int spacing)
  5850. - void SetLayoutBorder(const IntRect& border)
  5851. - void SetLayoutFlexScale(const Vector2& scale)
  5852. - void SetIndent(int indent)
  5853. - void SetIndentSpacing(int indentSpacing)
  5854. - void UpdateLayout()
  5855. - void DisableLayoutUpdate()
  5856. - void EnableLayoutUpdate()
  5857. - void BringToFront()
  5858. - UIElement* CreateChild(const String type, const String name = String::EMPTY, unsigned index = M_MAX_UNSIGNED)
  5859. - void AddChild(UIElement* element)
  5860. - void InsertChild(unsigned index, UIElement* element)
  5861. - void RemoveChild(UIElement* element, unsigned index = 0)
  5862. - void RemoveChildAtIndex(unsigned index)
  5863. - void RemoveAllChildren()
  5864. - void Remove()
  5865. - unsigned FindChild(UIElement* element) const
  5866. - void SetParent(UIElement* parent, unsigned index = M_MAX_UNSIGNED)
  5867. - void SetVar(StringHash key, const Variant& value)
  5868. - void SetInternal(bool enable)
  5869. - void SetTraversalMode(TraversalMode traversalMode)
  5870. - void SetElementEventSender(bool flag)
  5871. - void AddTag(const String tag)
  5872. - void AddTags(const String tags, char separator)
  5873. - bool RemoveTag(const String tag)
  5874. - void RemoveAllTags()
  5875. - const String GetName() const
  5876. - const IntVector2& GetPosition() const
  5877. - const IntVector2& GetSize() const
  5878. - int GetWidth() const
  5879. - int GetHeight() const
  5880. - const IntVector2& GetMinSize() const
  5881. - int GetMinWidth() const
  5882. - int GetMinHeight() const
  5883. - const IntVector2& GetMaxSize() const
  5884. - int GetMaxWidth() const
  5885. - int GetMaxHeight() const
  5886. - bool IsFixedSize() const
  5887. - bool IsFixedWidth() const
  5888. - bool IsFixedHeight() const
  5889. - const IntVector2& GetChildOffset() const
  5890. - HorizontalAlignment GetHorizontalAlignment() const
  5891. - VerticalAlignment GetVerticalAlignment() const
  5892. - const IntRect& GetClipBorder() const
  5893. - const Color& GetColor(Corner corner) const
  5894. - int GetPriority() const
  5895. - float GetOpacity() const
  5896. - float GetDerivedOpacity() const
  5897. - bool GetBringToFront() const
  5898. - bool GetBringToBack() const
  5899. - bool GetClipChildren() const
  5900. - bool GetSortChildren() const
  5901. - bool GetUseDerivedOpacity() const
  5902. - bool HasFocus() const
  5903. - bool IsEnabled() const
  5904. - bool IsEnabledSelf() const
  5905. - bool IsEditable() const
  5906. - bool IsSelected() const
  5907. - bool IsVisible() const
  5908. - bool IsVisibleEffective() const
  5909. - bool IsHovering() const
  5910. - bool IsInternal() const
  5911. - bool HasColorGradient() const
  5912. - FocusMode GetFocusMode() const
  5913. - unsigned GetDragDropMode() const
  5914. - const String GetAppliedStyle() const
  5915. - XMLFile* GetDefaultStyle(bool recursiveUp = true) const
  5916. - LayoutMode GetLayoutMode() const
  5917. - int GetLayoutSpacing() const
  5918. - const IntRect& GetLayoutBorder() const
  5919. - const Vector2& GetLayoutFlexScale() const
  5920. - unsigned GetNumChildren(bool recursive = false) const
  5921. - int GetDragButtonCombo() const
  5922. - unsigned GetDragButtonCount() const
  5923. - UIElement* GetChild(const String name, bool recursive = false) const
  5924. - UIElement* GetChild(unsigned index) const
  5925. - UIElement* GetParent() const
  5926. - UIElement* GetRoot() const
  5927. - const Color& GetDerivedColor() const
  5928. - const Variant& GetVar(StringHash key) const
  5929. - const VariantMap& GetVars() const
  5930. - bool HasTag(const String tag) const
  5931. - const StringVector& GetTags() const
  5932. - const PODVector<UIElement*>& GetChildrenWithTag(const String tag, bool recursive = false) const
  5933. - IntVector2 ScreenToElement(const IntVector2& screenPosition)
  5934. - IntVector2 ElementToScreen(const IntVector2& position)
  5935. - bool IsInside(IntVector2 position, bool isScreen)
  5936. - bool IsInsideCombined(IntVector2 position, bool isScreen)
  5937. - IntRect GetCombinedScreenRect()
  5938. - void SortChildren()
  5939. - int GetIndent() const
  5940. - int GetIndentSpacing() const
  5941. - int GetIndentWidth() const
  5942. - void SetChildOffset(const IntVector2& offset)
  5943. - void SetHovering(bool enable)
  5944. - const Color& GetColor() const
  5945. - TraversalMode GetTraversalMode() const
  5946. - bool IsElementEventSender() const
  5947. - UIElement* GetElementEventSender() const
  5948. Properties:
  5949. - IntVector2& screenPosition (readonly)
  5950. - String name
  5951. - IntVector2& position
  5952. - IntVector2 size
  5953. - int width
  5954. - int height
  5955. - IntVector2 minSize
  5956. - int minWidth
  5957. - int minHeight
  5958. - IntVector2 maxSize
  5959. - int maxWidth
  5960. - int maxHeight
  5961. - bool fixedSize (readonly)
  5962. - bool fixedWidth (readonly)
  5963. - bool fixedHeight (readonly)
  5964. - IntVector2& childOffset
  5965. - HorizontalAlignment horizontalAlignment
  5966. - VerticalAlignment verticalAlignment
  5967. - IntRect clipBorder
  5968. - Color& color
  5969. - int priority
  5970. - float opacity
  5971. - float derivedOpacity (readonly)
  5972. - bool bringToFront
  5973. - bool bringToBack
  5974. - bool clipChildren
  5975. - bool sortChildren
  5976. - bool useDerivedOpacity
  5977. - bool focus
  5978. - bool enabled
  5979. - bool enabledSelf (readonly)
  5980. - bool editable
  5981. - bool selected
  5982. - bool visible
  5983. - bool visibleEffective (readonly)
  5984. - bool hovering
  5985. - bool internal
  5986. - bool colorGradient (readonly)
  5987. - FocusMode focusMode
  5988. - unsigned dragDropMode
  5989. - String style
  5990. - XMLFile* defaultStyle
  5991. - LayoutMode layoutMode
  5992. - int layoutSpacing
  5993. - IntRect& layoutBorder
  5994. - Vector2& layoutFlexScale
  5995. - unsigned numChildren (readonly)
  5996. - UIElement* parent
  5997. - UIElement* root (readonly)
  5998. - Color& derivedColor (readonly)
  5999. - IntRect combinedScreenRect (readonly)
  6000. - int indent
  6001. - int indentSpacing
  6002. - int indentWidth (readonly)
  6003. - TraversalMode traversalMode
  6004. - bool elementEventSender
  6005. <a name="Class_ValueAnimation"></a>
  6006. ### ValueAnimation : Resource
  6007. Methods:
  6008. - ValueAnimation() (GC)
  6009. - ValueAnimation* new()
  6010. - void delete()
  6011. - void SetInterpolationMethod(InterpMethod method)
  6012. - void SetSplineTension(float tension)
  6013. - void SetValueType(VariantType valueType)
  6014. - bool SetKeyFrame(float time, const Variant& value)
  6015. - void SetEventFrame(float time, const StringHash& eventType)
  6016. - void SetEventFrame(float time, const StringHash& eventType, const VariantMap& eventData)
  6017. - InterpMethod GetInterpolationMethod() const
  6018. - float GetSplineTension() const
  6019. - VariantType GetValueType() const
  6020. Properties:
  6021. - InterpMethod interpolationMethod
  6022. - float splineTension
  6023. - VariantType valueType
  6024. <a name="Class_Variant"></a>
  6025. ### Variant
  6026. Methods:
  6027. - Variant() (GC)
  6028. - Variant* new()
  6029. - Variant(const Variant& value) (GC)
  6030. - Variant* new(const Variant& value)
  6031. - Variant(const char* type, const char* value) (GC)
  6032. - Variant* new(const char* type, const char* value)
  6033. - Variant(VariantType type, const char* value) (GC)
  6034. - Variant* new(VariantType type, const char* value)
  6035. - void delete()
  6036. - void Clear()
  6037. - bool operator==(const Variant& rhs) const
  6038. - void Set(const Variant& rhs)
  6039. - void* Get(const char* type = 0) const
  6040. - int GetInt() const
  6041. - unsigned GetUInt() const
  6042. - StringHash GetStringHash() const
  6043. - bool GetBool() const
  6044. - float GetFloat() const
  6045. - double GetDouble() const
  6046. - const Vector2& GetVector2() const
  6047. - const Vector3& GetVector3() const
  6048. - const Vector4& GetVector4() const
  6049. - const Quaternion& GetQuaternion() const
  6050. - const Color& GetColor() const
  6051. - const String GetString() const
  6052. - const PODVector<unsigned char>& GetRawBuffer() const
  6053. - VectorBuffer GetBuffer() const
  6054. - void* GetVoidPtr(const char* type) const
  6055. - const ResourceRef& GetResourceRef() const
  6056. - const ResourceRefList& GetResourceRefList() const
  6057. - const Vector<Variant>& GetVariantVector() const
  6058. - const VariantMap& GetVariantMap() const
  6059. - const Vector<String>& GetStringVector() const
  6060. - const IntRect& GetIntRect() const
  6061. - const IntVector2& GetIntVector2() const
  6062. - RefCounted* GetPtr(const char* type) const
  6063. - const Matrix3& GetMatrix3() const
  6064. - const Matrix3x4& GetMatrix3x4() const
  6065. - const Matrix4& GetMatrix4() const
  6066. - VariantType GetType() const
  6067. - String GetTypeName() const
  6068. - String ToString() const
  6069. - bool IsZero() const
  6070. - bool IsEmpty() const
  6071. Properties:
  6072. - VariantType type (readonly)
  6073. - String typeName (readonly)
  6074. - bool zero (readonly)
  6075. - bool empty (readonly)
  6076. <a name="Class_VariantMap"></a>
  6077. ### VariantMap
  6078. Methods:
  6079. - VariantMap() (GC)
  6080. - VariantMap* new()
  6081. - void delete()
  6082. <a name="Class_Vector2"></a>
  6083. ### Vector2
  6084. Methods:
  6085. - Vector2() (GC)
  6086. - Vector2* new()
  6087. - Vector2(const Vector2& vector) (GC)
  6088. - Vector2* new(const Vector2& vector)
  6089. - Vector2(float x, float y) (GC)
  6090. - Vector2* new(float x, float y)
  6091. - void delete()
  6092. - bool operator==(const Vector2& rhs) const
  6093. - Vector2 operator+(const Vector2& rhs) const
  6094. - Vector2 operator-() const
  6095. - Vector2 operator-(const Vector2& rhs) const
  6096. - Vector2 operator*(float rhs) const
  6097. - Vector2 operator*(const Vector2& rhs) const
  6098. - Vector2 operator/(float rhs) const
  6099. - Vector2 operator/(const Vector2& rhs) const
  6100. - Vector2 operator/(const Vector2& rhs) const
  6101. - void Normalize()
  6102. - float Length() const
  6103. - float LengthSquared() const
  6104. - float DotProduct(const Vector2& rhs) const
  6105. - float AbsDotProduct(const Vector2& rhs) const
  6106. - float Angle(const Vector2& rhs) const
  6107. - Vector2 Abs() const
  6108. - Vector2 Lerp(const Vector2& rhs, float t) const
  6109. - bool Equals(const Vector2& rhs) const
  6110. - bool IsNaN() const
  6111. - Vector2 Normalized() const
  6112. - String ToString() const
  6113. Properties:
  6114. - float x
  6115. - float y
  6116. - const Vector2 ZERO
  6117. - const Vector2 LEFT
  6118. - const Vector2 RIGHT
  6119. - const Vector2 UP
  6120. - const Vector2 DOWN
  6121. - const Vector2 ONE
  6122. <a name="Class_Vector3"></a>
  6123. ### Vector3
  6124. Methods:
  6125. - Vector3() (GC)
  6126. - Vector3* new()
  6127. - Vector3(const Vector3& vector) (GC)
  6128. - Vector3* new(const Vector3& vector)
  6129. - Vector3(const Vector2& vector, float z) (GC)
  6130. - Vector3* new(const Vector2& vector, float z)
  6131. - Vector3(const Vector2& vector) (GC)
  6132. - Vector3* new(const Vector2& vector)
  6133. - Vector3(float x, float y, float z) (GC)
  6134. - Vector3* new(float x, float y, float z)
  6135. - Vector3(float x, float y) (GC)
  6136. - Vector3* new(float x, float y)
  6137. - void delete()
  6138. - bool operator==(const Vector3& rhs) const
  6139. - Vector3 operator+(const Vector3& rhs) const
  6140. - Vector3 operator-() const
  6141. - Vector3 operator-(const Vector3& rhs) const
  6142. - Vector3 operator*(float rhs) const
  6143. - Vector3 operator*(const Vector3& rhs) const
  6144. - Vector3 operator/(float rhs) const
  6145. - Vector3 operator/(const Vector3& rhs) const
  6146. - void Normalize()
  6147. - float Length() const
  6148. - float LengthSquared() const
  6149. - float DotProduct(const Vector3& rhs) const
  6150. - float AbsDotProduct(const Vector3& rhs) const
  6151. - Vector3 CrossProduct(const Vector3& rhs) const
  6152. - Vector3 Abs() const
  6153. - Vector3 Lerp(const Vector3& rhs, float t) const
  6154. - bool Equals(const Vector3& rhs) const
  6155. - bool IsNaN() const
  6156. - float Angle(const Vector3& rhs) const
  6157. - Vector3 Normalized() const
  6158. - String ToString() const
  6159. Properties:
  6160. - float x
  6161. - float y
  6162. - float z
  6163. - const Vector3 ZERO
  6164. - const Vector3 LEFT
  6165. - const Vector3 RIGHT
  6166. - const Vector3 UP
  6167. - const Vector3 DOWN
  6168. - const Vector3 FORWARD
  6169. - const Vector3 BACK
  6170. - const Vector3 ONE
  6171. <a name="Class_Vector4"></a>
  6172. ### Vector4
  6173. Methods:
  6174. - Vector4() (GC)
  6175. - Vector4* new()
  6176. - Vector4(const Vector4& vector) (GC)
  6177. - Vector4* new(const Vector4& vector)
  6178. - Vector4(const Vector3& vector, float w) (GC)
  6179. - Vector4* new(const Vector3& vector, float w)
  6180. - Vector4(float x, float y, float z, float w) (GC)
  6181. - Vector4* new(float x, float y, float z, float w)
  6182. - void delete()
  6183. - bool operator==(const Vector4& rhs) const
  6184. - Vector4 operator+(const Vector4& rhs) const
  6185. - Vector4 operator-() const
  6186. - Vector4 operator-(const Vector4& rhs) const
  6187. - Vector4 operator*(float rhs) const
  6188. - Vector4 operator*(const Vector4& rhs) const
  6189. - Vector4 operator/(float rhs) const
  6190. - Vector4 operator/(const Vector4& rhs) const
  6191. - Vector4 operator/(const Vector4& rhs) const
  6192. - float DotProduct(const Vector4& rhs) const
  6193. - float AbsDotProduct(const Vector4& rhs) const
  6194. - Vector4 Abs() const
  6195. - Vector4 Lerp(const Vector4& rhs, float t) const
  6196. - bool Equals(const Vector4& rhs) const
  6197. - bool IsNaN() const
  6198. - String ToString() const
  6199. Properties:
  6200. - float x
  6201. - float y
  6202. - float z
  6203. - float w
  6204. - const Vector4 ZERO
  6205. - const Vector4 ONE
  6206. <a name="Class_VectorBuffer"></a>
  6207. ### VectorBuffer
  6208. Methods:
  6209. - VectorBuffer() (GC)
  6210. - VectorBuffer* new()
  6211. - VectorBuffer(Deserializer& source, unsigned size) (GC)
  6212. - VectorBuffer* new(Deserializer& source, unsigned size)
  6213. - void delete()
  6214. - void SetData(Deserializer& source, unsigned size)
  6215. - void Clear()
  6216. - void Resize(unsigned size)
  6217. - const void* GetData() const
  6218. - void* GetModifiableData()
  6219. - VectorBuffer Read(unsigned size)
  6220. - unsigned Seek(unsigned position)
  6221. - const String GetName() const
  6222. - unsigned GetChecksum()
  6223. - unsigned GetPosition() const
  6224. - unsigned GetSize() const
  6225. - bool IsEof() const
  6226. - int ReadInt()
  6227. - long ReadInt64()
  6228. - short ReadShort()
  6229. - char ReadByte()
  6230. - unsigned ReadUInt()
  6231. - long ReadUInt64()
  6232. - short ReadUShort()
  6233. - char ReadUByte()
  6234. - bool ReadBool()
  6235. - float ReadFloat()
  6236. - double ReadDouble()
  6237. - IntRect ReadIntRect()
  6238. - IntVector2 ReadIntVector2()
  6239. - Rect ReadRect()
  6240. - Vector2 ReadVector2()
  6241. - Vector3 ReadVector3()
  6242. - Vector3 ReadPackedVector3(float maxAbsCoord)
  6243. - Vector4 ReadVector4()
  6244. - Quaternion ReadQuaternion()
  6245. - Quaternion ReadPackedQuaternion()
  6246. - Matrix3 ReadMatrix3()
  6247. - Matrix3x4 ReadMatrix3x4()
  6248. - Matrix4 ReadMatrix4()
  6249. - Color ReadColor()
  6250. - BoundingBox ReadBoundingBox()
  6251. - String ReadString()
  6252. - String ReadFileID()
  6253. - StringHash ReadStringHash()
  6254. - VectorBuffer ReadBuffer()
  6255. - ResourceRef ReadResourceRef()
  6256. - ResourceRefList ReadResourceRefList()
  6257. - Variant ReadVariant()
  6258. - Variant ReadVariant(VariantType type)
  6259. - VariantVector ReadVariantVector()
  6260. - VariantMap ReadVariantMap()
  6261. - unsigned ReadVLE()
  6262. - unsigned ReadNetID()
  6263. - String ReadLine()
  6264. - unsigned Write(const VectorBuffer& buffer)
  6265. - bool WriteInt(int value)
  6266. - bool WriteInt64(long value)
  6267. - bool WriteShort(short value)
  6268. - bool WriteByte(char value)
  6269. - bool WriteUInt(unsigned value)
  6270. - bool WriteUInt64(long value)
  6271. - bool WriteUShort(short value)
  6272. - bool WriteUByte(char value)
  6273. - bool WriteBool(bool value)
  6274. - bool WriteFloat(float value)
  6275. - bool WriteDouble(double value)
  6276. - bool WriteIntRect(const IntRect& value)
  6277. - bool WriteIntVector2(const IntVector2& value)
  6278. - bool WriteRect(const Rect& value)
  6279. - bool WriteVector2(const Vector2& value)
  6280. - bool WriteVector3(const Vector3& value)
  6281. - bool WritePackedVector3(const Vector3& value, float maxAbsCoord)
  6282. - bool WriteVector4(const Vector4& value)
  6283. - bool WriteQuaternion(const Quaternion& value)
  6284. - bool WritePackedQuaternion(const Quaternion& value)
  6285. - bool WriteMatrix3(const Matrix3& value)
  6286. - bool WriteMatrix3x4(const Matrix3x4& value)
  6287. - bool WriteMatrix4(const Matrix4& value)
  6288. - bool WriteColor(const Color& value)
  6289. - bool WriteBoundingBox(const BoundingBox& value)
  6290. - bool WriteString(const String value)
  6291. - bool WriteFileID(const String value)
  6292. - bool WriteStringHash(const StringHash& value)
  6293. - bool WriteBuffer(const VectorBuffer& buffer)
  6294. - bool WriteResourceRef(const ResourceRef& value)
  6295. - bool WriteResourceRefList(const ResourceRefList& value)
  6296. - bool WriteVariant(const Variant& value)
  6297. - bool WriteVariantData(const Variant& value)
  6298. - bool WriteVariantVector(const VariantVector& value)
  6299. - bool WriteVariantMap(const VariantMap& value)
  6300. - bool WriteVLE(unsigned value)
  6301. - bool WriteNetID(unsigned value)
  6302. - bool WriteLine(const String value)
  6303. Properties:
  6304. - String name (readonly)
  6305. - unsigned checksum (readonly)
  6306. - unsigned position (readonly)
  6307. - unsigned size (readonly)
  6308. - bool eof (readonly)
  6309. <a name="Class_VertexBuffer"></a>
  6310. ### VertexBuffer : Object
  6311. Methods:
  6312. - VertexBuffer() (GC)
  6313. - VertexBuffer* new()
  6314. - void delete()
  6315. - void SetShadowed(bool enable)
  6316. - bool SetSize(unsigned vertexCount, const PODVector<VertexElement>& elements, bool dynamic = false)
  6317. - bool SetSize(unsigned vertexCount, unsigned elementMask, bool dynamic = false)
  6318. - bool SetData(VectorBuffer& data)
  6319. - bool SetDataRange(VectorBuffer& data, unsigned start, unsigned count, bool discard = false)
  6320. - VectorBuffer GetData()
  6321. - bool IsShadowed() const
  6322. - bool IsDynamic() const
  6323. - unsigned GetVertexCount() const
  6324. - unsigned GetVertexSize() const
  6325. - const PODVector<VertexElement>& GetElements() const
  6326. - bool HasElement(VertexElementSemantic semantic, char index = 0) const
  6327. - bool HasElement(VertexElementType type, VertexElementSemantic semantic, char index = 0) const
  6328. - unsigned GetElementOffset(VertexElementSemantic semantic, char index = 0) const
  6329. - unsigned GetElementOffset(VertexElementType type, VertexElementSemantic semantic, char index = 0) const
  6330. - unsigned GetElementMask() const
  6331. Properties:
  6332. - bool shadowed
  6333. - bool dynamic (readonly)
  6334. - unsigned vertexCount (readonly)
  6335. - unsigned vertexSize (readonly)
  6336. - unsigned elementMask (readonly)
  6337. <a name="Class_VertexElement"></a>
  6338. ### VertexElement
  6339. Methods:
  6340. - VertexElement() (GC)
  6341. - VertexElement* new()
  6342. - VertexElement(VertexElementType type, VertexElementSemantic semantic, char index = 0, bool perInstance = false) (GC)
  6343. - VertexElement* new(VertexElementType type, VertexElementSemantic semantic, char index = 0, bool perInstance = false)
  6344. Properties:
  6345. - VertexElementType type
  6346. - VertexElementSemantic semantic
  6347. - char index
  6348. - bool perInstance
  6349. - unsigned offset
  6350. <a name="Class_View3D"></a>
  6351. ### View3D : Window
  6352. Methods:
  6353. - View3D() (GC)
  6354. - View3D* new()
  6355. - void delete()
  6356. - void SetView(Scene* scene, Camera* camera, bool ownScene = true)
  6357. - void SetFormat(unsigned format)
  6358. - void SetAutoUpdate(bool enable)
  6359. - void QueueUpdate()
  6360. - unsigned GetFormat() const
  6361. - bool GetAutoUpdate() const
  6362. - Scene* GetScene() const
  6363. - Node* GetCameraNode() const
  6364. - Texture2D* GetRenderTexture() const
  6365. - Texture2D* GetDepthTexture() const
  6366. - Viewport* GetViewport() const
  6367. Properties:
  6368. - unsigned format
  6369. - bool autoUpdate
  6370. <a name="Class_Viewport"></a>
  6371. ### Viewport
  6372. Methods:
  6373. - Viewport() (GC)
  6374. - Viewport* new()
  6375. - Viewport(Scene* scene, Camera* camera, RenderPath* renderPath = 0) (GC)
  6376. - Viewport* new(Scene* scene, Camera* camera, RenderPath* renderPath = 0)
  6377. - Viewport(Scene* scene, Camera* camera, const IntRect& rect, RenderPath* renderPath = 0) (GC)
  6378. - Viewport* new(Scene* scene, Camera* camera, const IntRect& rect, RenderPath* renderPath = 0)
  6379. - void delete()
  6380. - void SetScene(Scene* scene)
  6381. - void SetCamera(Camera* camera)
  6382. - void SetCullCamera(Camera* camera)
  6383. - void SetRect(const IntRect& rect)
  6384. - void SetRenderPath(RenderPath* path)
  6385. - void SetRenderPath(XMLFile* file)
  6386. - void SetDrawDebug(bool enable)
  6387. - Scene* GetScene() const
  6388. - Camera* GetCamera() const
  6389. - Camera* GetCullCamera() const
  6390. - const IntRect& GetRect() const
  6391. - RenderPath* GetRenderPath() const
  6392. - bool GetDrawDebug() const
  6393. - Ray GetScreenRay(int x, int y) const
  6394. - IntVector2 WorldToScreenPoint(const Vector3& worldPos) const
  6395. - Vector3 ScreenToWorldPoint(int x, int y, float depth) const
  6396. Properties:
  6397. - Scene* scene
  6398. - Camera* camera
  6399. - Camera* cullCamera
  6400. - IntRect& rect
  6401. - RenderPath* renderPath
  6402. - bool drawDebug
  6403. <a name="Class_Window"></a>
  6404. ### Window : BorderImage
  6405. Methods:
  6406. - Window() (GC)
  6407. - Window* new()
  6408. - void delete()
  6409. - void SetMovable(bool enable)
  6410. - void SetResizable(bool enable)
  6411. - void SetFixedWidthResizing(bool enable)
  6412. - void SetFixedHeightResizing(bool enable)
  6413. - void SetResizeBorder(const IntRect& rect)
  6414. - void SetModal(bool modal)
  6415. - void SetModalShadeColor(const Color& color)
  6416. - void SetModalFrameColor(const Color& color)
  6417. - void SetModalFrameSize(const IntVector2& size)
  6418. - void SetModalAutoDismiss(bool enable)
  6419. - bool IsMovable() const
  6420. - bool IsResizable() const
  6421. - bool GetFixedWidthResizing() const
  6422. - bool GetFixedHeightResizing() const
  6423. - const IntRect& GetResizeBorder() const
  6424. - bool IsModal() const
  6425. - const Color& GetModalShadeColor() const
  6426. - const Color& GetModalFrameColor() const
  6427. - const IntVector2& GetModalFrameSize() const
  6428. - bool GetModalAutoDismiss() const
  6429. Properties:
  6430. - bool movable
  6431. - bool resizable
  6432. - bool fixedWidthResizing
  6433. - bool fixedHeightResizing
  6434. - IntRect& resizeBorder
  6435. - bool modal
  6436. - Color& modalShadeColor
  6437. - Color& modalFrameColor
  6438. - IntVector2& modalFrameSize
  6439. - bool modalAutoDismiss
  6440. <a name="Class_XMLElement"></a>
  6441. ### XMLElement
  6442. Methods:
  6443. - XMLElement CreateChild(const String name)
  6444. - bool RemoveChild(const XMLElement& element)
  6445. - bool RemoveChild(const String name)
  6446. - bool RemoveChildren(const String name = String::EMPTY)
  6447. - bool RemoveAttribute(const String name = String::EMPTY)
  6448. - bool SetValue(const String value)
  6449. - bool SetAttribute(const String name, const String value)
  6450. - bool SetAttribute(const String value)
  6451. - bool SetBool(const String name, bool value)
  6452. - bool SetBoundingBox(const BoundingBox& value)
  6453. - bool SetColor(const String name, const Color& value)
  6454. - bool SetFloat(const String name, float value)
  6455. - bool SetDouble(const String name, double value)
  6456. - bool SetUInt(const String name, unsigned value)
  6457. - bool SetInt(const String name, int value)
  6458. - bool SetIntRect(const String name, const IntRect& value)
  6459. - bool SetIntVector2(const String name, const IntVector2& value)
  6460. - bool SetRect(const String name, const Rect& value)
  6461. - bool SetQuaternion(const String name, const Quaternion& value)
  6462. - bool SetString(const String name, const String value)
  6463. - bool SetVariant(const Variant& value)
  6464. - bool SetVariantValue(const Variant& value)
  6465. - bool SetResourceRef(const ResourceRef& value)
  6466. - bool SetResourceRefList(const ResourceRefList& value)
  6467. - bool SetVector2(const String name, const Vector2& value)
  6468. - bool SetVector3(const String name, const Vector3& value)
  6469. - bool SetVector4(const String name, const Vector4& value)
  6470. - bool SetVectorVariant(const String name, const Variant& value)
  6471. - bool SetMatrix3(const String name, const Matrix3& value)
  6472. - bool SetMatrix3x4(const String name, const Matrix3x4& value)
  6473. - bool SetMatrix4(const String name, const Matrix4& value)
  6474. - bool IsNull() const
  6475. - bool NotNull() const
  6476. - bool operatorbool() const
  6477. - String GetName() const
  6478. - bool HasChild(const String name) const
  6479. - XMLElement GetChild(const String name = String::EMPTY) const
  6480. - XMLElement GetNext(const String name = String::EMPTY) const
  6481. - XMLElement GetParent() const
  6482. - unsigned GetNumAttributes() const
  6483. - bool HasAttribute(const String name) const
  6484. - String GetValue() const
  6485. - String GetAttribute(const String name = String::EMPTY) const
  6486. - String GetAttributeLower(const String name) const
  6487. - String GetAttributeUpper(const String name) const
  6488. - Vector<String> GetAttributeNames() const
  6489. - bool GetBool(const String name) const
  6490. - BoundingBox GetBoundingBox() const
  6491. - Color GetColor(const String name) const
  6492. - float GetFloat(const String name) const
  6493. - double GetDouble(const String name) const
  6494. - unsigned GetUInt(const String name) const
  6495. - int GetInt(const String name) const
  6496. - IntRect GetIntRect(const String name) const
  6497. - IntVector2 GetIntVector2(const String name) const
  6498. - Rect GetRect(const String name) const
  6499. - Quaternion GetQuaternion(const String name) const
  6500. - Variant GetVariant() const
  6501. - Variant GetVariantValue(VariantType type) const
  6502. - ResourceRef GetResourceRef() const
  6503. - ResourceRefList GetResourceRefList() const
  6504. - VariantMap GetVariantMap() const
  6505. - Vector2 GetVector2(const String name) const
  6506. - Vector3 GetVector3(const String name) const
  6507. - Vector4 GetVector4(const String name) const
  6508. - Vector4 GetVector(const String name) const
  6509. - Matrix3 GetMatrix3(const String name) const
  6510. - Matrix3x4 GetMatrix3x4(const String name) const
  6511. - Matrix4 GetMatrix4(const String name) const
  6512. - XMLFile* GetFile() const
  6513. Properties:
  6514. - const XMLElement EMPTY
  6515. - bool null (readonly)
  6516. - String name (readonly)
  6517. - XMLElement parent (readonly)
  6518. - String value (readonly)
  6519. - unsigned numAttributes (readonly)
  6520. - XMLFile* file (readonly)
  6521. <a name="Class_XMLFile"></a>
  6522. ### XMLFile : Resource
  6523. Methods:
  6524. - XMLFile() (GC)
  6525. - XMLFile* new()
  6526. - void delete()
  6527. - bool FromString(const String source)
  6528. - XMLElement CreateRoot(const String name = String::EMPTY)
  6529. - XMLElement GetRoot(const String name = String::EMPTY)
  6530. - String ToString(const String indentation = "\t") const
  6531. - void Patch(XMLFile* patchFile)
  6532. - void Patch(XMLElement patchElement)
  6533. - bool Save(const String fileName, const String indentation = "\t") const
  6534. <a name="Class_Zone"></a>
  6535. ### Zone : Drawable
  6536. Methods:
  6537. - void SetBoundingBox(const BoundingBox& box)
  6538. - void SetAmbientColor(const Color& color)
  6539. - void SetFogColor(const Color& color)
  6540. - void SetFogStart(float start)
  6541. - void SetFogEnd(float end)
  6542. - void SetFogHeight(float height)
  6543. - void SetFogHeightScale(float scale)
  6544. - void SetPriority(int priority)
  6545. - void SetHeightFog(bool enable)
  6546. - void SetOverride(bool enable)
  6547. - void SetAmbientGradient(bool enable)
  6548. - void SetZoneTexture(Texture* texture)
  6549. - const Matrix3x4& GetInverseWorldTransform() const
  6550. - const Color& GetAmbientColor() const
  6551. - const Color& GetAmbientStartColor()
  6552. - const Color& GetAmbientEndColor()
  6553. - const Color& GetFogColor() const
  6554. - float GetFogStart() const
  6555. - float GetFogEnd() const
  6556. - float GetFogHeight() const
  6557. - float GetFogHeightScale() const
  6558. - int GetPriority() const
  6559. - bool GetHeightFog() const
  6560. - bool GetOverride() const
  6561. - bool GetAmbientGradient() const
  6562. - Texture* GetZoneTexture() const
  6563. - bool IsInside(const Vector3& point) const
  6564. Properties:
  6565. - BoundingBox& boundingBox
  6566. - Matrix3x4& inverseWorldTransform (readonly)
  6567. - Color& ambientColor
  6568. - Color& ambientStartColor (readonly)
  6569. - Color& ambientEndColor (readonly)
  6570. - Color& fogColor
  6571. - float fogStart
  6572. - float fogEnd
  6573. - float fogHeight
  6574. - float fogHeightScale
  6575. - int priority
  6576. - bool heightFog
  6577. - bool override
  6578. - bool ambientGradient
  6579. - Texture* zoneTexture
  6580. \section LuaScriptAPI_Enums Enumerations
  6581. ### AnimationBlendMode
  6582. - int ABM_LERP
  6583. - int ABM_ADDITIVE
  6584. ### AutoRemoveMode
  6585. - int REMOVE_DISABLED
  6586. - int REMOVE_COMPONENT
  6587. - int REMOVE_NODE
  6588. ### BlendMode
  6589. - int BLEND_REPLACE
  6590. - int BLEND_ADD
  6591. - int BLEND_MULTIPLY
  6592. - int BLEND_ALPHA
  6593. - int BLEND_ADDALPHA
  6594. - int BLEND_PREMULALPHA
  6595. - int BLEND_INVDESTALPHA
  6596. - int BLEND_SUBTRACT
  6597. - int BLEND_SUBTRACTALPHA
  6598. - int MAX_BLENDMODES
  6599. ### BodyType2D
  6600. - int BT_STATIC
  6601. - int BT_KINEMATIC
  6602. - int BT_DYNAMIC
  6603. ### CollisionEventMode
  6604. - int COLLISION_NEVER
  6605. - int COLLISION_ACTIVE
  6606. - int COLLISION_ALWAYS
  6607. ### CompareMode
  6608. - int CMP_ALWAYS
  6609. - int CMP_EQUAL
  6610. - int CMP_NOTEQUAL
  6611. - int CMP_LESS
  6612. - int CMP_LESSEQUAL
  6613. - int CMP_GREATER
  6614. - int CMP_GREATEREQUAL
  6615. - int MAX_COMPAREMODES
  6616. ### CompressedFormat
  6617. - int CF_NONE
  6618. - int CF_RGBA
  6619. - int CF_DXT1
  6620. - int CF_DXT3
  6621. - int CF_DXT5
  6622. - int CF_ETC1
  6623. - int CF_PVRTC_RGB_2BPP
  6624. - int CF_PVRTC_RGBA_2BPP
  6625. - int CF_PVRTC_RGB_4BPP
  6626. - int CF_PVRTC_RGBA_4BPP
  6627. ### ConstraintType
  6628. - int CONSTRAINT_POINT
  6629. - int CONSTRAINT_HINGE
  6630. - int CONSTRAINT_SLIDER
  6631. - int CONSTRAINT_CONETWIST
  6632. ### Corner
  6633. - int C_TOPLEFT
  6634. - int C_TOPRIGHT
  6635. - int C_BOTTOMLEFT
  6636. - int C_BOTTOMRIGHT
  6637. - int MAX_UIELEMENT_CORNERS
  6638. ### CreateMode
  6639. - int REPLICATED
  6640. - int LOCAL
  6641. ### CrowdAgentRequestedTarget
  6642. - int CA_REQUESTEDTARGET_NONE
  6643. - int CA_REQUESTEDTARGET_POSITION
  6644. - int CA_REQUESTEDTARGET_VELOCITY
  6645. ### CrowdAgentState
  6646. - int CA_STATE_INVALID
  6647. - int CA_STATE_WALKING
  6648. - int CA_STATE_OFFMESH
  6649. ### CrowdAgentTargetState
  6650. - int CA_TARGET_NONE
  6651. - int CA_TARGET_FAILED
  6652. - int CA_TARGET_VALID
  6653. - int CA_TARGET_REQUESTING
  6654. - int CA_TARGET_WAITINGFORQUEUE
  6655. - int CA_TARGET_WAITINGFORPATH
  6656. - int CA_TARGET_VELOCITY
  6657. ### CubeMapFace
  6658. - int FACE_POSITIVE_X
  6659. - int FACE_NEGATIVE_X
  6660. - int FACE_POSITIVE_Y
  6661. - int FACE_NEGATIVE_Y
  6662. - int FACE_POSITIVE_Z
  6663. - int FACE_NEGATIVE_Z
  6664. - int MAX_CUBEMAP_FACES
  6665. ### CullMode
  6666. - int CULL_NONE
  6667. - int CULL_CCW
  6668. - int CULL_CW
  6669. - int MAX_CULLMODES
  6670. ### CursorShape
  6671. - int CS_NORMAL
  6672. - int CS_IBEAM
  6673. - int CS_CROSS
  6674. - int CS_RESIZEVERTICAL
  6675. - int CS_RESIZEDIAGONAL_TOPRIGHT
  6676. - int CS_RESIZEHORIZONTAL
  6677. - int CS_RESIZEDIAGONAL_TOPLEFT
  6678. - int CS_RESIZE_ALL
  6679. - int CS_ACCEPTDROP
  6680. - int CS_REJECTDROP
  6681. - int CS_BUSY
  6682. - int CS_BUSY_ARROW
  6683. - int CS_MAX_SHAPES
  6684. ### DBAPI
  6685. - int DBAPI_SQLITE
  6686. - int DBAPI_ODBC
  6687. ### EmitterType
  6688. - int EMITTER_SPHERE
  6689. - int EMITTER_BOX
  6690. ### EmitterType2D
  6691. - int EMITTER_TYPE_GRAVITY
  6692. - int EMITTER_TYPE_RADIAL
  6693. ### FaceCameraMode
  6694. - int FC_NONE
  6695. - int FC_ROTATE_XYZ
  6696. - int FC_ROTATE_Y
  6697. - int FC_LOOKAT_XYZ
  6698. - int FC_LOOKAT_Y
  6699. ### FaceCameraMode
  6700. - int FC_NONE
  6701. - int FC_ROTATE_XYZ
  6702. - int FC_ROTATE_Y
  6703. - int FC_LOOKAT_XYZ
  6704. - int FC_LOOKAT_Y
  6705. - int FC_DIRECTION
  6706. ### FileMode
  6707. - int FILE_READ
  6708. - int FILE_WRITE
  6709. - int FILE_READWRITE
  6710. ### FillMode
  6711. - int FILL_SOLID
  6712. - int FILL_WIREFRAME
  6713. - int FILL_POINT
  6714. ### FocusMode
  6715. - int FM_NOTFOCUSABLE
  6716. - int FM_RESETFOCUS
  6717. - int FM_FOCUSABLE
  6718. - int FM_FOCUSABLE_DEFOCUSABLE
  6719. ### FrustumPlane
  6720. - int PLANE_NEAR
  6721. - int PLANE_LEFT
  6722. - int PLANE_RIGHT
  6723. - int PLANE_UP
  6724. - int PLANE_DOWN
  6725. - int PLANE_FAR
  6726. ### GeometryType
  6727. - int GEOM_STATIC
  6728. - int GEOM_SKINNED
  6729. - int GEOM_INSTANCED
  6730. - int GEOM_BILLBOARD
  6731. - int GEOM_STATIC_NOINSTANCING
  6732. - int MAX_GEOMETRYTYPES
  6733. ### HighlightMode
  6734. - int HM_NEVER
  6735. - int HM_FOCUS
  6736. - int HM_ALWAYS
  6737. ### HorizontalAlignment
  6738. - int HA_LEFT
  6739. - int HA_CENTER
  6740. - int HA_RIGHT
  6741. ### HttpRequestState
  6742. - int HTTP_INITIALIZING
  6743. - int HTTP_ERROR
  6744. - int HTTP_OPEN
  6745. - int HTTP_CLOSED
  6746. ### InterpMethod
  6747. - int IM_NONE
  6748. - int IM_LINEAR
  6749. - int IM_SPLINE
  6750. ### InterpolationMode
  6751. - int BEZIER_CURVE
  6752. - int CATMULL_ROM_CURVE
  6753. - int LINEAR_CURVE
  6754. - int CATMULL_ROM_FULL_CURVE
  6755. ### Intersection
  6756. - int OUTSIDE
  6757. - int INTERSECTS
  6758. - int INSIDE
  6759. ### JSONNumberType
  6760. - int JSONNT_NAN
  6761. - int JSONNT_INT
  6762. - int JSONNT_UINT
  6763. - int JSONNT_FLOAT_DOUBLE
  6764. ### JSONValueType
  6765. - int JSON_NULL
  6766. - int JSON_BOOL
  6767. - int JSON_NUMBER
  6768. - int JSON_STRING
  6769. - int JSON_ARRAY
  6770. - int JSON_OBJECT
  6771. ### LayoutMode
  6772. - int LM_FREE
  6773. - int LM_HORIZONTAL
  6774. - int LM_VERTICAL
  6775. ### LegacyVertexElement
  6776. - int ELEMENT_POSITION
  6777. - int ELEMENT_NORMAL
  6778. - int ELEMENT_COLOR
  6779. - int ELEMENT_TEXCOORD1
  6780. - int ELEMENT_TEXCOORD2
  6781. - int ELEMENT_CUBETEXCOORD1
  6782. - int ELEMENT_CUBETEXCOORD2
  6783. - int ELEMENT_TANGENT
  6784. - int ELEMENT_BLENDWEIGHTS
  6785. - int ELEMENT_BLENDINDICES
  6786. - int ELEMENT_INSTANCEMATRIX1
  6787. - int ELEMENT_INSTANCEMATRIX2
  6788. - int ELEMENT_INSTANCEMATRIX3
  6789. - int ELEMENT_OBJECTINDEX
  6790. - int MAX_LEGACY_VERTEX_ELEMENTS
  6791. ### LightType
  6792. - int LIGHT_DIRECTIONAL
  6793. - int LIGHT_SPOT
  6794. - int LIGHT_POINT
  6795. ### LoadMode
  6796. - int LOAD_RESOURCES_ONLY
  6797. - int LOAD_SCENE
  6798. - int LOAD_SCENE_AND_RESOURCES
  6799. ### LockState
  6800. - int LOCK_NONE
  6801. - int LOCK_HARDWARE
  6802. - int LOCK_SHADOW
  6803. - int LOCK_SCRATCH
  6804. ### LoopMode2D
  6805. - int LM_DEFAULT
  6806. - int LM_FORCE_LOOPED
  6807. - int LM_FORCE_CLAMPED
  6808. ### MouseMode
  6809. - int MM_ABSOLUTE
  6810. - int MM_RELATIVE
  6811. - int MM_WRAP
  6812. - int MM_FREE
  6813. ### NavigationPushiness
  6814. - int NAVIGATIONPUSHINESS_LOW
  6815. - int NAVIGATIONPUSHINESS_MEDIUM
  6816. - int NAVIGATIONPUSHINESS_HIGH
  6817. ### NavigationQuality
  6818. - int NAVIGATIONQUALITY_LOW
  6819. - int NAVIGATIONQUALITY_MEDIUM
  6820. - int NAVIGATIONQUALITY_HIGH
  6821. ### NavmeshPartitionType
  6822. - int NAVMESH_PARTITION_WATERSHED
  6823. - int NAVMESH_PARTITION_MONOTONE
  6824. ### Orientation
  6825. - int O_HORIZONTAL
  6826. - int O_VERTICAL
  6827. ### Orientation2D
  6828. - int O_ORTHOGONAL
  6829. - int O_ISOMETRIC
  6830. - int O_STAGGERED
  6831. - int O_HEXAGONAL
  6832. ### PassLightingMode
  6833. - int LIGHTING_UNLIT
  6834. - int LIGHTING_PERVERTEX
  6835. - int LIGHTING_PERPIXEL
  6836. ### PrimitiveType
  6837. - int TRIANGLE_LIST
  6838. - int LINE_LIST
  6839. - int POINT_LIST
  6840. - int TRIANGLE_STRIP
  6841. - int LINE_STRIP
  6842. - int TRIANGLE_FAN
  6843. ### RayQueryLevel
  6844. - int RAY_AABB
  6845. - int RAY_OBB
  6846. - int RAY_TRIANGLE
  6847. - int RAY_TRIANGLE_UV
  6848. ### RenderCommandSortMode
  6849. - int SORT_FRONTTOBACK
  6850. - int SORT_BACKTOFRONT
  6851. ### RenderCommandType
  6852. - int CMD_NONE
  6853. - int CMD_CLEAR
  6854. - int CMD_SCENEPASS
  6855. - int CMD_QUAD
  6856. - int CMD_FORWARDLIGHTS
  6857. - int CMD_LIGHTVOLUMES
  6858. - int CMD_RENDERUI
  6859. - int CMD_SENDEVENT
  6860. ### RenderSurfaceUpdateMode
  6861. - int SURFACE_MANUALUPDATE
  6862. - int SURFACE_UPDATEVISIBLE
  6863. - int SURFACE_UPDATEALWAYS
  6864. ### RenderTargetSizeMode
  6865. - int SIZE_ABSOLUTE
  6866. - int SIZE_VIEWPORTDIVISOR
  6867. - int SIZE_VIEWPORTMULTIPLIER
  6868. ### ShaderType
  6869. - int VS
  6870. - int PS
  6871. ### ShadowQuality
  6872. - int SHADOWQUALITY_SIMPLE_16BIT
  6873. - int SHADOWQUALITY_SIMPLE_24BIT
  6874. - int SHADOWQUALITY_PCF_16BIT
  6875. - int SHADOWQUALITY_PCF_24BIT
  6876. - int SHADOWQUALITY_VSM
  6877. - int SHADOWQUALITY_BLUR_VSM
  6878. ### ShapeType
  6879. - int SHAPE_BOX
  6880. - int SHAPE_SPHERE
  6881. - int SHAPE_STATICPLANE
  6882. - int SHAPE_CYLINDER
  6883. - int SHAPE_CAPSULE
  6884. - int SHAPE_CONE
  6885. - int SHAPE_TRIANGLEMESH
  6886. - int SHAPE_CONVEXHULL
  6887. - int SHAPE_TERRAIN
  6888. ### StencilOp
  6889. - int OP_KEEP
  6890. - int OP_ZERO
  6891. - int OP_REF
  6892. - int OP_INCR
  6893. - int OP_DECR
  6894. ### TextEffect
  6895. - int TE_NONE
  6896. - int TE_SHADOW
  6897. - int TE_STROKE
  6898. ### TextureAddressMode
  6899. - int ADDRESS_WRAP
  6900. - int ADDRESS_MIRROR
  6901. - int ADDRESS_CLAMP
  6902. - int ADDRESS_BORDER
  6903. - int MAX_ADDRESSMODES
  6904. ### TextureCoordinate
  6905. - int COORD_U
  6906. - int COORD_V
  6907. - int COORD_W
  6908. - int MAX_COORDS
  6909. ### TextureFilterMode
  6910. - int FILTER_NEAREST
  6911. - int FILTER_BILINEAR
  6912. - int FILTER_TRILINEAR
  6913. - int FILTER_ANISOTROPIC
  6914. - int FILTER_DEFAULT
  6915. - int MAX_FILTERMODES
  6916. ### TextureUnit
  6917. - int TU_DIFFUSE
  6918. - int TU_ALBEDOBUFFER
  6919. - int TU_NORMAL
  6920. - int TU_NORMALBUFFER
  6921. - int TU_SPECULAR
  6922. - int TU_EMISSIVE
  6923. - int TU_ENVIRONMENT
  6924. ### TextureUsage
  6925. - int TEXTURE_STATIC
  6926. - int TEXTURE_DYNAMIC
  6927. - int TEXTURE_RENDERTARGET
  6928. - int TEXTURE_DEPTHSTENCIL
  6929. ### TileMapLayerType2D
  6930. - int LT_TILE_LAYER
  6931. - int LT_OBJECT_GROUP
  6932. - int LT_IMAGE_LAYER
  6933. - int LT_INVALID
  6934. ### TileMapObjectType2D
  6935. - int OT_RECTANGLE
  6936. - int OT_ELLIPSE
  6937. - int OT_POLYGON
  6938. - int OT_POLYLINE
  6939. - int OT_TILE
  6940. - int OT_INVALID
  6941. ### TrailType
  6942. - int TT_FACE_CAMERA
  6943. - int TT_BONE
  6944. ### TransformSpace
  6945. - int TS_LOCAL
  6946. - int TS_PARENT
  6947. - int TS_WORLD
  6948. ### TraversalMode
  6949. - int TM_BREADTH_FIRST
  6950. - int TM_DEPTH_FIRST
  6951. ### VariantType
  6952. - int VAR_NONE
  6953. - int VAR_INT
  6954. - int VAR_BOOL
  6955. - int VAR_FLOAT
  6956. - int VAR_VECTOR2
  6957. - int VAR_VECTOR3
  6958. - int VAR_VECTOR4
  6959. - int VAR_QUATERNION
  6960. - int VAR_COLOR
  6961. - int VAR_STRING
  6962. - int VAR_BUFFER
  6963. - int VAR_VOIDPTR
  6964. - int VAR_RESOURCEREF
  6965. - int VAR_RESOURCEREFLIST
  6966. - int VAR_VARIANTVECTOR
  6967. - int VAR_VARIANTMAP
  6968. - int VAR_INTRECT
  6969. - int VAR_INTVECTOR2
  6970. - int VAR_PTR
  6971. - int VAR_MATRIX3
  6972. - int VAR_MATRIX3X4
  6973. - int VAR_MATRIX4
  6974. - int VAR_DOUBLE
  6975. - int VAR_STRINGVECTOR
  6976. - int MAX_VAR_TYPES
  6977. ### VertexElementSemantic
  6978. - int SEM_POSITION
  6979. - int SEM_NORMAL
  6980. - int SEM_BINORMAL
  6981. - int SEM_TANGENT
  6982. - int SEM_TEXCOORD
  6983. - int SEM_COLOR
  6984. - int SEM_BLENDWEIGHTS
  6985. - int SEM_BLENDINDICES
  6986. - int SEM_OBJECTINDEX
  6987. - int MAX_VERTEX_ELEMENT_SEMANTICS
  6988. ### VertexElementType
  6989. - int TYPE_INT
  6990. - int TYPE_FLOAT
  6991. - int TYPE_VECTOR2
  6992. - int TYPE_VECTOR3
  6993. - int TYPE_VECTOR4
  6994. - int TYPE_UBYTE4
  6995. - int TYPE_UBYTE4_NORM
  6996. - int MAX_VERTEX_ELEMENT_TYPES
  6997. ### VerticalAlignment
  6998. - int VA_TOP
  6999. - int VA_CENTER
  7000. - int VA_BOTTOM
  7001. ### WindowDragMode
  7002. - int DRAG_NONE
  7003. - int DRAG_MOVE
  7004. - int DRAG_RESIZE_TOPLEFT
  7005. - int DRAG_RESIZE_TOP
  7006. - int DRAG_RESIZE_TOPRIGHT
  7007. - int DRAG_RESIZE_RIGHT
  7008. - int DRAG_RESIZE_BOTTOMRIGHT
  7009. - int DRAG_RESIZE_BOTTOM
  7010. - int DRAG_RESIZE_BOTTOMLEFT
  7011. - int DRAG_RESIZE_LEFT
  7012. ### WrapMode
  7013. - int WM_LOOP
  7014. - int WM_ONCE
  7015. - int WM_CLAMP
  7016. \section LuaScriptAPI_toluaFunctions tolua functions
  7017. - lua_usertype cast(lua_usertype object, const char* typename)
  7018. - lua_table getpeer(lua_userdata object)
  7019. - void inherit(lua_table table, lua_usertype c_instance)
  7020. - bool releaseownership(lua_usertype object)
  7021. - void setpeer(lua_userdata object, lua_table table)
  7022. - bool takeownership(lua_usertype object)
  7023. - const char* type(lua_object object)
  7024. \section LuaScriptAPI_GlobalFunctions Global functions
  7025. - float Abs(float value)
  7026. - int AbsInt(int value)
  7027. - float Acos(float x)
  7028. - String AddTrailingSlash(const String pathName)
  7029. - float Asin(float x)
  7030. - float Atan(float x)
  7031. - float Atan2(float y, float x)
  7032. - float Clamp(float value, float min, float max)
  7033. - int ClampInt(int value, int min, int max)
  7034. - VectorBuffer CompressVectorBuffer(VectorBuffer& src)
  7035. - float Cos(float angle)
  7036. - unsigned CountSetBits(unsigned value)
  7037. - VectorBuffer DecompressVectorBuffer(VectorBuffer& src)
  7038. - bool Equals(float lhs, float rhs)
  7039. - void ErrorDialog(const String title, const String message)
  7040. - void ErrorExit(const String message = String::EMPTY, int exitCode = EXIT_FAILURE)
  7041. - const Vector<String>& GetArguments()
  7042. - Audio* GetAudio()
  7043. - ResourceCache* GetCache()
  7044. - Console* GetConsole()
  7045. - String GetConsoleInput()
  7046. - Context* GetContext()
  7047. - DBAPI GetDBAPI()
  7048. - Database* GetDatabase()
  7049. - DebugHud* GetDebugHud()
  7050. - Engine* GetEngine()
  7051. - EventHandler* GetEventHandler() const
  7052. - Object* GetEventSender()
  7053. - bool GetExecuteConsoleCommands()
  7054. - String GetExtension(const String fullPath, bool lowercaseExtension = true)
  7055. - String GetFileName(const String fullPath)
  7056. - String GetFileNameAndExtension(const String fullPath, bool lowercaseExtension = false)
  7057. - String GetFileSizeString(long memorySize)
  7058. - FileSystem* GetFileSystem()
  7059. - Variant GetGlobalVar(const String key)
  7060. - VariantMap& GetGlobalVars()
  7061. - Graphics* GetGraphics()
  7062. - Input* GetInput()
  7063. - String GetInternalPath(const String pathName)
  7064. - Localization* GetLocalization()
  7065. - Log* GetLog()
  7066. - String GetMiniDumpDir()
  7067. - String GetNativePath(const String pathName)
  7068. - Network* GetNetwork()
  7069. - unsigned GetNumLogicalCPUs()
  7070. - unsigned GetNumPhysicalCPUs()
  7071. - String GetParentPath(const String pathName)
  7072. - String GetPath(const String fullPath)
  7073. - String GetPlatform()
  7074. - unsigned GetRandomSeed()
  7075. - Renderer* GetRenderer()
  7076. - Time* GetTime()
  7077. - UI* GetUI()
  7078. - bool HasSubscribedToEvent(Object* sender, const String eventName)
  7079. - bool HasSubscribedToEvent(const String eventName)
  7080. - bool IsAbsolutePath(const String pathName)
  7081. - bool IsAlpha(unsigned ch)
  7082. - bool IsDigit(unsigned ch)
  7083. - bool IsNaN(float value)
  7084. - bool IsPowerOfTwo(unsigned value)
  7085. - float Lerp(float lhs, float rhs, float t)
  7086. - float Max(float lhs, float rhs)
  7087. - int MaxInt(int lhs, int rhs)
  7088. - float Min(float lhs, float rhs)
  7089. - int MinInt(int lhs, int rhs)
  7090. - unsigned NextPowerOfTwo(unsigned value)
  7091. - void OpenConsoleWindow()
  7092. - void PrintLine(const String str, bool error = false)
  7093. - int Rand()
  7094. - float RandStandardNormal()
  7095. - float Random()
  7096. - float Random(float range)
  7097. - float Random(float min, float max)
  7098. - int RandomInt(int range)
  7099. - int RandomInt(int min, int max)
  7100. - float RandomNormal(float meanValue, float variance)
  7101. - void RegisterEventName(const String eventName)
  7102. - String RemoveTrailingSlash(const String pathName)
  7103. - String ReplaceExtension(const String fullPath, const String newExtension)
  7104. - unsigned SDBMHash(unsigned hash, char c)
  7105. - void SendEvent(const String eventName, VariantMap& eventData)
  7106. - void SetExecuteConsoleCommands(bool enable)
  7107. - void SetGlobalVar(const String key, Variant value)
  7108. - void SetMiniDumpDir(const String pathName)
  7109. - void SetRandomSeed(unsigned seed)
  7110. - float Sign(float value)
  7111. - float Sin(float angle)
  7112. - float SmoothStep(float lhs, float rhs, float t)
  7113. - void SubscribeToEvent(const String eventName, void* functionOrFunctionName)
  7114. - void SubscribeToEvent(void* sender, const String eventName, void* functionOrFunctionName)
  7115. - float Tan(float angle)
  7116. - bool ToBool(const String source)
  7117. - Color ToColor(const String source)
  7118. - float ToFloat(const String source)
  7119. - int ToInt(const String source, int base = 10)
  7120. - IntRect ToIntRect(const String source)
  7121. - IntVector2 ToIntVector2(const String source)
  7122. - unsigned ToLower(unsigned ch)
  7123. - Matrix3 ToMatrix3(const String source)
  7124. - Matrix3x4 ToMatrix3x4(const String source)
  7125. - Matrix4 ToMatrix4(const String source)
  7126. - Quaternion ToQuaternion(const String source)
  7127. - Rect ToRect(const String source)
  7128. - String ToString(void* value)
  7129. - String ToStringHex(unsigned value)
  7130. - unsigned ToUInt(const String source, int base = 10)
  7131. - unsigned ToUpper(unsigned ch)
  7132. - Vector2 ToVector2(const String source)
  7133. - Vector3 ToVector3(const String source)
  7134. - Vector4 ToVector4(const String source, bool allowMissingCoords = false)
  7135. - void UnsubscribeFromAllEvents()
  7136. - void UnsubscribeFromAllEventsExcept(const Vector<String>& exceptionNames)
  7137. - void UnsubscribeFromEvent(Object* sender, const String eventName)
  7138. - void UnsubscribeFromEvent(const String eventName)
  7139. - void UnsubscribeFromEvents(Object* sender)
  7140. \section LuaScriptAPI_GlobalProperties Global properties
  7141. - Audio* audio (readonly)
  7142. - ResourceCache* cache (readonly)
  7143. - Console* console (readonly)
  7144. - Context* context (readonly)
  7145. - Database* database (readonly)
  7146. - DebugHud* debugHud (readonly)
  7147. - Engine* engine (readonly)
  7148. - EventHandler* eventHandler (readonly)
  7149. - EventSender* eventSender (readonly)
  7150. - FileSystem* fileSystem (readonly)
  7151. - Graphics* graphics (readonly)
  7152. - Input* input (readonly)
  7153. - Localization* localization (readonly)
  7154. - Log* log (readonly)
  7155. - Network* network (readonly)
  7156. - Renderer* renderer (readonly)
  7157. - Time* time (readonly)
  7158. - UI* ui (readonly)
  7159. \section LuaScriptAPI_GlobalConstants Global constants
  7160. - float ANIMATION_LOD_BASESCALE
  7161. - char CHANNEL_POSITION
  7162. - char CHANNEL_ROTATION
  7163. - char CHANNEL_SCALE
  7164. - unsigned CLEAR_COLOR
  7165. - unsigned CLEAR_DEPTH
  7166. - unsigned CLEAR_STENCIL
  7167. - int CONTROLLER_AXIS_LEFTX
  7168. - int CONTROLLER_AXIS_LEFTY
  7169. - int CONTROLLER_AXIS_RIGHTX
  7170. - int CONTROLLER_AXIS_RIGHTY
  7171. - int CONTROLLER_AXIS_TRIGGERLEFT
  7172. - int CONTROLLER_AXIS_TRIGGERRIGHT
  7173. - int CONTROLLER_BUTTON_A
  7174. - int CONTROLLER_BUTTON_B
  7175. - int CONTROLLER_BUTTON_BACK
  7176. - int CONTROLLER_BUTTON_DPAD_DOWN
  7177. - int CONTROLLER_BUTTON_DPAD_LEFT
  7178. - int CONTROLLER_BUTTON_DPAD_RIGHT
  7179. - int CONTROLLER_BUTTON_DPAD_UP
  7180. - int CONTROLLER_BUTTON_GUIDE
  7181. - int CONTROLLER_BUTTON_LEFTSHOULDER
  7182. - int CONTROLLER_BUTTON_LEFTSTICK
  7183. - int CONTROLLER_BUTTON_RIGHTSHOULDER
  7184. - int CONTROLLER_BUTTON_RIGHTSTICK
  7185. - int CONTROLLER_BUTTON_START
  7186. - int CONTROLLER_BUTTON_X
  7187. - int CONTROLLER_BUTTON_Y
  7188. - unsigned DD_DISABLED
  7189. - unsigned DD_SOURCE
  7190. - unsigned DD_SOURCE_AND_TARGET
  7191. - unsigned DD_TARGET
  7192. - unsigned DEBUGHUD_SHOW_ALL
  7193. - unsigned DEBUGHUD_SHOW_EVENTPROFILER
  7194. - unsigned DEBUGHUD_SHOW_MEMORY
  7195. - unsigned DEBUGHUD_SHOW_MODE
  7196. - unsigned DEBUGHUD_SHOW_NONE
  7197. - unsigned DEBUGHUD_SHOW_PROFILER
  7198. - unsigned DEBUGHUD_SHOW_STATS
  7199. - unsigned DEFAULT_LIGHTMASK
  7200. - unsigned DEFAULT_SHADOWMASK
  7201. - unsigned DEFAULT_VIEWMASK
  7202. - unsigned DEFAULT_ZONEMASK
  7203. - unsigned DRAWABLE_ANY
  7204. - unsigned DRAWABLE_GEOMETRY
  7205. - unsigned DRAWABLE_GEOMETRY2D
  7206. - unsigned DRAWABLE_LIGHT
  7207. - unsigned DRAWABLE_ZONE
  7208. - unsigned FIRST_LOCAL_ID
  7209. - unsigned FIRST_REPLICATED_ID
  7210. - int HAT_CENTER
  7211. - int HAT_DOWN
  7212. - int HAT_LEFT
  7213. - int HAT_RIGHT
  7214. - int HAT_UP
  7215. - int KEY_0
  7216. - int KEY_1
  7217. - int KEY_2
  7218. - int KEY_3
  7219. - int KEY_4
  7220. - int KEY_5
  7221. - int KEY_6
  7222. - int KEY_7
  7223. - int KEY_8
  7224. - int KEY_9
  7225. - int KEY_A
  7226. - int KEY_ALT
  7227. - int KEY_APPLICATION
  7228. - int KEY_B
  7229. - int KEY_BACKSPACE
  7230. - int KEY_C
  7231. - int KEY_CAPSLOCK
  7232. - int KEY_CTRL
  7233. - int KEY_D
  7234. - int KEY_DELETE
  7235. - int KEY_DOWN
  7236. - int KEY_E
  7237. - int KEY_END
  7238. - int KEY_ESCAPE
  7239. - int KEY_F
  7240. - int KEY_F1
  7241. - int KEY_F10
  7242. - int KEY_F11
  7243. - int KEY_F12
  7244. - int KEY_F13
  7245. - int KEY_F14
  7246. - int KEY_F15
  7247. - int KEY_F16
  7248. - int KEY_F17
  7249. - int KEY_F18
  7250. - int KEY_F19
  7251. - int KEY_F2
  7252. - int KEY_F20
  7253. - int KEY_F21
  7254. - int KEY_F22
  7255. - int KEY_F23
  7256. - int KEY_F24
  7257. - int KEY_F3
  7258. - int KEY_F4
  7259. - int KEY_F5
  7260. - int KEY_F6
  7261. - int KEY_F7
  7262. - int KEY_F8
  7263. - int KEY_F9
  7264. - int KEY_G
  7265. - int KEY_GUI
  7266. - int KEY_H
  7267. - int KEY_HOME
  7268. - int KEY_I
  7269. - int KEY_INSERT
  7270. - int KEY_J
  7271. - int KEY_K
  7272. - int KEY_KP_0
  7273. - int KEY_KP_1
  7274. - int KEY_KP_2
  7275. - int KEY_KP_3
  7276. - int KEY_KP_4
  7277. - int KEY_KP_5
  7278. - int KEY_KP_6
  7279. - int KEY_KP_7
  7280. - int KEY_KP_8
  7281. - int KEY_KP_9
  7282. - int KEY_KP_DIVIDE
  7283. - int KEY_KP_ENTER
  7284. - int KEY_KP_MINUS
  7285. - int KEY_KP_MULTIPLY
  7286. - int KEY_KP_PERIOD
  7287. - int KEY_KP_PLUS
  7288. - int KEY_L
  7289. - int KEY_LALT
  7290. - int KEY_LCTRL
  7291. - int KEY_LEFT
  7292. - int KEY_LGUI
  7293. - int KEY_LSHIFT
  7294. - int KEY_M
  7295. - int KEY_N
  7296. - int KEY_NUMLOCKCLEAR
  7297. - int KEY_O
  7298. - int KEY_P
  7299. - int KEY_PAGEDOWN
  7300. - int KEY_PAGEUP
  7301. - int KEY_PAUSE
  7302. - int KEY_PRINTSCREEN
  7303. - int KEY_Q
  7304. - int KEY_R
  7305. - int KEY_RALT
  7306. - int KEY_RCTRL
  7307. - int KEY_RETURN
  7308. - int KEY_RETURN2
  7309. - int KEY_RGUI
  7310. - int KEY_RIGHT
  7311. - int KEY_RSHIFT
  7312. - int KEY_S
  7313. - int KEY_SCROLLLOCK
  7314. - int KEY_SELECT
  7315. - int KEY_SHIFT
  7316. - int KEY_SPACE
  7317. - int KEY_T
  7318. - int KEY_TAB
  7319. - int KEY_U
  7320. - int KEY_UP
  7321. - int KEY_V
  7322. - int KEY_W
  7323. - int KEY_X
  7324. - int KEY_Y
  7325. - int KEY_Z
  7326. - unsigned LAST_LOCAL_ID
  7327. - unsigned LAST_REPLICATED_ID
  7328. - int LOG_DEBUG
  7329. - int LOG_ERROR
  7330. - int LOG_INFO
  7331. - int LOG_NONE
  7332. - int LOG_WARNING
  7333. - unsigned MASK_BLENDINDICES
  7334. - unsigned MASK_BLENDWEIGHTS
  7335. - unsigned MASK_COLOR
  7336. - unsigned MASK_CUBETEXCOORD1
  7337. - unsigned MASK_CUBETEXCOORD2
  7338. - unsigned MASK_INSTANCEMATRIX1
  7339. - unsigned MASK_INSTANCEMATRIX2
  7340. - unsigned MASK_INSTANCEMATRIX3
  7341. - unsigned MASK_NONE
  7342. - unsigned MASK_NORMAL
  7343. - unsigned MASK_OBJECTINDEX
  7344. - unsigned MASK_POSITION
  7345. - unsigned MASK_TANGENT
  7346. - unsigned MASK_TEXCOORD1
  7347. - unsigned MASK_TEXCOORD2
  7348. - int MAX_VERTEX_LIGHTS
  7349. - int MOUSEB_LEFT
  7350. - int MOUSEB_MIDDLE
  7351. - int MOUSEB_RIGHT
  7352. - float M_DEGTORAD
  7353. - float M_DEGTORAD_2
  7354. - float M_EPSILON
  7355. - float M_HALF_PI
  7356. - float M_INFINITY
  7357. - float M_LARGE_EPSILON
  7358. - float M_LARGE_VALUE
  7359. - float M_MAX_FOV
  7360. - int M_MAX_INT
  7361. - unsigned M_MAX_UNSIGNED
  7362. - int M_MIN_INT
  7363. - float M_MIN_NEARCLIP
  7364. - unsigned M_MIN_UNSIGNED
  7365. - float M_PI
  7366. - float M_RADTODEG
  7367. - unsigned NUM_FRUSTUM_PLANES
  7368. - unsigned NUM_FRUSTUM_VERTICES
  7369. - float PIXEL_SIZE
  7370. - int QUALITY_HIGH
  7371. - int QUALITY_LOW
  7372. - int QUALITY_MAX
  7373. - int QUALITY_MEDIUM
  7374. - int QUAL_ALT
  7375. - int QUAL_ANY
  7376. - int QUAL_CTRL
  7377. - int QUAL_SHIFT
  7378. - int SCANCODE_0
  7379. - int SCANCODE_1
  7380. - int SCANCODE_2
  7381. - int SCANCODE_3
  7382. - int SCANCODE_4
  7383. - int SCANCODE_5
  7384. - int SCANCODE_6
  7385. - int SCANCODE_7
  7386. - int SCANCODE_8
  7387. - int SCANCODE_9
  7388. - int SCANCODE_A
  7389. - int SCANCODE_AC_BACK
  7390. - int SCANCODE_AC_BOOKMARKS
  7391. - int SCANCODE_AC_FORWARD
  7392. - int SCANCODE_AC_HOME
  7393. - int SCANCODE_AC_REFRESH
  7394. - int SCANCODE_AC_SEARCH
  7395. - int SCANCODE_AC_STOP
  7396. - int SCANCODE_AGAIN
  7397. - int SCANCODE_ALT
  7398. - int SCANCODE_ALTERASE
  7399. - int SCANCODE_APOSTROPHE
  7400. - int SCANCODE_APP1
  7401. - int SCANCODE_APP2
  7402. - int SCANCODE_APPLICATION
  7403. - int SCANCODE_AUDIOMUTE
  7404. - int SCANCODE_AUDIONEXT
  7405. - int SCANCODE_AUDIOPLAY
  7406. - int SCANCODE_AUDIOPREV
  7407. - int SCANCODE_AUDIOSTOP
  7408. - int SCANCODE_B
  7409. - int SCANCODE_BACKSLASH
  7410. - int SCANCODE_BACKSPACE
  7411. - int SCANCODE_BRIGHTNESSDOWN
  7412. - int SCANCODE_BRIGHTNESSUP
  7413. - int SCANCODE_C
  7414. - int SCANCODE_CALCULATOR
  7415. - int SCANCODE_CANCEL
  7416. - int SCANCODE_CAPSLOCK
  7417. - int SCANCODE_CLEAR
  7418. - int SCANCODE_CLEARAGAIN
  7419. - int SCANCODE_COMMA
  7420. - int SCANCODE_COMPUTER
  7421. - int SCANCODE_COPY
  7422. - int SCANCODE_CRSEL
  7423. - int SCANCODE_CTRL
  7424. - int SCANCODE_CURRENCYSUBUNIT
  7425. - int SCANCODE_CURRENCYUNIT
  7426. - int SCANCODE_CUT
  7427. - int SCANCODE_D
  7428. - int SCANCODE_DECIMALSEPARATOR
  7429. - int SCANCODE_DELETE
  7430. - int SCANCODE_DISPLAYSWITCH
  7431. - int SCANCODE_DOWN
  7432. - int SCANCODE_E
  7433. - int SCANCODE_EJECT
  7434. - int SCANCODE_END
  7435. - int SCANCODE_EQUALS
  7436. - int SCANCODE_ESCAPE
  7437. - int SCANCODE_EXECUTE
  7438. - int SCANCODE_EXSEL
  7439. - int SCANCODE_F
  7440. - int SCANCODE_F1
  7441. - int SCANCODE_F10
  7442. - int SCANCODE_F11
  7443. - int SCANCODE_F12
  7444. - int SCANCODE_F13
  7445. - int SCANCODE_F14
  7446. - int SCANCODE_F15
  7447. - int SCANCODE_F16
  7448. - int SCANCODE_F17
  7449. - int SCANCODE_F18
  7450. - int SCANCODE_F19
  7451. - int SCANCODE_F2
  7452. - int SCANCODE_F20
  7453. - int SCANCODE_F21
  7454. - int SCANCODE_F22
  7455. - int SCANCODE_F23
  7456. - int SCANCODE_F24
  7457. - int SCANCODE_F3
  7458. - int SCANCODE_F4
  7459. - int SCANCODE_F5
  7460. - int SCANCODE_F6
  7461. - int SCANCODE_F7
  7462. - int SCANCODE_F8
  7463. - int SCANCODE_F9
  7464. - int SCANCODE_FIND
  7465. - int SCANCODE_G
  7466. - int SCANCODE_GRAVE
  7467. - int SCANCODE_GUI
  7468. - int SCANCODE_H
  7469. - int SCANCODE_HELP
  7470. - int SCANCODE_HOME
  7471. - int SCANCODE_I
  7472. - int SCANCODE_INSERT
  7473. - int SCANCODE_INTERNATIONAL1
  7474. - int SCANCODE_INTERNATIONAL2
  7475. - int SCANCODE_INTERNATIONAL3
  7476. - int SCANCODE_INTERNATIONAL4
  7477. - int SCANCODE_INTERNATIONAL5
  7478. - int SCANCODE_INTERNATIONAL6
  7479. - int SCANCODE_INTERNATIONAL7
  7480. - int SCANCODE_INTERNATIONAL8
  7481. - int SCANCODE_INTERNATIONAL9
  7482. - int SCANCODE_J
  7483. - int SCANCODE_K
  7484. - int SCANCODE_KBDILLUMDOWN
  7485. - int SCANCODE_KBDILLUMTOGGLE
  7486. - int SCANCODE_KBDILLUMUP
  7487. - int SCANCODE_KP_0
  7488. - int SCANCODE_KP_00
  7489. - int SCANCODE_KP_000
  7490. - int SCANCODE_KP_1
  7491. - int SCANCODE_KP_2
  7492. - int SCANCODE_KP_3
  7493. - int SCANCODE_KP_4
  7494. - int SCANCODE_KP_5
  7495. - int SCANCODE_KP_6
  7496. - int SCANCODE_KP_7
  7497. - int SCANCODE_KP_8
  7498. - int SCANCODE_KP_9
  7499. - int SCANCODE_KP_A
  7500. - int SCANCODE_KP_AMPERSAND
  7501. - int SCANCODE_KP_AT
  7502. - int SCANCODE_KP_B
  7503. - int SCANCODE_KP_BACKSPACE
  7504. - int SCANCODE_KP_BINARY
  7505. - int SCANCODE_KP_C
  7506. - int SCANCODE_KP_CLEAR
  7507. - int SCANCODE_KP_CLEARENTRY
  7508. - int SCANCODE_KP_COLON
  7509. - int SCANCODE_KP_COMMA
  7510. - int SCANCODE_KP_D
  7511. - int SCANCODE_KP_DBLAMPERSAND
  7512. - int SCANCODE_KP_DBLVERTICALBAR
  7513. - int SCANCODE_KP_DECIMAL
  7514. - int SCANCODE_KP_DIVIDE
  7515. - int SCANCODE_KP_E
  7516. - int SCANCODE_KP_ENTER
  7517. - int SCANCODE_KP_EQUALS
  7518. - int SCANCODE_KP_EQUALSAS400
  7519. - int SCANCODE_KP_EXCLAM
  7520. - int SCANCODE_KP_F
  7521. - int SCANCODE_KP_GREATER
  7522. - int SCANCODE_KP_HASH
  7523. - int SCANCODE_KP_HEXADECIMAL
  7524. - int SCANCODE_KP_LEFTBRACE
  7525. - int SCANCODE_KP_LEFTPAREN
  7526. - int SCANCODE_KP_LESS
  7527. - int SCANCODE_KP_MEMADD
  7528. - int SCANCODE_KP_MEMCLEAR
  7529. - int SCANCODE_KP_MEMDIVIDE
  7530. - int SCANCODE_KP_MEMMULTIPLY
  7531. - int SCANCODE_KP_MEMRECALL
  7532. - int SCANCODE_KP_MEMSTORE
  7533. - int SCANCODE_KP_MEMSUBTRACT
  7534. - int SCANCODE_KP_MINUS
  7535. - int SCANCODE_KP_MULTIPLY
  7536. - int SCANCODE_KP_OCTAL
  7537. - int SCANCODE_KP_PERCENT
  7538. - int SCANCODE_KP_PERIOD
  7539. - int SCANCODE_KP_PLUS
  7540. - int SCANCODE_KP_PLUSMINUS
  7541. - int SCANCODE_KP_POWER
  7542. - int SCANCODE_KP_RIGHTBRACE
  7543. - int SCANCODE_KP_RIGHTPAREN
  7544. - int SCANCODE_KP_SPACE
  7545. - int SCANCODE_KP_TAB
  7546. - int SCANCODE_KP_VERTICALBAR
  7547. - int SCANCODE_KP_XOR
  7548. - int SCANCODE_L
  7549. - int SCANCODE_LALT
  7550. - int SCANCODE_LANG1
  7551. - int SCANCODE_LANG2
  7552. - int SCANCODE_LANG3
  7553. - int SCANCODE_LANG4
  7554. - int SCANCODE_LANG5
  7555. - int SCANCODE_LANG6
  7556. - int SCANCODE_LANG7
  7557. - int SCANCODE_LANG8
  7558. - int SCANCODE_LANG9
  7559. - int SCANCODE_LCTRL
  7560. - int SCANCODE_LEFT
  7561. - int SCANCODE_LEFTBRACKET
  7562. - int SCANCODE_LGUI
  7563. - int SCANCODE_LSHIFT
  7564. - int SCANCODE_M
  7565. - int SCANCODE_MAIL
  7566. - int SCANCODE_MEDIASELECT
  7567. - int SCANCODE_MENU
  7568. - int SCANCODE_MINUS
  7569. - int SCANCODE_MODE
  7570. - int SCANCODE_MUTE
  7571. - int SCANCODE_N
  7572. - int SCANCODE_NONUSBACKSLASH
  7573. - int SCANCODE_NONUSHASH
  7574. - int SCANCODE_NUMLOCKCLEAR
  7575. - int SCANCODE_O
  7576. - int SCANCODE_OPER
  7577. - int SCANCODE_OUT
  7578. - int SCANCODE_P
  7579. - int SCANCODE_PAGEDOWN
  7580. - int SCANCODE_PAGEUP
  7581. - int SCANCODE_PASTE
  7582. - int SCANCODE_PAUSE
  7583. - int SCANCODE_PERIOD
  7584. - int SCANCODE_POWER
  7585. - int SCANCODE_PRINTSCREEN
  7586. - int SCANCODE_PRIOR
  7587. - int SCANCODE_Q
  7588. - int SCANCODE_R
  7589. - int SCANCODE_RALT
  7590. - int SCANCODE_RCTRL
  7591. - int SCANCODE_RETURN
  7592. - int SCANCODE_RETURN2
  7593. - int SCANCODE_RGUI
  7594. - int SCANCODE_RIGHT
  7595. - int SCANCODE_RIGHTBRACKET
  7596. - int SCANCODE_RSHIFT
  7597. - int SCANCODE_S
  7598. - int SCANCODE_SCROLLLOCK
  7599. - int SCANCODE_SELECT
  7600. - int SCANCODE_SEMICOLON
  7601. - int SCANCODE_SEPARATOR
  7602. - int SCANCODE_SHIFT
  7603. - int SCANCODE_SLASH
  7604. - int SCANCODE_SLEEP
  7605. - int SCANCODE_SPACE
  7606. - int SCANCODE_STOP
  7607. - int SCANCODE_SYSREQ
  7608. - int SCANCODE_T
  7609. - int SCANCODE_TAB
  7610. - int SCANCODE_THOUSANDSSEPARATOR
  7611. - int SCANCODE_U
  7612. - int SCANCODE_UNDO
  7613. - int SCANCODE_UNKNOWN
  7614. - int SCANCODE_UP
  7615. - int SCANCODE_V
  7616. - int SCANCODE_VOLUMEDOWN
  7617. - int SCANCODE_VOLUMEUP
  7618. - int SCANCODE_W
  7619. - int SCANCODE_WWW
  7620. - int SCANCODE_X
  7621. - int SCANCODE_Y
  7622. - int SCANCODE_Z
  7623. - unsigned SCAN_DIRS
  7624. - unsigned SCAN_FILES
  7625. - unsigned SCAN_HIDDEN
  7626. - String SOUND_AMBIENT
  7627. - String SOUND_EFFECT
  7628. - String SOUND_MASTER
  7629. - String SOUND_MUSIC
  7630. - String SOUND_VOICE
  7631. - unsigned VO_DISABLE_OCCLUSION
  7632. - unsigned VO_DISABLE_SHADOWS
  7633. - unsigned VO_LOW_MATERIAL_QUALITY
  7634. - unsigned VO_NONE
  7635. */
  7636. }