LuaScriptAPI.dox 234 KB

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