LuaScriptAPI.dox 267 KB

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