LuaScriptAPI.dox 237 KB

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