LuaScriptAPI.dox 238 KB

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