LuaScriptAPI.dox 220 KB

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