LuaScriptAPI.dox 218 KB

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