LuaScriptAPI.dox 233 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262
  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. - bool Defined() const
  600. - void Merge(const Vector3& point)
  601. - void Merge(const BoundingBox& box)
  602. - void Merge(const Frustum& frustum)
  603. - void Merge(const Polyhedron& poly)
  604. - void Merge(const Sphere& sphere)
  605. - void Clip(const BoundingBox& box)
  606. - void Transform(const Matrix3& transform)
  607. - void Transform(const Matrix3x4& transform)
  608. - void Clear()
  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 SetMaxObstacles(unsigned maxObstacles)
  1788. - bool GetDrawObstacles() const
  1789. - unsigned GetMaxObstacles() const
  1790. Properties:
  1791. - bool drawObstacles
  1792. - int maxObstacles
  1793. <a name="Class_Engine"></a>
  1794. ### Engine : Object
  1795. Methods:
  1796. - void RunFrame()
  1797. - Console* CreateConsole()
  1798. - DebugHud* CreateDebugHud()
  1799. - void SetMinFps(int fps)
  1800. - void SetMaxFps(int fps)
  1801. - void SetMaxInactiveFps(int fps)
  1802. - void SetTimeStepSmoothing(int frames)
  1803. - void SetPauseMinimized(bool enable)
  1804. - void SetAutoExit(bool enable)
  1805. - void Exit()
  1806. - void DumpProfiler()
  1807. - void DumpResources(bool dumpFileName = false)
  1808. - void DumpMemory()
  1809. - int GetMinFps() const
  1810. - int GetMaxFps() const
  1811. - int GetMaxInactiveFps() const
  1812. - int GetTimeStepSmoothing() const
  1813. - bool GetPauseMinimized() const
  1814. - bool GetAutoExit() const
  1815. - bool IsInitialized() const
  1816. - bool IsExiting() const
  1817. - bool IsHeadless() const
  1818. Properties:
  1819. - int minFps
  1820. - int maxFps
  1821. - int maxInactiveFps
  1822. - int timeStepSmoothing
  1823. - bool pauseMinimized
  1824. - bool autoExit
  1825. - bool initialized (readonly)
  1826. - bool exiting (readonly)
  1827. - bool headless (readonly)
  1828. <a name="Class_File"></a>
  1829. ### File : Object
  1830. Methods:
  1831. - File() (GC)
  1832. - File* new()
  1833. - File(const String fileName, FileMode mode = FILE_READ) (GC)
  1834. - File* new(const String fileName, FileMode mode = FILE_READ)
  1835. - File(PackageFile* package, const String fileName) (GC)
  1836. - File* new(PackageFile* package, const String fileName)
  1837. - void delete()
  1838. - bool Open(const String fileName, FileMode mode = FILE_READ)
  1839. - bool Open(PackageFile* package, const String fileName)
  1840. - void Close()
  1841. - void Flush()
  1842. - void SetName(const String name)
  1843. - FileMode GetMode() const
  1844. - bool IsOpen() const
  1845. - void* GetHandle() const
  1846. - bool IsPackaged() const
  1847. - VectorBuffer Read(unsigned size)
  1848. - unsigned Seek(unsigned position)
  1849. - const String GetName() const
  1850. - unsigned GetChecksum()
  1851. - unsigned GetPosition() const
  1852. - unsigned GetSize() const
  1853. - bool IsEof() const
  1854. - int ReadInt()
  1855. - short ReadShort()
  1856. - char ReadByte()
  1857. - unsigned ReadUInt()
  1858. - short ReadUShort()
  1859. - char ReadUByte()
  1860. - bool ReadBool()
  1861. - float ReadFloat()
  1862. - double ReadDouble()
  1863. - IntRect ReadIntRect()
  1864. - IntVector2 ReadIntVector2()
  1865. - Rect ReadRect()
  1866. - Vector2 ReadVector2()
  1867. - Vector3 ReadVector3()
  1868. - Vector3 ReadPackedVector3(float maxAbsCoord)
  1869. - Vector4 ReadVector4()
  1870. - Quaternion ReadQuaternion()
  1871. - Quaternion ReadPackedQuaternion()
  1872. - Matrix3 ReadMatrix3()
  1873. - Matrix3x4 ReadMatrix3x4()
  1874. - Matrix4 ReadMatrix4()
  1875. - Color ReadColor()
  1876. - BoundingBox ReadBoundingBox()
  1877. - String ReadString()
  1878. - String ReadFileID()
  1879. - StringHash ReadStringHash()
  1880. - VectorBuffer ReadBuffer()
  1881. - ResourceRef ReadResourceRef()
  1882. - ResourceRefList ReadResourceRefList()
  1883. - Variant ReadVariant()
  1884. - Variant ReadVariant(VariantType type)
  1885. - VariantVector ReadVariantVector()
  1886. - VariantMap ReadVariantMap()
  1887. - unsigned ReadVLE()
  1888. - unsigned ReadNetID()
  1889. - String ReadLine()
  1890. - unsigned Write(const VectorBuffer& buffer)
  1891. - bool WriteInt(int value)
  1892. - bool WriteShort(short value)
  1893. - bool WriteByte(char value)
  1894. - bool WriteUInt(unsigned value)
  1895. - bool WriteUShort(short value)
  1896. - bool WriteUByte(char value)
  1897. - bool WriteBool(bool value)
  1898. - bool WriteFloat(float value)
  1899. - bool WriteDouble(double value)
  1900. - bool WriteIntRect(const IntRect& value)
  1901. - bool WriteIntVector2(const IntVector2& value)
  1902. - bool WriteRect(const Rect& value)
  1903. - bool WriteVector2(const Vector2& value)
  1904. - bool WriteVector3(const Vector3& value)
  1905. - bool WritePackedVector3(const Vector3& value, float maxAbsCoord)
  1906. - bool WriteVector4(const Vector4& value)
  1907. - bool WriteQuaternion(const Quaternion& value)
  1908. - bool WritePackedQuaternion(const Quaternion& value)
  1909. - bool WriteMatrix3(const Matrix3& value)
  1910. - bool WriteMatrix3x4(const Matrix3x4& value)
  1911. - bool WriteMatrix4(const Matrix4& value)
  1912. - bool WriteColor(const Color& value)
  1913. - bool WriteBoundingBox(const BoundingBox& value)
  1914. - bool WriteString(const String value)
  1915. - bool WriteFileID(const String value)
  1916. - bool WriteStringHash(const StringHash& value)
  1917. - bool WriteBuffer(const VectorBuffer& buffer)
  1918. - bool WriteResourceRef(const ResourceRef& value)
  1919. - bool WriteResourceRefList(const ResourceRefList& value)
  1920. - bool WriteVariant(const Variant& value)
  1921. - bool WriteVariantData(const Variant& value)
  1922. - bool WriteVariantVector(const VariantVector& value)
  1923. - bool WriteVariantMap(const VariantMap& value)
  1924. - bool WriteVLE(unsigned value)
  1925. - bool WriteNetID(unsigned value)
  1926. - bool WriteLine(const String value)
  1927. Properties:
  1928. - FileMode mode (readonly)
  1929. - bool open (readonly)
  1930. - bool packaged (readonly)
  1931. - String name (readonly)
  1932. - unsigned checksum (readonly)
  1933. - unsigned position (readonly)
  1934. - unsigned size (readonly)
  1935. - bool eof (readonly)
  1936. <a name="Class_FileSelector"></a>
  1937. ### FileSelector : Object
  1938. Methods:
  1939. - FileSelector() (GC)
  1940. - FileSelector* new()
  1941. - void delete()
  1942. - void SetDefaultStyle(XMLFile* style)
  1943. - void SetTitle(const String text)
  1944. - void SetButtonTexts(const String okText, const String cancelText)
  1945. - void SetPath(const String path)
  1946. - void SetFileName(const String fileName)
  1947. - void SetFilters(const Vector<String>& filters, unsigned defaultIndex)
  1948. - void SetDirectoryMode(bool enable)
  1949. - void UpdateElements()
  1950. - XMLFile* GetDefaultStyle() const
  1951. - Window* GetWindow() const
  1952. - Text* GetTitleText() const
  1953. - ListView* GetFileList() const
  1954. - LineEdit* GetPathEdit() const
  1955. - LineEdit* GetFileNameEdit() const
  1956. - DropDownList* GetFilterList() const
  1957. - Button* GetOKButton() const
  1958. - Button* GetCancelButton() const
  1959. - Button* GetCloseButton() const
  1960. - const String GetTitle() const
  1961. - const String GetPath() const
  1962. - const String GetFileName() const
  1963. - const String GetFilter() const
  1964. - unsigned GetFilterIndex() const
  1965. - bool GetDirectoryMode() const
  1966. Properties:
  1967. - XMLFile* defaultStyle
  1968. - Window* window (readonly)
  1969. - Text* titleText (readonly)
  1970. - ListView* fileList (readonly)
  1971. - LineEdit* pathEdit (readonly)
  1972. - LineEdit* fileNameEdit (readonly)
  1973. - DropDownList* filterList (readonly)
  1974. - Button* OKButton (readonly)
  1975. - Button* cancelButton (readonly)
  1976. - Button* closeButton (readonly)
  1977. - String title
  1978. - String path
  1979. - String fileName
  1980. - String filter (readonly)
  1981. - unsigned filterIndex (readonly)
  1982. - bool directoryMode
  1983. <a name="Class_FileSelectorEntry"></a>
  1984. ### FileSelectorEntry
  1985. Properties:
  1986. - String name
  1987. - bool directory
  1988. <a name="Class_FileSystem"></a>
  1989. ### FileSystem : Object
  1990. Methods:
  1991. - bool SetCurrentDir(const String pathName)
  1992. - bool CreateDir(const String pathName)
  1993. - void SetExecuteConsoleCommands(bool enable)
  1994. - int SystemCommand(const String commandLine, bool redirectStdOutToLog = false)
  1995. - int SystemRun(const String fileName, const Vector<String>& arguments)
  1996. - unsigned SystemCommandAsync(const String commandLine)
  1997. - unsigned SystemRunAsync(const String fileName, const Vector<String>& arguments)
  1998. - bool SystemOpen(const String fileName, const String mode = String::EMPTY)
  1999. - bool Copy(const String srcFileName, const String destFileName)
  2000. - bool Rename(const String srcFileName, const String destFileName)
  2001. - bool Delete(const String fileName)
  2002. - bool SetLastModifiedTime(const String fileName, unsigned newTime)
  2003. - String GetCurrentDir() const
  2004. - bool GetExecuteConsoleCommands() const
  2005. - bool HasRegisteredPaths() const
  2006. - bool CheckAccess(const String pathName) const
  2007. - unsigned GetLastModifiedTime(const String fileName) const
  2008. - bool FileExists(const String fileName) const
  2009. - bool DirExists(const String pathName) const
  2010. - const Vector<String>& ScanDir(const String pathName, const String filter, unsigned flags, bool recursive) const
  2011. - String GetProgramDir() const
  2012. - String GetUserDocumentsDir() const
  2013. - String GetAppPreferencesDir(const String org, const String app) const
  2014. <a name="Class_FocusParameters"></a>
  2015. ### FocusParameters
  2016. Methods:
  2017. - FocusParameters() (GC)
  2018. - FocusParameters* new()
  2019. - FocusParameters(bool focus, bool nonUniform, bool autoSize, float quantize, float minView) (GC)
  2020. - FocusParameters* new(bool focus, bool nonUniform, bool autoSize, float quantize, float minView)
  2021. - void delete()
  2022. <a name="Class_Font"></a>
  2023. ### Font : Resource
  2024. Methods:
  2025. - void SetAbsoluteGlyphOffset(const IntVector2& offset)
  2026. - void SetScaledGlyphOffset(const Vector2& offset)
  2027. - const IntVector2& GetAbsoluteGlyphOffset() const
  2028. - const Vector2& GetScaledGlyphOffset() const
  2029. - IntVector2 GetTotalGlyphOffset(int pointSize) const
  2030. - bool IsSDFFont() const
  2031. Properties:
  2032. - IntVector2 absoluteGlyphOffset
  2033. - Vector2 scaledGlyphOffset
  2034. <a name="Class_Frustum"></a>
  2035. ### Frustum
  2036. Methods:
  2037. - Frustum() (GC)
  2038. - Frustum* new()
  2039. - Frustum(const Frustum& frustum) (GC)
  2040. - Frustum* new(const Frustum& frustum)
  2041. - void delete()
  2042. - void Define(float fov, float aspectRatio, float zoom, float nearZ, float farZ)
  2043. - void Define(float fov, float aspectRatio, float zoom, float nearZ, float farZ, const Matrix3x4& transform)
  2044. - void Define(const Vector3& near, const Vector3& far)
  2045. - void Define(const Vector3& near, const Vector3& far, const Matrix3x4& transform)
  2046. - void Define(const BoundingBox& box)
  2047. - void Define(const BoundingBox& box, const Matrix3x4& transform)
  2048. - void DefineOrtho(float orthoSize, float aspectRatio, float zoom, float nearZ, float farZ)
  2049. - void DefineOrtho(float orthoSize, float aspectRatio, float zoom, float nearZ, float farZ, const Matrix3x4& transform)
  2050. - void Transform(const Matrix3& transform)
  2051. - void Transform(const Matrix3x4& transform)
  2052. - Intersection IsInside(const Vector3& point) const
  2053. - Intersection IsInside(const Sphere& sphere) const
  2054. - Intersection IsInsideFast(const Sphere& sphere) const
  2055. - Intersection IsInside(const BoundingBox& box) const
  2056. - Intersection IsInsideFast(const BoundingBox& box) const
  2057. - float Distance(const Vector3& point) const
  2058. - Frustum Transformed(const Matrix3& transform) const
  2059. - Frustum Transformed(const Matrix3x4& transform) const
  2060. - Rect Projected(const Matrix4& transform) const
  2061. - void UpdatePlanes()
  2062. <a name="Class_Geometry"></a>
  2063. ### Geometry : Object
  2064. Methods:
  2065. - Geometry() (GC)
  2066. - Geometry* new()
  2067. - void delete()
  2068. - bool SetNumVertexBuffers(unsigned num)
  2069. - bool SetVertexBuffer(unsigned index, VertexBuffer* buffer, unsigned elementMask = MASK_DEFAULT)
  2070. - void SetIndexBuffer(IndexBuffer* buffer)
  2071. - bool SetDrawRange(PrimitiveType type, unsigned indexStart, unsigned indexCount, bool getUsedVertexRange = true)
  2072. - bool SetDrawRange(PrimitiveType type, unsigned indexStart, unsigned indexCount, unsigned vertexStart, unsigned vertexCount, bool checkIllegal = true)
  2073. - void SetLodDistance(float distance)
  2074. - unsigned GetNumVertexBuffers() const
  2075. - VertexBuffer* GetVertexBuffer(unsigned index) const
  2076. - unsigned GetVertexElementMask(unsigned index) const
  2077. - IndexBuffer* GetIndexBuffer() const
  2078. - PrimitiveType GetPrimitiveType() const
  2079. - unsigned GetIndexStart() const
  2080. - unsigned GetIndexCount() const
  2081. - unsigned GetVertexStart() const
  2082. - unsigned GetVertexCount() const
  2083. - float GetLodDistance()
  2084. - bool IsEmpty() const
  2085. Properties:
  2086. - unsigned numVertexBuffers
  2087. - IndexBuffer* indexBuffer
  2088. - PrimitiveType primitiveType (readonly)
  2089. - unsigned indexStart (readonly)
  2090. - unsigned indexCount (readonly)
  2091. - unsigned vertexStart (readonly)
  2092. - unsigned vertexCount (readonly)
  2093. - float lodDistance
  2094. - bool empty (readonly)
  2095. <a name="Class_Graphics"></a>
  2096. ### Graphics : Object
  2097. Methods:
  2098. - void SetWindowTitle(const String windowTitle)
  2099. - void SetWindowIcon(Image* windowIcon)
  2100. - void SetWindowPosition(const IntVector2& position)
  2101. - void SetWindowPosition(int x, int y)
  2102. - bool SetMode(int width, int height, bool fullscreen, bool borderless, bool resizable, bool vsync, bool tripleBuffer, int multiSample)
  2103. - bool SetMode(int width, int height)
  2104. - void SetSRGB(bool enable)
  2105. - void SetFlushGPU(bool enable)
  2106. - void SetOrientations(const String orientations)
  2107. - bool ToggleFullscreen()
  2108. - void Maximize()
  2109. - void Minimize()
  2110. - void Close()
  2111. - bool TakeScreenShot(Image& destImage)
  2112. - void BeginDumpShaders(const String fileName)
  2113. - void EndDumpShaders()
  2114. - void PrecacheShaders(Deserializer& source)
  2115. - void PrecacheShaders(const String fileName)
  2116. - bool IsInitialized() const
  2117. - void* GetExternalWindow() const
  2118. - const String GetWindowTitle() const
  2119. - const String GetApiName() const
  2120. - IntVector2 GetWindowPosition() const
  2121. - int GetWidth() const
  2122. - int GetHeight() const
  2123. - int GetMultiSample() const
  2124. - bool GetFullscreen() const
  2125. - bool GetResizable() const
  2126. - bool GetBorderless() const
  2127. - bool GetVSync() const
  2128. - bool GetTripleBuffer() const
  2129. - bool GetSRGB() const
  2130. - bool GetFlushGPU() const
  2131. - const String GetOrientations() const
  2132. - bool IsDeviceLost() const
  2133. - unsigned GetNumPrimitives() const
  2134. - unsigned GetNumBatches() const
  2135. - unsigned GetDummyColorFormat() const
  2136. - unsigned GetShadowMapFormat() const
  2137. - unsigned GetHiresShadowMapFormat() const
  2138. - bool GetInstancingSupport() const
  2139. - bool GetLightPrepassSupport() const
  2140. - bool GetDeferredSupport() const
  2141. - bool GetHardwareShadowSupport() const
  2142. - bool GetReadableDepthSupport() const
  2143. - bool GetSRGBSupport() const
  2144. - bool GetSRGBWriteSupport() const
  2145. - IntVector2 GetDesktopResolution() const
  2146. - unsigned GetAlphaFormat()
  2147. - unsigned GetLuminanceFormat()
  2148. - unsigned GetLuminanceAlphaFormat()
  2149. - unsigned GetRGBFormat()
  2150. - unsigned GetRGBAFormat()
  2151. - unsigned GetRGBA16Format()
  2152. - unsigned GetRGBAFloat16Format()
  2153. - unsigned GetRGBAFloat32Format()
  2154. - unsigned GetRG16Format()
  2155. - unsigned GetRGFloat16Format()
  2156. - unsigned GetRGFloat32Format()
  2157. - unsigned GetFloat16Format()
  2158. - unsigned GetFloat32Format()
  2159. - unsigned GetLinearDepthFormat()
  2160. - unsigned GetDepthStencilFormat()
  2161. - unsigned GetReadableDepthFormat()
  2162. - unsigned GetFormat(const String formatName)
  2163. - unsigned GetMaxBones()
  2164. Properties:
  2165. - bool initialized (readonly)
  2166. - String windowTitle
  2167. - String apiName (readonly)
  2168. - IntVector2 windowPosition
  2169. - int width (readonly)
  2170. - int height (readonly)
  2171. - int multiSample (readonly)
  2172. - bool fullscreen (readonly)
  2173. - bool resizable (readonly)
  2174. - bool borderless (readonly)
  2175. - bool vSync (readonly)
  2176. - bool tripleBuffer (readonly)
  2177. - bool sRGB
  2178. - bool flushGPU
  2179. - String orientations
  2180. - bool deviceLost (readonly)
  2181. - unsigned numPrimitives (readonly)
  2182. - unsigned numBatches (readonly)
  2183. - unsigned dummyColorFormat (readonly)
  2184. - unsigned shadowMapFormat (readonly)
  2185. - unsigned hiresShadowMapFormat (readonly)
  2186. - bool instancingSupport (readonly)
  2187. - bool lightPrepassSupport (readonly)
  2188. - bool deferredSupport (readonly)
  2189. - bool hardwareShadowSupport (readonly)
  2190. - bool readableDepthSupport (readonly)
  2191. - bool sRGBSupport (readonly)
  2192. - bool sRGBWriteSupport (readonly)
  2193. - IntVector2 desktopResolution (readonly)
  2194. <a name="Class_HttpRequest"></a>
  2195. ### HttpRequest : Deserializer
  2196. Methods:
  2197. - const String GetURL() const
  2198. - const String GetVerb() const
  2199. - String GetError() const
  2200. - HttpRequestState GetState() const
  2201. - unsigned GetAvailableSize() const
  2202. - bool IsOpen() const
  2203. Properties:
  2204. - String URL (readonly)
  2205. - String verb (readonly)
  2206. - String error (readonly)
  2207. - HttpRequestState state (readonly)
  2208. - unsigned availableSize (readonly)
  2209. - bool open (readonly)
  2210. <a name="Class_Image"></a>
  2211. ### Image : Resource
  2212. Methods:
  2213. - Image() (GC)
  2214. - Image* new()
  2215. - void delete()
  2216. - bool SetSize(int width, int height, unsigned components)
  2217. - bool SetSize(int width, int height, int depth, unsigned components)
  2218. - void SetPixel(int x, int y, const Color& color)
  2219. - void SetPixel(int x, int y, int z, const Color& color)
  2220. - void SetPixelInt(int x, int y, unsigned uintColor)
  2221. - void SetPixelInt(int x, int y, int z, unsigned uintColor)
  2222. - bool LoadColorLUT(Deserializer& source)
  2223. - bool LoadColorLUT(const String fileName)
  2224. - bool FlipHorizontal()
  2225. - bool FlipVertical()
  2226. - bool Resize(int width, int height)
  2227. - void Clear(const Color& color)
  2228. - void ClearInt(unsigned uintColor)
  2229. - bool SaveBMP(const String fileName) const
  2230. - bool SavePNG(const String fileName) const
  2231. - bool SaveTGA(const String fileName) const
  2232. - bool SaveJPG(const String fileName, int quality) const
  2233. - Color GetPixel(int x, int y) const
  2234. - Color GetPixel(int x, int y, int z) const
  2235. - unsigned GetPixelInt(int x, int y) const
  2236. - unsigned GetPixelInt(int x, int y, int z) const
  2237. - Color GetPixelBilinear(float x, float y) const
  2238. - Color GetPixelTrilinear(float x, float y, float z) const
  2239. - int GetWidth() const
  2240. - int GetHeight() const
  2241. - int GetDepth() const
  2242. - unsigned GetComponents() const
  2243. - bool IsCompressed() const
  2244. - CompressedFormat GetCompressedFormat() const
  2245. - unsigned GetNumCompressedLevels() const
  2246. - Image* GetSubimage(const IntRect& rect) const
  2247. - bool IsCubemap() const
  2248. - bool IsArray() const
  2249. - bool IsSRGB() const
  2250. Properties:
  2251. - int width (readonly)
  2252. - int height (readonly)
  2253. - int depth (readonly)
  2254. - unsigned components (readonly)
  2255. - bool compressed (readonly)
  2256. - CompressedFormat compressedFormat (readonly)
  2257. - unsigned numCompressedLevels (readonly)
  2258. - bool cubemap (readonly)
  2259. - bool array (readonly)
  2260. - bool sRGB (readonly)
  2261. <a name="Class_IndexBuffer"></a>
  2262. ### IndexBuffer : Object
  2263. Methods:
  2264. - IndexBuffer() (GC)
  2265. - IndexBuffer* new()
  2266. - void delete()
  2267. - void SetShadowed(bool enable)
  2268. - bool SetSize(unsigned indexCount, bool largeIndices, bool dynamic = false)
  2269. - bool SetData(VectorBuffer& data)
  2270. - bool SetDataRange(VectorBuffer& data, unsigned start, unsigned count, bool discard = false)
  2271. - VectorBuffer GetData()
  2272. - bool IsShadowed() const
  2273. - bool IsDynamic() const
  2274. - unsigned GetIndexCount() const
  2275. - unsigned GetIndexSize() const
  2276. Properties:
  2277. - bool shadowed
  2278. - bool dynamic (readonly)
  2279. - unsigned indexCount (readonly)
  2280. - unsigned indexSize (readonly)
  2281. <a name="Class_Input"></a>
  2282. ### Input : Object
  2283. Methods:
  2284. - void SetToggleFullscreen(bool enable)
  2285. - void SetMouseVisible(bool enable, bool suppressEvent = false)
  2286. - void SetMouseGrabbed(bool grab)
  2287. - void SetMouseMode(MouseMode mode)
  2288. - int AddScreenJoystick(XMLFile* layoutFile = 0, XMLFile* styleFile = 0)
  2289. - bool RemoveScreenJoystick(int id)
  2290. - void SetScreenJoystickVisible(int id, bool enable)
  2291. - void SetScreenKeyboardVisible(bool enable)
  2292. - void SetTouchEmulation(bool enable)
  2293. - bool RecordGesture()
  2294. - bool SaveGestures(File* dest)
  2295. - bool SaveGesture(File* dest, unsigned gestureID)
  2296. - unsigned LoadGestures(File* source)
  2297. - bool SaveGestures(const String fileName)
  2298. - bool SaveGesture(const String fileName, unsigned gestureID)
  2299. - unsigned LoadGestures(const String fileName)
  2300. - bool RemoveGesture(unsigned gestureID)
  2301. - void RemoveAllGestures()
  2302. - int GetKeyFromName(const String name) const
  2303. - int GetKeyFromScancode(int scancode) const
  2304. - String GetKeyName(int key) const
  2305. - int GetScancodeFromKey(int key) const
  2306. - int GetScancodeFromName(const String name) const
  2307. - String GetScancodeName(int scancode) const
  2308. - bool GetKeyDown(int key) const
  2309. - bool GetKeyPress(int key) const
  2310. - bool GetScancodeDown(int scancode) const
  2311. - bool GetScancodePress(int scancode) const
  2312. - bool GetMouseButtonDown(int button) const
  2313. - bool GetMouseButtonPress(int button) const
  2314. - bool GetQualifierDown(int qualifier) const
  2315. - bool GetQualifierPress(int qualifier) const
  2316. - int GetQualifiers() const
  2317. - IntVector2 GetMousePosition() const
  2318. - const IntVector2& GetMouseMove() const
  2319. - int GetMouseMoveX() const
  2320. - int GetMouseMoveY() const
  2321. - int GetMouseMoveWheel() const
  2322. - unsigned GetNumTouches() const
  2323. - TouchState* GetTouch(unsigned index) const
  2324. - unsigned GetNumJoysticks() const
  2325. - JoystickState* GetJoystick(int id)
  2326. - JoystickState* GetJoystickByIndex(unsigned index)
  2327. - bool GetToggleFullscreen() const
  2328. - bool GetScreenKeyboardSupport() const
  2329. - bool IsScreenJoystickVisible(int id) const
  2330. - bool IsScreenKeyboardVisible() const
  2331. - bool GetTouchEmulation() const
  2332. - bool IsMouseVisible() const
  2333. - bool IsMouseGrabbed() const
  2334. - MouseMode GetMouseMode() const
  2335. - bool HasFocus()
  2336. - bool IsMinimized() const
  2337. Properties:
  2338. - int qualifiers (readonly)
  2339. - IntVector2 mousePosition (readonly)
  2340. - IntVector2& mouseMove (readonly)
  2341. - int mouseMoveX (readonly)
  2342. - int mouseMoveY (readonly)
  2343. - int mouseMoveWheel (readonly)
  2344. - unsigned numTouches (readonly)
  2345. - unsigned numJoysticks (readonly)
  2346. - bool toggleFullscreen (readonly)
  2347. - bool screenKeyboardSupport (readonly)
  2348. - MouseMode mouseMode
  2349. - bool screenKeyboardVisible
  2350. - bool touchEmulation
  2351. - bool mouseVisible
  2352. - bool mouseGrabbed
  2353. - bool focus (readonly)
  2354. - bool minimized (readonly)
  2355. <a name="Class_IntRect"></a>
  2356. ### IntRect
  2357. Methods:
  2358. - IntRect() (GC)
  2359. - IntRect* new()
  2360. - IntRect(int left, int top, int right, int bottom) (GC)
  2361. - IntRect* new(int left, int top, int right, int bottom)
  2362. - void delete()
  2363. - bool operator==(const IntRect& rhs) const
  2364. - IntVector2 Size() const
  2365. - int Width() const
  2366. - int Height() const
  2367. - Intersection IsInside(const IntVector2& point) const
  2368. Properties:
  2369. - int left
  2370. - int top
  2371. - int right
  2372. - int bottom
  2373. - const IntRect ZERO
  2374. - IntVector2 size (readonly)
  2375. - int width (readonly)
  2376. - int height (readonly)
  2377. <a name="Class_IntVector2"></a>
  2378. ### IntVector2
  2379. Methods:
  2380. - IntVector2() (GC)
  2381. - IntVector2* new()
  2382. - IntVector2(int x, int y) (GC)
  2383. - IntVector2* new(int x, int y)
  2384. - IntVector2(const IntVector2& rhs) (GC)
  2385. - IntVector2* new(const IntVector2& rhs)
  2386. - void delete()
  2387. - bool operator==(const IntVector2& rhs) const
  2388. - IntVector2 operator+(const IntVector2& rhs) const
  2389. - IntVector2 operator-() const
  2390. - IntVector2 operator-(const IntVector2& rhs) const
  2391. - IntVector2 operator*(int rhs) const
  2392. - IntVector2 operator/(int rhs) const
  2393. - String ToString() const
  2394. Properties:
  2395. - int x
  2396. - int y
  2397. - const IntVector2 ZERO
  2398. <a name="Class_JSONFile"></a>
  2399. ### JSONFile : Resource
  2400. Methods:
  2401. - JSONFile() (GC)
  2402. - JSONFile* new()
  2403. - void delete()
  2404. - const JSONValue& GetRoot() const
  2405. - bool Save(const String fileName, const String indentation = "\t") const
  2406. <a name="Class_JSONValue"></a>
  2407. ### JSONValue
  2408. Methods:
  2409. - JSONValue() (GC)
  2410. - JSONValue* new()
  2411. - JSONValue(bool value) (GC)
  2412. - JSONValue* new(bool value)
  2413. - JSONValue(const char* value) (GC)
  2414. - JSONValue* new(const char* value)
  2415. - JSONValue(double value) (GC)
  2416. - JSONValue* new(double value)
  2417. - JSONValue(const JSONArray& value) (GC)
  2418. - JSONValue* new(const JSONArray& value)
  2419. - JSONValue(const JSONObject& value) (GC)
  2420. - JSONValue* new(const JSONObject& value)
  2421. - JSONValue(const JSONValue& value) (GC)
  2422. - JSONValue* new(const JSONValue& value)
  2423. - void delete()
  2424. - void SetBool(bool value)
  2425. - void SetInt(int value)
  2426. - void SetUint(unsigned value)
  2427. - void SetFloat(float value)
  2428. - void SetDouble(double value)
  2429. - void SetString(const String value)
  2430. - void SetArray(const JSONArray& value)
  2431. - void SetObject(const JSONObject& value)
  2432. - JSONValueType GetValueType() const
  2433. - bool IsNull() const
  2434. - bool IsBool() const
  2435. - bool IsNumber() const
  2436. - bool IsString() const
  2437. - bool IsArray() const
  2438. - bool IsObject() const
  2439. - bool GetBool() const
  2440. - int GetInt() const
  2441. - unsigned GetUInt() const
  2442. - float GetFloat() const
  2443. - double GetDouble() const
  2444. - const String GetString() const
  2445. - const JSONArray& GetArray() const
  2446. - const JSONObject& GetObject() const
  2447. - JSONValue operator&[](unsigned index, JSONValue tolua_value)
  2448. - JSONValue operator[](unsigned index)
  2449. - const JSONValue operator[](unsigned index) const
  2450. - void Push(const JSONValue& value)
  2451. - void Pop()
  2452. - void Insert(unsigned pos, const JSONValue& value)
  2453. - void Erase(unsigned pos, unsigned length = 1)
  2454. - void Resize(unsigned newSize)
  2455. - unsigned Size() const
  2456. - void Set(const String key, const JSONValue& value)
  2457. - const JSONValue& Get(const String key) const
  2458. - bool Erase(const String key)
  2459. - bool Contains(const String key) const
  2460. - void Clear()
  2461. Properties:
  2462. - const JSONValue EMPTY
  2463. - const JSONArray emptyArray
  2464. - const JSONObject emptyObject
  2465. - bool null (readonly)
  2466. <a name="Class_JoystickState"></a>
  2467. ### JoystickState
  2468. Methods:
  2469. - bool IsController() const
  2470. - unsigned GetNumButtons() const
  2471. - unsigned GetNumAxes() const
  2472. - unsigned GetNumHats() const
  2473. - bool GetButtonDown(unsigned index) const
  2474. - bool GetButtonPress(unsigned index) const
  2475. - float GetAxisPosition(unsigned index) const
  2476. - int GetHatPosition(unsigned index) const
  2477. Properties:
  2478. - const String name
  2479. - const int joystickID
  2480. - bool controller (readonly)
  2481. - unsigned numButtons (readonly)
  2482. - unsigned numAxes (readonly)
  2483. - unsigned numHats (readonly)
  2484. <a name="Class_Light"></a>
  2485. ### Light : Drawable
  2486. Methods:
  2487. - void SetLightType(LightType type)
  2488. - void SetPerVertex(bool enable)
  2489. - void SetColor(const Color& color)
  2490. - void SetSpecularIntensity(float intensity)
  2491. - void SetBrightness(float brightness)
  2492. - void SetRange(float range)
  2493. - void SetFov(float fov)
  2494. - void SetAspectRatio(float aspectRatio)
  2495. - void SetFadeDistance(float distance)
  2496. - void SetShadowFadeDistance(float distance)
  2497. - void SetShadowBias(const BiasParameters& parameters)
  2498. - void SetShadowCascade(const CascadeParameters& parameters)
  2499. - void SetShadowFocus(const FocusParameters& parameters)
  2500. - void SetShadowIntensity(float intensity)
  2501. - void SetShadowResolution(float resolution)
  2502. - void SetShadowNearFarRatio(float nearFarRatio)
  2503. - void SetRampTexture(Texture* texture)
  2504. - void SetShapeTexture(Texture* texture)
  2505. - LightType GetLightType() const
  2506. - bool GetPerVertex() const
  2507. - const Color& GetColor() const
  2508. - float GetSpecularIntensity() const
  2509. - float GetBrightness() const
  2510. - Color GetEffectiveColor() const
  2511. - float GetEffectiveSpecularIntensity() const
  2512. - float GetRange() const
  2513. - float GetFov() const
  2514. - float GetAspectRatio() const
  2515. - float GetFadeDistance() const
  2516. - float GetShadowFadeDistance() const
  2517. - const BiasParameters& GetShadowBias() const
  2518. - const CascadeParameters& GetShadowCascade() const
  2519. - const FocusParameters& GetShadowFocus() const
  2520. - float GetShadowIntensity() const
  2521. - float GetShadowResolution() const
  2522. - float GetShadowNearFarRatio() const
  2523. - Texture* GetRampTexture() const
  2524. - Texture* GetShapeTexture() const
  2525. - Frustum GetFrustum() const
  2526. - int GetNumShadowSplits() const
  2527. - bool IsNegative() const
  2528. Properties:
  2529. - LightType lightType
  2530. - bool perVertex
  2531. - Color& color
  2532. - float specularIntensity
  2533. - float brightness
  2534. - float range
  2535. - float fov
  2536. - float aspectRatio
  2537. - float fadeDistance
  2538. - float shadowFadeDistance
  2539. - BiasParameters& shadowBias
  2540. - CascadeParameters& shadowCascade
  2541. - FocusParameters& shadowFocus
  2542. - float shadowIntensity
  2543. - float shadowResolution
  2544. - float shadowNearFarRatio
  2545. - Texture* rampTexture
  2546. - Texture* shapeTexture
  2547. - Frustum frustum (readonly)
  2548. - int numShadowSplits (readonly)
  2549. - bool negative (readonly)
  2550. - Color effectiveColor (readonly)
  2551. - float effectiveSpecularIntensity (readonly)
  2552. <a name="Class_LineEdit"></a>
  2553. ### LineEdit : BorderImage
  2554. Methods:
  2555. - LineEdit() (GC)
  2556. - LineEdit* new()
  2557. - void delete()
  2558. - void SetText(const String text)
  2559. - void SetCursorPosition(unsigned position)
  2560. - void SetCursorBlinkRate(float rate)
  2561. - void SetMaxLength(unsigned length)
  2562. - void SetEchoCharacter(unsigned c)
  2563. - void SetCursorMovable(bool enable)
  2564. - void SetTextSelectable(bool enable)
  2565. - void SetTextCopyable(bool enable)
  2566. - const String GetText() const
  2567. - unsigned GetCursorPosition() const
  2568. - float GetCursorBlinkRate() const
  2569. - unsigned GetMaxLength() const
  2570. - unsigned GetEchoCharacter() const
  2571. - bool IsCursorMovable() const
  2572. - bool IsTextSelectable() const
  2573. - bool IsTextCopyable() const
  2574. - Text* GetTextElement() const
  2575. - BorderImage* GetCursor() const
  2576. Properties:
  2577. - String text
  2578. - unsigned cursorPosition
  2579. - float cursorBlinkRate
  2580. - unsigned maxLength
  2581. - unsigned echoCharacter
  2582. - bool cursorMovable
  2583. - bool textSelectable
  2584. - bool textCopyable
  2585. - Text* textElement (readonly)
  2586. - BorderImage* cursor (readonly)
  2587. <a name="Class_ListView"></a>
  2588. ### ListView : ScrollView
  2589. Methods:
  2590. - ListView() (GC)
  2591. - ListView* new()
  2592. - void delete()
  2593. - void AddItem(UIElement* item)
  2594. - void InsertItem(unsigned index, UIElement* item, UIElement* parentItem = 0)
  2595. - void RemoveItem(UIElement* item, unsigned index = 0)
  2596. - void RemoveItem(unsigned index)
  2597. - void RemoveAllItems()
  2598. - void SetSelection(unsigned index)
  2599. - void SetSelections(const PODVector<unsigned>& indices)
  2600. - void AddSelection(unsigned index)
  2601. - void RemoveSelection(unsigned index)
  2602. - void ToggleSelection(unsigned index)
  2603. - void ChangeSelection(int delta, bool additive = false)
  2604. - void ClearSelection()
  2605. - void SetHighlightMode(HighlightMode mode)
  2606. - void SetMultiselect(bool enable)
  2607. - void SetHierarchyMode(bool enable)
  2608. - void SetBaseIndent(int baseIndent)
  2609. - void SetClearSelectionOnDefocus(bool enable)
  2610. - void SetSelectOnClickEnd(bool enable)
  2611. - void Expand(unsigned index, bool enable, bool recursive = false)
  2612. - void ToggleExpand(unsigned index, bool recursive = false)
  2613. - unsigned GetNumItems() const
  2614. - UIElement* GetItem(unsigned index) const
  2615. - const PODVector<UIElement*>& GetItems() const
  2616. - unsigned FindItem(UIElement* item) const
  2617. - unsigned GetSelection() const
  2618. - const PODVector<unsigned>& GetSelections() const
  2619. - void CopySelectedItemsToClipboard() const
  2620. - UIElement* GetSelectedItem() const
  2621. - const PODVector<UIElement*>& GetSelectedItems() const
  2622. - bool IsSelected(unsigned index) const
  2623. - bool IsExpanded(unsigned index) const
  2624. - HighlightMode GetHighlightMode() const
  2625. - bool GetMultiselect() const
  2626. - bool GetClearSelectionOnDefocus() const
  2627. - bool GetSelectOnClickEnd() const
  2628. - bool GetHierarchyMode() const
  2629. - int GetBaseIndent() const
  2630. Properties:
  2631. - unsigned numItems (readonly)
  2632. - unsigned selection
  2633. - UIElement* selectedItem (readonly)
  2634. - HighlightMode highlightMode
  2635. - bool multiselect
  2636. - bool clearSelectionOnDefocus
  2637. - bool selectOnClickEnd
  2638. - bool hierarchyMode
  2639. - int baseIndent
  2640. <a name="Class_Localization"></a>
  2641. ### Localization : Object
  2642. Methods:
  2643. - int GetNumLanguages() const
  2644. - int GetLanguageIndex() const
  2645. - int GetLanguageIndex(const String language)
  2646. - String GetLanguage()
  2647. - String GetLanguage(int index)
  2648. - void SetLanguage(const String language)
  2649. - void SetLanguage(int index)
  2650. - String Get(const String id)
  2651. - void Reset()
  2652. - void LoadJSON(const JSONValue& source)
  2653. - void LoadJSONFile(const String name)
  2654. Properties:
  2655. - int numLanguages (readonly)
  2656. - int languageIndex (readonly)
  2657. - String language (readonly)
  2658. <a name="Class_Log"></a>
  2659. ### Log : Object
  2660. Methods:
  2661. - void Open(const String fileName)
  2662. - void Close()
  2663. - void SetLevel(int level)
  2664. - void SetTimeStamp(bool enable)
  2665. - void SetQuiet(bool quiet)
  2666. - int GetLevel() const
  2667. - bool GetTimeStamp() const
  2668. - String GetLastMessage() const
  2669. - bool IsQuiet() const
  2670. - void Write(int level, const String message)
  2671. - void WriteRaw(const String message, bool error = false)
  2672. Properties:
  2673. - int level
  2674. - bool timeStamp
  2675. - bool quiet
  2676. <a name="Class_LuaScriptInstance"></a>
  2677. ### LuaScriptInstance : Component
  2678. Methods:
  2679. - bool CreateObject(const String scriptObjectType)
  2680. - bool CreateObject(LuaFile* scriptFile, const String scriptObjectType)
  2681. - void SetScriptFile(LuaFile* scriptFile)
  2682. - void SetScriptObjectType(const String scriptObjectType)
  2683. - void SubscribeToEvent(const String eventName, void* functionOrFunctionName)
  2684. - void SubscribeToEvent(void* sender, const String eventName, void* functionOrFunctionName)
  2685. - void UnsubscribeFromEvent(const String eventName)
  2686. - void UnsubscribeFromEvent(Object* sender, const String eventName)
  2687. - void UnsubscribeFromEvents(Object* sender)
  2688. - void UnsubscribeFromAllEvents()
  2689. - void UnsubscribeFromAllEventsExcept(const Vector<String>& exceptionNames)
  2690. - LuaFile* GetScriptFile() const
  2691. - const String GetScriptObjectType() const
  2692. Properties:
  2693. - const LuaFile* scriptFile
  2694. - const String scriptObjectType
  2695. <a name="Class_Material"></a>
  2696. ### Material : Resource
  2697. Methods:
  2698. - Material() (GC)
  2699. - Material* new()
  2700. - void delete()
  2701. - void SetNumTechniques(unsigned num)
  2702. - void SetTechnique(unsigned index, Technique* tech, unsigned qualityLevel = 0, float lodDistance = 0.0f)
  2703. - void SetShaderParameter(const String name, const Variant& value)
  2704. - void SetShaderParameterAnimation(const String name, ValueAnimation* animation, WrapMode wrapMode = WM_LOOP, float speed = 1.0f)
  2705. - void SetShaderParameterAnimationWrapMode(const String name, WrapMode wrapMode)
  2706. - void SetShaderParameterAnimationSpeed(const String name, float speed)
  2707. - void SetTexture(TextureUnit unit, Texture* texture)
  2708. - void SetUVTransform(const Vector2& offset, float rotation, const Vector2& repeat)
  2709. - void SetUVTransform(const Vector2& offset, float rotation, float repeat)
  2710. - void SetCullMode(CullMode mode)
  2711. - void SetShadowCullMode(CullMode mode)
  2712. - void SetFillMode(FillMode mode)
  2713. - void SetDepthBias(const BiasParameters& parameters)
  2714. - void SetRenderOrder(char renderOrder)
  2715. - void SetScene(Scene* scene)
  2716. - void RemoveShaderParameter(const String name)
  2717. - void ReleaseShaders()
  2718. - Material* Clone(const String cloneName = String::EMPTY) const
  2719. - void SortTechniques()
  2720. - void MarkForAuxView(unsigned frameNumber)
  2721. - unsigned GetNumTechniques() const
  2722. - Technique* GetTechnique(unsigned index) const
  2723. - Pass* GetPass(unsigned index, const String passName) const
  2724. - Texture* GetTexture(TextureUnit unit) const
  2725. - ValueAnimation* GetShaderParameterAnimation(const String name) const
  2726. - WrapMode GetShaderParameterAnimationWrapMode(const String name) const
  2727. - float GetShaderParameterAnimationSpeed(const String name) const
  2728. - CullMode GetCullMode() const
  2729. - CullMode GetShadowCullMode() const
  2730. - FillMode GetFillMode() const
  2731. - const BiasParameters& GetDepthBias() const
  2732. - char GetRenderOrder() const
  2733. - bool GetOcclusion() const
  2734. - bool GetSpecular() const
  2735. - Scene* GetScene() const
  2736. Properties:
  2737. - CullMode cullMode
  2738. - CullMode shadowCullMode
  2739. - FillMode fillMode
  2740. - BiasParameters depthBias
  2741. - char renderOrder
  2742. - bool occlusion (readonly)
  2743. - bool specular (readonly)
  2744. - Scene* scene
  2745. <a name="Class_Matrix3"></a>
  2746. ### Matrix3
  2747. Methods:
  2748. - Matrix3() (GC)
  2749. - Matrix3* new()
  2750. - Matrix3(const Matrix3& matrix) (GC)
  2751. - Matrix3* new(const Matrix3& matrix)
  2752. - Matrix3(float v00, float v01, float v02, float v10, float v11, float v12, float v20, float v21, float v22) (GC)
  2753. - Matrix3* new(float v00, float v01, float v02, float v10, float v11, float v12, float v20, float v21, float v22)
  2754. - void delete()
  2755. - bool operator==(const Matrix3& rhs) const
  2756. - Vector3 operator*(const Vector3& rhs) const
  2757. - Matrix3 operator+(const Matrix3& rhs) const
  2758. - Matrix3 operator-(const Matrix3& rhs) const
  2759. - Matrix3 operator*(float rhs) const
  2760. - Matrix3 operator*(const Matrix3& rhs) const
  2761. - void SetScale(const Vector3& scale)
  2762. - void SetScale(float scale)
  2763. - Vector3 Scale() const
  2764. - Matrix3 Transpose() const
  2765. - Matrix3 Scaled(const Vector3& scale) const
  2766. - bool Equals(const Matrix3& rhs) const
  2767. - Matrix3 Inverse() const
  2768. - String ToString() const
  2769. Properties:
  2770. - float m00
  2771. - float m01
  2772. - float m02
  2773. - float m10
  2774. - float m11
  2775. - float m12
  2776. - float m20
  2777. - float m21
  2778. - float m22
  2779. - const Matrix3 ZERO
  2780. - const Matrix3 IDENTITY
  2781. <a name="Class_Matrix3x4"></a>
  2782. ### Matrix3x4
  2783. Methods:
  2784. - Matrix3x4() (GC)
  2785. - Matrix3x4* new()
  2786. - Matrix3x4(const Matrix3x4& matrix) (GC)
  2787. - Matrix3x4* new(const Matrix3x4& matrix)
  2788. - Matrix3x4(const Matrix3& matrix) (GC)
  2789. - Matrix3x4* new(const Matrix3& matrix)
  2790. - Matrix3x4(const Matrix4& matrix) (GC)
  2791. - Matrix3x4* new(const Matrix4& matrix)
  2792. - 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)
  2793. - 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)
  2794. - Matrix3x4(const Vector3& translation, const Quaternion& rotation, float scale) (GC)
  2795. - Matrix3x4* new(const Vector3& translation, const Quaternion& rotation, float scale)
  2796. - Matrix3x4(const Vector3& translation, const Quaternion& rotation, const Vector3& scale) (GC)
  2797. - Matrix3x4* new(const Vector3& translation, const Quaternion& rotation, const Vector3& scale)
  2798. - void delete()
  2799. - bool operator==(const Matrix3x4& rhs) const
  2800. - Vector3 operator*(const Vector3& rhs) const
  2801. - Vector3 operator*(const Vector4& rhs) const
  2802. - Matrix3x4 operator+(const Matrix3x4& rhs) const
  2803. - Matrix3x4 operator-(const Matrix3x4& rhs) const
  2804. - Matrix3x4 operator*(float rhs) const
  2805. - Matrix3x4 operator*(const Matrix3x4& rhs) const
  2806. - Matrix4 operator*(const Matrix4& rhs) const
  2807. - void SetTranslation(const Vector3& translation)
  2808. - void SetRotation(const Matrix3& rotation)
  2809. - void SetScale(const Vector3& scale)
  2810. - void SetScale(float scale)
  2811. - Matrix3 ToMatrix3() const
  2812. - Matrix4 ToMatrix4() const
  2813. - Matrix3 RotationMatrix() const
  2814. - Vector3 Translation() const
  2815. - Quaternion Rotation() const
  2816. - Vector3 Scale() const
  2817. - bool Equals(const Matrix3x4& rhs) const
  2818. - void Decompose(Vector3& translation, Quaternion& rotation, Vector3& scale) const
  2819. - Matrix3x4 Inverse() const
  2820. - String ToString() const
  2821. Properties:
  2822. - float m00
  2823. - float m01
  2824. - float m02
  2825. - float m03
  2826. - float m10
  2827. - float m11
  2828. - float m12
  2829. - float m13
  2830. - float m20
  2831. - float m21
  2832. - float m22
  2833. - float m23
  2834. - const Matrix3x4 ZERO
  2835. - const Matrix3x4 IDENTITY
  2836. <a name="Class_Matrix4"></a>
  2837. ### Matrix4
  2838. Methods:
  2839. - Matrix4() (GC)
  2840. - Matrix4* new()
  2841. - Matrix4(const Matrix4& matrix) (GC)
  2842. - Matrix4* new(const Matrix4& matrix)
  2843. - Matrix4(const Matrix3& matrix) (GC)
  2844. - Matrix4* new(const Matrix3& matrix)
  2845. - 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)
  2846. - 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)
  2847. - void delete()
  2848. - bool operator==(const Matrix4& rhs) const
  2849. - Vector3 operator*(const Vector3& rhs) const
  2850. - Vector4 operator*(const Vector4& rhs) const
  2851. - Matrix4 operator+(const Matrix4& rhs) const
  2852. - Matrix4 operator-(const Matrix4& rhs) const
  2853. - Matrix4 operator*(float rhs) const
  2854. - Matrix4 operator*(const Matrix4& rhs) const
  2855. - Matrix4 operator*(const Matrix3x4& rhs) const
  2856. - void SetTranslation(const Vector3& translation)
  2857. - void SetRotation(const Matrix3& rotation)
  2858. - void SetScale(const Vector3& scale)
  2859. - void SetScale(float scale)
  2860. - Matrix3 ToMatrix3() const
  2861. - Matrix3 RotationMatrix() const
  2862. - Vector3 Translation() const
  2863. - Quaternion Rotation() const
  2864. - Vector3 Scale() const
  2865. - Matrix4 Transpose() const
  2866. - bool Equals(const Matrix4& rhs) const
  2867. - void Decompose(Vector3& translation, Quaternion& rotation, Vector3& scale) const
  2868. - Matrix4 Inverse() const
  2869. - String ToString() const
  2870. Properties:
  2871. - float m00
  2872. - float m01
  2873. - float m02
  2874. - float m03
  2875. - float m10
  2876. - float m11
  2877. - float m12
  2878. - float m13
  2879. - float m20
  2880. - float m21
  2881. - float m22
  2882. - float m23
  2883. - float m30
  2884. - float m31
  2885. - float m32
  2886. - float m33
  2887. - const Matrix4 ZERO
  2888. - const Matrix4 IDENTITY
  2889. <a name="Class_Menu"></a>
  2890. ### Menu : Button
  2891. Methods:
  2892. - Menu() (GC)
  2893. - Menu* new()
  2894. - void delete()
  2895. - void SetPopup(UIElement* element)
  2896. - void SetPopupOffset(const IntVector2& offset)
  2897. - void SetPopupOffset(int x, int y)
  2898. - void ShowPopup(bool enable)
  2899. - void SetAccelerator(int key, int qualifiers)
  2900. - UIElement* GetPopup() const
  2901. - const IntVector2& GetPopupOffset() const
  2902. - bool GetShowPopup() const
  2903. - int GetAcceleratorKey() const
  2904. - int GetAcceleratorQualifiers() const
  2905. Properties:
  2906. - UIElement* popup
  2907. - IntVector2& popupOffset
  2908. - bool showPopup
  2909. - int acceleratorKey (readonly)
  2910. - int acceleratorQualifiers (readonly)
  2911. <a name="Class_MessageBox"></a>
  2912. ### MessageBox : Object
  2913. Methods:
  2914. - MessageBox(const String messageString = String::EMPTY, const String titleString = String::EMPTY, XMLFile* layoutFile = 0, XMLFile* styleFile = 0) (GC)
  2915. - MessageBox* new(const String messageString = String::EMPTY, const String titleString = String::EMPTY, XMLFile* layoutFile = 0, XMLFile* styleFile = 0)
  2916. - void delete()
  2917. - void SetTitle(const String text)
  2918. - void SetMessage(const String text)
  2919. - const String GetTitle() const
  2920. - const String GetMessage() const
  2921. - UIElement* GetWindow() const
  2922. Properties:
  2923. - String title
  2924. - String message
  2925. - UIElement* window (readonly)
  2926. <a name="Class_Model"></a>
  2927. ### Model : Resource
  2928. Methods:
  2929. - Model() (GC)
  2930. - Model* new()
  2931. - void delete()
  2932. - Model* Clone(const String cloneName = String::EMPTY) const
  2933. - void SetBoundingBox(const BoundingBox& box)
  2934. - void SetNumGeometries(unsigned num)
  2935. - bool SetNumGeometryLodLevels(unsigned index, unsigned num)
  2936. - bool SetGeometry(unsigned index, unsigned lodLevel, Geometry* geometry)
  2937. - bool SetGeometryCenter(unsigned index, const Vector3& center)
  2938. - const BoundingBox& GetBoundingBox() const
  2939. - Skeleton& GetSkeleton()
  2940. - unsigned GetNumGeometries() const
  2941. - unsigned GetNumGeometryLodLevels(unsigned index) const
  2942. - Geometry* GetGeometry(unsigned index, unsigned lodLevel) const
  2943. - const Vector3& GetGeometryCenter(unsigned index) const
  2944. - unsigned GetNumMorphs() const
  2945. - const ModelMorph* GetMorph(const String name) const
  2946. - const ModelMorph* GetMorph(StringHash nameHash) const
  2947. - const ModelMorph* GetMorph(unsigned index) const
  2948. - unsigned GetMorphRangeStart(unsigned bufferIndex) const
  2949. - unsigned GetMorphRangeCount(unsigned bufferIndex) const
  2950. Properties:
  2951. - BoundingBox& boundingBox
  2952. - Skeleton skeleton (readonly)
  2953. - unsigned numGeometries
  2954. - unsigned numMorphs (readonly)
  2955. <a name="Class_NavArea"></a>
  2956. ### NavArea : Component
  2957. Methods:
  2958. - unsigned GetAreaID() const
  2959. - void SetAreaID(unsigned tolua_var_3)
  2960. - BoundingBox GetBoundingBox()
  2961. - void SetBoundingBox(const BoundingBox& bnds)
  2962. - BoundingBox GetWorldBoundingBox() const
  2963. Properties:
  2964. - unsigned areaID
  2965. - BoundingBox boundingBox
  2966. - BoundingBox worldBoundingBox (readonly)
  2967. <a name="Class_Navigable"></a>
  2968. ### Navigable : Component
  2969. Methods:
  2970. - void SetRecursive(bool enable)
  2971. - bool IsRecursive() const
  2972. Properties:
  2973. - bool recursive
  2974. <a name="Class_NavigationGeometryInfo"></a>
  2975. ### NavigationGeometryInfo
  2976. Properties:
  2977. - Component* component
  2978. - unsigned lodLevel
  2979. - Matrix3x4 transform
  2980. - BoundingBox boundingBox
  2981. <a name="Class_NavigationMesh"></a>
  2982. ### NavigationMesh : Component
  2983. Methods:
  2984. - void SetTileSize(int size)
  2985. - void SetCellSize(float size)
  2986. - void SetCellHeight(float height)
  2987. - void SetAgentHeight(float height)
  2988. - void SetAgentRadius(float radius)
  2989. - void SetAgentMaxClimb(float maxClimb)
  2990. - void SetAgentMaxSlope(float maxSlope)
  2991. - void SetRegionMinSize(float size)
  2992. - void SetRegionMergeSize(float size)
  2993. - void SetEdgeMaxLength(float length)
  2994. - void SetEdgeMaxError(float error)
  2995. - void SetDetailSampleDistance(float distance)
  2996. - void SetDetailSampleMaxError(float error)
  2997. - void SetPadding(const Vector3& padding)
  2998. - void SetAreaCost(unsigned areaID, float cost)
  2999. - bool Build()
  3000. - bool Build(const BoundingBox& boundingBox)
  3001. - void SetPartitionType(NavmeshPartitionType aType)
  3002. - void SetDrawOffMeshConnections(bool enable)
  3003. - void SetDrawNavAreas(bool enable)
  3004. - Vector3 FindNearestPoint(const Vector3& point)
  3005. - Vector3 FindNearestPoint(const Vector3& point, const Vector3& extents)
  3006. - Vector3 MoveAlongSurface(const Vector3& start, const Vector3& end)
  3007. - Vector3 MoveAlongSurface(const Vector3& start, const Vector3& end, const Vector3& extents, int maxVisited = 3)
  3008. - const PODVector<Vector3>& FindPath(const Vector3& start, const Vector3& end)
  3009. - const PODVector<Vector3>& FindPath(const Vector3& start, const Vector3& end, const Vector3& extents)
  3010. - Vector3 GetRandomPoint()
  3011. - Vector3 GetRandomPointInCircle(const Vector3& center, float radius)
  3012. - Vector3 GetRandomPointInCircle(const Vector3& center, float radius, const Vector3& extents)
  3013. - float GetDistanceToWall(const Vector3& point, float radius)
  3014. - float GetDistanceToWall(const Vector3& point, float radius, const Vector3& extents)
  3015. - Vector3 Raycast(const Vector3& start, const Vector3& end)
  3016. - Vector3 Raycast(const Vector3& start, const Vector3& end, const Vector3& extents)
  3017. - void DrawDebugGeometry(bool depthTest)
  3018. - int GetTileSize() const
  3019. - float GetCellSize() const
  3020. - float GetCellHeight() const
  3021. - float GetAgentHeight() const
  3022. - float GetAgentRadius() const
  3023. - float GetAgentMaxClimb() const
  3024. - float GetAgentMaxSlope() const
  3025. - float GetRegionMinSize() const
  3026. - float GetRegionMergeSize() const
  3027. - float GetEdgeMaxLength() const
  3028. - float GetEdgeMaxError() const
  3029. - float GetDetailSampleDistance() const
  3030. - float GetDetailSampleMaxError() const
  3031. - const Vector3& GetPadding() const
  3032. - float GetAreaCost(unsigned areaID) const
  3033. - bool IsInitialized() const
  3034. - const BoundingBox& GetBoundingBox() const
  3035. - BoundingBox GetWorldBoundingBox() const
  3036. - IntVector2 GetNumTiles() const
  3037. - NavmeshPartitionType GetPartitionType()
  3038. - bool GetDrawOffMeshConnections() const
  3039. - bool GetDrawNavAreas() const
  3040. Properties:
  3041. - int tileSize
  3042. - float cellSize
  3043. - float cellHeight
  3044. - float agentHeight
  3045. - float agentRadius
  3046. - float agentMaxClimb
  3047. - float agentMaxSlope
  3048. - float regionMinSize
  3049. - float regionMergeSize
  3050. - float edgeMaxLength
  3051. - float edgeMaxError
  3052. - float detailSampleDistance
  3053. - float detailSampleMaxError
  3054. - Vector3& padding
  3055. - NavmeshPartitionType partitionType
  3056. - bool drawOffMeshConnections
  3057. - bool drawNavAreas
  3058. - bool initialized (readonly)
  3059. - BoundingBox& boundingBox (readonly)
  3060. - BoundingBox worldBoundingBox (readonly)
  3061. - IntVector2 numTiles (readonly)
  3062. <a name="Class_Network"></a>
  3063. ### Network
  3064. Methods:
  3065. - bool Connect(const String address, short port, Scene* scene)
  3066. - bool Connect(const String address, short port, Scene* scene, const VariantMap& identity)
  3067. - void Disconnect(int waitMSec = 0)
  3068. - bool StartServer(short port)
  3069. - void StopServer()
  3070. - void BroadcastMessage(int msgID, bool reliable, bool inOrder, const VectorBuffer& msg, unsigned contentID = 0)
  3071. - void BroadcastRemoteEvent(StringHash eventType, bool inOrder)
  3072. - void BroadcastRemoteEvent(StringHash eventType, bool inOrder, const VariantMap& eventData)
  3073. - void BroadcastRemoteEvent(const String eventType, bool inOrder)
  3074. - void BroadcastRemoteEvent(const String eventType, bool inOrder, const VariantMap& eventData)
  3075. - void BroadcastRemoteEvent(Scene* scene, StringHash eventType, bool inOrder)
  3076. - void BroadcastRemoteEvent(Scene* scene, StringHash eventType, bool inOrder, const VariantMap& eventData)
  3077. - void BroadcastRemoteEvent(Scene* scene, const String eventType, bool inOrder)
  3078. - void BroadcastRemoteEvent(Scene* scene, const String eventType, bool inOrder, const VariantMap& eventData)
  3079. - void BroadcastRemoteEvent(Node* node, StringHash eventType, bool inOrder)
  3080. - void BroadcastRemoteEvent(Node* node, StringHash eventType, bool inOrder, const VariantMap& eventData)
  3081. - void BroadcastRemoteEvent(Node* node, const String eventType, bool inOrder)
  3082. - void BroadcastRemoteEvent(Node* node, const String eventType, bool inOrder, const VariantMap& eventData)
  3083. - void SetUpdateFps(int fps)
  3084. - void SetSimulatedLatency(int ms)
  3085. - void SetSimulatedPacketLoss(float loss)
  3086. - void RegisterRemoteEvent(StringHash eventType)
  3087. - void RegisterRemoteEvent(const String eventType)
  3088. - void UnregisterRemoteEvent(StringHash eventType)
  3089. - void UnregisterRemoteEvent(const String eventType)
  3090. - void UnregisterAllRemoteEvents()
  3091. - void SetPackageCacheDir(const String path)
  3092. - void SendPackageToClients(Scene* scene, PackageFile* package)
  3093. - HttpRequest* MakeHttpRequest(const String url, const String verb = String::EMPTY)
  3094. - HttpRequest* MakeHttpRequest(const String url, const String verb, const Vector<String>& headers, const String postData = String::EMPTY)
  3095. - int GetUpdateFps() const
  3096. - int GetSimulatedLatency() const
  3097. - float GetSimulatedPacketLoss() const
  3098. - Connection* GetServerConnection() const
  3099. - bool IsServerRunning() const
  3100. - bool CheckRemoteEvent(StringHash eventType) const
  3101. - const String GetPackageCacheDir() const
  3102. Properties:
  3103. - int updateFps
  3104. - int simulatedLatency
  3105. - float simulatedPacketLoss
  3106. - Connection* serverConnection (readonly)
  3107. - bool serverRunning (readonly)
  3108. - String packageCacheDir
  3109. <a name="Class_NetworkPriority"></a>
  3110. ### NetworkPriority : Component
  3111. Methods:
  3112. - void SetBasePriority(float priority)
  3113. - void SetDistanceFactor(float factor)
  3114. - void SetMinPriority(float priority)
  3115. - void SetAlwaysUpdateOwner(bool enable)
  3116. - float GetBasePriority() const
  3117. - float GetDistanceFactor() const
  3118. - float GetMinPriority() const
  3119. - bool GetAlwaysUpdateOwner() const
  3120. - bool CheckUpdate(float distance, float accumulator)
  3121. Properties:
  3122. - float basePriority
  3123. - float distanceFactor
  3124. - float minPriority
  3125. - bool alwaysUpdateOwner
  3126. <a name="Class_Node"></a>
  3127. ### Node : Animatable
  3128. Methods:
  3129. - Node() (GC)
  3130. - Node* new()
  3131. - void delete()
  3132. - bool SaveXML(File* dest, const String indentation = "\t") const
  3133. - void SetName(const String name)
  3134. - void SetPosition(const Vector3& position)
  3135. - void SetPosition2D(const Vector2& position)
  3136. - void SetPosition2D(float x, float y)
  3137. - void SetRotation(const Quaternion& rotation)
  3138. - void SetRotation2D(float rotation)
  3139. - void SetDirection(const Vector3& direction)
  3140. - void SetScale(float scale)
  3141. - void SetScale(const Vector3& scale)
  3142. - void SetScale2D(const Vector2& scale)
  3143. - void SetScale2D(float x, float y)
  3144. - void SetTransform(const Vector3& position, const Quaternion& rotation)
  3145. - void SetTransform(const Vector3& position, const Quaternion& rotation, const Vector3& scale)
  3146. - void SetTransform(const Vector3& position, const Quaternion& rotation, float scale)
  3147. - void SetTransform2D(const Vector2& position, float rotation)
  3148. - void SetTransform2D(const Vector2& position, float rotation, const Vector2& scale)
  3149. - void SetTransform2D(const Vector2& position, float rotation, float scale)
  3150. - void SetWorldPosition(const Vector3& position)
  3151. - void SetWorldPosition2D(const Vector2& position)
  3152. - void SetWorldPosition2D(float x, float y)
  3153. - void SetWorldRotation(const Quaternion& rotation)
  3154. - void SetWorldRotation2D(float rotation)
  3155. - void SetWorldDirection(const Vector3& direction)
  3156. - void SetWorldScale(float scale)
  3157. - void SetWorldScale(const Vector3& scale)
  3158. - void SetWorldScale2D(const Vector2& scale)
  3159. - void SetWorldScale2D(float x, float y)
  3160. - void SetWorldTransform(const Vector3& position, const Quaternion& rotation)
  3161. - void SetWorldTransform(const Vector3& position, const Quaternion& rotation, const Vector3& scale)
  3162. - void SetWorldTransform(const Vector3& position, const Quaternion& rotation, float scale)
  3163. - void SetWorldTransform2D(const Vector2& position, float rotation)
  3164. - void SetWorldTransform2D(const Vector2& position, float rotation, const Vector2& scale)
  3165. - void SetWorldTransform2D(const Vector2& position, float rotation, float scale)
  3166. - void Translate(const Vector3& delta, TransformSpace space = TS_LOCAL)
  3167. - void Translate2D(const Vector2& delta, TransformSpace space = TS_LOCAL)
  3168. - void Rotate(const Quaternion& delta, TransformSpace space = TS_LOCAL)
  3169. - void Rotate2D(float delta, TransformSpace space = TS_LOCAL)
  3170. - void RotateAround(const Vector3& point, const Quaternion& delta, TransformSpace space = TS_LOCAL)
  3171. - void RotateAround2D(const Vector2& point, float delta, TransformSpace space = TS_LOCAL)
  3172. - void Pitch(float angle, TransformSpace space = TS_LOCAL)
  3173. - void Yaw(float angle, TransformSpace space = TS_LOCAL)
  3174. - void Roll(float angle, TransformSpace space = TS_LOCAL)
  3175. - bool LookAt(const Vector3& target)
  3176. - bool LookAt(const Vector3& target, const Vector3& upAxis, TransformSpace space = TS_WORLD)
  3177. - void Scale(float scale)
  3178. - void Scale(const Vector3& scale)
  3179. - void Scale2D(const Vector2& scale)
  3180. - void SetEnabled(bool enable)
  3181. - void SetDeepEnabled(bool enable)
  3182. - void ResetDeepEnabled()
  3183. - void SetEnabledRecursive(bool enable)
  3184. - void SetOwner(Connection* owner)
  3185. - void MarkDirty()
  3186. - Node* CreateChild(const String name = String::EMPTY, CreateMode mode = REPLICATED, unsigned id = 0)
  3187. - void AddChild(Node* node, unsigned index = M_MAX_UNSIGNED)
  3188. - void RemoveChild(Node* node)
  3189. - void RemoveAllChildren()
  3190. - void RemoveChildren(bool removeReplicated, bool removeLocal, bool recursive)
  3191. - void RemoveComponent(Component* component)
  3192. - void RemoveComponent(StringHash type)
  3193. - void RemoveComponent(const String type)
  3194. - void RemoveComponents(bool removeReplicated, bool removeLocal)
  3195. - void RemoveComponents(const String type)
  3196. - void RemoveAllComponents()
  3197. - Node* Clone(CreateMode mode = REPLICATED)
  3198. - void Remove()
  3199. - void SetParent(Node* parent)
  3200. - void SetVar(StringHash key, const Variant& value)
  3201. - void AddListener(Component* component)
  3202. - void RemoveListener(Component* component)
  3203. - Component* CreateComponent(const String type, CreateMode mode = REPLICATED, unsigned id = 0)
  3204. - Component* GetOrCreateComponent(const String type, CreateMode mode = REPLICATED, unsigned id = 0)
  3205. - Component* CloneComponent(Component* component, unsigned id = 0)
  3206. - Component* CloneComponent(Component* component, CreateMode mode, unsigned id = 0)
  3207. - int CreateScriptObject(const String scriptObjectType)
  3208. - int CreateScriptObject(const String fileName, const String scriptObjectType)
  3209. - int GetScriptObject() const
  3210. - int GetScriptObject(const String scriptObjectType) const
  3211. - unsigned GetID() const
  3212. - const String GetName() const
  3213. - StringHash GetNameHash() const
  3214. - Node* GetParent() const
  3215. - Scene* GetScene() const
  3216. - bool IsEnabled() const
  3217. - bool IsEnabledSelf() const
  3218. - Connection* GetOwner() const
  3219. - const Vector3& GetPosition() const
  3220. - Vector2 GetPosition2D() const
  3221. - const Quaternion& GetRotation() const
  3222. - float GetRotation2D() const
  3223. - Vector3 GetDirection() const
  3224. - Vector3 GetUp() const
  3225. - Vector3 GetRight() const
  3226. - const Vector3& GetScale() const
  3227. - Vector2 GetScale2D() const
  3228. - Matrix3x4 GetTransform() const
  3229. - Vector3 GetWorldPosition() const
  3230. - Vector2 GetWorldPosition2D() const
  3231. - Quaternion GetWorldRotation() const
  3232. - float GetWorldRotation2D() const
  3233. - Vector3 GetWorldDirection() const
  3234. - Vector3 GetWorldUp() const
  3235. - Vector3 GetWorldRight() const
  3236. - Vector3 GetWorldScale() const
  3237. - Vector2 GetWorldScale2D() const
  3238. - const Matrix3x4& GetWorldTransform() const
  3239. - Vector3 LocalToWorld(const Vector3& position) const
  3240. - Vector3 LocalToWorld(const Vector4& vector) const
  3241. - Vector2 LocalToWorld2D(const Vector2& vector) const
  3242. - Vector3 WorldToLocal(const Vector3& position) const
  3243. - Vector3 WorldToLocal(const Vector4& vector) const
  3244. - Vector2 WorldToLocal2D(const Vector2& vector) const
  3245. - bool IsDirty() const
  3246. - unsigned GetNumChildren(bool recursive = false) const
  3247. - Node* GetChild(const String name, bool recursive = false) const
  3248. - Node* GetChild(StringHash nameHash, bool recursive = false) const
  3249. - Node* GetChild(unsigned index) const
  3250. - unsigned GetNumComponents() const
  3251. - unsigned GetNumNetworkComponents() const
  3252. - bool HasComponent(StringHash type) const
  3253. - bool HasComponent(const String type) const
  3254. - const Variant& GetVar(StringHash key) const
  3255. - const VariantMap& GetVars() const
  3256. - Component* GetComponent(const String type, bool recursive = false) const
  3257. - Component* GetParentComponent(const String type, bool recursive = false) const
  3258. - const PODVector<Component*>& GetComponents(const String type, bool recursive = false)
  3259. - const PODVector<Node*>& GetChildren(bool recursive = false)
  3260. - const PODVector<Node*>& GetChildrenWithComponent(const String type, bool recursive = false)
  3261. - bool Load(Deserializer& source, SceneResolver& resolver, bool loadChildren = true, bool rewriteIDs = false, CreateMode mode = REPLICATED)
  3262. - bool LoadXML(const XMLElement& source, SceneResolver& resolver, bool loadChildren = true, bool rewriteIDs = false, CreateMode mode = REPLICATED)
  3263. - Node* CreateChild(unsigned id, CreateMode mode)
  3264. - void AddComponent(Component* component, unsigned id, CreateMode mode)
  3265. Properties:
  3266. - unsigned ID (readonly)
  3267. - String name
  3268. - StringHash nameHash (readonly)
  3269. - Node* parent
  3270. - Scene* scene (readonly)
  3271. - bool enabled
  3272. - bool enabledSelf (readonly)
  3273. - Connection* owner
  3274. - Vector3& position
  3275. - Vector2 position2D
  3276. - Quaternion& rotation
  3277. - float rotation2D
  3278. - Vector3 direction
  3279. - Vector3 up (readonly)
  3280. - Vector3 right (readonly)
  3281. - Vector3& scale
  3282. - Vector2 scale2D
  3283. - Matrix3x4 transform (readonly)
  3284. - Vector3 worldPosition
  3285. - Vector2 worldPosition2D
  3286. - Quaternion worldRotation
  3287. - float worldRotation2D
  3288. - Vector3 worldDirection
  3289. - Vector3 worldUp (readonly)
  3290. - Vector3 worldRight (readonly)
  3291. - Vector3 worldScale
  3292. - Vector2 worldScale2D
  3293. - Matrix3x4& worldTransform (readonly)
  3294. - bool dirty (readonly)
  3295. - unsigned numComponents (readonly)
  3296. - unsigned numNetworkComponents (readonly)
  3297. <a name="Class_Object"></a>
  3298. ### Object : RefCounted
  3299. Methods:
  3300. - StringHash GetType() const
  3301. - const String GetTypeName() const
  3302. - const String GetCategory() const
  3303. - void SendEvent(const String eventName, VariantMap* eventData = 0)
  3304. Properties:
  3305. - StringHash type (readonly)
  3306. - const String typeName (readonly)
  3307. - const String category (readonly)
  3308. <a name="Class_ObjectAnimation"></a>
  3309. ### ObjectAnimation : Resource
  3310. Methods:
  3311. - ObjectAnimation() (GC)
  3312. - ObjectAnimation* new()
  3313. - void delete()
  3314. - void AddAttributeAnimation(const String name, ValueAnimation* attributeAnimation, WrapMode wrapMode = WM_LOOP, float speed = 1.0f)
  3315. - void RemoveAttributeAnimation(const String name)
  3316. - void RemoveAttributeAnimation(ValueAnimation* attributeAnimation)
  3317. - ValueAnimation* GetAttributeAnimation(const String name) const
  3318. - WrapMode GetAttributeAnimationWrapMode(const String name) const
  3319. - float GetAttributeAnimationSpeed(const String name) const
  3320. <a name="Class_Obstacle"></a>
  3321. ### Obstacle : Component
  3322. Methods:
  3323. - void DrawDebugGeometry(bool depthTest)
  3324. - void SetRadius(float radius)
  3325. - void SetHeight(float height)
  3326. - float GetRadius() const
  3327. - float GetHeight() const
  3328. Properties:
  3329. - float radius
  3330. - float height
  3331. <a name="Class_Octree"></a>
  3332. ### Octree : Component
  3333. Methods:
  3334. - void SetSize(const BoundingBox& box, unsigned numLevels)
  3335. - void Update(const FrameInfo& frame)
  3336. - void AddManualDrawable(Drawable* drawable)
  3337. - void RemoveManualDrawable(Drawable* drawable)
  3338. - const PODVector<OctreeQueryResult>& GetDrawables(const Vector3& point, char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3339. - const PODVector<OctreeQueryResult>& GetDrawables(const BoundingBox& box, char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3340. - const PODVector<OctreeQueryResult>& GetDrawables(const Frustum& frustum, char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3341. - const PODVector<OctreeQueryResult>& GetDrawables(const Sphere& sphere, char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3342. - const PODVector<OctreeQueryResult>& GetAllDrawables(char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3343. - const PODVector<RayQueryResult>& Raycast(const Ray& ray, RayQueryLevel level, float maxDistance, char drawableFlags, unsigned viewMask = DEFAULT_VIEWMASK) const
  3344. - RayQueryResult RaycastSingle(const Ray& ray, RayQueryLevel level, float maxDistance, char drawableFlags, unsigned viewMask = DEFAULT_VIEWMASK) const
  3345. - unsigned GetNumLevels() const
  3346. - void QueueUpdate(Drawable* drawable)
  3347. - void DrawDebugGeometry(bool depthTest)
  3348. Properties:
  3349. - unsigned numLevels (readonly)
  3350. <a name="Class_OctreeQueryResult"></a>
  3351. ### OctreeQueryResult
  3352. Methods:
  3353. - OctreeQueryResult() (GC)
  3354. - OctreeQueryResult* new()
  3355. - void delete()
  3356. Properties:
  3357. - Drawable* drawable
  3358. - Node* node
  3359. <a name="Class_OffMeshConnection"></a>
  3360. ### OffMeshConnection : Component
  3361. Methods:
  3362. - void SetEndPoint(Node* node)
  3363. - void SetRadius(float radius)
  3364. - void SetBidirectional(bool enabled)
  3365. - void SetMask(unsigned newMask)
  3366. - void SetAreaID(unsigned newAreaID)
  3367. - Node* GetEndPoint() const
  3368. - float GetRadius() const
  3369. - bool IsBidirectional() const
  3370. - unsigned GetMask() const
  3371. - unsigned GetAreaID() const
  3372. Properties:
  3373. - Node* endPoint
  3374. - float radius
  3375. - bool bidirectional
  3376. - unsigned mask
  3377. - unsigned areaID
  3378. <a name="Class_PackageEntry"></a>
  3379. ### PackageEntry
  3380. Properties:
  3381. - unsigned offset
  3382. - unsigned size
  3383. - unsigned checksum
  3384. <a name="Class_PackageFile"></a>
  3385. ### PackageFile : Object
  3386. Methods:
  3387. - PackageFile() (GC)
  3388. - PackageFile* new()
  3389. - PackageFile(const String fileName, unsigned startOffset = 0) (GC)
  3390. - PackageFile* new(const String fileName, unsigned startOffset = 0)
  3391. - void delete()
  3392. - bool Open(const String fileName, unsigned startOffset = 0)
  3393. - bool Exists(const String fileName) const
  3394. - const PackageEntry* GetEntry(const String fileName) const
  3395. - const HashMap<String,PackageEntry>& GetEntries() const
  3396. - const String GetName() const
  3397. - StringHash GetNameHash() const
  3398. - unsigned GetNumFiles() const
  3399. - unsigned GetTotalSize() const
  3400. - unsigned GetChecksum() const
  3401. - bool IsCompressed() const
  3402. Properties:
  3403. - String name (readonly)
  3404. - StringHash nameHash (readonly)
  3405. - unsigned numFiles (readonly)
  3406. - unsigned totalSize (readonly)
  3407. - unsigned checksum (readonly)
  3408. - bool compressed (readonly)
  3409. <a name="Class_ParticleEffect"></a>
  3410. ### ParticleEffect : Resource
  3411. Methods:
  3412. - ParticleEffect() (GC)
  3413. - ParticleEffect* new()
  3414. - void delete()
  3415. - void SetMaterial(Material* material)
  3416. - void SetNumParticles(unsigned num)
  3417. - void SetUpdateInvisible(bool enable)
  3418. - void SetRelative(bool enable)
  3419. - void SetScaled(bool enable)
  3420. - void SetSorted(bool enable)
  3421. - void SetAnimationLodBias(float lodBias)
  3422. - void SetEmitterType(EmitterType type)
  3423. - void SetEmitterSize(const Vector3& size)
  3424. - void SetMinDirection(const Vector3& direction)
  3425. - void SetMaxDirection(const Vector3& direction)
  3426. - void SetConstantForce(const Vector3& force)
  3427. - void SetDampingForce(float force)
  3428. - void SetActiveTime(float time)
  3429. - void SetInactiveTime(float time)
  3430. - void SetMinEmissionRate(float rate)
  3431. - void SetMaxEmissionRate(float rate)
  3432. - void SetMinParticleSize(const Vector2& size)
  3433. - void SetMaxParticleSize(const Vector2& size)
  3434. - void SetMinTimeToLive(float time)
  3435. - void SetMaxTimeToLive(float time)
  3436. - void SetMinVelocity(float velocity)
  3437. - void SetMaxVelocity(float velocity)
  3438. - void SetMinRotation(float rotation)
  3439. - void SetMaxRotation(float rotation)
  3440. - void SetMinRotationSpeed(float speed)
  3441. - void SetMaxRotationSpeed(float speed)
  3442. - void SetSizeAdd(float sizeAdd)
  3443. - void SetSizeMul(float sizeMul)
  3444. - void AddColorTime(const Color& color, const float time)
  3445. - void AddColorFrame(const ColorFrame& colorFrame)
  3446. - void RemoveColorFrame(unsigned index)
  3447. - void SetColorFrame(unsigned index, const ColorFrame& colorFrame)
  3448. - void SetNumColorFrames(unsigned number)
  3449. - void SortColorFrames()
  3450. - void AddTextureTime(const Rect& uv, const float time)
  3451. - void AddTextureFrame(const TextureFrame& textureFrame)
  3452. - void RemoveTextureFrame(unsigned index)
  3453. - void SetTextureFrame(unsigned index, const TextureFrame& textureFrame)
  3454. - void SetNumTextureFrames(unsigned number)
  3455. - void SortTextureFrames()
  3456. - Material* GetMaterial() const
  3457. - unsigned GetNumParticles() const
  3458. - bool GetUpdateInvisible() const
  3459. - bool IsRelative() const
  3460. - bool IsScaled() const
  3461. - bool IsSorted() const
  3462. - float GetAnimationLodBias() const
  3463. - EmitterType GetEmitterType() const
  3464. - const Vector3& GetEmitterSize() const
  3465. - const Vector3& GetMinDirection() const
  3466. - const Vector3& GetMaxDirection() const
  3467. - const Vector3& GetConstantForce() const
  3468. - float GetDampingForce() const
  3469. - float GetActiveTime() const
  3470. - float GetInactiveTime() const
  3471. - float GetMinEmissionRate() const
  3472. - float GetMaxEmissionRate() const
  3473. - const Vector2& GetMinParticleSize() const
  3474. - const Vector2& GetMaxParticleSize() const
  3475. - float GetMinTimeToLive() const
  3476. - float GetMaxTimeToLive() const
  3477. - float GetMinVelocity() const
  3478. - float GetMaxVelocity() const
  3479. - float GetMinRotation() const
  3480. - float GetMaxRotation() const
  3481. - float GetMinRotationSpeed() const
  3482. - float GetMaxRotationSpeed() const
  3483. - float GetSizeAdd() const
  3484. - float GetSizeMul() const
  3485. - unsigned GetNumColorFrames() const
  3486. - const ColorFrame* GetColorFrame(unsigned index) const
  3487. - unsigned GetNumTextureFrames() const
  3488. - const TextureFrame* GetTextureFrame(unsigned index) const
  3489. Properties:
  3490. - Material* material
  3491. - unsigned numParticles
  3492. - bool updateInvisible
  3493. - bool relative
  3494. - bool scaled
  3495. - bool sorted
  3496. - float animationLodBias
  3497. - EmitterType emitterType
  3498. - const Vector3& emitterSize
  3499. - const Vector3& minDirection
  3500. - const Vector3& maxDirection
  3501. - const Vector3& constantForce
  3502. - float dampingForce
  3503. - float activeTime
  3504. - float inactiveTime
  3505. - float minEmissionRate
  3506. - float maxEmissionRate
  3507. - const Vector2& minParticleSize
  3508. - const Vector2& maxParticleSize
  3509. - float minTimeToLive
  3510. - float maxTimeToLive
  3511. - float minVelocity
  3512. - float maxVelocity
  3513. - float minRotation
  3514. - float maxRotation
  3515. - float minRotationSpeed
  3516. - float maxRotationSpeed
  3517. - float sizeAdd
  3518. - float sizeMul
  3519. - unsigned numColorFrames
  3520. - unsigned numTextureFrames
  3521. <a name="Class_ParticleEffect2D"></a>
  3522. ### ParticleEffect2D : Resource
  3523. <a name="Class_ParticleEmitter"></a>
  3524. ### ParticleEmitter : BillboardSet
  3525. Methods:
  3526. - void SetEffect(ParticleEffect* effect)
  3527. - void SetNumParticles(unsigned num)
  3528. - void SetEmitting(bool enable)
  3529. - void SetSerializeParticles(bool enable)
  3530. - void ResetEmissionTimer()
  3531. - void RemoveAllParticles()
  3532. - void Reset()
  3533. - void ApplyEffect()
  3534. - ParticleEffect* GetEffect() const
  3535. - unsigned GetNumParticles() const
  3536. - bool IsEmitting() const
  3537. - bool GetSerializeParticles() const
  3538. Properties:
  3539. - ParticleEffect* effect
  3540. - unsigned numParticles
  3541. - bool emitting
  3542. - bool serializeParticles
  3543. <a name="Class_ParticleEmitter2D"></a>
  3544. ### ParticleEmitter2D : Drawable2D
  3545. Methods:
  3546. - void SetEffect(ParticleEffect2D* effect)
  3547. - void SetSprite(Sprite2D* sprite)
  3548. - void SetBlendMode(BlendMode blendMode)
  3549. - ParticleEffect2D* GetEffect() const
  3550. - Sprite2D* GetSprite() const
  3551. - BlendMode GetBlendMode() const
  3552. Properties:
  3553. - ParticleEffect2D* effect
  3554. - Sprite2D* sprite
  3555. - BlendMode blendMode
  3556. <a name="Class_Pass"></a>
  3557. ### Pass : RefCounted
  3558. Methods:
  3559. - bool IsDesktop() const
  3560. - const String GetVertexShader() const
  3561. - const String GetPixelShader() const
  3562. Properties:
  3563. - bool desktop (readonly)
  3564. - const String vertexShader (readonly)
  3565. - const String pixelShader (readonly)
  3566. <a name="Class_PhysicsRaycastResult"></a>
  3567. ### PhysicsRaycastResult
  3568. Methods:
  3569. - PhysicsRaycastResult() (GC)
  3570. - PhysicsRaycastResult* new()
  3571. - void delete()
  3572. Properties:
  3573. - Vector3 position
  3574. - Vector3 normal
  3575. - float distance
  3576. - RigidBody* body
  3577. <a name="Class_PhysicsRaycastResult2D"></a>
  3578. ### PhysicsRaycastResult2D
  3579. Methods:
  3580. - PhysicsRaycastResult2D() (GC)
  3581. - PhysicsRaycastResult2D* new()
  3582. - void delete()
  3583. Properties:
  3584. - Vector2 position
  3585. - Vector2 normal
  3586. - float distance
  3587. - RigidBody2D* body
  3588. <a name="Class_PhysicsWorld"></a>
  3589. ### PhysicsWorld : Component
  3590. Methods:
  3591. - void Update(float timeStep)
  3592. - void UpdateCollisions()
  3593. - void SetFps(int fps)
  3594. - void SetGravity(const Vector3& gravity)
  3595. - void SetMaxSubSteps(int num)
  3596. - void SetNumIterations(int num)
  3597. - void SetInterpolation(bool enable)
  3598. - void SetInternalEdge(bool enable)
  3599. - void SetSplitImpulse(bool enable)
  3600. - void SetMaxNetworkAngularVelocity(float velocity)
  3601. - const PODVector<PhysicsRaycastResult>& Raycast(const Ray& ray, float maxDistance, unsigned collisionMask = M_MAX_UNSIGNED)
  3602. - PhysicsRaycastResult RaycastSingle(const Ray& ray, float maxDistance, unsigned collisionMask = M_MAX_UNSIGNED)
  3603. - PhysicsRaycastResult SphereCast(const Ray& ray, float radius, float maxDistance, unsigned collisionMask = M_MAX_UNSIGNED)
  3604. - PhysicsRaycastResult ConvexCast(CollisionShape* shape, const Vector3& startPos, const Quaternion& startRot, const Vector3& endPos, const Quaternion& endRot, unsigned collisionMask = M_MAX_UNSIGNED)
  3605. - const PODVector<RigidBody*>& GetRigidBodies(const Sphere& sphere, unsigned collisionMask = M_MAX_UNSIGNED)
  3606. - const PODVector<RigidBody*>& GetRigidBodies(const BoundingBox& box, unsigned collisionMask = M_MAX_UNSIGNED)
  3607. - const PODVector<RigidBody*>& GetRigidBodies(const RigidBody* body)
  3608. - void DrawDebugGeometry(bool depthTest)
  3609. - void RemoveCachedGeometry(Model* model)
  3610. - Vector3 GetGravity() const
  3611. - int GetMaxSubSteps() const
  3612. - int GetNumIterations() const
  3613. - bool GetInterpolation() const
  3614. - bool GetInternalEdge() const
  3615. - bool GetSplitImpulse() const
  3616. - int GetFps() const
  3617. - float GetMaxNetworkAngularVelocity() const
  3618. Properties:
  3619. - Vector3 gravity
  3620. - int maxSubSteps
  3621. - int numIterations
  3622. - bool interpolation
  3623. - bool internalEdge
  3624. - bool splitImpulse
  3625. - int fps
  3626. - float maxNetworkAngularVelocity
  3627. - bool applyingTransforms
  3628. <a name="Class_PhysicsWorld2D"></a>
  3629. ### PhysicsWorld2D : Component
  3630. Methods:
  3631. - void DrawDebugGeometry()
  3632. - void SetDrawShape(bool drawShape)
  3633. - void SetDrawJoint(bool drawJoint)
  3634. - void SetDrawAabb(bool drawAabb)
  3635. - void SetDrawPair(bool drawPair)
  3636. - void SetDrawCenterOfMass(bool drawCenterOfMass)
  3637. - void SetAllowSleeping(bool enable)
  3638. - void SetWarmStarting(bool enable)
  3639. - void SetContinuousPhysics(bool enable)
  3640. - void SetSubStepping(bool enable)
  3641. - void SetGravity(const Vector2& gravity)
  3642. - void SetAutoClearForces(bool enable)
  3643. - void SetVelocityIterations(int velocityIterations)
  3644. - void SetPositionIterations(int positionIterations)
  3645. - const PODVector<PhysicsRaycastResult2D>& Raycast(const Vector2& startPoint, const Vector2& endPoint, unsigned collisionMask = M_MAX_UNSIGNED)
  3646. - PhysicsRaycastResult2D RaycastSingle(const Vector2& startPoint, const Vector2& endPoint, unsigned collisionMask = M_MAX_UNSIGNED)
  3647. - RigidBody2D* GetRigidBody(const Vector2& point, unsigned collisionMask = M_MAX_UNSIGNED)
  3648. - RigidBody2D* GetRigidBody(int screenX, int screenY, unsigned collisionMask = M_MAX_UNSIGNED)
  3649. - const PODVector<RigidBody2D*>& GetRigidBodies(const Rect& aabb, unsigned collisionMask = M_MAX_UNSIGNED)
  3650. - bool GetDrawShape() const
  3651. - bool GetDrawJoint() const
  3652. - bool GetDrawAabb() const
  3653. - bool GetDrawPair() const
  3654. - bool GetDrawCenterOfMass() const
  3655. - bool GetAllowSleeping() const
  3656. - bool GetWarmStarting() const
  3657. - bool GetContinuousPhysics() const
  3658. - bool GetSubStepping() const
  3659. - bool GetAutoClearForces() const
  3660. - const Vector2& GetGravity() const
  3661. - int GetVelocityIterations() const
  3662. - int GetPositionIterations() const
  3663. Properties:
  3664. - bool drawShape
  3665. - bool drawJoint
  3666. - bool drawAabb
  3667. - bool drawPair
  3668. - bool drawCenterOfMass
  3669. - bool allowSleeping
  3670. - bool warmStarting
  3671. - bool continuousPhysics
  3672. - bool subStepping
  3673. - bool autoClearForces
  3674. - Vector2& gravity
  3675. - int velocityIterations
  3676. - int positionIterations
  3677. <a name="Class_Plane"></a>
  3678. ### Plane
  3679. Methods:
  3680. - Plane() (GC)
  3681. - Plane* new()
  3682. - Plane(const Plane& plane) (GC)
  3683. - Plane* new(const Plane& plane)
  3684. - Plane(const Vector3& v0, const Vector3& v1, const Vector3& v2) (GC)
  3685. - Plane* new(const Vector3& v0, const Vector3& v1, const Vector3& v2)
  3686. - Plane(const Vector3& normal, const Vector3& point) (GC)
  3687. - Plane* new(const Vector3& normal, const Vector3& point)
  3688. - Plane(const Vector4& plane) (GC)
  3689. - Plane* new(const Vector4& plane)
  3690. - void delete()
  3691. - void Define(const Vector3& v0, const Vector3& v1, const Vector3& v2)
  3692. - void Define(const Vector3& normal, const Vector3& point)
  3693. - void Define(const Vector4& plane)
  3694. - void Transform(const Matrix3& transform)
  3695. - void Transform(const Matrix3x4& transform)
  3696. - void Transform(const Matrix4& transform)
  3697. - Vector3 Project(const Vector3& point) const
  3698. - float Distance(const Vector3& point) const
  3699. - Vector3 Reflect(const Vector3& direction) const
  3700. - Matrix3x4 ReflectionMatrix() const
  3701. - Plane Transformed(const Matrix3& transform) const
  3702. - Plane Transformed(const Matrix3x4& transform) const
  3703. - Plane Transformed(const Matrix4& transform) const
  3704. - Vector4 ToVector4() const
  3705. Properties:
  3706. - Vector3 normal
  3707. - Vector3 absNormal
  3708. - float d
  3709. - const Plane UP
  3710. <a name="Class_Polyhedron"></a>
  3711. ### Polyhedron
  3712. Methods:
  3713. - Polyhedron() (GC)
  3714. - Polyhedron* new()
  3715. - Polyhedron(const Polyhedron& polyhedron) (GC)
  3716. - Polyhedron* new(const Polyhedron& polyhedron)
  3717. - Polyhedron(const BoundingBox& box) (GC)
  3718. - Polyhedron* new(const BoundingBox& box)
  3719. - Polyhedron(const Frustum& frustum) (GC)
  3720. - Polyhedron* new(const Frustum& frustum)
  3721. - void delete()
  3722. - void Define(const BoundingBox& box)
  3723. - void Define(const Frustum& frustum)
  3724. - void AddFace(const Vector3& v0, const Vector3& v1, const Vector3& v2)
  3725. - void AddFace(const Vector3& v0, const Vector3& v1, const Vector3& v2, const Vector3& v3)
  3726. - void Clip(const Plane& plane)
  3727. - void Clip(const BoundingBox& box)
  3728. - void Clip(const Frustum& box)
  3729. - void Clear()
  3730. - void Transform(const Matrix3& transform)
  3731. - void Transform(const Matrix3x4& transform)
  3732. - Polyhedron Transformed(const Matrix3& transform) const
  3733. - Polyhedron Transformed(const Matrix3x4& transform) const
  3734. - bool Empty() const
  3735. Properties:
  3736. - bool empty (readonly)
  3737. <a name="Class_PropertySet2D"></a>
  3738. ### PropertySet2D
  3739. Methods:
  3740. - bool HasProperty(const String name) const
  3741. - const String GetProperty(const String name) const
  3742. <a name="Class_Quaternion"></a>
  3743. ### Quaternion
  3744. Methods:
  3745. - Quaternion() (GC)
  3746. - Quaternion* new()
  3747. - Quaternion(const Quaternion& quat) (GC)
  3748. - Quaternion* new(const Quaternion& quat)
  3749. - Quaternion(float w, float x, float y, float z) (GC)
  3750. - Quaternion* new(float w, float x, float y, float z)
  3751. - Quaternion(float angle, const Vector3& axis) (GC)
  3752. - Quaternion* new(float angle, const Vector3& axis)
  3753. - Quaternion(float angle) (GC)
  3754. - Quaternion* new(float angle)
  3755. - Quaternion(float x, float y, float z) (GC)
  3756. - Quaternion* new(float x, float y, float z)
  3757. - Quaternion(const Vector3& start, const Vector3& end) (GC)
  3758. - Quaternion* new(const Vector3& start, const Vector3& end)
  3759. - Quaternion(const Vector3& xAxis, const Vector3& yAxis, const Vector3& zAxis) (GC)
  3760. - Quaternion* new(const Vector3& xAxis, const Vector3& yAxis, const Vector3& zAxis)
  3761. - Quaternion(const Matrix3& matrix) (GC)
  3762. - Quaternion* new(const Matrix3& matrix)
  3763. - void delete()
  3764. - bool operator==(const Quaternion& rhs) const
  3765. - Quaternion operator*(float rhs) const
  3766. - Quaternion operator-() const
  3767. - bool operator==(const Quaternion& rhs) const
  3768. - Quaternion operator*(float rhs) const
  3769. - Quaternion operator-() const
  3770. - Quaternion operator+(const Quaternion& rhs) const
  3771. - Quaternion operator-(const Quaternion& rhs) const
  3772. - Quaternion operator*(const Quaternion& rhs) const
  3773. - Vector3 operator*(const Vector3& rhs) const
  3774. - void FromAngleAxis(float angle, const Vector3& axis)
  3775. - void FromEulerAngles(float x, float y, float z)
  3776. - void FromRotationTo(const Vector3& start, const Vector3& end)
  3777. - void FromAxes(const Vector3& xAxis, const Vector3& yAxis, const Vector3& zAxis)
  3778. - void FromRotationMatrix(const Matrix3& matrix)
  3779. - bool FromLookRotation(const Vector3& direction, const Vector3& up)
  3780. - void Normalize()
  3781. - Quaternion Normalized() const
  3782. - Quaternion Inverse() const
  3783. - float LengthSquared() const
  3784. - float DotProduct(const Quaternion& rhs) const
  3785. - bool Equals(const Quaternion& rhs) const
  3786. - bool IsNaN() const
  3787. - Quaternion Conjugate() const
  3788. - Vector3 EulerAngles() const
  3789. - float YawAngle() const
  3790. - float PitchAngle() const
  3791. - float RollAngle() const
  3792. - Matrix3 RotationMatrix() const
  3793. - Quaternion Slerp(Quaternion rhs, float t) const
  3794. - Quaternion Nlerp(Quaternion rhs, float t, bool shortestPath) const
  3795. - String ToString() const
  3796. Properties:
  3797. - float w
  3798. - float x
  3799. - float y
  3800. - float z
  3801. - const Quaternion IDENTITY
  3802. <a name="Class_Ray"></a>
  3803. ### Ray
  3804. Methods:
  3805. - Ray() (GC)
  3806. - Ray* new()
  3807. - Ray(const Vector3& origin, const Vector3& direction) (GC)
  3808. - Ray* new(const Vector3& origin, const Vector3& direction)
  3809. - Ray(const Ray& ray) (GC)
  3810. - Ray* new(const Ray& ray)
  3811. - void delete()
  3812. - bool operator==(const Ray& rhs) const
  3813. - void Define(const Vector3& origin, const Vector3& direction)
  3814. - Vector3 Project(const Vector3& point) const
  3815. - float Distance(const Vector3& point) const
  3816. - Vector3 ClosestPoint(const Ray& ray) const
  3817. - float HitDistance(const Plane& plane) const
  3818. - float HitDistance(const BoundingBox& box) const
  3819. - float HitDistance(const Frustum& frustum, bool solidInside = true) const
  3820. - float HitDistance(const Sphere& sphere) const
  3821. - float HitDistance(const Vector3& v0, const Vector3& v1, const Vector3& v2) const
  3822. - Ray Transformed(const Matrix3x4& transform) const
  3823. Properties:
  3824. - Vector3 origin
  3825. - Vector3 direction
  3826. <a name="Class_RayQueryResult"></a>
  3827. ### RayQueryResult
  3828. Methods:
  3829. - RayQueryResult() (GC)
  3830. - RayQueryResult* new()
  3831. - void delete()
  3832. Properties:
  3833. - Vector3 position
  3834. - Vector3 normal
  3835. - Vector2 textureUV
  3836. - float distance
  3837. - Drawable* drawable
  3838. - Node* node
  3839. - unsigned subObject
  3840. <a name="Class_Rect"></a>
  3841. ### Rect
  3842. Methods:
  3843. - Rect() (GC)
  3844. - Rect* new()
  3845. - Rect(const Rect& rect) (GC)
  3846. - Rect* new(const Rect& rect)
  3847. - Rect(const Vector2& min, const Vector2& max) (GC)
  3848. - Rect* new(const Vector2& min, const Vector2& max)
  3849. - Rect(float left, float top, float right, float bottom) (GC)
  3850. - Rect* new(float left, float top, float right, float bottom)
  3851. - Rect(const Vector4& vector) (GC)
  3852. - Rect* new(const Vector4& vector)
  3853. - void delete()
  3854. - bool operator==(const Rect& rhs) const
  3855. - void Define(const Rect& rect)
  3856. - void Define(const Vector2& min, const Vector2& max)
  3857. - void Define(const Vector2& point)
  3858. - void Merge(const Vector2& point)
  3859. - void Merge(const Rect& rect)
  3860. - void Clear()
  3861. - void Clip(const Rect& rect)
  3862. - Vector2 Center() const
  3863. - Vector2 Size() const
  3864. - Vector2 HalfSize() const
  3865. - bool Equals(const Rect& rhs) const
  3866. - Intersection IsInside(const Vector2& point) const
  3867. - Vector4 ToVector4() const
  3868. - String ToString() const
  3869. Properties:
  3870. - Vector2 min
  3871. - Vector2 max
  3872. - const Rect FULL
  3873. - const Rect POSITIVE
  3874. - const Rect ZERO
  3875. - Vector2 center (readonly)
  3876. - Vector2 size (readonly)
  3877. - Vector2 halfSize (readonly)
  3878. <a name="Class_RemoteEvent"></a>
  3879. ### RemoteEvent
  3880. Properties:
  3881. - unsigned senderID
  3882. - StringHash eventType
  3883. - VariantMap eventData
  3884. - bool inOrder
  3885. <a name="Class_RenderPath"></a>
  3886. ### RenderPath
  3887. Methods:
  3888. - RenderPath* Clone()
  3889. - bool Load(XMLFile* file)
  3890. - bool Append(XMLFile* file)
  3891. - void SetEnabled(const String tag, bool active)
  3892. - void ToggleEnabled(const String tag)
  3893. - void SetRenderTarget(unsigned index, const RenderTargetInfo& info)
  3894. - void AddRenderTarget(const RenderTargetInfo& info)
  3895. - void RemoveRenderTarget(const String name)
  3896. - void RemoveRenderTarget(unsigned index)
  3897. - void RemoveRenderTargets(const String tag)
  3898. - void SetCommand(unsigned index, const RenderPathCommand& command)
  3899. - void AddCommand(const RenderPathCommand& command)
  3900. - void InsertCommand(unsigned index, const RenderPathCommand& command)
  3901. - void RemoveCommand(unsigned index)
  3902. - void RemoveCommands(const String tag)
  3903. - void SetShaderParameter(const String name, const Variant& value)
  3904. - unsigned GetNumRenderTargets() const
  3905. - unsigned GetNumCommands() const
  3906. - RenderPathCommand* GetCommand(unsigned index)
  3907. - const Variant& GetShaderParameter(const String name) const
  3908. <a name="Class_RenderPathCommand"></a>
  3909. ### RenderPathCommand
  3910. Methods:
  3911. - RenderPathCommand() (GC)
  3912. - RenderPathCommand* new()
  3913. - void Load(const XMLElement& element)
  3914. - void SetTextureName(TextureUnit unit, const String name)
  3915. - void SetShaderParameter(const String name, const Variant& value)
  3916. - void RemoveShaderParameter(const String name)
  3917. - void SetNumOutputs(unsigned num)
  3918. - void SetOutput(unsigned index, const String name, CubeMapFace face)
  3919. - void SetOutputName(unsigned index, const String name)
  3920. - void SetOutputFace(unsigned index, CubeMapFace face)
  3921. - void SetDepthStencilName(const String name)
  3922. - const String GetTextureName(TextureUnit unit) const
  3923. - const Variant& GetShaderParameter(const String name) const
  3924. - unsigned GetNumOutputs() const
  3925. - const String GetOutputName(unsigned index) const
  3926. - CubeMapFace GetOutputFace(unsigned index) const
  3927. - const String GetDepthStencilName() const
  3928. Properties:
  3929. - String tag
  3930. - RenderCommandType type
  3931. - RenderCommandSortMode sortMode
  3932. - String pass
  3933. - String metadata
  3934. - String vertexShaderName
  3935. - String pixelShaderName
  3936. - String vertexShaderDefines
  3937. - String pixelShaderDefines
  3938. - unsigned clearFlags
  3939. - Color clearColor
  3940. - float clearDepth
  3941. - unsigned clearStencil
  3942. - BlendMode blendMode
  3943. - bool enabled
  3944. - bool useFogColor
  3945. - bool markToStencil
  3946. - bool useLitBase
  3947. - bool vertexLights
  3948. <a name="Class_RenderSurface"></a>
  3949. ### RenderSurface
  3950. Methods:
  3951. - RenderSurface(Texture* parentTexture) (GC)
  3952. - RenderSurface* new(Texture* parentTexture)
  3953. - void delete()
  3954. - void SetNumViewports(unsigned num)
  3955. - void SetViewport(unsigned index, Viewport* viewport)
  3956. - void SetUpdateMode(RenderSurfaceUpdateMode mode)
  3957. - void SetLinkedRenderTarget(RenderSurface* renderTarget)
  3958. - void SetLinkedDepthStencil(RenderSurface* depthStencil)
  3959. - void QueueUpdate()
  3960. - void Release()
  3961. - Texture* GetParentTexture() const
  3962. - int GetWidth() const
  3963. - int GetHeight() const
  3964. - TextureUsage GetUsage() const
  3965. - unsigned GetNumViewports() const
  3966. - Viewport* GetViewport(unsigned index) const
  3967. - RenderSurfaceUpdateMode GetUpdateMode() const
  3968. - RenderSurface* GetLinkedRenderTarget() const
  3969. - RenderSurface* GetLinkedDepthStencil() const
  3970. Properties:
  3971. - Texture* parentTexture (readonly)
  3972. - int width (readonly)
  3973. - int height (readonly)
  3974. - TextureUsage usage (readonly)
  3975. - unsigned numViewports
  3976. - RenderSurfaceUpdateMode updateMode
  3977. - RenderSurface* linkedRenderTarget
  3978. - RenderSurface* linkedDepthStencil
  3979. <a name="Class_RenderTargetInfo"></a>
  3980. ### RenderTargetInfo
  3981. Methods:
  3982. - RenderTargetInfo() (GC)
  3983. - RenderTargetInfo* new()
  3984. - void Load(const XMLElement& element)
  3985. Properties:
  3986. - String name
  3987. - String tag
  3988. - unsigned format
  3989. - Vector2 size
  3990. - RenderTargetSizeMode sizeMode
  3991. - bool enabled
  3992. - bool cubemap
  3993. - bool filtered
  3994. - bool sRGB
  3995. - bool persistent
  3996. <a name="Class_Renderer"></a>
  3997. ### Renderer
  3998. Methods:
  3999. - void SetNumViewports(unsigned num)
  4000. - void SetViewport(unsigned index, Viewport* viewport)
  4001. - void SetDefaultRenderPath(RenderPath* renderPath)
  4002. - void SetDefaultRenderPath(XMLFile* file)
  4003. - void SetHDRRendering(bool enable)
  4004. - void SetSpecularLighting(bool enable)
  4005. - void SetTextureAnisotropy(int level)
  4006. - void SetTextureFilterMode(TextureFilterMode mode)
  4007. - void SetTextureQuality(int quality)
  4008. - void SetMaterialQuality(int quality)
  4009. - void SetDrawShadows(bool enable)
  4010. - void SetShadowMapSize(int size)
  4011. - void SetShadowQuality(int quality)
  4012. - void SetReuseShadowMaps(bool enable)
  4013. - void SetMaxShadowMaps(int shadowMaps)
  4014. - void SetDynamicInstancing(bool enable)
  4015. - void SetMinInstances(int instances)
  4016. - void SetMaxSortedInstances(int instances)
  4017. - void SetMaxOccluderTriangles(int triangles)
  4018. - void SetOcclusionBufferSize(int size)
  4019. - void SetOccluderSizeThreshold(float screenSize)
  4020. - void SetMobileShadowBiasMul(float mul)
  4021. - void SetMobileShadowBiasAdd(float add)
  4022. - void ReloadShaders()
  4023. - unsigned GetNumViewports() const
  4024. - Viewport* GetViewport(unsigned index) const
  4025. - RenderPath* GetDefaultRenderPath() const
  4026. - bool GetHDRRendering() const
  4027. - bool GetSpecularLighting() const
  4028. - bool GetDrawShadows() const
  4029. - int GetTextureAnisotropy() const
  4030. - TextureFilterMode GetTextureFilterMode() const
  4031. - int GetTextureQuality() const
  4032. - int GetMaterialQuality() const
  4033. - int GetShadowMapSize() const
  4034. - int GetShadowQuality() const
  4035. - bool GetReuseShadowMaps() const
  4036. - int GetMaxShadowMaps() const
  4037. - bool GetDynamicInstancing() const
  4038. - int GetMinInstances() const
  4039. - int GetMaxSortedInstances() const
  4040. - int GetMaxOccluderTriangles() const
  4041. - int GetOcclusionBufferSize() const
  4042. - float GetOccluderSizeThreshold() const
  4043. - float GetMobileShadowBiasMul() const
  4044. - float GetMobileShadowBiasAdd() const
  4045. - unsigned GetNumViews() const
  4046. - unsigned GetNumPrimitives() const
  4047. - unsigned GetNumBatches() const
  4048. - unsigned GetNumGeometries(bool allViews = false) const
  4049. - unsigned GetNumLights(bool allViews = false) const
  4050. - unsigned GetNumShadowMaps(bool allViews = false) const
  4051. - unsigned GetNumOccluders(bool allViews = false) const
  4052. - Zone* GetDefaultZone() const
  4053. - Material* GetDefaultMaterial() const
  4054. - Texture2D* GetDefaultLightRamp() const
  4055. - Texture2D* GetDefaultLightSpot() const
  4056. - void DrawDebugGeometry(bool depthTest)
  4057. Properties:
  4058. - unsigned numViewports
  4059. - RenderPath* defaultRenderPath
  4060. - bool HDRRendering
  4061. - bool specularLighting
  4062. - bool drawShadows
  4063. - int textureAnisotropy
  4064. - TextureFilterMode textureFilterMode
  4065. - int textureQuality
  4066. - int materialQuality
  4067. - int shadowMapSize
  4068. - int shadowQuality
  4069. - bool reuseShadowMaps
  4070. - int maxShadowMaps
  4071. - bool dynamicInstancing
  4072. - int minInstances
  4073. - int maxSortedInstances
  4074. - int maxOccluderTriangles
  4075. - int occlusionBufferSize
  4076. - float occluderSizeThreshold
  4077. - float mobileShadowBiasMul
  4078. - float mobileShadowBiasAdd
  4079. - unsigned numViews (readonly)
  4080. - unsigned numPrimitives (readonly)
  4081. - unsigned numBatches (readonly)
  4082. - Zone* defaultZone (readonly)
  4083. - Material* defaultMaterial (readonly)
  4084. - Texture2D* defaultLightRamp (readonly)
  4085. - Texture2D* defaultLightSpot (readonly)
  4086. <a name="Class_Resource"></a>
  4087. ### Resource
  4088. Methods:
  4089. - bool Load(Deserializer& source)
  4090. - bool Save(Serializer& dest) const
  4091. - bool Load(const String fileName)
  4092. - bool Save(const String fileName) const
  4093. - const String GetName() const
  4094. - StringHash GetNameHash() const
  4095. - unsigned GetMemoryUse() const
  4096. Properties:
  4097. - String name (readonly)
  4098. - StringHash nameHash (readonly)
  4099. - unsigned memoryUse (readonly)
  4100. <a name="Class_ResourceCache"></a>
  4101. ### ResourceCache
  4102. Methods:
  4103. - void ReleaseAllResources(bool force = false)
  4104. - bool ReloadResource(Resource* resource)
  4105. - void ReloadResourceWithDependencies(const String fileName)
  4106. - void SetMemoryBudget(StringHash type, unsigned budget)
  4107. - void SetMemoryBudget(const String type, unsigned budget)
  4108. - void SetAutoReloadResources(bool enable)
  4109. - void SetReturnFailedResources(bool enable)
  4110. - void SetSearchPackagesFirst(bool value)
  4111. - void SetFinishBackgroundResourcesMs(int ms)
  4112. - File* GetFile(const String name)
  4113. - Resource* GetResource(const String type, const String name, bool sendEventOnFailure = true)
  4114. - Resource* GetExistingResource(const String type, const String name)
  4115. - bool BackgroundLoadResource(const String type, const String name, bool sendEventOnFailure = true)
  4116. - unsigned GetNumBackgroundLoadResources() const
  4117. - const Vector<String>& GetResourceDirs() const
  4118. - bool Exists(const String name) const
  4119. - unsigned GetMemoryBudget(StringHash type) const
  4120. - unsigned GetMemoryUse(StringHash type) const
  4121. - unsigned GetTotalMemoryUse() const
  4122. - String GetResourceFileName(const String name) const
  4123. - bool GetAutoReloadResources() const
  4124. - bool GetReturnFailedResources() const
  4125. - bool GetSearchPackagesFirst() const
  4126. - int GetFinishBackgroundResourcesMs() const
  4127. - String GetPreferredResourceDir(const String path) const
  4128. - String SanitateResourceName(const String name) const
  4129. - String SanitateResourceDirName(const String name) const
  4130. Properties:
  4131. - unsigned totalMemoryUse (readonly)
  4132. - bool autoReloadResources
  4133. - bool returnFailedResources
  4134. - bool searchPackagesFirst
  4135. - unsigned numBackgroundLoadResources (readonly)
  4136. - Vector<String>& resourceDirs (readonly)
  4137. - int finishBackgroundResourcesMs
  4138. <a name="Class_ResourceRef"></a>
  4139. ### ResourceRef
  4140. Methods:
  4141. - ResourceRef() (GC)
  4142. - ResourceRef* new()
  4143. - ResourceRef(StringHash type) (GC)
  4144. - ResourceRef* new(StringHash type)
  4145. - ResourceRef(StringHash type, String name) (GC)
  4146. - ResourceRef* new(StringHash type, String name)
  4147. - ResourceRef(const ResourceRef& rhs) (GC)
  4148. - ResourceRef* new(const ResourceRef& rhs)
  4149. - void delete()
  4150. - bool operator==(const ResourceRef& rhs) const
  4151. Properties:
  4152. - StringHash type
  4153. - String name
  4154. <a name="Class_ResourceRefList"></a>
  4155. ### ResourceRefList
  4156. Methods:
  4157. - ResourceRefList() (GC)
  4158. - ResourceRefList* new()
  4159. - ResourceRefList(StringHash type) (GC)
  4160. - ResourceRefList* new(StringHash type)
  4161. - void delete()
  4162. - bool operator==(const ResourceRefList& rhs) const
  4163. Properties:
  4164. - StringHash type
  4165. <a name="Class_RigidBody"></a>
  4166. ### RigidBody : Component
  4167. Methods:
  4168. - void SetMass(float mass)
  4169. - void SetPosition(const Vector3& position)
  4170. - void SetRotation(const Quaternion& rotation)
  4171. - void SetTransform(const Vector3& position, const Quaternion& rotation)
  4172. - void SetLinearVelocity(const Vector3& velocity)
  4173. - void SetLinearFactor(const Vector3& factor)
  4174. - void SetLinearRestThreshold(float threshold)
  4175. - void SetLinearDamping(float damping)
  4176. - void SetAngularVelocity(const Vector3& angularVelocity)
  4177. - void SetAngularFactor(const Vector3& factor)
  4178. - void SetAngularRestThreshold(float threshold)
  4179. - void SetAngularDamping(float factor)
  4180. - void SetFriction(float friction)
  4181. - void SetAnisotropicFriction(const Vector3& friction)
  4182. - void SetRollingFriction(float friction)
  4183. - void SetRestitution(float restitution)
  4184. - void SetContactProcessingThreshold(float threshold)
  4185. - void SetCcdRadius(float radius)
  4186. - void SetCcdMotionThreshold(float threshold)
  4187. - void SetUseGravity(bool enable)
  4188. - void SetGravityOverride(const Vector3& gravity)
  4189. - void SetKinematic(bool enable)
  4190. - void SetTrigger(bool enable)
  4191. - void SetCollisionLayer(unsigned layer)
  4192. - void SetCollisionMask(unsigned mask)
  4193. - void SetCollisionLayerAndMask(unsigned layer, unsigned mask)
  4194. - void SetCollisionEventMode(CollisionEventMode mode)
  4195. - void DisableMassUpdate()
  4196. - void EnableMassUpdate()
  4197. - void ApplyForce(const Vector3& force)
  4198. - void ApplyForce(const Vector3& force, const Vector3& position)
  4199. - void ApplyTorque(const Vector3& torque)
  4200. - void ApplyImpulse(const Vector3& impulse)
  4201. - void ApplyImpulse(const Vector3& impulse, const Vector3& position)
  4202. - void ApplyTorqueImpulse(const Vector3& torque)
  4203. - void ResetForces()
  4204. - void Activate()
  4205. - void ReAddBodyToWorld()
  4206. - PhysicsWorld* GetPhysicsWorld() const
  4207. - float GetMass() const
  4208. - Vector3 GetPosition() const
  4209. - Quaternion GetRotation() const
  4210. - Vector3 GetLinearVelocity() const
  4211. - Vector3 GetLinearFactor() const
  4212. - Vector3 GetVelocityAtPoint(const Vector3& position) const
  4213. - float GetLinearRestThreshold() const
  4214. - float GetLinearDamping() const
  4215. - Vector3 GetAngularVelocity() const
  4216. - Vector3 GetAngularFactor() const
  4217. - float GetAngularRestThreshold() const
  4218. - float GetAngularDamping() const
  4219. - float GetFriction() const
  4220. - Vector3 GetAnisotropicFriction() const
  4221. - float GetRollingFriction() const
  4222. - float GetRestitution() const
  4223. - float GetContactProcessingThreshold() const
  4224. - float GetCcdRadius() const
  4225. - float GetCcdMotionThreshold() const
  4226. - bool GetUseGravity() const
  4227. - const Vector3& GetGravityOverride() const
  4228. - const Vector3& GetCenterOfMass() const
  4229. - bool IsKinematic() const
  4230. - bool IsTrigger() const
  4231. - bool IsActive() const
  4232. - unsigned GetCollisionLayer() const
  4233. - unsigned GetCollisionMask() const
  4234. - CollisionEventMode GetCollisionEventMode() const
  4235. Properties:
  4236. - PhysicsWorld* physicsWorld (readonly)
  4237. - float mass
  4238. - Vector3 position
  4239. - Quaternion rotation
  4240. - Vector3 linearVelocity
  4241. - Vector3 linearFactor
  4242. - float linearRestThreshold
  4243. - float linearDamping
  4244. - Vector3 angularVelocity
  4245. - Vector3 angularFactor
  4246. - float angularRestThreshold
  4247. - float angularDamping
  4248. - float friction
  4249. - Vector3 anisotropicFriction
  4250. - float rollingFriction
  4251. - float restitution
  4252. - float contactProcessingThreshold
  4253. - float ccdRadius
  4254. - float ccdMotionThreshold
  4255. - bool useGravity
  4256. - Vector3& gravityOverride
  4257. - Vector3& centerOfMass (readonly)
  4258. - bool kinematic
  4259. - bool trigger
  4260. - bool active (readonly)
  4261. - unsigned collisionLayer
  4262. - unsigned collisionMask
  4263. - CollisionEventMode collisionEventMode
  4264. <a name="Class_RigidBody2D"></a>
  4265. ### RigidBody2D : Component
  4266. Methods:
  4267. - void SetBodyType(BodyType2D bodyType)
  4268. - void SetMass(float mass)
  4269. - void SetInertia(float inertia)
  4270. - void SetMassCenter(const Vector2& center)
  4271. - void SetUseFixtureMass(bool useFixtureMass)
  4272. - void SetLinearDamping(float linearDamping)
  4273. - void SetAngularDamping(float angularDamping)
  4274. - void SetAllowSleep(bool allowSleep)
  4275. - void SetFixedRotation(bool fixedRotation)
  4276. - void SetBullet(bool bullet)
  4277. - void SetGravityScale(float gravityScale)
  4278. - void SetAwake(bool awake)
  4279. - void SetLinearVelocity(const Vector2& linearVelocity)
  4280. - void SetAngularVelocity(float angularVelocity)
  4281. - void ApplyForce(const Vector2& force, const Vector2& point, bool wake)
  4282. - void ApplyForceToCenter(const Vector2& force, bool wake)
  4283. - void ApplyTorque(float torque, bool wake)
  4284. - void ApplyLinearImpulse(const Vector2& impulse, const Vector2& point, bool wake)
  4285. - void ApplyAngularImpulse(float impulse, bool wake)
  4286. - BodyType2D GetBodyType() const
  4287. - float GetMass() const
  4288. - float GetInertia() const
  4289. - Vector2 GetMassCenter() const
  4290. - bool GetUseFixtureMass() const
  4291. - float GetLinearDamping() const
  4292. - float GetAngularDamping() const
  4293. - bool IsAllowSleep() const
  4294. - bool IsFixedRotation() const
  4295. - bool IsBullet() const
  4296. - float GetGravityScale() const
  4297. - bool IsAwake() const
  4298. - Vector2 GetLinearVelocity() const
  4299. - float GetAngularVelocity() const
  4300. Properties:
  4301. - BodyType2D bodyType
  4302. - float mass
  4303. - float inertia
  4304. - Vector2 massCenter
  4305. - bool useFixtureMass
  4306. - float linearDamping
  4307. - float angularDamping
  4308. - bool allowSleep
  4309. - bool fixedRotation
  4310. - bool bullet
  4311. - float gravityScale
  4312. - bool awake
  4313. - Vector2 linearVelocity
  4314. - float angularVelocity
  4315. <a name="Class_Scene"></a>
  4316. ### Scene : Node
  4317. Methods:
  4318. - Scene() (GC)
  4319. - Scene* new()
  4320. - void delete()
  4321. - bool Load(File* source)
  4322. - bool Save(File* dest) const
  4323. - bool Load(const String fileName)
  4324. - bool Save(const String fileName) const
  4325. - bool LoadXML(File* source)
  4326. - bool SaveXML(File* dest, const String indentation = "\t") const
  4327. - bool LoadXML(const String fileName)
  4328. - bool SaveXML(const String fileName, const String indentation = "\t") const
  4329. - Node* Instantiate(File* source, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
  4330. - Node* Instantiate(const String fileName, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
  4331. - Node* InstantiateXML(File* source, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
  4332. - Node* InstantiateXML(const String fileName, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
  4333. - bool LoadAsync(File* file, LoadMode mode = LOAD_SCENE_AND_RESOURCES)
  4334. - bool LoadAsyncXML(File* file, LoadMode mode = LOAD_SCENE_AND_RESOURCES)
  4335. - bool LoadAsync(const String fileName, LoadMode mode = LOAD_SCENE_AND_RESOURCES)
  4336. - bool LoadAsyncXML(const String fileName, LoadMode mode = LOAD_SCENE_AND_RESOURCES)
  4337. - void StopAsyncLoading()
  4338. - void Clear(bool clearReplicated = true, bool clearLocal = true)
  4339. - void SetUpdateEnabled(bool enable)
  4340. - void SetTimeScale(float scale)
  4341. - void SetElapsedTime(float time)
  4342. - void SetSmoothingConstant(float constant)
  4343. - void SetSnapThreshold(float threshold)
  4344. - void SetAsyncLoadingMs(int ms)
  4345. - Node* GetNode(unsigned id) const
  4346. - bool IsUpdateEnabled() const
  4347. - bool IsAsyncLoading() const
  4348. - float GetAsyncProgress() const
  4349. - LoadMode GetAsyncLoadMode() const
  4350. - const String GetFileName() const
  4351. - unsigned GetChecksum() const
  4352. - float GetTimeScale() const
  4353. - float GetElapsedTime() const
  4354. - float GetSmoothingConstant() const
  4355. - float GetSnapThreshold() const
  4356. - int GetAsyncLoadingMs() const
  4357. - const String GetVarName(StringHash hash) const
  4358. - void Update(float timeStep)
  4359. - void BeginThreadedUpdate()
  4360. - void EndThreadedUpdate()
  4361. - void DelayedMarkedDirty(Component* component)
  4362. - bool IsThreadedUpdate() const
  4363. - unsigned GetFreeNodeID(CreateMode mode)
  4364. - unsigned GetFreeComponentID(CreateMode mode)
  4365. - void NodeAdded(Node* node)
  4366. - void NodeRemoved(Node* node)
  4367. - void ComponentAdded(Component* component)
  4368. - void ComponentRemoved(Component* component)
  4369. - void SetVarNamesAttr(const String value)
  4370. - String GetVarNamesAttr() const
  4371. - void PrepareNetworkUpdate()
  4372. - void CleanupConnection(Connection* connection)
  4373. - void MarkNetworkUpdate(Node* node)
  4374. - void MarkNetworkUpdate(Component* component)
  4375. - void MarkReplicationDirty(Node* node)
  4376. Properties:
  4377. - bool updateEnabled
  4378. - bool asyncLoading (readonly)
  4379. - float asyncProgress (readonly)
  4380. - LoadMode asyncLoadMode (readonly)
  4381. - const String fileName
  4382. - unsigned checksum (readonly)
  4383. - float timeScale
  4384. - float elapsedTime
  4385. - float smoothingConstant
  4386. - float snapThreshold
  4387. - int asyncLoadingMs
  4388. - bool threadedUpdate (readonly)
  4389. - String varNamesAttr
  4390. <a name="Class_ScrollBar"></a>
  4391. ### ScrollBar : UIElement
  4392. Methods:
  4393. - ScrollBar() (GC)
  4394. - ScrollBar* new()
  4395. - void delete()
  4396. - void SetOrientation(Orientation orientation)
  4397. - void SetRange(float range)
  4398. - void SetValue(float value)
  4399. - void ChangeValue(float delta)
  4400. - void SetScrollStep(float step)
  4401. - void SetStepFactor(float factor)
  4402. - void StepBack()
  4403. - void StepForward()
  4404. - Orientation GetOrientation() const
  4405. - float GetRange() const
  4406. - float GetValue() const
  4407. - float GetScrollStep() const
  4408. - float GetStepFactor() const
  4409. - float GetEffectiveScrollStep() const
  4410. - Button* GetBackButton() const
  4411. - Button* GetForwardButton() const
  4412. - Slider* GetSlider() const
  4413. Properties:
  4414. - Orientation orientation
  4415. - float range
  4416. - float value
  4417. - float scrollStep
  4418. - float stepFactor
  4419. - float effectiveScrollStep (readonly)
  4420. - Button* backButton (readonly)
  4421. - Button* forwardButton (readonly)
  4422. - Slider* slider (readonly)
  4423. <a name="Class_ScrollView"></a>
  4424. ### ScrollView : UIElement
  4425. Methods:
  4426. - ScrollView() (GC)
  4427. - ScrollView* new()
  4428. - void delete()
  4429. - void SetContentElement(UIElement* element)
  4430. - void SetViewPosition(const IntVector2& position)
  4431. - void SetViewPosition(int x, int y)
  4432. - void SetScrollBarsVisible(bool horizontal, bool vertical)
  4433. - void SetScrollBarsAutoVisible(bool enable)
  4434. - void SetScrollStep(float step)
  4435. - void SetPageStep(float step)
  4436. - void SetScrollDeceleration(float deceleration)
  4437. - void SetScrollSnapEpsilon(float snap)
  4438. - void SetAutoDisableChildren(bool disable)
  4439. - void SetAutoDisableThreshold(float amount)
  4440. - const IntVector2& GetViewPosition() const
  4441. - UIElement* GetContentElement() const
  4442. - ScrollBar* GetHorizontalScrollBar() const
  4443. - ScrollBar* GetVerticalScrollBar() const
  4444. - BorderImage* GetScrollPanel() const
  4445. - bool GetScrollBarsAutoVisible() const
  4446. - float GetScrollStep() const
  4447. - float GetPageStep() const
  4448. - float GetScrollDeceleration() const
  4449. - float GetScrollSnapEpsilon() const
  4450. - bool GetAutoDisableChildren() const
  4451. - float GetAutoDisableThreshold() const
  4452. Properties:
  4453. - IntVector2& viewPosition
  4454. - UIElement* contentElement
  4455. - ScrollBar* horizontalScrollBar (readonly)
  4456. - ScrollBar* verticalScrollBar (readonly)
  4457. - BorderImage* scrollPanel (readonly)
  4458. - bool scrollBarsAutoVisible
  4459. - float scrollStep
  4460. - float pageStep
  4461. - float scrollDeceleration
  4462. - float scrollSnapEpsilon
  4463. <a name="Class_Serializable"></a>
  4464. ### Serializable : Object
  4465. Methods:
  4466. - void SetTemporary(bool enable)
  4467. - bool IsTemporary() const
  4468. - void SetInterceptNetworkUpdate(const String attributeName, bool enable)
  4469. - bool GetInterceptNetworkUpdate(const String attributeName)
  4470. Properties:
  4471. - bool temporary
  4472. <a name="Class_Serializer"></a>
  4473. ### Serializer
  4474. Methods:
  4475. - unsigned Write(const VectorBuffer& buffer)
  4476. - bool WriteInt(int value)
  4477. - bool WriteShort(short value)
  4478. - bool WriteByte(char value)
  4479. - bool WriteUInt(unsigned value)
  4480. - bool WriteUShort(short value)
  4481. - bool WriteUByte(char value)
  4482. - bool WriteBool(bool value)
  4483. - bool WriteFloat(float value)
  4484. - bool WriteDouble(double value)
  4485. - bool WriteIntRect(const IntRect& value)
  4486. - bool WriteIntVector2(const IntVector2& value)
  4487. - bool WriteRect(const Rect& value)
  4488. - bool WriteVector2(const Vector2& value)
  4489. - bool WriteVector3(const Vector3& value)
  4490. - bool WritePackedVector3(const Vector3& value, float maxAbsCoord)
  4491. - bool WriteVector4(const Vector4& value)
  4492. - bool WriteQuaternion(const Quaternion& value)
  4493. - bool WritePackedQuaternion(const Quaternion& value)
  4494. - bool WriteMatrix3(const Matrix3& value)
  4495. - bool WriteMatrix3x4(const Matrix3x4& value)
  4496. - bool WriteMatrix4(const Matrix4& value)
  4497. - bool WriteColor(const Color& value)
  4498. - bool WriteBoundingBox(const BoundingBox& value)
  4499. - bool WriteString(const String value)
  4500. - bool WriteFileID(const String value)
  4501. - bool WriteStringHash(const StringHash& value)
  4502. - bool WriteBuffer(const VectorBuffer& buffer)
  4503. - bool WriteResourceRef(const ResourceRef& value)
  4504. - bool WriteResourceRefList(const ResourceRefList& value)
  4505. - bool WriteVariant(const Variant& value)
  4506. - bool WriteVariantData(const Variant& value)
  4507. - bool WriteVariantVector(const VariantVector& value)
  4508. - bool WriteVariantMap(const VariantMap& value)
  4509. - bool WriteVLE(unsigned value)
  4510. - bool WriteNetID(unsigned value)
  4511. - bool WriteLine(const String value)
  4512. <a name="Class_Skeleton"></a>
  4513. ### Skeleton
  4514. Methods:
  4515. - unsigned GetNumBones() const
  4516. - Bone* GetRootBone()
  4517. - Bone* GetBone(const String name)
  4518. - Bone* GetBone(unsigned index)
  4519. Properties:
  4520. - unsigned numBones (readonly)
  4521. - Bone* rootBone (readonly)
  4522. <a name="Class_Skybox"></a>
  4523. ### Skybox : StaticModel
  4524. <a name="Class_Slider"></a>
  4525. ### Slider : BorderImage
  4526. Methods:
  4527. - Slider() (GC)
  4528. - Slider* new()
  4529. - void delete()
  4530. - void SetOrientation(Orientation orientation)
  4531. - void SetRange(float range)
  4532. - void SetValue(float value)
  4533. - void ChangeValue(float delta)
  4534. - void SetRepeatRate(float rate)
  4535. - Orientation GetOrientation() const
  4536. - float GetRange() const
  4537. - float GetValue() const
  4538. - BorderImage* GetKnob() const
  4539. - float GetRepeatRate() const
  4540. Properties:
  4541. - Orientation orientation
  4542. - float range
  4543. - float value
  4544. - BorderImage* knob (readonly)
  4545. - float repeatRate
  4546. <a name="Class_Sound"></a>
  4547. ### Sound : Resource
  4548. Methods:
  4549. - Sound() (GC)
  4550. - Sound* new()
  4551. - void delete()
  4552. - bool LoadRaw(Deserializer& source)
  4553. - bool LoadWav(Deserializer& source)
  4554. - bool LoadOggVorbis(Deserializer& source)
  4555. - bool LoadRaw(const String fileName)
  4556. - bool LoadWav(const String fileName)
  4557. - bool LoadOggVorbis(const String fileName)
  4558. - void SetSize(unsigned dataSize)
  4559. - void SetData(const void* data, unsigned dataSize)
  4560. - void SetFormat(unsigned frequency, bool sixteenBit, bool stereo)
  4561. - void SetLooped(bool enable)
  4562. - void SetLoop(unsigned repeatOffset, unsigned endOffset)
  4563. - void FixInterpolation()
  4564. - float GetLength() const
  4565. - unsigned GetDataSize() const
  4566. - unsigned GetSampleSize() const
  4567. - float GetFrequency() const
  4568. - unsigned GetIntFrequency() const
  4569. - bool IsLooped() const
  4570. - bool IsSixteenBit() const
  4571. - bool IsStereo() const
  4572. - bool IsCompressed() const
  4573. Properties:
  4574. - float length (readonly)
  4575. - unsigned dataSize (readonly)
  4576. - unsigned sampleSize (readonly)
  4577. - float frequency (readonly)
  4578. - int intFrequency (readonly)
  4579. - bool looped
  4580. - bool sixteenBit (readonly)
  4581. - bool stereo (readonly)
  4582. - bool compressed (readonly)
  4583. <a name="Class_SoundListener"></a>
  4584. ### SoundListener : Component
  4585. <a name="Class_SoundSource"></a>
  4586. ### SoundSource : Component
  4587. Methods:
  4588. - void Play(Sound* sound)
  4589. - void Play(Sound* sound, float frequency)
  4590. - void Play(Sound* sound, float frequency, float gain)
  4591. - void Play(Sound* sound, float frequency, float gain, float panning)
  4592. - void Stop()
  4593. - void SetSoundType(const String type)
  4594. - void SetFrequency(float frequency)
  4595. - void SetGain(float gain)
  4596. - void SetAttenuation(float attenuation)
  4597. - void SetPanning(float panning)
  4598. - void SetAutoRemove(bool enable)
  4599. - Sound* GetSound() const
  4600. - String GetSoundType() const
  4601. - float GetTimePosition() const
  4602. - float GetFrequency() const
  4603. - float GetGain() const
  4604. - float GetAttenuation() const
  4605. - float GetPanning() const
  4606. - bool GetAutoRemove() const
  4607. - bool IsPlaying() const
  4608. Properties:
  4609. - Sound* sound (readonly)
  4610. - String soundType
  4611. - float timePosition (readonly)
  4612. - float frequency
  4613. - float gain
  4614. - float attenuation
  4615. - float panning
  4616. - bool autoRemove
  4617. - bool playing (readonly)
  4618. <a name="Class_SoundSource3D"></a>
  4619. ### SoundSource3D : SoundSource
  4620. Methods:
  4621. - void SetDistanceAttenuation(float nearDistance, float farDistance, float rolloffFactor)
  4622. - void SetAngleAttenuation(float innerAngle, float outerAngle)
  4623. - void SetNearDistance(float distance)
  4624. - void SetFarDistance(float distance)
  4625. - void SetInnerAngle(float angle)
  4626. - void SetOuterAngle(float angle)
  4627. - void SetRolloffFactor(float factor)
  4628. - void CalculateAttenuation()
  4629. - float GetNearDistance() const
  4630. - float GetFarDistance() const
  4631. - float GetInnerAngle() const
  4632. - float GetOuterAngle() const
  4633. - float RollAngleoffFactor() const
  4634. Properties:
  4635. - float nearDistance
  4636. - float farDistance
  4637. - float innerAngle
  4638. - float outerAngle
  4639. - float rolloffFactor
  4640. <a name="Class_Sphere"></a>
  4641. ### Sphere
  4642. Methods:
  4643. - Sphere() (GC)
  4644. - Sphere* new()
  4645. - Sphere(const Sphere& sphere) (GC)
  4646. - Sphere* new(const Sphere& sphere)
  4647. - Sphere(const Vector3& center, float radius) (GC)
  4648. - Sphere* new(const Vector3& center, float radius)
  4649. - Sphere(const BoundingBox& box) (GC)
  4650. - Sphere* new(const BoundingBox& box)
  4651. - Sphere(const Frustum& frustum) (GC)
  4652. - Sphere* new(const Frustum& frustum)
  4653. - Sphere(const Polyhedron& poly) (GC)
  4654. - Sphere* new(const Polyhedron& poly)
  4655. - void delete()
  4656. - bool operator==(const Sphere& rhs) const
  4657. - void Define(const Sphere& sphere)
  4658. - void Define(const Vector3& center, float radius)
  4659. - void Define(const BoundingBox& box)
  4660. - void Define(const Frustum& frustum)
  4661. - void Define(const Polyhedron& poly)
  4662. - void Merge(const Vector3& point)
  4663. - void Merge(const BoundingBox& box)
  4664. - void Merge(const Frustum& frustum)
  4665. - void Merge(const Polyhedron& poly)
  4666. - void Merge(const Sphere& sphere)
  4667. - void Clear()
  4668. - Intersection IsInside(const Vector3& point) const
  4669. - Intersection IsInside(const Sphere& sphere) const
  4670. - Intersection IsInsideFast(const Sphere& sphere) const
  4671. - Intersection IsInside(const BoundingBox& box) const
  4672. - Intersection IsInsideFast(const BoundingBox& box) const
  4673. - float Distance(const Vector3& point) const
  4674. Properties:
  4675. - Vector3 center
  4676. - float radius
  4677. - bool defined
  4678. <a name="Class_Spline"></a>
  4679. ### Spline
  4680. Methods:
  4681. - Spline() (GC)
  4682. - Spline* new()
  4683. - Spline(InterpolationMode mode) (GC)
  4684. - Spline* new(InterpolationMode mode)
  4685. - Spline(const Spline& rhs) (GC)
  4686. - Spline* new(const Spline& rhs)
  4687. - void delete()
  4688. - bool operator==(const Spline& rhs) const
  4689. - Variant GetPoint(float f) const
  4690. - Variant GetKnot(unsigned index) const
  4691. - void SetKnot(const Variant& knot, unsigned tolua_var_1)
  4692. - void AddKnot(const Variant& knot)
  4693. - void AddKnot(const Variant& knot, unsigned index)
  4694. - void RemoveKnot()
  4695. - void RemoveKnot(unsigned index)
  4696. - void Clear()
  4697. Properties:
  4698. - InterpolationMode interpolationMode
  4699. <a name="Class_SplinePath"></a>
  4700. ### SplinePath : Component
  4701. Methods:
  4702. - void AddControlPoint(Node* point, unsigned index = M_MAX_UNSIGNED)
  4703. - void RemoveControlPoint(Node* point)
  4704. - void ClearControlPoints()
  4705. - void SetInterpolationMode(InterpolationMode mode)
  4706. - void SetPosition(float factor)
  4707. - void SetControlledNode(Node* controlled)
  4708. - InterpolationMode GetInterpolationMode() const
  4709. - float GetSpeed() const
  4710. - float GetLength() const
  4711. - Vector3 GetPosition() const
  4712. - Node* GetControlledNode() const
  4713. - Vector3 GetPoint(float factor) const
  4714. - void Move(float timeStep)
  4715. - void Reset()
  4716. - bool IsFinished() const
  4717. Properties:
  4718. - InterpolationMode interpolationMode
  4719. - float speed
  4720. - float length (readonly)
  4721. - Node* controlledNode
  4722. <a name="Class_Sprite"></a>
  4723. ### Sprite : UIElement
  4724. Methods:
  4725. - Sprite() (GC)
  4726. - Sprite* new()
  4727. - void delete()
  4728. - void SetPosition(const Vector2& position)
  4729. - void SetPosition(float x, float y)
  4730. - void SetHotSpot(const IntVector2& hotSpot)
  4731. - void SetHotSpot(int x, int y)
  4732. - void SetScale(const Vector2& scale)
  4733. - void SetScale(float x, float y)
  4734. - void SetScale(float scale)
  4735. - void SetRotation(float angle)
  4736. - void SetTexture(Texture* texture)
  4737. - void SetImageRect(const IntRect& rect)
  4738. - void SetFullImageRect()
  4739. - void SetBlendMode(BlendMode mode)
  4740. - const Vector2& GetPosition() const
  4741. - const IntVector2& GetHotSpot() const
  4742. - const Vector2& GetScale() const
  4743. - float GetRotation() const
  4744. - Texture* GetTexture() const
  4745. - const IntRect& GetImageRect() const
  4746. - BlendMode GetBlendMode() const
  4747. - const Matrix3x4& GetTransform() const
  4748. Properties:
  4749. - Vector2& position
  4750. - IntVector2& hotSpot
  4751. - Vector2& scale
  4752. - float rotation
  4753. - Texture* texture
  4754. - IntRect& imageRect
  4755. - BlendMode blendMode
  4756. - Matrix3x4& transform (readonly)
  4757. <a name="Class_Sprite2D"></a>
  4758. ### Sprite2D : Resource
  4759. Methods:
  4760. - void SetTexture(Texture2D* texture)
  4761. - void SetRectangle(const IntRect& rectangle)
  4762. - void SetHotSpot(const Vector2& hotSpot)
  4763. - void SetOffset(const IntVector2& offset)
  4764. - void SetSpriteSheet(SpriteSheet2D* spriteSheet)
  4765. - Texture2D* GetTexture() const
  4766. - const IntRect& GetRectangle() const
  4767. - const Vector2& GetHotSpot() const
  4768. - const IntVector2& GetOffset() const
  4769. - SpriteSheet2D* GetSpriteSheet() const
  4770. Properties:
  4771. - Texture2D* texture
  4772. - IntRect rectangle
  4773. - Vector2 hotSpot
  4774. - IntVector2 offset
  4775. - SpriteSheet2D* spriteSheet
  4776. <a name="Class_SpriteSheet2D"></a>
  4777. ### SpriteSheet2D : Resource
  4778. Methods:
  4779. - Texture2D* GetTexture() const
  4780. - Sprite2D* GetSprite(const String name) const
  4781. - void DefineSprite(const String name, const IntRect& rectangle)
  4782. - void DefineSprite(const String name, const IntRect& rectangle, const Vector2& hotSpot)
  4783. - void DefineSprite(const String name, const IntRect& rectangle, const Vector2& hotSpot, const IntVector2& originSize)
  4784. <a name="Class_StaticModel"></a>
  4785. ### StaticModel : Drawable
  4786. Methods:
  4787. - void SetModel(Model* model)
  4788. - void SetMaterial(Material* material)
  4789. - bool SetMaterial(unsigned index, Material* material)
  4790. - void SetOcclusionLodLevel(unsigned level)
  4791. - void ApplyMaterialList(const String fileName = String::EMPTY)
  4792. - Model* GetModel() const
  4793. - unsigned GetNumGeometries() const
  4794. - Material* GetMaterial(unsigned index = 0) const
  4795. - unsigned GetOcclusionLodLevel() const
  4796. - bool IsInside(const Vector3& point) const
  4797. - bool IsInsideLocal(const Vector3& point) const
  4798. Properties:
  4799. - Model* model
  4800. - Material* material
  4801. - BoundingBox& boundingBox (readonly)
  4802. - unsigned numGeometries (readonly)
  4803. - unsigned occlusionLodLevel
  4804. <a name="Class_StaticModelGroup"></a>
  4805. ### StaticModelGroup : StaticModel
  4806. Methods:
  4807. - void AddInstanceNode(Node* node)
  4808. - void RemoveInstanceNode(Node* node)
  4809. - void RemoveAllInstanceNodes()
  4810. - unsigned GetNumInstanceNodes() const
  4811. - Node* GetInstanceNode(unsigned index) const
  4812. Properties:
  4813. - unsigned numInstanceNodes (readonly)
  4814. <a name="Class_StaticSprite2D"></a>
  4815. ### StaticSprite2D : Drawable2D
  4816. Methods:
  4817. - void SetSprite(Sprite2D* sprite)
  4818. - void SetBlendMode(BlendMode mode)
  4819. - void SetFlip(bool flipX, bool flipY)
  4820. - void SetFlipX(bool flipX)
  4821. - void SetFlipY(bool flipY)
  4822. - void SetColor(const Color& color)
  4823. - void SetAlpha(float alpha)
  4824. - void SetUseHotSpot(bool useHotSpot)
  4825. - void SetHotSpot(const Vector2& hotspot)
  4826. - void SetCustomMaterial(Material* customMaterial)
  4827. - Sprite2D* GetSprite() const
  4828. - BlendMode GetBlendMode() const
  4829. - bool GetFlipX() const
  4830. - bool GetFlipY() const
  4831. - const Color& GetColor() const
  4832. - float GetAlpha() const
  4833. - bool GetUseHotSpot() const
  4834. - const Vector2& GetHotSpot() const
  4835. - Material* GetCustomMaterial() const
  4836. Properties:
  4837. - Sprite2D* sprite
  4838. - BlendMode blendMode
  4839. - bool flipX
  4840. - bool flipY
  4841. - Color& color
  4842. - float alpha
  4843. - bool useHotSpot
  4844. - Vector2 hotSpot
  4845. - Material* customMaterial
  4846. <a name="Class_StringHash"></a>
  4847. ### StringHash
  4848. Methods:
  4849. - StringHash() (GC)
  4850. - StringHash* new()
  4851. - StringHash(const StringHash& rhs) (GC)
  4852. - StringHash* new(const StringHash& rhs)
  4853. - StringHash(const char* str) (GC)
  4854. - StringHash* new(const char* str)
  4855. - StringHash(unsigned value) (GC)
  4856. - StringHash* new(unsigned value)
  4857. - void delete()
  4858. - StringHash operator+(const StringHash& rhs) const
  4859. - bool operator==(const StringHash& rhs) const
  4860. - bool operator<(const StringHash& rhs) const
  4861. - bool operatorbool() const
  4862. - unsigned Value() const
  4863. - String ToString() const
  4864. - unsigned ToHash() const
  4865. - unsigned Calculate(const char* str)
  4866. Properties:
  4867. - const StringHash ZERO
  4868. - unsigned value (readonly)
  4869. <a name="Class_Technique"></a>
  4870. ### Technique : Resource
  4871. Methods:
  4872. - bool HasPass(const String type) const
  4873. - Pass* GetPass(const String type) const
  4874. - Pass* GetSupportedPass(const String type) const
  4875. - bool IsSupported() const
  4876. - bool IsDesktop() const
  4877. - unsigned GetNumPasses() const
  4878. - const Vector<String>& GetPassTypes() const
  4879. - const PODVector<Pass*>& GetPasses() const
  4880. Properties:
  4881. - bool supported (readonly)
  4882. - bool desktop (readonly)
  4883. - unsigned numPasses (readonly)
  4884. <a name="Class_Terrain"></a>
  4885. ### Terrain : Component
  4886. Methods:
  4887. - void SetPatchSize(int size)
  4888. - void SetSpacing(const Vector3& spacing)
  4889. - void SetMaxLodLevels(unsigned levels)
  4890. - void SetOcclusionLodLevel(unsigned level)
  4891. - void SetSmoothing(bool enable)
  4892. - bool SetHeightMap(Image* image)
  4893. - void SetMaterial(Material* material)
  4894. - void SetDrawDistance(float distance)
  4895. - void SetShadowDistance(float distance)
  4896. - void SetLodBias(float bias)
  4897. - void SetViewMask(unsigned mask)
  4898. - void SetLightMask(unsigned mask)
  4899. - void SetShadowMask(unsigned mask)
  4900. - void SetZoneMask(unsigned mask)
  4901. - void SetMaxLights(unsigned num)
  4902. - void SetCastShadows(bool enable)
  4903. - void SetOccluder(bool enable)
  4904. - void SetOccludee(bool enable)
  4905. - void ApplyHeightMap()
  4906. - int GetPatchSize() const
  4907. - const Vector3& GetSpacing() const
  4908. - const IntVector2& GetNumVertices() const
  4909. - const IntVector2& GetNumPatches() const
  4910. - unsigned GetMaxLodLevels() const
  4911. - unsigned GetOcclusionLodLevel() const
  4912. - bool GetSmoothing() const
  4913. - Image* GetHeightMap() const
  4914. - Material* GetMaterial() const
  4915. - TerrainPatch* GetPatch(unsigned index) const
  4916. - TerrainPatch* GetPatch(int x, int z) const
  4917. - float GetHeight(const Vector3& worldPosition) const
  4918. - Vector3 GetNormal(const Vector3& worldPosition) const
  4919. - IntVector2 WorldToHeightMap(const Vector3& worldPosition) const
  4920. - SharedArrayPtr<float> GetHeightData() const
  4921. - float GetDrawDistance() const
  4922. - float GetShadowDistance() const
  4923. - float GetLodBias() const
  4924. - unsigned GetViewMask() const
  4925. - unsigned GetLightMask() const
  4926. - unsigned GetShadowMask() const
  4927. - unsigned GetZoneMask() const
  4928. - unsigned GetMaxLights() const
  4929. - bool IsVisible() const
  4930. - bool GetCastShadows() const
  4931. - bool IsOccluder() const
  4932. - bool IsOccludee() const
  4933. Properties:
  4934. - int patchSize
  4935. - Vector3& spacing
  4936. - IntVector2& numVertices (readonly)
  4937. - IntVector2& numPatches (readonly)
  4938. - unsigned maxLodLevels
  4939. - unsigned occlusionLodLevel
  4940. - bool smoothing
  4941. - Image* heightMap
  4942. - Material* material
  4943. - float drawDistance
  4944. - float shadowDistance
  4945. - float lodBias
  4946. - unsigned viewMask
  4947. - unsigned lightMask
  4948. - unsigned shadowMask
  4949. - unsigned zoneMask
  4950. - unsigned maxLights
  4951. - bool visible (readonly)
  4952. - bool castShadows
  4953. - bool occluder
  4954. - bool occludee
  4955. <a name="Class_TerrainPatch"></a>
  4956. ### TerrainPatch : Drawable
  4957. Methods:
  4958. - void SetOwner(Terrain* terrain)
  4959. - void SetNeighbors(TerrainPatch* north, TerrainPatch* south, TerrainPatch* west, TerrainPatch* east)
  4960. - void SetMaterial(Material* material)
  4961. - void SetBoundingBox(const BoundingBox& box)
  4962. - void SetCoordinates(const IntVector2& coordinates)
  4963. - void ResetLod()
  4964. - Geometry* GetGeometry() const
  4965. - Geometry* GetMaxLodGeometry() const
  4966. - Geometry* GetOcclusionGeometry() const
  4967. - VertexBuffer* GetVertexBuffer() const
  4968. - Terrain* GetOwner() const
  4969. - TerrainPatch* GetNorthPatch() const
  4970. - TerrainPatch* GetSouthPatch() const
  4971. - TerrainPatch* GetWestPatch() const
  4972. - TerrainPatch* GetEastPatch() const
  4973. - const IntVector2& GetCoordinates() const
  4974. - unsigned GetLodLevel() const
  4975. Properties:
  4976. - Geometry* geometry (readonly)
  4977. - Geometry* maxLodGeometry (readonly)
  4978. - Geometry* occlusionGeometry (readonly)
  4979. - VertexBuffer* vertexBuffer (readonly)
  4980. - Terrain* owner
  4981. - TerrainPatch* northPatch (readonly)
  4982. - TerrainPatch* southPatch (readonly)
  4983. - TerrainPatch* westPatch (readonly)
  4984. - TerrainPatch* eastPatch (readonly)
  4985. - BoundingBox& boundingBox
  4986. - IntVector2& coordinates
  4987. - unsigned lodLevel (readonly)
  4988. <a name="Class_Text"></a>
  4989. ### Text : UIElement
  4990. Methods:
  4991. - Text() (GC)
  4992. - Text* new()
  4993. - void delete()
  4994. - bool SetFont(const String fontName, int size = DEFAULT_FONT_SIZE)
  4995. - bool SetFont(Font* font, int size = DEFAULT_FONT_SIZE)
  4996. - void SetText(const String text)
  4997. - void SetTextAlignment(HorizontalAlignment align)
  4998. - void SetRowSpacing(float spacing)
  4999. - void SetWordwrap(bool enable)
  5000. - void SetSelection(unsigned start, unsigned length = M_MAX_UNSIGNED)
  5001. - void ClearSelection()
  5002. - void SetSelectionColor(const Color& color)
  5003. - void SetHoverColor(const Color& color)
  5004. - void SetTextEffect(TextEffect textEffect)
  5005. - void SetEffectColor(const Color& effectColor)
  5006. - bool GetAutoLocalizable() const
  5007. - void SetAutoLocalizable(bool enable)
  5008. - Font* GetFont() const
  5009. - int GetFontSize() const
  5010. - const String GetText() const
  5011. - HorizontalAlignment GetTextAlignment() const
  5012. - float GetRowSpacing() const
  5013. - bool GetWordwrap() const
  5014. - unsigned GetSelectionStart() const
  5015. - unsigned GetSelectionLength() const
  5016. - const Color& GetSelectionColor() const
  5017. - const Color& GetHoverColor() const
  5018. - TextEffect GetTextEffect() const
  5019. - const Color& GetEffectColor() const
  5020. - int GetRowHeight() const
  5021. - unsigned GetNumRows() const
  5022. - unsigned GetNumChars() const
  5023. - int GetRowWidth(unsigned index) const
  5024. - IntVector2 GetCharPosition(unsigned index)
  5025. - IntVector2 GetCharSize(unsigned index)
  5026. - void SetEffectDepthBias(float bias)
  5027. - float GetEffectDepthBias() const
  5028. Properties:
  5029. - Font* font
  5030. - int fontSize (readonly)
  5031. - String text
  5032. - HorizontalAlignment textAlignment
  5033. - float rowSpacing
  5034. - bool wordwrap
  5035. - bool autoLocalizable
  5036. - unsigned selectionStart (readonly)
  5037. - unsigned selectionLength (readonly)
  5038. - Color& selectionColor
  5039. - Color& hoverColor
  5040. - TextEffect textEffect
  5041. - Color& effectColor
  5042. - int rowHeight (readonly)
  5043. - unsigned numRows (readonly)
  5044. - unsigned numChars (readonly)
  5045. <a name="Class_Text3D"></a>
  5046. ### Text3D : Drawable
  5047. Methods:
  5048. - Text3D() (GC)
  5049. - Text3D* new()
  5050. - void delete()
  5051. - bool SetFont(const String fontName, int size = DEFAULT_FONT_SIZE)
  5052. - bool SetFont(Font* font, int size = DEFAULT_FONT_SIZE)
  5053. - void SetMaterial(Material* material)
  5054. - void SetText(const String text)
  5055. - void SetAlignment(HorizontalAlignment hAlign, VerticalAlignment vAlign)
  5056. - void SetHorizontalAlignment(HorizontalAlignment align)
  5057. - void SetVerticalAlignment(VerticalAlignment align)
  5058. - void SetTextAlignment(HorizontalAlignment align)
  5059. - void SetRowSpacing(float spacing)
  5060. - void SetWordwrap(bool enable)
  5061. - void SetTextEffect(TextEffect textEffect)
  5062. - void SetEffectColor(const Color& effectColor)
  5063. - void SetEffectDepthBias(float bias)
  5064. - void SetWidth(int width)
  5065. - void SetColor(const Color& color)
  5066. - void SetColor(Corner corner, const Color& color)
  5067. - void SetOpacity(float opacity)
  5068. - void SetFaceCameraMode(FaceCameraMode mode)
  5069. - Font* GetFont() const
  5070. - Material* GetMaterial() const
  5071. - int GetFontSize() const
  5072. - const String GetText() const
  5073. - HorizontalAlignment GetTextAlignment() const
  5074. - HorizontalAlignment GetHorizontalAlignment() const
  5075. - VerticalAlignment GetVerticalAlignment() const
  5076. - float GetRowSpacing() const
  5077. - bool GetWordwrap() const
  5078. - TextEffect GetTextEffect() const
  5079. - const Color& GetEffectColor() const
  5080. - float GetEffectDepthBias() const
  5081. - int GetWidth() const
  5082. - int GetRowHeight() const
  5083. - unsigned GetNumRows() const
  5084. - unsigned GetNumChars() const
  5085. - int GetRowWidth(unsigned index) const
  5086. - IntVector2 GetCharPosition(unsigned index)
  5087. - IntVector2 GetCharSize(unsigned index)
  5088. - const Color& GetColor(Corner corner) const
  5089. - float GetOpacity() const
  5090. - FaceCameraMode GetFaceCameraMode() const
  5091. Properties:
  5092. - Font* font
  5093. - Material* material
  5094. - int fontSize (readonly)
  5095. - String text
  5096. - HorizontalAlignment textAlignment
  5097. - HorizontalAlignment horizontalAlignment
  5098. - VerticalAlignment verticalAlignment
  5099. - float rowSpacing
  5100. - bool wordwrap
  5101. - TextEffect textEffect
  5102. - Color& effectColor
  5103. - float effectDepthBias
  5104. - int width
  5105. - Color& color
  5106. - int rowHeight (readonly)
  5107. - unsigned numRows (readonly)
  5108. - unsigned numChars (readonly)
  5109. - float opacity
  5110. - FaceCameraMode faceCameraMode
  5111. <a name="Class_Texture"></a>
  5112. ### Texture : Resource
  5113. Methods:
  5114. - void SetNumLevels(unsigned levels)
  5115. - void SetFilterMode(TextureFilterMode filter)
  5116. - void SetAddressMode(TextureCoordinate coord, TextureAddressMode address)
  5117. - void SetBorderColor(const Color& color)
  5118. - void SetSRGB(bool enable)
  5119. - void SetBackupTexture(Texture* texture)
  5120. - void SetMipsToSkip(int quality, int mips)
  5121. - unsigned GetFormat() const
  5122. - bool IsCompressed() const
  5123. - unsigned GetLevels() const
  5124. - int GetWidth() const
  5125. - int GetHeight() const
  5126. - TextureFilterMode GetFilterMode() const
  5127. - TextureAddressMode GetAddressMode(TextureCoordinate coord) const
  5128. - const Color& GetBorderColor() const
  5129. - bool GetSRGB() const
  5130. - Texture* GetBackupTexture() const
  5131. - int GetMipsToSkip(int quality) const
  5132. - int GetLevelWidth(unsigned level) const
  5133. - int GetLevelHeight(unsigned level) const
  5134. - TextureUsage GetUsage() const
  5135. - unsigned GetDataSize(int width, int height) const
  5136. - unsigned GetRowDataSize(int width) const
  5137. - unsigned GetComponents() const
  5138. Properties:
  5139. - unsigned format (readonly)
  5140. - bool compressed (readonly)
  5141. - unsigned levels (readonly)
  5142. - int width (readonly)
  5143. - int height (readonly)
  5144. - unsigned components (readonly)
  5145. - TextureFilterMode filterMode
  5146. - Color& borderColor
  5147. - bool sRGB
  5148. - Texture* backupTexture
  5149. - TextureUsage usage (readonly)
  5150. <a name="Class_Texture2D"></a>
  5151. ### Texture2D : Texture
  5152. Methods:
  5153. - Texture2D() (GC)
  5154. - Texture2D* new()
  5155. - void delete()
  5156. - bool SetSize(int width, int height, unsigned format, TextureUsage usage = TEXTURE_STATIC)
  5157. - bool SetData(Image* image, bool useAlpha = false)
  5158. - RenderSurface* GetRenderSurface() const
  5159. Properties:
  5160. - RenderSurface* renderSurface (readonly)
  5161. <a name="Class_TextureCube"></a>
  5162. ### TextureCube : Texture
  5163. Methods:
  5164. - RenderSurface* GetRenderSurface(CubeMapFace face) const
  5165. <a name="Class_TextureFrame"></a>
  5166. ### TextureFrame
  5167. Methods:
  5168. - TextureFrame() (GC)
  5169. - TextureFrame* new()
  5170. - void delete()
  5171. Properties:
  5172. - Rect uv
  5173. - float time
  5174. <a name="Class_Tile2D"></a>
  5175. ### Tile2D
  5176. Methods:
  5177. - int GetGid() const
  5178. - Sprite2D* GetSprite() const
  5179. - bool HasProperty(const String name) const
  5180. - const String GetProperty(const String name) const
  5181. Properties:
  5182. - int gid (readonly)
  5183. - Sprite2D* sprite (readonly)
  5184. <a name="Class_TileMap2D"></a>
  5185. ### TileMap2D : Component
  5186. Methods:
  5187. - void SetTmxFile(TmxFile2D* tmxFile)
  5188. - TmxFile2D* GetTmxFile() const
  5189. - const TileMapInfo2D& GetInfo() const
  5190. - unsigned GetNumLayers() const
  5191. - TileMapLayer2D* GetLayer(unsigned index) const
  5192. - Vector2 TileIndexToPosition(int x, int y) const
  5193. - bool PositionToTileIndex(const Vector2& position, int x = 0, int y = 0) const
  5194. Properties:
  5195. - TmxFile2D* tmxFile
  5196. - TileMapInfo2D& info (readonly)
  5197. - unsigned numLayers (readonly)
  5198. <a name="Class_TileMapInfo2D"></a>
  5199. ### TileMapInfo2D
  5200. Methods:
  5201. - float GetMapWidth() const
  5202. - float GetMapHeight() const
  5203. Properties:
  5204. - Orientation2D orientation
  5205. - int width
  5206. - int height
  5207. - float tileWidth
  5208. - float tileHeight
  5209. - float mapWidth (readonly)
  5210. - float mapHeight (readonly)
  5211. <a name="Class_TileMapLayer2D"></a>
  5212. ### TileMapLayer2D : Component
  5213. Methods:
  5214. - void SetDrawOrder(int drawOrder)
  5215. - void SetVisible(bool visible)
  5216. - int GetDrawOrder() const
  5217. - bool IsVisible() const
  5218. - bool HasProperty(const String name) const
  5219. - const String GetProperty(const String name) const
  5220. - TileMapLayerType2D GetLayerType() const
  5221. - int GetWidth() const
  5222. - int GetHeight() const
  5223. - Node* GetTileNode(int x, int y) const
  5224. - Tile2D* GetTile(int x, int y) const
  5225. - unsigned GetNumObjects() const
  5226. - TileMapObject2D* GetObject(unsigned index) const
  5227. - Node* GetObjectNode(unsigned index) const
  5228. - Node* GetImageNode() const
  5229. Properties:
  5230. - int drawOrder (readonly)
  5231. - bool visible (readonly)
  5232. - TileMapLayerType2D layerType (readonly)
  5233. - int width (readonly)
  5234. - int height (readonly)
  5235. - unsigned numObjects (readonly)
  5236. - Node* imageNode (readonly)
  5237. <a name="Class_TileMapObject2D"></a>
  5238. ### TileMapObject2D
  5239. Methods:
  5240. - TileMapObjectType2D GetObjectType() const
  5241. - const String GetName() const
  5242. - const String GetType() const
  5243. - const Vector2& GetPosition() const
  5244. - const Vector2& GetSize() const
  5245. - unsigned GetNumPoints() const
  5246. - const Vector2& GetPoint(unsigned index) const
  5247. - int GetTileGid() const
  5248. - Sprite2D* GetTileSprite() const
  5249. - bool HasProperty(const String name) const
  5250. - const String GetProperty(const String name) const
  5251. Properties:
  5252. - TileMapObjectType2D objectType (readonly)
  5253. - String name (readonly)
  5254. - String type (readonly)
  5255. - Vector2 position (readonly)
  5256. - Vector2 size (readonly)
  5257. - unsigned numPoints (readonly)
  5258. - int tileGid (readonly)
  5259. - Sprite2D* tileSprite (readonly)
  5260. <a name="Class_Time"></a>
  5261. ### Time : Object
  5262. Methods:
  5263. - unsigned GetFrameNumber() const
  5264. - float GetTimeStep() const
  5265. - unsigned GetTimerPeriod() const
  5266. - float GetElapsedTime()
  5267. - unsigned GetSystemTime()
  5268. - unsigned GetTimeSinceEpoch()
  5269. - String GetTimeStamp()
  5270. - void Sleep(unsigned mSec)
  5271. Properties:
  5272. - unsigned frameNumber (readonly)
  5273. - float timeStep (readonly)
  5274. - unsigned timerPeriod (readonly)
  5275. - float elapsedTime (readonly)
  5276. <a name="Class_TmxFile2D"></a>
  5277. ### TmxFile2D : Resource
  5278. <a name="Class_ToolTip"></a>
  5279. ### ToolTip : UIElement
  5280. Methods:
  5281. - ToolTip() (GC)
  5282. - ToolTip* new()
  5283. - void delete()
  5284. - void SetDelay(float delay)
  5285. - float GetDelay() const
  5286. Properties:
  5287. - float delay
  5288. <a name="Class_TouchState"></a>
  5289. ### TouchState
  5290. Methods:
  5291. - UIElement* GetTouchedElement()
  5292. Properties:
  5293. - int touchID
  5294. - IntVector2 position
  5295. - IntVector2 lastPosition
  5296. - IntVector2 delta
  5297. - float pressure
  5298. - UIElement* touchedElement (readonly)
  5299. <a name="Class_UI"></a>
  5300. ### UI : Object
  5301. Methods:
  5302. - void SetCursor(Cursor* cursor)
  5303. - void SetFocusElement(UIElement* element, bool byKey = false)
  5304. - bool SetModalElement(UIElement* modalElement, bool enable)
  5305. - void Clear()
  5306. - void DebugDraw(UIElement* element)
  5307. - UIElement* LoadLayout(File* source, XMLFile* styleFile = 0)
  5308. - UIElement* LoadLayout(const String fileName, XMLFile* styleFile = 0)
  5309. - UIElement* LoadLayout(XMLFile* file, XMLFile* styleFile = 0)
  5310. - bool SaveLayout(Serializer& dest, UIElement* element)
  5311. - void SetClipboardText(const String text)
  5312. - void SetDoubleClickInterval(float interval)
  5313. - void SetDragBeginInterval(float interval)
  5314. - void SetDragBeginDistance(int pixels)
  5315. - void SetDefaultToolTipDelay(float delay)
  5316. - void SetMaxFontTextureSize(int size)
  5317. - void SetNonFocusedMouseWheel(bool nonFocusedMouseWheel)
  5318. - void SetUseSystemClipboard(bool enable)
  5319. - void SetUseScreenKeyboard(bool enable)
  5320. - void SetUseMutableGlyphs(bool enable)
  5321. - void SetForceAutoHint(bool enable)
  5322. - UIElement* GetRoot() const
  5323. - UIElement* GetRootModalElement() const
  5324. - Cursor* GetCursor() const
  5325. - IntVector2 GetCursorPosition() const
  5326. - UIElement* GetElementAt(const IntVector2& position, bool enabledOnly = true)
  5327. - UIElement* GetElementAt(int x, int y, bool enabledOnly = true)
  5328. - UIElement* GetFocusElement() const
  5329. - UIElement* GetFrontElement() const
  5330. - UIElement* GetDragElement(unsigned index)
  5331. - const String GetClipboardText() const
  5332. - float GetDoubleClickInterval() const
  5333. - float GetDragBeginInterval() const
  5334. - int GetDragBeginDistance() const
  5335. - float GetDefaultToolTipDelay() const
  5336. - int GetMaxFontTextureSize() const
  5337. - bool IsNonFocusedMouseWheel() const
  5338. - bool GetUseSystemClipboard() const
  5339. - bool GetUseScreenKeyboard() const
  5340. - bool GetUseMutableGlyphs() const
  5341. - bool GetForceAutoHint() const
  5342. - bool HasModalElement() const
  5343. - bool IsDragging() const
  5344. Properties:
  5345. - UIElement* root (readonly)
  5346. - UIElement* rootModalElement (readonly)
  5347. - Cursor* cursor
  5348. - IntVector2 cursorPosition (readonly)
  5349. - UIElement* focusElement (readonly)
  5350. - UIElement* frontElement (readonly)
  5351. - String clipboardText
  5352. - float doubleClickInterval
  5353. - float dragBeginInterval
  5354. - int dragBeginDistance
  5355. - float defaultToolTipDelay
  5356. - int maxFontTextureSize
  5357. - bool nonFocusedMouseWheel
  5358. - bool useSystemClipboard
  5359. - bool useScreenKeyboard
  5360. - bool useMutableGlyphs
  5361. - bool forceAutoHint
  5362. - bool modalElement (readonly)
  5363. <a name="Class_UIElement"></a>
  5364. ### UIElement : Animatable
  5365. Methods:
  5366. - UIElement() (GC)
  5367. - UIElement* new()
  5368. - void delete()
  5369. - const IntVector2& GetScreenPosition() const
  5370. - bool LoadXML(Deserializer& source)
  5371. - bool SaveXML(Serializer& dest, const String indentation = "\t") const
  5372. - bool LoadXML(const String fileName)
  5373. - bool SaveXML(const String fileName, const String indentation = "\t") const
  5374. - bool FilterAttributes(XMLElement& dest) const
  5375. - void SetName(const String name)
  5376. - void SetPosition(const IntVector2& position)
  5377. - void SetPosition(int x, int y)
  5378. - void SetSize(const IntVector2& size)
  5379. - void SetSize(int width, int height)
  5380. - void SetWidth(int width)
  5381. - void SetHeight(int height)
  5382. - void SetMinSize(const IntVector2& minSize)
  5383. - void SetMinSize(int width, int height)
  5384. - void SetMinWidth(int width)
  5385. - void SetMinHeight(int height)
  5386. - void SetMaxSize(const IntVector2& maxSize)
  5387. - void SetMaxSize(int width, int height)
  5388. - void SetMaxWidth(int width)
  5389. - void SetMaxHeight(int height)
  5390. - void SetFixedSize(const IntVector2& size)
  5391. - void SetFixedSize(int width, int height)
  5392. - void SetFixedWidth(int width)
  5393. - void SetFixedHeight(int height)
  5394. - void SetAlignment(HorizontalAlignment hAlign, VerticalAlignment vAlign)
  5395. - void SetHorizontalAlignment(HorizontalAlignment align)
  5396. - void SetVerticalAlignment(VerticalAlignment align)
  5397. - void SetClipBorder(const IntRect& rect)
  5398. - void SetColor(const Color& color)
  5399. - void SetColor(Corner corner, const Color& color)
  5400. - void SetPriority(int priority)
  5401. - void SetOpacity(float opacity)
  5402. - void SetBringToFront(bool enable)
  5403. - void SetBringToBack(bool enable)
  5404. - void SetClipChildren(bool enable)
  5405. - void SetSortChildren(bool enable)
  5406. - void SetUseDerivedOpacity(bool enable)
  5407. - void SetEnabled(bool enable)
  5408. - void SetDeepEnabled(bool enable)
  5409. - void ResetDeepEnabled()
  5410. - void SetEnabledRecursive(bool enable)
  5411. - void SetEditable(bool enable)
  5412. - void SetFocus(bool enable)
  5413. - void SetSelected(bool enable)
  5414. - void SetVisible(bool enable)
  5415. - void SetFocusMode(FocusMode mode)
  5416. - void SetDragDropMode(unsigned mode)
  5417. - bool SetStyle(const String styleName, XMLFile* file = 0)
  5418. - bool SetStyle(const XMLElement& element)
  5419. - bool SetStyleAuto(XMLFile* file = 0)
  5420. - void SetDefaultStyle(XMLFile* style)
  5421. - void SetLayout(LayoutMode mode, int spacing = 0)
  5422. - void SetLayout(LayoutMode mode, int spacing, const IntRect& border)
  5423. - void SetLayoutMode(LayoutMode mode)
  5424. - void SetLayoutSpacing(int spacing)
  5425. - void SetLayoutBorder(const IntRect& border)
  5426. - void SetLayoutFlexScale(const Vector2& scale)
  5427. - void SetIndent(int indent)
  5428. - void SetIndentSpacing(int indentSpacing)
  5429. - void UpdateLayout()
  5430. - void DisableLayoutUpdate()
  5431. - void EnableLayoutUpdate()
  5432. - void BringToFront()
  5433. - UIElement* CreateChild(const String type, const String name = String::EMPTY, unsigned index = M_MAX_UNSIGNED)
  5434. - void AddChild(UIElement* element)
  5435. - void InsertChild(unsigned index, UIElement* element)
  5436. - void RemoveChild(UIElement* element, unsigned index = 0)
  5437. - void RemoveChildAtIndex(unsigned index)
  5438. - void RemoveAllChildren()
  5439. - void Remove()
  5440. - unsigned FindChild(UIElement* element) const
  5441. - void SetParent(UIElement* parent, unsigned index = M_MAX_UNSIGNED)
  5442. - void SetVar(StringHash key, const Variant& value)
  5443. - void SetInternal(bool enable)
  5444. - void SetTraversalMode(TraversalMode traversalMode)
  5445. - void SetElementEventSender(bool flag)
  5446. - const String GetName() const
  5447. - const IntVector2& GetPosition() const
  5448. - const IntVector2& GetSize() const
  5449. - int GetWidth() const
  5450. - int GetHeight() const
  5451. - const IntVector2& GetMinSize() const
  5452. - int GetMinWidth() const
  5453. - int GetMinHeight() const
  5454. - const IntVector2& GetMaxSize() const
  5455. - int GetMaxWidth() const
  5456. - int GetMaxHeight() const
  5457. - bool IsFixedSize() const
  5458. - bool IsFixedWidth() const
  5459. - bool IsFixedHeight() const
  5460. - const IntVector2& GetChildOffset() const
  5461. - HorizontalAlignment GetHorizontalAlignment() const
  5462. - VerticalAlignment GetVerticalAlignment() const
  5463. - const IntRect& GetClipBorder() const
  5464. - const Color& GetColor(Corner corner) const
  5465. - int GetPriority() const
  5466. - float GetOpacity() const
  5467. - float GetDerivedOpacity() const
  5468. - bool GetBringToFront() const
  5469. - bool GetBringToBack() const
  5470. - bool GetClipChildren() const
  5471. - bool GetSortChildren() const
  5472. - bool GetUseDerivedOpacity() const
  5473. - bool HasFocus() const
  5474. - bool IsEnabled() const
  5475. - bool IsEnabledSelf() const
  5476. - bool IsEditable() const
  5477. - bool IsSelected() const
  5478. - bool IsVisible() const
  5479. - bool IsVisibleEffective() const
  5480. - bool IsHovering() const
  5481. - bool IsInternal() const
  5482. - bool HasColorGradient() const
  5483. - FocusMode GetFocusMode() const
  5484. - unsigned GetDragDropMode() const
  5485. - const String GetAppliedStyle() const
  5486. - XMLFile* GetDefaultStyle(bool recursiveUp = true) const
  5487. - LayoutMode GetLayoutMode() const
  5488. - int GetLayoutSpacing() const
  5489. - const IntRect& GetLayoutBorder() const
  5490. - const Vector2& GetLayoutFlexScale() const
  5491. - unsigned GetNumChildren(bool recursive = false) const
  5492. - int GetDragButtonCombo() const
  5493. - unsigned GetDragButtonCount() const
  5494. - UIElement* GetChild(const String name, bool recursive = false) const
  5495. - UIElement* GetChild(unsigned index) const
  5496. - UIElement* GetParent() const
  5497. - UIElement* GetRoot() const
  5498. - const Color& GetDerivedColor() const
  5499. - const Variant& GetVar(StringHash key) const
  5500. - const VariantMap& GetVars() const
  5501. - IntVector2 ScreenToElement(const IntVector2& screenPosition)
  5502. - IntVector2 ElementToScreen(const IntVector2& position)
  5503. - bool IsInside(IntVector2 position, bool isScreen)
  5504. - bool IsInsideCombined(IntVector2 position, bool isScreen)
  5505. - IntRect GetCombinedScreenRect()
  5506. - void SortChildren()
  5507. - int GetIndent() const
  5508. - int GetIndentSpacing() const
  5509. - int GetIndentWidth() const
  5510. - void SetChildOffset(const IntVector2& offset)
  5511. - void SetHovering(bool enable)
  5512. - const Color& GetColor() const
  5513. - TraversalMode GetTraversalMode() const
  5514. - bool IsElementEventSender() const
  5515. - UIElement* GetElementEventSender() const
  5516. Properties:
  5517. - IntVector2& screenPosition (readonly)
  5518. - String name
  5519. - IntVector2& position
  5520. - IntVector2 size
  5521. - int width
  5522. - int height
  5523. - IntVector2 minSize
  5524. - int minWidth
  5525. - int minHeight
  5526. - IntVector2 maxSize
  5527. - int maxWidth
  5528. - int maxHeight
  5529. - bool fixedSize (readonly)
  5530. - bool fixedWidth (readonly)
  5531. - bool fixedHeight (readonly)
  5532. - IntVector2& childOffset
  5533. - HorizontalAlignment horizontalAlignment
  5534. - VerticalAlignment verticalAlignment
  5535. - IntRect clipBorder
  5536. - Color& color
  5537. - int priority
  5538. - float opacity
  5539. - float derivedOpacity (readonly)
  5540. - bool bringToFront
  5541. - bool bringToBack
  5542. - bool clipChildren
  5543. - bool sortChildren
  5544. - bool useDerivedOpacity
  5545. - bool focus
  5546. - bool enabled
  5547. - bool enabledSelf (readonly)
  5548. - bool editable
  5549. - bool selected
  5550. - bool visible
  5551. - bool visibleEffective (readonly)
  5552. - bool hovering
  5553. - bool internal
  5554. - bool colorGradient (readonly)
  5555. - FocusMode focusMode
  5556. - unsigned dragDropMode
  5557. - String style
  5558. - XMLFile* defaultStyle
  5559. - LayoutMode layoutMode
  5560. - int layoutSpacing
  5561. - IntRect& layoutBorder
  5562. - Vector2& layoutFlexScale
  5563. - unsigned numChildren (readonly)
  5564. - UIElement* parent
  5565. - UIElement* root (readonly)
  5566. - Color& derivedColor (readonly)
  5567. - IntRect combinedScreenRect (readonly)
  5568. - int indent
  5569. - int indentSpacing
  5570. - int indentWidth (readonly)
  5571. - TraversalMode traversalMode
  5572. - bool elementEventSender
  5573. <a name="Class_ValueAnimation"></a>
  5574. ### ValueAnimation : Resource
  5575. Methods:
  5576. - ValueAnimation() (GC)
  5577. - ValueAnimation* new()
  5578. - void delete()
  5579. - void SetInterpolationMethod(InterpMethod method)
  5580. - void SetSplineTension(float tension)
  5581. - void SetValueType(VariantType valueType)
  5582. - bool SetKeyFrame(float time, const Variant& value)
  5583. - void SetEventFrame(float time, const StringHash& eventType)
  5584. - void SetEventFrame(float time, const StringHash& eventType, const VariantMap& eventData)
  5585. - InterpMethod GetInterpolationMethod() const
  5586. - float GetSplineTension() const
  5587. - VariantType GetValueType() const
  5588. Properties:
  5589. - InterpMethod interpolationMethod
  5590. - float splineTension
  5591. - VariantType valueType
  5592. <a name="Class_Variant"></a>
  5593. ### Variant
  5594. Methods:
  5595. - Variant() (GC)
  5596. - Variant* new()
  5597. - Variant(const Variant& value) (GC)
  5598. - Variant* new(const Variant& value)
  5599. - Variant(const char* type, const char* value) (GC)
  5600. - Variant* new(const char* type, const char* value)
  5601. - Variant(VariantType type, const char* value) (GC)
  5602. - Variant* new(VariantType type, const char* value)
  5603. - void delete()
  5604. - void Clear()
  5605. - bool operator==(const Variant& rhs) const
  5606. - void Set(const Variant& rhs)
  5607. - void* Get(const char* type = 0) const
  5608. - int GetInt() const
  5609. - unsigned GetUInt() const
  5610. - StringHash GetStringHash() const
  5611. - bool GetBool() const
  5612. - float GetFloat() const
  5613. - double GetDouble() const
  5614. - const Vector2& GetVector2() const
  5615. - const Vector3& GetVector3() const
  5616. - const Vector4& GetVector4() const
  5617. - const Quaternion& GetQuaternion() const
  5618. - const Color& GetColor() const
  5619. - const String GetString() const
  5620. - const PODVector<unsigned char>& GetRawBuffer() const
  5621. - const VectorBuffer GetBuffer() const
  5622. - void* GetVoidPtr(const char* type) const
  5623. - const ResourceRef& GetResourceRef() const
  5624. - const ResourceRefList& GetResourceRefList() const
  5625. - const Vector<Variant>& GetVariantVector() const
  5626. - const VariantMap& GetVariantMap() const
  5627. - const Vector<String>& GetStringVector() const
  5628. - const IntRect& GetIntRect() const
  5629. - const IntVector2& GetIntVector2() const
  5630. - RefCounted* GetPtr(const char* type) const
  5631. - const Matrix3& GetMatrix3() const
  5632. - const Matrix3x4& GetMatrix3x4() const
  5633. - const Matrix4& GetMatrix4() const
  5634. - VariantType GetType() const
  5635. - String GetTypeName() const
  5636. - String ToString() const
  5637. - bool IsZero() const
  5638. - bool IsEmpty() const
  5639. Properties:
  5640. - VariantType type (readonly)
  5641. - String typeName (readonly)
  5642. - bool zero (readonly)
  5643. - bool empty (readonly)
  5644. <a name="Class_VariantMap"></a>
  5645. ### VariantMap
  5646. Methods:
  5647. - VariantMap() (GC)
  5648. - VariantMap* new()
  5649. - void delete()
  5650. <a name="Class_Vector2"></a>
  5651. ### Vector2
  5652. Methods:
  5653. - Vector2() (GC)
  5654. - Vector2* new()
  5655. - Vector2(const Vector2& vector) (GC)
  5656. - Vector2* new(const Vector2& vector)
  5657. - Vector2(float x, float y) (GC)
  5658. - Vector2* new(float x, float y)
  5659. - void delete()
  5660. - bool operator==(const Vector2& rhs) const
  5661. - Vector2 operator+(const Vector2& rhs) const
  5662. - Vector2 operator-() const
  5663. - Vector2 operator-(const Vector2& rhs) const
  5664. - Vector2 operator*(float rhs) const
  5665. - Vector2 operator*(const Vector2& rhs) const
  5666. - Vector2 operator/(float rhs) const
  5667. - Vector2 operator/(const Vector2& rhs) const
  5668. - Vector2 operator/(const Vector2& rhs) const
  5669. - void Normalize()
  5670. - float Length() const
  5671. - float LengthSquared() const
  5672. - float DotProduct(const Vector2& rhs) const
  5673. - float AbsDotProduct(const Vector2& rhs) const
  5674. - Vector2 Abs() const
  5675. - Vector2 Lerp(const Vector2& rhs, float t) const
  5676. - bool Equals(const Vector2& rhs) const
  5677. - bool IsNaN() const
  5678. - Vector2 Normalized() const
  5679. - String ToString() const
  5680. Properties:
  5681. - float x
  5682. - float y
  5683. - const Vector2 ZERO
  5684. - const Vector2 LEFT
  5685. - const Vector2 RIGHT
  5686. - const Vector2 UP
  5687. - const Vector2 DOWN
  5688. - const Vector2 ONE
  5689. <a name="Class_Vector3"></a>
  5690. ### Vector3
  5691. Methods:
  5692. - Vector3() (GC)
  5693. - Vector3* new()
  5694. - Vector3(const Vector3& vector) (GC)
  5695. - Vector3* new(const Vector3& vector)
  5696. - Vector3(const Vector2& vector, float z) (GC)
  5697. - Vector3* new(const Vector2& vector, float z)
  5698. - Vector3(const Vector2& vector) (GC)
  5699. - Vector3* new(const Vector2& vector)
  5700. - Vector3(float x, float y, float z) (GC)
  5701. - Vector3* new(float x, float y, float z)
  5702. - Vector3(float x, float y) (GC)
  5703. - Vector3* new(float x, float y)
  5704. - void delete()
  5705. - bool operator==(const Vector3& rhs) const
  5706. - Vector3 operator+(const Vector3& rhs) const
  5707. - Vector3 operator-() const
  5708. - Vector3 operator-(const Vector3& rhs) const
  5709. - Vector3 operator*(float rhs) const
  5710. - Vector3 operator*(const Vector3& rhs) const
  5711. - Vector3 operator/(float rhs) const
  5712. - Vector3 operator/(const Vector3& rhs) const
  5713. - void Normalize()
  5714. - float Length() const
  5715. - float LengthSquared() const
  5716. - float DotProduct(const Vector3& rhs) const
  5717. - float AbsDotProduct(const Vector3& rhs) const
  5718. - Vector3 CrossProduct(const Vector3& rhs) const
  5719. - Vector3 Abs() const
  5720. - Vector3 Lerp(const Vector3& rhs, float t) const
  5721. - bool Equals(const Vector3& rhs) const
  5722. - bool IsNaN() const
  5723. - float Angle(const Vector3& rhs) const
  5724. - Vector3 Normalized() const
  5725. - String ToString() const
  5726. Properties:
  5727. - float x
  5728. - float y
  5729. - float z
  5730. - const Vector3 ZERO
  5731. - const Vector3 LEFT
  5732. - const Vector3 RIGHT
  5733. - const Vector3 UP
  5734. - const Vector3 DOWN
  5735. - const Vector3 FORWARD
  5736. - const Vector3 BACK
  5737. - const Vector3 ONE
  5738. <a name="Class_Vector4"></a>
  5739. ### Vector4
  5740. Methods:
  5741. - Vector4() (GC)
  5742. - Vector4* new()
  5743. - Vector4(const Vector4& vector) (GC)
  5744. - Vector4* new(const Vector4& vector)
  5745. - Vector4(const Vector3& vector, float w) (GC)
  5746. - Vector4* new(const Vector3& vector, float w)
  5747. - Vector4(float x, float y, float z, float w) (GC)
  5748. - Vector4* new(float x, float y, float z, float w)
  5749. - void delete()
  5750. - bool operator==(const Vector4& rhs) const
  5751. - Vector4 operator+(const Vector4& rhs) const
  5752. - Vector4 operator-() const
  5753. - Vector4 operator-(const Vector4& rhs) const
  5754. - Vector4 operator*(float rhs) const
  5755. - Vector4 operator*(const Vector4& rhs) const
  5756. - Vector4 operator/(float rhs) const
  5757. - Vector4 operator/(const Vector4& rhs) const
  5758. - Vector4 operator/(const Vector4& rhs) const
  5759. - float DotProduct(const Vector4& rhs) const
  5760. - float AbsDotProduct(const Vector4& rhs) const
  5761. - Vector4 Abs() const
  5762. - Vector4 Lerp(const Vector4& rhs, float t) const
  5763. - bool Equals(const Vector4& rhs) const
  5764. - bool IsNaN() const
  5765. - String ToString() const
  5766. Properties:
  5767. - float x
  5768. - float y
  5769. - float z
  5770. - float w
  5771. - const Vector4 ZERO
  5772. - const Vector4 ONE
  5773. <a name="Class_VectorBuffer"></a>
  5774. ### VectorBuffer
  5775. Methods:
  5776. - VectorBuffer() (GC)
  5777. - VectorBuffer* new()
  5778. - VectorBuffer(Deserializer& source, unsigned size) (GC)
  5779. - VectorBuffer* new(Deserializer& source, unsigned size)
  5780. - void delete()
  5781. - void SetData(Deserializer& source, unsigned size)
  5782. - void Clear()
  5783. - void Resize(unsigned size)
  5784. - const void* GetData() const
  5785. - void* GetModifiableData()
  5786. - VectorBuffer Read(unsigned size)
  5787. - unsigned Seek(unsigned position)
  5788. - const String GetName() const
  5789. - unsigned GetChecksum()
  5790. - unsigned GetPosition() const
  5791. - unsigned GetSize() const
  5792. - bool IsEof() const
  5793. - int ReadInt()
  5794. - short ReadShort()
  5795. - char ReadByte()
  5796. - unsigned ReadUInt()
  5797. - short ReadUShort()
  5798. - char ReadUByte()
  5799. - bool ReadBool()
  5800. - float ReadFloat()
  5801. - double ReadDouble()
  5802. - IntRect ReadIntRect()
  5803. - IntVector2 ReadIntVector2()
  5804. - Rect ReadRect()
  5805. - Vector2 ReadVector2()
  5806. - Vector3 ReadVector3()
  5807. - Vector3 ReadPackedVector3(float maxAbsCoord)
  5808. - Vector4 ReadVector4()
  5809. - Quaternion ReadQuaternion()
  5810. - Quaternion ReadPackedQuaternion()
  5811. - Matrix3 ReadMatrix3()
  5812. - Matrix3x4 ReadMatrix3x4()
  5813. - Matrix4 ReadMatrix4()
  5814. - Color ReadColor()
  5815. - BoundingBox ReadBoundingBox()
  5816. - String ReadString()
  5817. - String ReadFileID()
  5818. - StringHash ReadStringHash()
  5819. - VectorBuffer ReadBuffer()
  5820. - ResourceRef ReadResourceRef()
  5821. - ResourceRefList ReadResourceRefList()
  5822. - Variant ReadVariant()
  5823. - Variant ReadVariant(VariantType type)
  5824. - VariantVector ReadVariantVector()
  5825. - VariantMap ReadVariantMap()
  5826. - unsigned ReadVLE()
  5827. - unsigned ReadNetID()
  5828. - String ReadLine()
  5829. - unsigned Write(const VectorBuffer& buffer)
  5830. - bool WriteInt(int value)
  5831. - bool WriteShort(short value)
  5832. - bool WriteByte(char value)
  5833. - bool WriteUInt(unsigned value)
  5834. - bool WriteUShort(short value)
  5835. - bool WriteUByte(char value)
  5836. - bool WriteBool(bool value)
  5837. - bool WriteFloat(float value)
  5838. - bool WriteDouble(double value)
  5839. - bool WriteIntRect(const IntRect& value)
  5840. - bool WriteIntVector2(const IntVector2& value)
  5841. - bool WriteRect(const Rect& value)
  5842. - bool WriteVector2(const Vector2& value)
  5843. - bool WriteVector3(const Vector3& value)
  5844. - bool WritePackedVector3(const Vector3& value, float maxAbsCoord)
  5845. - bool WriteVector4(const Vector4& value)
  5846. - bool WriteQuaternion(const Quaternion& value)
  5847. - bool WritePackedQuaternion(const Quaternion& value)
  5848. - bool WriteMatrix3(const Matrix3& value)
  5849. - bool WriteMatrix3x4(const Matrix3x4& value)
  5850. - bool WriteMatrix4(const Matrix4& value)
  5851. - bool WriteColor(const Color& value)
  5852. - bool WriteBoundingBox(const BoundingBox& value)
  5853. - bool WriteString(const String value)
  5854. - bool WriteFileID(const String value)
  5855. - bool WriteStringHash(const StringHash& value)
  5856. - bool WriteBuffer(const VectorBuffer& buffer)
  5857. - bool WriteResourceRef(const ResourceRef& value)
  5858. - bool WriteResourceRefList(const ResourceRefList& value)
  5859. - bool WriteVariant(const Variant& value)
  5860. - bool WriteVariantData(const Variant& value)
  5861. - bool WriteVariantVector(const VariantVector& value)
  5862. - bool WriteVariantMap(const VariantMap& value)
  5863. - bool WriteVLE(unsigned value)
  5864. - bool WriteNetID(unsigned value)
  5865. - bool WriteLine(const String value)
  5866. Properties:
  5867. - String name (readonly)
  5868. - unsigned checksum (readonly)
  5869. - unsigned position (readonly)
  5870. - unsigned size (readonly)
  5871. - bool eof (readonly)
  5872. <a name="Class_VertexBuffer"></a>
  5873. ### VertexBuffer : Object
  5874. Methods:
  5875. - VertexBuffer() (GC)
  5876. - VertexBuffer* new()
  5877. - void delete()
  5878. - void SetShadowed(bool enable)
  5879. - bool SetSize(unsigned vertexCount, unsigned elementMask, bool dynamic = false)
  5880. - bool SetData(VectorBuffer& data)
  5881. - bool SetDataRange(VectorBuffer& data, unsigned start, unsigned count, bool discard = false)
  5882. - VectorBuffer GetData()
  5883. - bool IsShadowed() const
  5884. - bool IsDynamic() const
  5885. - unsigned GetVertexCount() const
  5886. - unsigned GetVertexSize() const
  5887. - unsigned GetElementMask() const
  5888. Properties:
  5889. - bool shadowed
  5890. - bool dynamic (readonly)
  5891. - unsigned vertexCount (readonly)
  5892. - unsigned vertexSize (readonly)
  5893. - unsigned elementMask (readonly)
  5894. <a name="Class_View3D"></a>
  5895. ### View3D : Window
  5896. Methods:
  5897. - View3D() (GC)
  5898. - View3D* new()
  5899. - void delete()
  5900. - void SetView(Scene* scene, Camera* camera, bool ownScene = true)
  5901. - void SetFormat(unsigned format)
  5902. - void SetAutoUpdate(bool enable)
  5903. - void QueueUpdate()
  5904. - unsigned GetFormat() const
  5905. - bool GetAutoUpdate() const
  5906. - Scene* GetScene() const
  5907. - Node* GetCameraNode() const
  5908. - Texture2D* GetRenderTexture() const
  5909. - Texture2D* GetDepthTexture() const
  5910. - Viewport* GetViewport() const
  5911. Properties:
  5912. - unsigned format
  5913. - bool autoUpdate
  5914. <a name="Class_Viewport"></a>
  5915. ### Viewport
  5916. Methods:
  5917. - Viewport() (GC)
  5918. - Viewport* new()
  5919. - Viewport(Scene* scene, Camera* camera, RenderPath* renderPath = 0) (GC)
  5920. - Viewport* new(Scene* scene, Camera* camera, RenderPath* renderPath = 0)
  5921. - Viewport(Scene* scene, Camera* camera, const IntRect& rect, RenderPath* renderPath = 0) (GC)
  5922. - Viewport* new(Scene* scene, Camera* camera, const IntRect& rect, RenderPath* renderPath = 0)
  5923. - void delete()
  5924. - void SetScene(Scene* scene)
  5925. - void SetCamera(Camera* camera)
  5926. - void SetCullCamera(Camera* camera)
  5927. - void SetRect(const IntRect& rect)
  5928. - void SetRenderPath(RenderPath* path)
  5929. - void SetRenderPath(XMLFile* file)
  5930. - void SetDrawDebug(bool enable)
  5931. - Scene* GetScene() const
  5932. - Camera* GetCamera() const
  5933. - Camera* GetCullCamera() const
  5934. - const IntRect& GetRect() const
  5935. - RenderPath* GetRenderPath() const
  5936. - bool GetDrawDebug() const
  5937. - Ray GetScreenRay(int x, int y) const
  5938. - IntVector2 WorldToScreenPoint(const Vector3& worldPos) const
  5939. - Vector3 ScreenToWorldPoint(int x, int y, float depth) const
  5940. Properties:
  5941. - Scene* scene
  5942. - Camera* camera
  5943. - Camera* cullCamera
  5944. - IntRect& rect
  5945. - RenderPath* renderPath
  5946. - bool drawDebug
  5947. <a name="Class_Window"></a>
  5948. ### Window : BorderImage
  5949. Methods:
  5950. - Window() (GC)
  5951. - Window* new()
  5952. - void delete()
  5953. - void SetMovable(bool enable)
  5954. - void SetResizable(bool enable)
  5955. - void SetFixedWidthResizing(bool enable)
  5956. - void SetFixedHeightResizing(bool enable)
  5957. - void SetResizeBorder(const IntRect& rect)
  5958. - void SetModal(bool modal)
  5959. - void SetModalShadeColor(const Color& color)
  5960. - void SetModalFrameColor(const Color& color)
  5961. - void SetModalFrameSize(const IntVector2& size)
  5962. - void SetModalAutoDismiss(bool enable)
  5963. - bool IsMovable() const
  5964. - bool IsResizable() const
  5965. - bool GetFixedWidthResizing() const
  5966. - bool GetFixedHeightResizing() const
  5967. - const IntRect& GetResizeBorder() const
  5968. - bool IsModal() const
  5969. - const Color& GetModalShadeColor() const
  5970. - const Color& GetModalFrameColor() const
  5971. - const IntVector2& GetModalFrameSize() const
  5972. - bool GetModalAutoDismiss() const
  5973. Properties:
  5974. - bool movable
  5975. - bool resizable
  5976. - bool fixedWidthResizing
  5977. - bool fixedHeightResizing
  5978. - IntRect& resizeBorder
  5979. - bool modal
  5980. - Color& modalShadeColor
  5981. - Color& modalFrameColor
  5982. - IntVector2& modalFrameSize
  5983. - bool modalAutoDismiss
  5984. <a name="Class_XMLElement"></a>
  5985. ### XMLElement
  5986. Methods:
  5987. - XMLElement CreateChild(const String name)
  5988. - bool RemoveChild(const XMLElement& element)
  5989. - bool RemoveChild(const String name)
  5990. - bool RemoveChildren(const String name = String::EMPTY)
  5991. - bool RemoveAttribute(const String name = String::EMPTY)
  5992. - bool SetValue(const String value)
  5993. - bool SetAttribute(const String name, const String value)
  5994. - bool SetAttribute(const String value)
  5995. - bool SetBool(const String name, bool value)
  5996. - bool SetBoundingBox(const BoundingBox& value)
  5997. - bool SetColor(const String name, const Color& value)
  5998. - bool SetFloat(const String name, float value)
  5999. - bool SetDouble(const String name, double value)
  6000. - bool SetUInt(const String name, unsigned value)
  6001. - bool SetInt(const String name, int value)
  6002. - bool SetIntRect(const String name, const IntRect& value)
  6003. - bool SetIntVector2(const String name, const IntVector2& value)
  6004. - bool SetRect(const String name, const Rect& value)
  6005. - bool SetQuaternion(const String name, const Quaternion& value)
  6006. - bool SetString(const String name, const String value)
  6007. - bool SetVariant(const Variant& value)
  6008. - bool SetVariantValue(const Variant& value)
  6009. - bool SetResourceRef(const ResourceRef& value)
  6010. - bool SetResourceRefList(const ResourceRefList& value)
  6011. - bool SetVector2(const String name, const Vector2& value)
  6012. - bool SetVector3(const String name, const Vector3& value)
  6013. - bool SetVector4(const String name, const Vector4& value)
  6014. - bool SetVectorVariant(const String name, const Variant& value)
  6015. - bool SetMatrix3(const String name, const Matrix3& value)
  6016. - bool SetMatrix3x4(const String name, const Matrix3x4& value)
  6017. - bool SetMatrix4(const String name, const Matrix4& value)
  6018. - bool IsNull() const
  6019. - bool NotNull() const
  6020. - bool operatorbool() const
  6021. - String GetName() const
  6022. - bool HasChild(const String name) const
  6023. - XMLElement GetChild(const String name = String::EMPTY) const
  6024. - XMLElement GetNext(const String name = String::EMPTY) const
  6025. - XMLElement GetParent() const
  6026. - unsigned GetNumAttributes() const
  6027. - bool HasAttribute(const String name) const
  6028. - String GetValue() const
  6029. - String GetAttribute(const String name = String::EMPTY) const
  6030. - String GetAttributeLower(const String name) const
  6031. - String GetAttributeUpper(const String name) const
  6032. - Vector<String> GetAttributeNames() const
  6033. - bool GetBool(const String name) const
  6034. - BoundingBox GetBoundingBox() const
  6035. - Color GetColor(const String name) const
  6036. - float GetFloat(const String name) const
  6037. - double GetDouble(const String name) const
  6038. - unsigned GetUInt(const String name) const
  6039. - int GetInt(const String name) const
  6040. - IntRect GetIntRect(const String name) const
  6041. - IntVector2 GetIntVector2(const String name) const
  6042. - Rect GetRect(const String name) const
  6043. - Quaternion GetQuaternion(const String name) const
  6044. - Variant GetVariant() const
  6045. - Variant GetVariantValue(VariantType type) const
  6046. - ResourceRef GetResourceRef() const
  6047. - ResourceRefList GetResourceRefList() const
  6048. - VariantMap GetVariantMap() const
  6049. - Vector2 GetVector2(const String name) const
  6050. - Vector3 GetVector3(const String name) const
  6051. - Vector4 GetVector4(const String name) const
  6052. - Vector4 GetVector(const String name) const
  6053. - Matrix3 GetMatrix3(const String name) const
  6054. - Matrix3x4 GetMatrix3x4(const String name) const
  6055. - Matrix4 GetMatrix4(const String name) const
  6056. - XMLFile* GetFile() const
  6057. Properties:
  6058. - const XMLElement EMPTY
  6059. - bool null (readonly)
  6060. - String name (readonly)
  6061. - XMLElement parent (readonly)
  6062. - String value (readonly)
  6063. - unsigned numAttributes (readonly)
  6064. - XMLFile* file (readonly)
  6065. <a name="Class_XMLFile"></a>
  6066. ### XMLFile : Resource
  6067. Methods:
  6068. - XMLFile() (GC)
  6069. - XMLFile* new()
  6070. - void delete()
  6071. - bool FromString(const String source)
  6072. - XMLElement CreateRoot(const String name = String::EMPTY)
  6073. - XMLElement GetRoot(const String name = String::EMPTY)
  6074. - String ToString(const String indentation = "\t") const
  6075. - void Patch(XMLFile* patchFile)
  6076. - void Patch(XMLElement patchElement)
  6077. - bool Save(const String fileName, const String indentation = "\t") const
  6078. <a name="Class_Zone"></a>
  6079. ### Zone : Drawable
  6080. Methods:
  6081. - void SetBoundingBox(const BoundingBox& box)
  6082. - void SetAmbientColor(const Color& color)
  6083. - void SetFogColor(const Color& color)
  6084. - void SetFogStart(float start)
  6085. - void SetFogEnd(float end)
  6086. - void SetFogHeight(float height)
  6087. - void SetFogHeightScale(float scale)
  6088. - void SetPriority(int priority)
  6089. - void SetHeightFog(bool enable)
  6090. - void SetOverride(bool enable)
  6091. - void SetAmbientGradient(bool enable)
  6092. - void SetZoneTexture(Texture* texture)
  6093. - const Matrix3x4& GetInverseWorldTransform() const
  6094. - const Color& GetAmbientColor() const
  6095. - const Color& GetAmbientStartColor()
  6096. - const Color& GetAmbientEndColor()
  6097. - const Color& GetFogColor() const
  6098. - float GetFogStart() const
  6099. - float GetFogEnd() const
  6100. - float GetFogHeight() const
  6101. - float GetFogHeightScale() const
  6102. - int GetPriority() const
  6103. - bool GetHeightFog() const
  6104. - bool GetOverride() const
  6105. - bool GetAmbientGradient() const
  6106. - Texture* GetZoneTexture() const
  6107. - bool IsInside(const Vector3& point) const
  6108. Properties:
  6109. - BoundingBox& boundingBox
  6110. - Matrix3x4& inverseWorldTransform (readonly)
  6111. - Color& ambientColor
  6112. - Color& ambientStartColor (readonly)
  6113. - Color& ambientEndColor (readonly)
  6114. - Color& fogColor
  6115. - float fogStart
  6116. - float fogEnd
  6117. - float fogHeight
  6118. - float fogHeightScale
  6119. - int priority
  6120. - bool heightFog
  6121. - bool override
  6122. - bool ambientGradient
  6123. - Texture* zoneTexture
  6124. \section LuaScriptAPI_Enums Enumerations
  6125. ### BlendMode
  6126. - int BLEND_REPLACE
  6127. - int BLEND_ADD
  6128. - int BLEND_MULTIPLY
  6129. - int BLEND_ALPHA
  6130. - int BLEND_ADDALPHA
  6131. - int BLEND_PREMULALPHA
  6132. - int BLEND_INVDESTALPHA
  6133. - int BLEND_SUBTRACT
  6134. - int BLEND_SUBTRACTALPHA
  6135. - int MAX_BLENDMODES
  6136. ### BodyType2D
  6137. - int BT_STATIC
  6138. - int BT_KINEMATIC
  6139. - int BT_DYNAMIC
  6140. ### CollisionEventMode
  6141. - int COLLISION_NEVER
  6142. - int COLLISION_ACTIVE
  6143. - int COLLISION_ALWAYS
  6144. ### CompareMode
  6145. - int CMP_ALWAYS
  6146. - int CMP_EQUAL
  6147. - int CMP_NOTEQUAL
  6148. - int CMP_LESS
  6149. - int CMP_LESSEQUAL
  6150. - int CMP_GREATER
  6151. - int CMP_GREATEREQUAL
  6152. - int MAX_COMPAREMODES
  6153. ### CompressedFormat
  6154. - int CF_NONE
  6155. - int CF_RGBA
  6156. - int CF_DXT1
  6157. - int CF_DXT3
  6158. - int CF_DXT5
  6159. - int CF_ETC1
  6160. - int CF_PVRTC_RGB_2BPP
  6161. - int CF_PVRTC_RGBA_2BPP
  6162. - int CF_PVRTC_RGB_4BPP
  6163. - int CF_PVRTC_RGBA_4BPP
  6164. ### ConstraintType
  6165. - int CONSTRAINT_POINT
  6166. - int CONSTRAINT_HINGE
  6167. - int CONSTRAINT_SLIDER
  6168. - int CONSTRAINT_CONETWIST
  6169. ### Corner
  6170. - int C_TOPLEFT
  6171. - int C_TOPRIGHT
  6172. - int C_BOTTOMLEFT
  6173. - int C_BOTTOMRIGHT
  6174. - int MAX_UIELEMENT_CORNERS
  6175. ### CreateMode
  6176. - int REPLICATED
  6177. - int LOCAL
  6178. ### CrowdAgentRequestedTarget
  6179. - int CA_REQUESTEDTARGET_NONE
  6180. - int CA_REQUESTEDTARGET_POSITION
  6181. - int CA_REQUESTEDTARGET_VELOCITY
  6182. ### CrowdAgentState
  6183. - int CA_STATE_INVALID
  6184. - int CA_STATE_WALKING
  6185. - int CA_STATE_OFFMESH
  6186. ### CrowdAgentTargetState
  6187. - int CA_TARGET_NONE
  6188. - int CA_TARGET_FAILED
  6189. - int CA_TARGET_VALID
  6190. - int CA_TARGET_REQUESTING
  6191. - int CA_TARGET_WAITINGFORQUEUE
  6192. - int CA_TARGET_WAITINGFORPATH
  6193. - int CA_TARGET_VELOCITY
  6194. ### CubeMapFace
  6195. - int FACE_POSITIVE_X
  6196. - int FACE_NEGATIVE_X
  6197. - int FACE_POSITIVE_Y
  6198. - int FACE_NEGATIVE_Y
  6199. - int FACE_POSITIVE_Z
  6200. - int FACE_NEGATIVE_Z
  6201. - int MAX_CUBEMAP_FACES
  6202. ### CullMode
  6203. - int CULL_NONE
  6204. - int CULL_CCW
  6205. - int CULL_CW
  6206. - int MAX_CULLMODES
  6207. ### CursorShape
  6208. - int CS_NORMAL
  6209. - int CS_IBEAM
  6210. - int CS_CROSS
  6211. - int CS_RESIZEVERTICAL
  6212. - int CS_RESIZEDIAGONAL_TOPRIGHT
  6213. - int CS_RESIZEHORIZONTAL
  6214. - int CS_RESIZEDIAGONAL_TOPLEFT
  6215. - int CS_RESIZE_ALL
  6216. - int CS_ACCEPTDROP
  6217. - int CS_REJECTDROP
  6218. - int CS_BUSY
  6219. - int CS_BUSY_ARROW
  6220. - int CS_MAX_SHAPES
  6221. ### DBAPI
  6222. - int DBAPI_SQLITE
  6223. - int DBAPI_ODBC
  6224. ### EmitterType
  6225. - int EMITTER_SPHERE
  6226. - int EMITTER_BOX
  6227. ### EmitterType2D
  6228. - int EMITTER_TYPE_GRAVITY
  6229. - int EMITTER_TYPE_RADIAL
  6230. ### FaceCameraMode
  6231. - int FC_NONE
  6232. - int FC_ROTATE_XYZ
  6233. - int FC_ROTATE_Y
  6234. - int FC_LOOKAT_XYZ
  6235. - int FC_LOOKAT_Y
  6236. ### FaceCameraMode
  6237. - int FC_NONE
  6238. - int FC_ROTATE_XYZ
  6239. - int FC_ROTATE_Y
  6240. - int FC_LOOKAT_XYZ
  6241. - int FC_LOOKAT_Y
  6242. ### FileMode
  6243. - int FILE_READ
  6244. - int FILE_WRITE
  6245. - int FILE_READWRITE
  6246. ### FillMode
  6247. - int FILL_SOLID
  6248. - int FILL_WIREFRAME
  6249. - int FILL_POINT
  6250. ### FocusMode
  6251. - int FM_NOTFOCUSABLE
  6252. - int FM_RESETFOCUS
  6253. - int FM_FOCUSABLE
  6254. - int FM_FOCUSABLE_DEFOCUSABLE
  6255. ### FrustumPlane
  6256. - int PLANE_NEAR
  6257. - int PLANE_LEFT
  6258. - int PLANE_RIGHT
  6259. - int PLANE_UP
  6260. - int PLANE_DOWN
  6261. - int PLANE_FAR
  6262. ### GeometryType
  6263. - int GEOM_STATIC
  6264. - int GEOM_SKINNED
  6265. - int GEOM_INSTANCED
  6266. - int GEOM_BILLBOARD
  6267. - int GEOM_STATIC_NOINSTANCING
  6268. - int MAX_GEOMETRYTYPES
  6269. ### HighlightMode
  6270. - int HM_NEVER
  6271. - int HM_FOCUS
  6272. - int HM_ALWAYS
  6273. ### HorizontalAlignment
  6274. - int HA_LEFT
  6275. - int HA_CENTER
  6276. - int HA_RIGHT
  6277. ### HttpRequestState
  6278. - int HTTP_INITIALIZING
  6279. - int HTTP_ERROR
  6280. - int HTTP_OPEN
  6281. - int HTTP_CLOSED
  6282. ### InterpMethod
  6283. - int IM_LINEAR
  6284. - int IM_SPLINE
  6285. ### InterpolationMode
  6286. - int BEZIER_CURVE
  6287. - int CATMULL_ROM_CURVE
  6288. - int LINEAR_CURVE
  6289. - int CATMULL_ROM_FULL_CURVE
  6290. ### Intersection
  6291. - int OUTSIDE
  6292. - int INTERSECTS
  6293. - int INSIDE
  6294. ### JSONValueType
  6295. - int JSON_NULL
  6296. - int JSON_BOOL
  6297. - int JSON_NUMBER
  6298. - int JSON_STRING
  6299. - int JSON_ARRAY
  6300. - int JSON_OBJECT
  6301. ### LayoutMode
  6302. - int LM_FREE
  6303. - int LM_HORIZONTAL
  6304. - int LM_VERTICAL
  6305. ### LightType
  6306. - int LIGHT_DIRECTIONAL
  6307. - int LIGHT_SPOT
  6308. - int LIGHT_POINT
  6309. ### LoadMode
  6310. - int LOAD_RESOURCES_ONLY
  6311. - int LOAD_SCENE
  6312. - int LOAD_SCENE_AND_RESOURCES
  6313. ### LockState
  6314. - int LOCK_NONE
  6315. - int LOCK_HARDWARE
  6316. - int LOCK_SHADOW
  6317. - int LOCK_SCRATCH
  6318. ### LoopMode2D
  6319. - int LM_DEFAULT
  6320. - int LM_FORCE_LOOPED
  6321. - int LM_FORCE_CLAMPED
  6322. ### MouseMode
  6323. - int MM_ABSOLUTE
  6324. - int MM_RELATIVE
  6325. - int MM_WRAP
  6326. - int MM_FREE
  6327. ### NavigationPushiness
  6328. - int NAVIGATIONPUSHINESS_LOW
  6329. - int NAVIGATIONPUSHINESS_MEDIUM
  6330. - int NAVIGATIONPUSHINESS_HIGH
  6331. ### NavigationQuality
  6332. - int NAVIGATIONQUALITY_LOW
  6333. - int NAVIGATIONQUALITY_MEDIUM
  6334. - int NAVIGATIONQUALITY_HIGH
  6335. ### NavmeshPartitionType
  6336. - int NAVMESH_PARTITION_WATERSHED
  6337. - int NAVMESH_PARTITION_MONOTONE
  6338. ### Orientation
  6339. - int O_HORIZONTAL
  6340. - int O_VERTICAL
  6341. ### Orientation2D
  6342. - int O_ORTHOGONAL
  6343. - int O_ISOMETRIC
  6344. - int O_STAGGERED
  6345. ### PassLightingMode
  6346. - int LIGHTING_UNLIT
  6347. - int LIGHTING_PERVERTEX
  6348. - int LIGHTING_PERPIXEL
  6349. ### PrimitiveType
  6350. - int TRIANGLE_LIST
  6351. - int LINE_LIST
  6352. - int POINT_LIST
  6353. - int TRIANGLE_STRIP
  6354. - int LINE_STRIP
  6355. - int TRIANGLE_FAN
  6356. ### RayQueryLevel
  6357. - int RAY_AABB
  6358. - int RAY_OBB
  6359. - int RAY_TRIANGLE
  6360. - int RAY_TRIANGLE_UV
  6361. ### RenderCommandSortMode
  6362. - int SORT_FRONTTOBACK
  6363. - int SORT_BACKTOFRONT
  6364. ### RenderCommandType
  6365. - int CMD_NONE
  6366. - int CMD_CLEAR
  6367. - int CMD_SCENEPASS
  6368. - int CMD_QUAD
  6369. - int CMD_FORWARDLIGHTS
  6370. - int CMD_LIGHTVOLUMES
  6371. - int CMD_RENDERUI
  6372. ### RenderSurfaceUpdateMode
  6373. - int SURFACE_MANUALUPDATE
  6374. - int SURFACE_UPDATEVISIBLE
  6375. - int SURFACE_UPDATEALWAYS
  6376. ### RenderTargetSizeMode
  6377. - int SIZE_ABSOLUTE
  6378. - int SIZE_VIEWPORTDIVISOR
  6379. - int SIZE_VIEWPORTMULTIPLIER
  6380. ### ShaderType
  6381. - int VS
  6382. - int PS
  6383. ### ShapeType
  6384. - int SHAPE_BOX
  6385. - int SHAPE_SPHERE
  6386. - int SHAPE_STATICPLANE
  6387. - int SHAPE_CYLINDER
  6388. - int SHAPE_CAPSULE
  6389. - int SHAPE_CONE
  6390. - int SHAPE_TRIANGLEMESH
  6391. - int SHAPE_CONVEXHULL
  6392. - int SHAPE_TERRAIN
  6393. ### StencilOp
  6394. - int OP_KEEP
  6395. - int OP_ZERO
  6396. - int OP_REF
  6397. - int OP_INCR
  6398. - int OP_DECR
  6399. ### TextEffect
  6400. - int TE_NONE
  6401. - int TE_SHADOW
  6402. - int TE_STROKE
  6403. ### TextureAddressMode
  6404. - int ADDRESS_WRAP
  6405. - int ADDRESS_MIRROR
  6406. - int ADDRESS_CLAMP
  6407. - int ADDRESS_BORDER
  6408. - int MAX_ADDRESSMODES
  6409. ### TextureCoordinate
  6410. - int COORD_U
  6411. - int COORD_V
  6412. - int COORD_W
  6413. - int MAX_COORDS
  6414. ### TextureFilterMode
  6415. - int FILTER_NEAREST
  6416. - int FILTER_BILINEAR
  6417. - int FILTER_TRILINEAR
  6418. - int FILTER_ANISOTROPIC
  6419. - int FILTER_DEFAULT
  6420. - int MAX_FILTERMODES
  6421. ### TextureUnit
  6422. - int TU_DIFFUSE
  6423. - int TU_ALBEDOBUFFER
  6424. - int TU_NORMAL
  6425. - int TU_NORMALBUFFER
  6426. - int TU_SPECULAR
  6427. - int TU_EMISSIVE
  6428. - int TU_ENVIRONMENT
  6429. ### TextureUsage
  6430. - int TEXTURE_STATIC
  6431. - int TEXTURE_DYNAMIC
  6432. - int TEXTURE_RENDERTARGET
  6433. - int TEXTURE_DEPTHSTENCIL
  6434. ### TileMapLayerType2D
  6435. - int LT_TILE_LAYER
  6436. - int LT_OBJECT_GROUP
  6437. - int LT_IMAGE_LAYER
  6438. - int LT_INVALID
  6439. ### TileMapObjectType2D
  6440. - int OT_RECTANGLE
  6441. - int OT_ELLIPSE
  6442. - int OT_POLYGON
  6443. - int OT_POLYLINE
  6444. - int OT_TILE
  6445. - int OT_INVALID
  6446. ### TransformSpace
  6447. - int TS_LOCAL
  6448. - int TS_PARENT
  6449. - int TS_WORLD
  6450. ### TraversalMode
  6451. - int TM_BREADTH_FIRST
  6452. - int TM_DEPTH_FIRST
  6453. ### VariantType
  6454. - int VAR_NONE
  6455. - int VAR_INT
  6456. - int VAR_BOOL
  6457. - int VAR_FLOAT
  6458. - int VAR_VECTOR2
  6459. - int VAR_VECTOR3
  6460. - int VAR_VECTOR4
  6461. - int VAR_QUATERNION
  6462. - int VAR_COLOR
  6463. - int VAR_STRING
  6464. - int VAR_BUFFER
  6465. - int VAR_VOIDPTR
  6466. - int VAR_RESOURCEREF
  6467. - int VAR_RESOURCEREFLIST
  6468. - int VAR_VARIANTVECTOR
  6469. - int VAR_VARIANTMAP
  6470. - int VAR_INTRECT
  6471. - int VAR_INTVECTOR2
  6472. - int VAR_PTR
  6473. - int VAR_MATRIX3
  6474. - int VAR_MATRIX3X4
  6475. - int VAR_MATRIX4
  6476. - int VAR_DOUBLE
  6477. - int VAR_STRINGVECTOR
  6478. - int MAX_VAR_TYPES
  6479. ### VertexElement
  6480. - int ELEMENT_POSITION
  6481. - int ELEMENT_NORMAL
  6482. - int ELEMENT_COLOR
  6483. - int ELEMENT_TEXCOORD1
  6484. - int ELEMENT_TEXCOORD2
  6485. - int ELEMENT_CUBETEXCOORD1
  6486. - int ELEMENT_CUBETEXCOORD2
  6487. - int ELEMENT_TANGENT
  6488. - int ELEMENT_BLENDWEIGHTS
  6489. - int ELEMENT_BLENDINDICES
  6490. - int ELEMENT_INSTANCEMATRIX1
  6491. - int ELEMENT_INSTANCEMATRIX2
  6492. - int ELEMENT_INSTANCEMATRIX3
  6493. - int MAX_VERTEX_ELEMENTS
  6494. ### VerticalAlignment
  6495. - int VA_TOP
  6496. - int VA_CENTER
  6497. - int VA_BOTTOM
  6498. ### WindowDragMode
  6499. - int DRAG_NONE
  6500. - int DRAG_MOVE
  6501. - int DRAG_RESIZE_TOPLEFT
  6502. - int DRAG_RESIZE_TOP
  6503. - int DRAG_RESIZE_TOPRIGHT
  6504. - int DRAG_RESIZE_RIGHT
  6505. - int DRAG_RESIZE_BOTTOMRIGHT
  6506. - int DRAG_RESIZE_BOTTOM
  6507. - int DRAG_RESIZE_BOTTOMLEFT
  6508. - int DRAG_RESIZE_LEFT
  6509. ### WrapMode
  6510. - int WM_LOOP
  6511. - int WM_ONCE
  6512. - int WM_CLAMP
  6513. \section LuaScriptAPI_toluaFunctions tolua functions
  6514. - lua_usertype cast(lua_usertype object, const char* typename)
  6515. - lua_table getpeer(lua_userdata object)
  6516. - void inherit(lua_table table, lua_usertype c_instance)
  6517. - bool releaseownership(lua_usertype object)
  6518. - void setpeer(lua_userdata object, lua_table table)
  6519. - bool takeownership(lua_usertype object)
  6520. - const char* type(lua_object object)
  6521. \section LuaScriptAPI_GlobalFunctions Global functions
  6522. - float Abs(float value)
  6523. - int AbsInt(int value)
  6524. - float Acos(float x)
  6525. - String AddTrailingSlash(const String pathName)
  6526. - float Asin(float x)
  6527. - float Atan(float x)
  6528. - float Atan2(float y, float x)
  6529. - float Clamp(float value, float min, float max)
  6530. - int ClampInt(int value, int min, int max)
  6531. - VectorBuffer CompressVectorBuffer(VectorBuffer& src)
  6532. - float Cos(float angle)
  6533. - unsigned CountSetBits(unsigned value)
  6534. - VectorBuffer DecompressVectorBuffer(VectorBuffer& src)
  6535. - bool Equals(float lhs, float rhs)
  6536. - void ErrorDialog(const String title, const String message)
  6537. - void ErrorExit(const String message = String::EMPTY, int exitCode = EXIT_FAILURE)
  6538. - const Vector<String>& GetArguments()
  6539. - Audio* GetAudio()
  6540. - ResourceCache* GetCache()
  6541. - Console* GetConsole()
  6542. - String GetConsoleInput()
  6543. - Context* GetContext()
  6544. - DBAPI GetDBAPI()
  6545. - Database* GetDatabase()
  6546. - DebugHud* GetDebugHud()
  6547. - Engine* GetEngine()
  6548. - EventHandler* GetEventHandler() const
  6549. - Object* GetEventSender()
  6550. - bool GetExecuteConsoleCommands()
  6551. - String GetExtension(const String fullPath, bool lowercaseExtension = true)
  6552. - String GetFileName(const String fullPath)
  6553. - String GetFileNameAndExtension(const String fullPath, bool lowercaseExtension = false)
  6554. - FileSystem* GetFileSystem()
  6555. - Graphics* GetGraphics()
  6556. - Input* GetInput()
  6557. - String GetInternalPath(const String pathName)
  6558. - Localization* GetLocalization()
  6559. - Log* GetLog()
  6560. - String GetNativePath(const String pathName)
  6561. - Network* GetNetwork()
  6562. - unsigned GetNumLogicalCPUs()
  6563. - unsigned GetNumPhysicalCPUs()
  6564. - String GetParentPath(const String pathName)
  6565. - String GetPath(const String fullPath)
  6566. - String GetPlatform()
  6567. - unsigned GetRandomSeed()
  6568. - Renderer* GetRenderer()
  6569. - Time* GetTime()
  6570. - UI* GetUI()
  6571. - bool IsAbsolutePath(const String pathName)
  6572. - bool IsAlpha(unsigned ch)
  6573. - bool IsDigit(unsigned ch)
  6574. - bool IsNaN(float value)
  6575. - bool IsPowerOfTwo(unsigned value)
  6576. - float Lerp(float lhs, float rhs, float t)
  6577. - float Max(float lhs, float rhs)
  6578. - int MaxInt(int lhs, int rhs)
  6579. - float Min(float lhs, float rhs)
  6580. - int MinInt(int lhs, int rhs)
  6581. - unsigned NextPowerOfTwo(unsigned value)
  6582. - void OpenConsoleWindow()
  6583. - void PrintLine(const String str, bool error = false)
  6584. - int Rand()
  6585. - float RandStandardNormal()
  6586. - float Random()
  6587. - float Random(float range)
  6588. - float Random(float min, float max)
  6589. - int RandomInt(int min, int max)
  6590. - int RandomInt(int range)
  6591. - float RandomNormal(float meanValue, float variance)
  6592. - String RemoveTrailingSlash(const String pathName)
  6593. - String ReplaceExtension(const String fullPath, const String newExtension)
  6594. - unsigned SDBMHash(unsigned hash, char c)
  6595. - void SendEvent(const String eventName, VariantMap& eventData)
  6596. - void SetExecuteConsoleCommands(bool enable)
  6597. - void SetRandomSeed(unsigned seed)
  6598. - float Sign(float value)
  6599. - float Sin(float angle)
  6600. - float SmoothStep(float lhs, float rhs, float t)
  6601. - void SubscribeToEvent(void* sender, const String eventName, void* functionOrFunctionName)
  6602. - void SubscribeToEvent(const String eventName, void* functionOrFunctionName)
  6603. - float Tan(float angle)
  6604. - bool ToBool(const String source)
  6605. - Color ToColor(const String source)
  6606. - float ToFloat(const String source)
  6607. - int ToInt(const String source)
  6608. - IntRect ToIntRect(const String source)
  6609. - IntVector2 ToIntVector2(const String source)
  6610. - unsigned ToLower(unsigned ch)
  6611. - Matrix3 ToMatrix3(const String source)
  6612. - Matrix3x4 ToMatrix3x4(const String source)
  6613. - Matrix4 ToMatrix4(const String source)
  6614. - Quaternion ToQuaternion(const String source)
  6615. - Rect ToRect(const String source)
  6616. - String ToString(void* value)
  6617. - String ToStringHex(unsigned value)
  6618. - unsigned ToUInt(const String source)
  6619. - unsigned ToUpper(unsigned ch)
  6620. - Vector2 ToVector2(const String source)
  6621. - Vector3 ToVector3(const String source)
  6622. - Vector4 ToVector4(const String source, bool allowMissingCoords = false)
  6623. - void UnsubscribeFromAllEvents()
  6624. - void UnsubscribeFromAllEventsExcept(const Vector<String>& exceptionNames)
  6625. - void UnsubscribeFromEvent(Object* sender, const String eventName)
  6626. - void UnsubscribeFromEvent(const String eventName)
  6627. - void UnsubscribeFromEvents(Object* sender)
  6628. \section LuaScriptAPI_GlobalProperties Global properties
  6629. - Audio* audio (readonly)
  6630. - ResourceCache* cache (readonly)
  6631. - Console* console (readonly)
  6632. - Context* context (readonly)
  6633. - Database* database (readonly)
  6634. - DebugHud* debugHud (readonly)
  6635. - Engine* engine (readonly)
  6636. - EventHandler* eventHandler (readonly)
  6637. - EventSender* eventSender (readonly)
  6638. - FileSystem* fileSystem (readonly)
  6639. - Graphics* graphics (readonly)
  6640. - Input* input (readonly)
  6641. - Localization* localization (readonly)
  6642. - Log* log (readonly)
  6643. - Network* network (readonly)
  6644. - Renderer* renderer (readonly)
  6645. - Time* time (readonly)
  6646. - UI* ui (readonly)
  6647. \section LuaScriptAPI_GlobalConstants Global constants
  6648. - float ANIMATION_LOD_BASESCALE
  6649. - char CHANNEL_POSITION
  6650. - char CHANNEL_ROTATION
  6651. - char CHANNEL_SCALE
  6652. - unsigned CLEAR_COLOR
  6653. - unsigned CLEAR_DEPTH
  6654. - unsigned CLEAR_STENCIL
  6655. - int CONTROLLER_AXIS_LEFTX
  6656. - int CONTROLLER_AXIS_LEFTY
  6657. - int CONTROLLER_AXIS_RIGHTX
  6658. - int CONTROLLER_AXIS_RIGHTY
  6659. - int CONTROLLER_AXIS_TRIGGERLEFT
  6660. - int CONTROLLER_AXIS_TRIGGERRIGHT
  6661. - int CONTROLLER_BUTTON_A
  6662. - int CONTROLLER_BUTTON_B
  6663. - int CONTROLLER_BUTTON_BACK
  6664. - int CONTROLLER_BUTTON_DPAD_DOWN
  6665. - int CONTROLLER_BUTTON_DPAD_LEFT
  6666. - int CONTROLLER_BUTTON_DPAD_RIGHT
  6667. - int CONTROLLER_BUTTON_DPAD_UP
  6668. - int CONTROLLER_BUTTON_GUIDE
  6669. - int CONTROLLER_BUTTON_LEFTSHOULDER
  6670. - int CONTROLLER_BUTTON_LEFTSTICK
  6671. - int CONTROLLER_BUTTON_RIGHTSHOULDER
  6672. - int CONTROLLER_BUTTON_RIGHTSTICK
  6673. - int CONTROLLER_BUTTON_START
  6674. - int CONTROLLER_BUTTON_X
  6675. - int CONTROLLER_BUTTON_Y
  6676. - unsigned DD_DISABLED
  6677. - unsigned DD_SOURCE
  6678. - unsigned DD_SOURCE_AND_TARGET
  6679. - unsigned DD_TARGET
  6680. - unsigned DEBUGHUD_SHOW_ALL
  6681. - unsigned DEBUGHUD_SHOW_MODE
  6682. - unsigned DEBUGHUD_SHOW_NONE
  6683. - unsigned DEBUGHUD_SHOW_PROFILER
  6684. - unsigned DEBUGHUD_SHOW_STATS
  6685. - unsigned DEFAULT_LIGHTMASK
  6686. - unsigned DEFAULT_SHADOWMASK
  6687. - unsigned DEFAULT_VIEWMASK
  6688. - unsigned DEFAULT_ZONEMASK
  6689. - unsigned DRAWABLE_ANY
  6690. - unsigned DRAWABLE_GEOMETRY
  6691. - unsigned DRAWABLE_GEOMETRY2D
  6692. - unsigned DRAWABLE_LIGHT
  6693. - unsigned DRAWABLE_ZONE
  6694. - unsigned FIRST_LOCAL_ID
  6695. - unsigned FIRST_REPLICATED_ID
  6696. - int HAT_CENTER
  6697. - int HAT_DOWN
  6698. - int HAT_LEFT
  6699. - int HAT_RIGHT
  6700. - int HAT_UP
  6701. - int KEY_0
  6702. - int KEY_1
  6703. - int KEY_2
  6704. - int KEY_3
  6705. - int KEY_4
  6706. - int KEY_5
  6707. - int KEY_6
  6708. - int KEY_7
  6709. - int KEY_8
  6710. - int KEY_9
  6711. - int KEY_A
  6712. - int KEY_ALT
  6713. - int KEY_APPLICATION
  6714. - int KEY_B
  6715. - int KEY_BACKSPACE
  6716. - int KEY_C
  6717. - int KEY_CAPSLOCK
  6718. - int KEY_CTRL
  6719. - int KEY_D
  6720. - int KEY_DELETE
  6721. - int KEY_DOWN
  6722. - int KEY_E
  6723. - int KEY_END
  6724. - int KEY_ESC
  6725. - int KEY_F
  6726. - int KEY_F1
  6727. - int KEY_F10
  6728. - int KEY_F11
  6729. - int KEY_F12
  6730. - int KEY_F13
  6731. - int KEY_F14
  6732. - int KEY_F15
  6733. - int KEY_F16
  6734. - int KEY_F17
  6735. - int KEY_F18
  6736. - int KEY_F19
  6737. - int KEY_F2
  6738. - int KEY_F20
  6739. - int KEY_F21
  6740. - int KEY_F22
  6741. - int KEY_F23
  6742. - int KEY_F24
  6743. - int KEY_F3
  6744. - int KEY_F4
  6745. - int KEY_F5
  6746. - int KEY_F6
  6747. - int KEY_F7
  6748. - int KEY_F8
  6749. - int KEY_F9
  6750. - int KEY_G
  6751. - int KEY_GUI
  6752. - int KEY_H
  6753. - int KEY_HOME
  6754. - int KEY_I
  6755. - int KEY_INSERT
  6756. - int KEY_J
  6757. - int KEY_K
  6758. - int KEY_KP_0
  6759. - int KEY_KP_1
  6760. - int KEY_KP_2
  6761. - int KEY_KP_3
  6762. - int KEY_KP_4
  6763. - int KEY_KP_5
  6764. - int KEY_KP_6
  6765. - int KEY_KP_7
  6766. - int KEY_KP_8
  6767. - int KEY_KP_9
  6768. - int KEY_KP_DIVIDE
  6769. - int KEY_KP_ENTER
  6770. - int KEY_KP_MINUS
  6771. - int KEY_KP_MULTIPLY
  6772. - int KEY_KP_PERIOD
  6773. - int KEY_KP_PLUS
  6774. - int KEY_L
  6775. - int KEY_LALT
  6776. - int KEY_LCTRL
  6777. - int KEY_LEFT
  6778. - int KEY_LGUI
  6779. - int KEY_LSHIFT
  6780. - int KEY_M
  6781. - int KEY_N
  6782. - int KEY_NUMLOCKCLEAR
  6783. - int KEY_O
  6784. - int KEY_P
  6785. - int KEY_PAGEDOWN
  6786. - int KEY_PAGEUP
  6787. - int KEY_PAUSE
  6788. - int KEY_PRINTSCREEN
  6789. - int KEY_Q
  6790. - int KEY_R
  6791. - int KEY_RALT
  6792. - int KEY_RCTRL
  6793. - int KEY_RETURN
  6794. - int KEY_RETURN2
  6795. - int KEY_RGUI
  6796. - int KEY_RIGHT
  6797. - int KEY_RSHIFT
  6798. - int KEY_S
  6799. - int KEY_SCROLLLOCK
  6800. - int KEY_SELECT
  6801. - int KEY_SHIFT
  6802. - int KEY_SPACE
  6803. - int KEY_T
  6804. - int KEY_TAB
  6805. - int KEY_U
  6806. - int KEY_UP
  6807. - int KEY_V
  6808. - int KEY_W
  6809. - int KEY_X
  6810. - int KEY_Y
  6811. - int KEY_Z
  6812. - unsigned LAST_LOCAL_ID
  6813. - unsigned LAST_REPLICATED_ID
  6814. - int LOG_DEBUG
  6815. - int LOG_ERROR
  6816. - int LOG_INFO
  6817. - int LOG_NONE
  6818. - int LOG_WARNING
  6819. - unsigned MASK_BLENDINDICES
  6820. - unsigned MASK_BLENDWEIGHTS
  6821. - unsigned MASK_COLOR
  6822. - unsigned MASK_CUBETEXCOORD1
  6823. - unsigned MASK_CUBETEXCOORD2
  6824. - unsigned MASK_DEFAULT
  6825. - unsigned MASK_INSTANCEMATRIX1
  6826. - unsigned MASK_INSTANCEMATRIX2
  6827. - unsigned MASK_INSTANCEMATRIX3
  6828. - unsigned MASK_NONE
  6829. - unsigned MASK_NORMAL
  6830. - unsigned MASK_POSITION
  6831. - unsigned MASK_TANGENT
  6832. - unsigned MASK_TEXCOORD1
  6833. - unsigned MASK_TEXCOORD2
  6834. - int MAX_VERTEX_LIGHTS
  6835. - int MOUSEB_LEFT
  6836. - int MOUSEB_MIDDLE
  6837. - int MOUSEB_RIGHT
  6838. - float M_DEGTORAD
  6839. - float M_DEGTORAD_2
  6840. - float M_EPSILON
  6841. - float M_HALF_PI
  6842. - float M_INFINITY
  6843. - float M_LARGE_EPSILON
  6844. - float M_LARGE_VALUE
  6845. - float M_MAX_FOV
  6846. - int M_MAX_INT
  6847. - unsigned M_MAX_UNSIGNED
  6848. - int M_MIN_INT
  6849. - float M_MIN_NEARCLIP
  6850. - unsigned M_MIN_UNSIGNED
  6851. - float M_PI
  6852. - float M_RADTODEG
  6853. - unsigned NUM_FRUSTUM_PLANES
  6854. - unsigned NUM_FRUSTUM_VERTICES
  6855. - float PIXEL_SIZE
  6856. - int QUALITY_HIGH
  6857. - int QUALITY_LOW
  6858. - int QUALITY_MAX
  6859. - int QUALITY_MEDIUM
  6860. - int QUAL_ALT
  6861. - int QUAL_ANY
  6862. - int QUAL_CTRL
  6863. - int QUAL_SHIFT
  6864. - int SCANCODE_0
  6865. - int SCANCODE_1
  6866. - int SCANCODE_2
  6867. - int SCANCODE_3
  6868. - int SCANCODE_4
  6869. - int SCANCODE_5
  6870. - int SCANCODE_6
  6871. - int SCANCODE_7
  6872. - int SCANCODE_8
  6873. - int SCANCODE_9
  6874. - int SCANCODE_A
  6875. - int SCANCODE_AC_BACK
  6876. - int SCANCODE_AC_BOOKMARKS
  6877. - int SCANCODE_AC_FORWARD
  6878. - int SCANCODE_AC_HOME
  6879. - int SCANCODE_AC_REFRESH
  6880. - int SCANCODE_AC_SEARCH
  6881. - int SCANCODE_AC_STOP
  6882. - int SCANCODE_AGAIN
  6883. - int SCANCODE_ALT
  6884. - int SCANCODE_ALTERASE
  6885. - int SCANCODE_APOSTROPHE
  6886. - int SCANCODE_APP1
  6887. - int SCANCODE_APP2
  6888. - int SCANCODE_APPLICATION
  6889. - int SCANCODE_AUDIOMUTE
  6890. - int SCANCODE_AUDIONEXT
  6891. - int SCANCODE_AUDIOPLAY
  6892. - int SCANCODE_AUDIOPREV
  6893. - int SCANCODE_AUDIOSTOP
  6894. - int SCANCODE_B
  6895. - int SCANCODE_BACKSLASH
  6896. - int SCANCODE_BACKSPACE
  6897. - int SCANCODE_BRIGHTNESSDOWN
  6898. - int SCANCODE_BRIGHTNESSUP
  6899. - int SCANCODE_C
  6900. - int SCANCODE_CALCULATOR
  6901. - int SCANCODE_CANCEL
  6902. - int SCANCODE_CAPSLOCK
  6903. - int SCANCODE_CLEAR
  6904. - int SCANCODE_CLEARAGAIN
  6905. - int SCANCODE_COMMA
  6906. - int SCANCODE_COMPUTER
  6907. - int SCANCODE_COPY
  6908. - int SCANCODE_CRSEL
  6909. - int SCANCODE_CTRL
  6910. - int SCANCODE_CURRENCYSUBUNIT
  6911. - int SCANCODE_CURRENCYUNIT
  6912. - int SCANCODE_CUT
  6913. - int SCANCODE_D
  6914. - int SCANCODE_DECIMALSEPARATOR
  6915. - int SCANCODE_DELETE
  6916. - int SCANCODE_DISPLAYSWITCH
  6917. - int SCANCODE_DOWN
  6918. - int SCANCODE_E
  6919. - int SCANCODE_EJECT
  6920. - int SCANCODE_END
  6921. - int SCANCODE_EQUALS
  6922. - int SCANCODE_ESCAPE
  6923. - int SCANCODE_EXECUTE
  6924. - int SCANCODE_EXSEL
  6925. - int SCANCODE_F
  6926. - int SCANCODE_F1
  6927. - int SCANCODE_F10
  6928. - int SCANCODE_F11
  6929. - int SCANCODE_F12
  6930. - int SCANCODE_F13
  6931. - int SCANCODE_F14
  6932. - int SCANCODE_F15
  6933. - int SCANCODE_F16
  6934. - int SCANCODE_F17
  6935. - int SCANCODE_F18
  6936. - int SCANCODE_F19
  6937. - int SCANCODE_F2
  6938. - int SCANCODE_F20
  6939. - int SCANCODE_F21
  6940. - int SCANCODE_F22
  6941. - int SCANCODE_F23
  6942. - int SCANCODE_F24
  6943. - int SCANCODE_F3
  6944. - int SCANCODE_F4
  6945. - int SCANCODE_F5
  6946. - int SCANCODE_F6
  6947. - int SCANCODE_F7
  6948. - int SCANCODE_F8
  6949. - int SCANCODE_F9
  6950. - int SCANCODE_FIND
  6951. - int SCANCODE_G
  6952. - int SCANCODE_GRAVE
  6953. - int SCANCODE_GUI
  6954. - int SCANCODE_H
  6955. - int SCANCODE_HELP
  6956. - int SCANCODE_HOME
  6957. - int SCANCODE_I
  6958. - int SCANCODE_INSERT
  6959. - int SCANCODE_INTERNATIONAL1
  6960. - int SCANCODE_INTERNATIONAL2
  6961. - int SCANCODE_INTERNATIONAL3
  6962. - int SCANCODE_INTERNATIONAL4
  6963. - int SCANCODE_INTERNATIONAL5
  6964. - int SCANCODE_INTERNATIONAL6
  6965. - int SCANCODE_INTERNATIONAL7
  6966. - int SCANCODE_INTERNATIONAL8
  6967. - int SCANCODE_INTERNATIONAL9
  6968. - int SCANCODE_J
  6969. - int SCANCODE_K
  6970. - int SCANCODE_KBDILLUMDOWN
  6971. - int SCANCODE_KBDILLUMTOGGLE
  6972. - int SCANCODE_KBDILLUMUP
  6973. - int SCANCODE_KP_0
  6974. - int SCANCODE_KP_00
  6975. - int SCANCODE_KP_000
  6976. - int SCANCODE_KP_1
  6977. - int SCANCODE_KP_2
  6978. - int SCANCODE_KP_3
  6979. - int SCANCODE_KP_4
  6980. - int SCANCODE_KP_5
  6981. - int SCANCODE_KP_6
  6982. - int SCANCODE_KP_7
  6983. - int SCANCODE_KP_8
  6984. - int SCANCODE_KP_9
  6985. - int SCANCODE_KP_A
  6986. - int SCANCODE_KP_AMPERSAND
  6987. - int SCANCODE_KP_AT
  6988. - int SCANCODE_KP_B
  6989. - int SCANCODE_KP_BACKSPACE
  6990. - int SCANCODE_KP_BINARY
  6991. - int SCANCODE_KP_C
  6992. - int SCANCODE_KP_CLEAR
  6993. - int SCANCODE_KP_CLEARENTRY
  6994. - int SCANCODE_KP_COLON
  6995. - int SCANCODE_KP_COMMA
  6996. - int SCANCODE_KP_D
  6997. - int SCANCODE_KP_DBLAMPERSAND
  6998. - int SCANCODE_KP_DBLVERTICALBAR
  6999. - int SCANCODE_KP_DECIMAL
  7000. - int SCANCODE_KP_DIVIDE
  7001. - int SCANCODE_KP_E
  7002. - int SCANCODE_KP_ENTER
  7003. - int SCANCODE_KP_EQUALS
  7004. - int SCANCODE_KP_EQUALSAS400
  7005. - int SCANCODE_KP_EXCLAM
  7006. - int SCANCODE_KP_F
  7007. - int SCANCODE_KP_GREATER
  7008. - int SCANCODE_KP_HASH
  7009. - int SCANCODE_KP_HEXADECIMAL
  7010. - int SCANCODE_KP_LEFTBRACE
  7011. - int SCANCODE_KP_LEFTPAREN
  7012. - int SCANCODE_KP_LESS
  7013. - int SCANCODE_KP_MEMADD
  7014. - int SCANCODE_KP_MEMCLEAR
  7015. - int SCANCODE_KP_MEMDIVIDE
  7016. - int SCANCODE_KP_MEMMULTIPLY
  7017. - int SCANCODE_KP_MEMRECALL
  7018. - int SCANCODE_KP_MEMSTORE
  7019. - int SCANCODE_KP_MEMSUBTRACT
  7020. - int SCANCODE_KP_MINUS
  7021. - int SCANCODE_KP_MULTIPLY
  7022. - int SCANCODE_KP_OCTAL
  7023. - int SCANCODE_KP_PERCENT
  7024. - int SCANCODE_KP_PERIOD
  7025. - int SCANCODE_KP_PLUS
  7026. - int SCANCODE_KP_PLUSMINUS
  7027. - int SCANCODE_KP_POWER
  7028. - int SCANCODE_KP_RIGHTBRACE
  7029. - int SCANCODE_KP_RIGHTPAREN
  7030. - int SCANCODE_KP_SPACE
  7031. - int SCANCODE_KP_TAB
  7032. - int SCANCODE_KP_VERTICALBAR
  7033. - int SCANCODE_KP_XOR
  7034. - int SCANCODE_L
  7035. - int SCANCODE_LALT
  7036. - int SCANCODE_LANG1
  7037. - int SCANCODE_LANG2
  7038. - int SCANCODE_LANG3
  7039. - int SCANCODE_LANG4
  7040. - int SCANCODE_LANG5
  7041. - int SCANCODE_LANG6
  7042. - int SCANCODE_LANG7
  7043. - int SCANCODE_LANG8
  7044. - int SCANCODE_LANG9
  7045. - int SCANCODE_LCTRL
  7046. - int SCANCODE_LEFT
  7047. - int SCANCODE_LEFTBRACKET
  7048. - int SCANCODE_LGUI
  7049. - int SCANCODE_LSHIFT
  7050. - int SCANCODE_M
  7051. - int SCANCODE_MAIL
  7052. - int SCANCODE_MEDIASELECT
  7053. - int SCANCODE_MENU
  7054. - int SCANCODE_MINUS
  7055. - int SCANCODE_MODE
  7056. - int SCANCODE_MUTE
  7057. - int SCANCODE_N
  7058. - int SCANCODE_NONUSBACKSLASH
  7059. - int SCANCODE_NONUSHASH
  7060. - int SCANCODE_NUMLOCKCLEAR
  7061. - int SCANCODE_O
  7062. - int SCANCODE_OPER
  7063. - int SCANCODE_OUT
  7064. - int SCANCODE_P
  7065. - int SCANCODE_PAGEDOWN
  7066. - int SCANCODE_PAGEUP
  7067. - int SCANCODE_PASTE
  7068. - int SCANCODE_PAUSE
  7069. - int SCANCODE_PERIOD
  7070. - int SCANCODE_POWER
  7071. - int SCANCODE_PRINTSCREEN
  7072. - int SCANCODE_PRIOR
  7073. - int SCANCODE_Q
  7074. - int SCANCODE_R
  7075. - int SCANCODE_RALT
  7076. - int SCANCODE_RCTRL
  7077. - int SCANCODE_RETURN
  7078. - int SCANCODE_RETURN2
  7079. - int SCANCODE_RGUI
  7080. - int SCANCODE_RIGHT
  7081. - int SCANCODE_RIGHTBRACKET
  7082. - int SCANCODE_RSHIFT
  7083. - int SCANCODE_S
  7084. - int SCANCODE_SCROLLLOCK
  7085. - int SCANCODE_SELECT
  7086. - int SCANCODE_SEMICOLON
  7087. - int SCANCODE_SEPARATOR
  7088. - int SCANCODE_SHIFT
  7089. - int SCANCODE_SLASH
  7090. - int SCANCODE_SLEEP
  7091. - int SCANCODE_SPACE
  7092. - int SCANCODE_STOP
  7093. - int SCANCODE_SYSREQ
  7094. - int SCANCODE_T
  7095. - int SCANCODE_TAB
  7096. - int SCANCODE_THOUSANDSSEPARATOR
  7097. - int SCANCODE_U
  7098. - int SCANCODE_UNDO
  7099. - int SCANCODE_UNKNOWN
  7100. - int SCANCODE_UP
  7101. - int SCANCODE_V
  7102. - int SCANCODE_VOLUMEDOWN
  7103. - int SCANCODE_VOLUMEUP
  7104. - int SCANCODE_W
  7105. - int SCANCODE_WWW
  7106. - int SCANCODE_X
  7107. - int SCANCODE_Y
  7108. - int SCANCODE_Z
  7109. - unsigned SCAN_DIRS
  7110. - unsigned SCAN_FILES
  7111. - unsigned SCAN_HIDDEN
  7112. - int SHADOWQUALITY_HIGH_16BIT
  7113. - int SHADOWQUALITY_HIGH_24BIT
  7114. - int SHADOWQUALITY_LOW_16BIT
  7115. - int SHADOWQUALITY_LOW_24BIT
  7116. - String SOUND_AMBIENT
  7117. - String SOUND_EFFECT
  7118. - String SOUND_MASTER
  7119. - String SOUND_MUSIC
  7120. - String SOUND_VOICE
  7121. - unsigned VO_DISABLE_OCCLUSION
  7122. - unsigned VO_DISABLE_SHADOWS
  7123. - unsigned VO_LOW_MATERIAL_QUALITY
  7124. - unsigned VO_NONE
  7125. */
  7126. }