LuaScriptAPI.dox 217 KB

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