LuaScriptAPI.dox 253 KB

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