LuaScriptAPI.dox 217 KB

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