LuaScriptAPI.dox 222 KB

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