LuaScriptAPI.dox 272 KB

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