LuaScriptAPI.dox 248 KB

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