LuaScriptAPI.dox 218 KB

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