LuaScriptAPI.dox 226 KB

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