LuaScriptAPI.dox 250 KB

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