LuaScriptAPI.dox 241 KB

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