LuaScriptAPI.dox 240 KB

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