LuaScriptAPI.dox 232 KB

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