LuaScriptAPI.dox 231 KB

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