LuaScriptAPI.dox 267 KB

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