LuaScriptAPI.dox 275 KB

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