LuaScriptAPI.dox 233 KB

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