LuaScriptAPI.dox 272 KB

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