LuaScriptAPI.dox 231 KB

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