LuaScriptAPI.dox 220 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756
  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(const String 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. - bool HasMasterGain(const String type) const
  415. - float GetMasterGain(const String type) const
  416. - SoundListener* GetListener() const
  417. - const PODVector<SoundSource*>& GetSoundSources() const
  418. - void AddSoundSource(SoundSource* soundSource)
  419. - void RemoveSoundSource(SoundSource* soundSource)
  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(const String shape, Image* image, const IntRect& imageRect, const IntVector2& hotSpot)
  1326. - void DefineShape(CursorShape shape, Image* image, const IntRect& imageRect, const IntVector2& hotSpot)
  1327. - void SetShape(CursorShape shape)
  1328. - void SetShape(const String shape)
  1329. - void SetUseSystemShapes(bool enable)
  1330. - String GetShape() const
  1331. - bool GetUseSystemShapes() const
  1332. Properties:
  1333. - String shape
  1334. - bool useSystemShapes
  1335. <a name="Class_CustomGeometry"></a>
  1336. ### CustomGeometry : Drawable
  1337. Methods:
  1338. - void Clear()
  1339. - void SetNumGeometries(unsigned num)
  1340. - void SetDynamic(bool enable)
  1341. - void BeginGeometry(unsigned index, PrimitiveType type)
  1342. - void DefineVertex(const Vector3& position)
  1343. - void DefineNormal(const Vector3& normal)
  1344. - void DefineTangent(const Vector4& tangent)
  1345. - void DefineColor(const Color& color)
  1346. - void DefineTexCoord(const Vector2& texCoord)
  1347. - void DefineGeometry(unsigned index, PrimitiveType type, unsigned numVertices, bool hasNormals, bool hasColors, bool hasTexCoords, bool hasTangents)
  1348. - void Commit()
  1349. - void SetMaterial(Material* material)
  1350. - bool SetMaterial(unsigned index, Material* material)
  1351. - unsigned GetNumGeometries() const
  1352. - unsigned GetNumVertices(unsigned index) const
  1353. - bool IsDynamic() const
  1354. - Material* GetMaterial(unsigned index = 0)
  1355. - CustomGeometryVertex* GetVertex(unsigned geometryIndex, unsigned vertexNum)
  1356. Properties:
  1357. - Material* material
  1358. - unsigned numGeometries
  1359. - bool dynamic
  1360. <a name="Class_CustomGeometryVertex"></a>
  1361. ### CustomGeometryVertex
  1362. Properties:
  1363. - Vector3 position
  1364. - Vector3 normal
  1365. - unsigned color
  1366. - Vector2 texCoord
  1367. - Vector4 tangent
  1368. <a name="Class_DebugHud"></a>
  1369. ### DebugHud : Object
  1370. Methods:
  1371. - void Update()
  1372. - void SetDefaultStyle(XMLFile* style)
  1373. - void SetMode(unsigned mode)
  1374. - void SetProfilerMaxDepth(unsigned depth)
  1375. - void SetProfilerInterval(float interval)
  1376. - void SetUseRendererStats(bool enable)
  1377. - void Toggle(unsigned mode)
  1378. - void ToggleAll()
  1379. - XMLFile* GetDefaultStyle() const
  1380. - Text* GetStatsText() const
  1381. - Text* GetModeText() const
  1382. - Text* GetProfilerText() const
  1383. - unsigned GetMode() const
  1384. - unsigned GetProfilerMaxDepth() const
  1385. - float GetProfilerInterval() const
  1386. - bool GetUseRendererStats() const
  1387. - void SetAppStats(const String label, const Variant stats)
  1388. - void SetAppStats(const String label, const String stats)
  1389. - bool ResetAppStats(const String label)
  1390. - void ClearAppStats()
  1391. Properties:
  1392. - XMLFile* defaultStyle
  1393. - Text* statsText (readonly)
  1394. - Text* modeText (readonly)
  1395. - Text* profilerText (readonly)
  1396. - unsigned mode
  1397. - unsigned profilerMaxDepth
  1398. - float profilerInterval
  1399. - bool useRendererStats
  1400. <a name="Class_DebugRenderer"></a>
  1401. ### DebugRenderer : Component
  1402. Methods:
  1403. - void SetView(Camera* camera)
  1404. - void AddLine(const Vector3& start, const Vector3& end, const Color& color, bool depthTest = true)
  1405. - void AddLine(const Vector3& start, const Vector3& end, unsigned color, bool depthTest = true)
  1406. - void AddTriangle(const Vector3& v1, const Vector3& v2, const Vector3& v3, const Color& color, bool depthTest = true)
  1407. - void AddTriangle(const Vector3& v1, const Vector3& v2, const Vector3& v3, unsigned color, bool depthTest = true)
  1408. - void AddNode(Node* node, float scale = 1.0f, bool depthTest = true)
  1409. - void AddBoundingBox(const BoundingBox& box, const Color& color, bool depthTest = true)
  1410. - void AddBoundingBox(const BoundingBox& box, const Matrix3x4& transform, const Color& color, bool depthTest = true)
  1411. - void AddFrustum(const Frustum& frustum, const Color& color, bool depthTest = true)
  1412. - void AddPolyhedron(const Polyhedron& poly, const Color& color, bool depthTest = true)
  1413. - void AddSphere(const Sphere& sphere, const Color& color, bool depthTest = true)
  1414. - void AddSkeleton(const Skeleton& skeleton, const Color& color, bool depthTest = true)
  1415. - 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)
  1416. - void Render()
  1417. - const Matrix3x4& GetView() const
  1418. - const Matrix4& GetProjection() const
  1419. - const Frustum& GetFrustum() const
  1420. - bool IsInside(const BoundingBox& box) const
  1421. Properties:
  1422. - Matrix3x4& view (readonly)
  1423. - Matrix4& projection (readonly)
  1424. - Frustum& frustum (readonly)
  1425. <a name="Class_DecalSet"></a>
  1426. ### DecalSet : Drawable
  1427. Methods:
  1428. - void SetMaterial(Material* material)
  1429. - void SetMaxVertices(unsigned num)
  1430. - void SetMaxIndices(unsigned num)
  1431. - 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)
  1432. - void RemoveDecals(unsigned num)
  1433. - void RemoveAllDecals()
  1434. - Material* GetMaterial() const
  1435. - unsigned GetNumDecals() const
  1436. - unsigned GetNumVertices() const
  1437. - unsigned GetNumIndices() const
  1438. - unsigned GetMaxVertices() const
  1439. - unsigned GetMaxIndices() const
  1440. Properties:
  1441. - Material* material
  1442. - unsigned numDecals (readonly)
  1443. - unsigned numVertices (readonly)
  1444. - unsigned numIndices (readonly)
  1445. - unsigned maxVertices
  1446. - unsigned maxIndices
  1447. <a name="Class_Deserializer"></a>
  1448. ### Deserializer
  1449. Methods:
  1450. - VectorBuffer Read(unsigned size)
  1451. - unsigned Seek(unsigned position)
  1452. - const String GetName() const
  1453. - unsigned GetChecksum()
  1454. - unsigned GetPosition() const
  1455. - unsigned GetSize() const
  1456. - bool IsEof() const
  1457. - int ReadInt()
  1458. - short ReadShort()
  1459. - char ReadByte()
  1460. - unsigned ReadUInt()
  1461. - short ReadUShort()
  1462. - char ReadUByte()
  1463. - bool ReadBool()
  1464. - float ReadFloat()
  1465. - IntRect ReadIntRect()
  1466. - IntVector2 ReadIntVector2()
  1467. - Rect ReadRect()
  1468. - Vector2 ReadVector2()
  1469. - Vector3 ReadVector3()
  1470. - Vector3 ReadPackedVector3(float maxAbsCoord)
  1471. - Vector4 ReadVector4()
  1472. - Quaternion ReadQuaternion()
  1473. - Quaternion ReadPackedQuaternion()
  1474. - Matrix3 ReadMatrix3()
  1475. - Matrix3x4 ReadMatrix3x4()
  1476. - Matrix4 ReadMatrix4()
  1477. - Color ReadColor()
  1478. - BoundingBox ReadBoundingBox()
  1479. - String ReadString()
  1480. - String ReadFileID()
  1481. - StringHash ReadStringHash()
  1482. - VectorBuffer ReadBuffer()
  1483. - ResourceRef ReadResourceRef()
  1484. - ResourceRefList ReadResourceRefList()
  1485. - Variant ReadVariant()
  1486. - Variant ReadVariant(VariantType type)
  1487. - VariantVector ReadVariantVector()
  1488. - VariantMap ReadVariantMap()
  1489. - unsigned ReadVLE()
  1490. - unsigned ReadNetID()
  1491. - String ReadLine()
  1492. Properties:
  1493. - String name (readonly)
  1494. - unsigned checksum (readonly)
  1495. - unsigned position (readonly)
  1496. - unsigned size (readonly)
  1497. - bool eof (readonly)
  1498. <a name="Class_Drawable"></a>
  1499. ### Drawable : Component
  1500. Methods:
  1501. - void SetDrawDistance(float distance)
  1502. - void SetShadowDistance(float distance)
  1503. - void SetLodBias(float bias)
  1504. - void SetViewMask(unsigned mask)
  1505. - void SetLightMask(unsigned mask)
  1506. - void SetShadowMask(unsigned mask)
  1507. - void SetZoneMask(unsigned mask)
  1508. - void SetMaxLights(unsigned num)
  1509. - void SetCastShadows(bool enable)
  1510. - void SetOccluder(bool enable)
  1511. - void SetOccludee(bool enable)
  1512. - void MarkForUpdate()
  1513. - const BoundingBox& GetBoundingBox() const
  1514. - const BoundingBox& GetWorldBoundingBox()
  1515. - char GetDrawableFlags() const
  1516. - float GetDrawDistance() const
  1517. - float GetShadowDistance() const
  1518. - float GetLodBias() const
  1519. - unsigned GetViewMask() const
  1520. - unsigned GetLightMask() const
  1521. - unsigned GetShadowMask() const
  1522. - unsigned GetZoneMask() const
  1523. - unsigned GetMaxLights() const
  1524. - bool GetCastShadows() const
  1525. - bool IsOccluder() const
  1526. - bool IsOccludee() const
  1527. - bool IsInView() const
  1528. - bool IsInView(Camera* tolua_var_2) const
  1529. - Zone* GetZone() const
  1530. Properties:
  1531. - BoundingBox& worldBoundingBox (readonly)
  1532. - char drawableFlags (readonly)
  1533. - float drawDistance
  1534. - float shadowDistance
  1535. - float lodBias
  1536. - unsigned viewMask
  1537. - unsigned lightMask
  1538. - unsigned shadowMask
  1539. - unsigned zoneMask
  1540. - unsigned maxLights
  1541. - bool castShadows
  1542. - bool occluder
  1543. - bool occludee
  1544. - bool inView (readonly)
  1545. - Zone* zone (readonly)
  1546. <a name="Class_Drawable2D"></a>
  1547. ### Drawable2D : Drawable
  1548. Methods:
  1549. - void SetLayer(int layer)
  1550. - void SetOrderInLayer(int orderInLayer)
  1551. - void SetTexture(Texture2D* texture)
  1552. - void SetBlendMode(BlendMode mode)
  1553. - int GetLayer() const
  1554. - int GetOrderInLayer() const
  1555. - Texture2D* GetTexture() const
  1556. - BlendMode GetBlendMode() const
  1557. Properties:
  1558. - int layer
  1559. - int orderInLayer
  1560. - Texture2D* texture
  1561. - BlendMode blendMode
  1562. <a name="Class_DropDownList"></a>
  1563. ### DropDownList : Menu
  1564. Methods:
  1565. - DropDownList() (GC)
  1566. - DropDownList* new()
  1567. - void delete()
  1568. - void AddItem(UIElement* item)
  1569. - void InsertItem(unsigned index, UIElement* item)
  1570. - void RemoveItem(UIElement* item)
  1571. - void RemoveItem(unsigned index)
  1572. - void RemoveAllItems()
  1573. - void SetSelection(unsigned index)
  1574. - void SetPlaceholderText(const String text)
  1575. - void SetResizePopup(bool enable)
  1576. - unsigned GetNumItems() const
  1577. - UIElement* GetItem(unsigned index) const
  1578. - const PODVector<UIElement*>& GetItems() const
  1579. - unsigned GetSelection() const
  1580. - UIElement* GetSelectedItem() const
  1581. - ListView* GetListView() const
  1582. - UIElement* GetPlaceholder() const
  1583. - const String GetPlaceholderText() const
  1584. - bool GetResizePopup() const
  1585. Properties:
  1586. - unsigned numItems (readonly)
  1587. - unsigned selection
  1588. - UIElement* selectedItem (readonly)
  1589. - ListView* listView (readonly)
  1590. - UIElement* placeholder (readonly)
  1591. - String placeholderText
  1592. - bool resizePopup
  1593. <a name="Class_Engine"></a>
  1594. ### Engine : Object
  1595. Methods:
  1596. - void RunFrame()
  1597. - Console* CreateConsole()
  1598. - DebugHud* CreateDebugHud()
  1599. - void SetMinFps(int fps)
  1600. - void SetMaxFps(int fps)
  1601. - void SetMaxInactiveFps(int fps)
  1602. - void SetTimeStepSmoothing(int frames)
  1603. - void SetPauseMinimized(bool enable)
  1604. - void SetAutoExit(bool enable)
  1605. - void Exit()
  1606. - void DumpProfiler()
  1607. - void DumpResources(bool dumpFileName = false)
  1608. - void DumpMemory()
  1609. - int GetMinFps() const
  1610. - int GetMaxFps() const
  1611. - int GetMaxInactiveFps() const
  1612. - int GetTimeStepSmoothing() const
  1613. - bool GetPauseMinimized() const
  1614. - bool GetAutoExit() const
  1615. - bool IsInitialized() const
  1616. - bool IsExiting() const
  1617. - bool IsHeadless() const
  1618. Properties:
  1619. - int minFps
  1620. - int maxFps
  1621. - int maxInactiveFps
  1622. - int timeStepSmoothing
  1623. - bool pauseMinimized
  1624. - bool autoExit
  1625. - bool initialized (readonly)
  1626. - bool exiting (readonly)
  1627. - bool headless (readonly)
  1628. <a name="Class_File"></a>
  1629. ### File : Object
  1630. Methods:
  1631. - File() (GC)
  1632. - File* new()
  1633. - File(const String fileName, FileMode mode = FILE_READ) (GC)
  1634. - File* new(const String fileName, FileMode mode = FILE_READ)
  1635. - File(PackageFile* package, const String fileName) (GC)
  1636. - File* new(PackageFile* package, const String fileName)
  1637. - void delete()
  1638. - bool Open(const String fileName, FileMode mode = FILE_READ)
  1639. - bool Open(PackageFile* package, const String fileName)
  1640. - void Close()
  1641. - void Flush()
  1642. - void SetName(const String name)
  1643. - FileMode GetMode() const
  1644. - bool IsOpen() const
  1645. - void* GetHandle() const
  1646. - bool IsPackaged() const
  1647. - VectorBuffer Read(unsigned size)
  1648. - unsigned Seek(unsigned position)
  1649. - const String GetName() const
  1650. - unsigned GetChecksum()
  1651. - unsigned GetPosition() const
  1652. - unsigned GetSize() const
  1653. - bool IsEof() const
  1654. - int ReadInt()
  1655. - short ReadShort()
  1656. - char ReadByte()
  1657. - unsigned ReadUInt()
  1658. - short ReadUShort()
  1659. - char ReadUByte()
  1660. - bool ReadBool()
  1661. - float ReadFloat()
  1662. - IntRect ReadIntRect()
  1663. - IntVector2 ReadIntVector2()
  1664. - Rect ReadRect()
  1665. - Vector2 ReadVector2()
  1666. - Vector3 ReadVector3()
  1667. - Vector3 ReadPackedVector3(float maxAbsCoord)
  1668. - Vector4 ReadVector4()
  1669. - Quaternion ReadQuaternion()
  1670. - Quaternion ReadPackedQuaternion()
  1671. - Matrix3 ReadMatrix3()
  1672. - Matrix3x4 ReadMatrix3x4()
  1673. - Matrix4 ReadMatrix4()
  1674. - Color ReadColor()
  1675. - BoundingBox ReadBoundingBox()
  1676. - String ReadString()
  1677. - String ReadFileID()
  1678. - StringHash ReadStringHash()
  1679. - VectorBuffer ReadBuffer()
  1680. - ResourceRef ReadResourceRef()
  1681. - ResourceRefList ReadResourceRefList()
  1682. - Variant ReadVariant()
  1683. - Variant ReadVariant(VariantType type)
  1684. - VariantVector ReadVariantVector()
  1685. - VariantMap ReadVariantMap()
  1686. - unsigned ReadVLE()
  1687. - unsigned ReadNetID()
  1688. - String ReadLine()
  1689. - unsigned Write(const VectorBuffer& buffer)
  1690. - bool WriteInt(int value)
  1691. - bool WriteShort(short value)
  1692. - bool WriteByte(char value)
  1693. - bool WriteUInt(unsigned value)
  1694. - bool WriteUShort(short value)
  1695. - bool WriteUByte(char value)
  1696. - bool WriteBool(bool value)
  1697. - bool WriteFloat(float value)
  1698. - bool WriteIntRect(const IntRect& value)
  1699. - bool WriteIntVector2(const IntVector2& value)
  1700. - bool WriteRect(const Rect& value)
  1701. - bool WriteVector2(const Vector2& value)
  1702. - bool WriteVector3(const Vector3& value)
  1703. - bool WritePackedVector3(const Vector3& value, float maxAbsCoord)
  1704. - bool WriteVector4(const Vector4& value)
  1705. - bool WriteQuaternion(const Quaternion& value)
  1706. - bool WritePackedQuaternion(const Quaternion& value)
  1707. - bool WriteMatrix3(const Matrix3& value)
  1708. - bool WriteMatrix3x4(const Matrix3x4& value)
  1709. - bool WriteMatrix4(const Matrix4& value)
  1710. - bool WriteColor(const Color& value)
  1711. - bool WriteBoundingBox(const BoundingBox& value)
  1712. - bool WriteString(const String value)
  1713. - bool WriteFileID(const String value)
  1714. - bool WriteStringHash(const StringHash& value)
  1715. - bool WriteBuffer(const VectorBuffer& buffer)
  1716. - bool WriteResourceRef(const ResourceRef& value)
  1717. - bool WriteResourceRefList(const ResourceRefList& value)
  1718. - bool WriteVariant(const Variant& value)
  1719. - bool WriteVariantData(const Variant& value)
  1720. - bool WriteVariantVector(const VariantVector& value)
  1721. - bool WriteVariantMap(const VariantMap& value)
  1722. - bool WriteVLE(unsigned value)
  1723. - bool WriteNetID(unsigned value)
  1724. - bool WriteLine(const String value)
  1725. Properties:
  1726. - FileMode mode (readonly)
  1727. - bool open (readonly)
  1728. - bool packaged (readonly)
  1729. - String name (readonly)
  1730. - unsigned checksum (readonly)
  1731. - unsigned position (readonly)
  1732. - unsigned size (readonly)
  1733. - bool eof (readonly)
  1734. <a name="Class_FileSelector"></a>
  1735. ### FileSelector : Object
  1736. Methods:
  1737. - FileSelector() (GC)
  1738. - FileSelector* new()
  1739. - void delete()
  1740. - void SetDefaultStyle(XMLFile* style)
  1741. - void SetTitle(const String text)
  1742. - void SetButtonTexts(const String okText, const String cancelText)
  1743. - void SetPath(const String path)
  1744. - void SetFileName(const String fileName)
  1745. - void SetFilters(const Vector<String>& filters, unsigned defaultIndex)
  1746. - void SetDirectoryMode(bool enable)
  1747. - void UpdateElements()
  1748. - XMLFile* GetDefaultStyle() const
  1749. - Window* GetWindow() const
  1750. - Text* GetTitleText() const
  1751. - ListView* GetFileList() const
  1752. - LineEdit* GetPathEdit() const
  1753. - LineEdit* GetFileNameEdit() const
  1754. - DropDownList* GetFilterList() const
  1755. - Button* GetOKButton() const
  1756. - Button* GetCancelButton() const
  1757. - Button* GetCloseButton() const
  1758. - const String GetTitle() const
  1759. - const String GetPath() const
  1760. - const String GetFileName() const
  1761. - const String GetFilter() const
  1762. - unsigned GetFilterIndex() const
  1763. - bool GetDirectoryMode() const
  1764. Properties:
  1765. - XMLFile* defaultStyle
  1766. - Window* window (readonly)
  1767. - Text* titleText (readonly)
  1768. - ListView* fileList (readonly)
  1769. - LineEdit* pathEdit (readonly)
  1770. - LineEdit* fileNameEdit (readonly)
  1771. - DropDownList* filterList (readonly)
  1772. - Button* OKButton (readonly)
  1773. - Button* cancelButton (readonly)
  1774. - Button* closeButton (readonly)
  1775. - String title
  1776. - String path
  1777. - String fileName
  1778. - String filter (readonly)
  1779. - unsigned filterIndex (readonly)
  1780. - bool directoryMode
  1781. <a name="Class_FileSelectorEntry"></a>
  1782. ### FileSelectorEntry
  1783. Properties:
  1784. - String name
  1785. - bool directory
  1786. <a name="Class_FileSystem"></a>
  1787. ### FileSystem : Object
  1788. Methods:
  1789. - bool SetCurrentDir(const String pathName)
  1790. - bool CreateDir(const String pathName)
  1791. - void SetExecuteConsoleCommands(bool enable)
  1792. - int SystemCommand(const String commandLine, bool redirectStdOutToLog = false)
  1793. - int SystemRun(const String fileName, const Vector<String>& arguments)
  1794. - unsigned SystemCommandAsync(const String commandLine)
  1795. - unsigned SystemRunAsync(const String fileName, const Vector<String>& arguments)
  1796. - bool SystemOpen(const String fileName, const String mode = String::EMPTY)
  1797. - bool Copy(const String srcFileName, const String destFileName)
  1798. - bool Rename(const String srcFileName, const String destFileName)
  1799. - bool Delete(const String fileName)
  1800. - bool SetLastModifiedTime(const String fileName, unsigned newTime)
  1801. - String GetCurrentDir() const
  1802. - bool GetExecuteConsoleCommands() const
  1803. - bool HasRegisteredPaths() const
  1804. - bool CheckAccess(const String pathName) const
  1805. - unsigned GetLastModifiedTime(const String fileName) const
  1806. - bool FileExists(const String fileName) const
  1807. - bool DirExists(const String pathName) const
  1808. - const Vector<String>& ScanDir(const String pathName, const String filter, unsigned flags, bool recursive) const
  1809. - String GetProgramDir() const
  1810. - String GetUserDocumentsDir() const
  1811. - String GetAppPreferencesDir(const String org, const String app) const
  1812. <a name="Class_FocusParameters"></a>
  1813. ### FocusParameters
  1814. Methods:
  1815. - FocusParameters() (GC)
  1816. - FocusParameters* new()
  1817. - FocusParameters(bool focus, bool nonUniform, bool autoSize, float quantize, float minView) (GC)
  1818. - FocusParameters* new(bool focus, bool nonUniform, bool autoSize, float quantize, float minView)
  1819. - void delete()
  1820. <a name="Class_Font"></a>
  1821. ### Font : Resource
  1822. Methods:
  1823. - void SetAbsoluteGlyphOffset(const IntVector2& offset)
  1824. - void SetScaledGlyphOffset(const Vector2& offset)
  1825. - const IntVector2& GetAbsoluteGlyphOffset() const
  1826. - const Vector2& GetScaledGlyphOffset() const
  1827. - IntVector2 GetTotalGlyphOffset(int pointSize) const
  1828. - bool IsSDFFont() const
  1829. Properties:
  1830. - IntVector2 absoluteGlyphOffset
  1831. - Vector2 scaledGlyphOffset
  1832. <a name="Class_Frustum"></a>
  1833. ### Frustum
  1834. Methods:
  1835. - Frustum() (GC)
  1836. - Frustum* new()
  1837. - Frustum(const Frustum& frustum) (GC)
  1838. - Frustum* new(const Frustum& frustum)
  1839. - void delete()
  1840. - void Define(float fov, float aspectRatio, float zoom, float nearZ, float farZ)
  1841. - void Define(float fov, float aspectRatio, float zoom, float nearZ, float farZ, const Matrix3x4& transform)
  1842. - void Define(const Vector3& near, const Vector3& far)
  1843. - void Define(const Vector3& near, const Vector3& far, const Matrix3x4& transform)
  1844. - void Define(const BoundingBox& box)
  1845. - void Define(const BoundingBox& box, const Matrix3x4& transform)
  1846. - void DefineOrtho(float orthoSize, float aspectRatio, float zoom, float nearZ, float farZ)
  1847. - void DefineOrtho(float orthoSize, float aspectRatio, float zoom, float nearZ, float farZ, const Matrix3x4& transform)
  1848. - void Transform(const Matrix3& transform)
  1849. - void Transform(const Matrix3x4& transform)
  1850. - Intersection IsInside(const Vector3& point) const
  1851. - Intersection IsInside(const Sphere& sphere) const
  1852. - Intersection IsInsideFast(const Sphere& sphere) const
  1853. - Intersection IsInside(const BoundingBox& box) const
  1854. - Intersection IsInsideFast(const BoundingBox& box) const
  1855. - float Distance(const Vector3& point) const
  1856. - Frustum Transformed(const Matrix3& transform) const
  1857. - Frustum Transformed(const Matrix3x4& transform) const
  1858. - Rect Projected(const Matrix4& transform) const
  1859. - void UpdatePlanes()
  1860. <a name="Class_Graphics"></a>
  1861. ### Graphics : Object
  1862. Methods:
  1863. - void SetWindowTitle(const String windowTitle)
  1864. - void SetWindowIcon(Image* windowIcon)
  1865. - void SetWindowPosition(const IntVector2& position)
  1866. - void SetWindowPosition(int x, int y)
  1867. - bool SetMode(int width, int height, bool fullscreen, bool borderless, bool resizable, bool vsync, bool tripleBuffer, int multiSample)
  1868. - bool SetMode(int width, int height)
  1869. - void SetSRGB(bool enable)
  1870. - void SetFlushGPU(bool enable)
  1871. - void SetOrientations(const String orientations)
  1872. - bool ToggleFullscreen()
  1873. - void Maximize()
  1874. - void Minimize()
  1875. - void Close()
  1876. - bool TakeScreenShot(Image& destImage)
  1877. - void BeginDumpShaders(const String fileName)
  1878. - void EndDumpShaders()
  1879. - void PrecacheShaders(Deserializer& source)
  1880. - void PrecacheShaders(const String fileName)
  1881. - bool IsInitialized() const
  1882. - void* GetExternalWindow() const
  1883. - const String GetWindowTitle() const
  1884. - IntVector2 GetWindowPosition() const
  1885. - int GetWidth() const
  1886. - int GetHeight() const
  1887. - int GetMultiSample() const
  1888. - bool GetFullscreen() const
  1889. - bool GetResizable() const
  1890. - bool GetBorderless() const
  1891. - bool GetVSync() const
  1892. - bool GetTripleBuffer() const
  1893. - bool GetSRGB() const
  1894. - bool GetFlushGPU() const
  1895. - const String GetOrientations() const
  1896. - bool IsDeviceLost() const
  1897. - unsigned GetNumPrimitives() const
  1898. - unsigned GetNumBatches() const
  1899. - unsigned GetDummyColorFormat() const
  1900. - unsigned GetShadowMapFormat() const
  1901. - unsigned GetHiresShadowMapFormat() const
  1902. - bool GetSM3Support() const
  1903. - bool GetInstancingSupport() const
  1904. - bool GetLightPrepassSupport() const
  1905. - bool GetDeferredSupport() const
  1906. - bool GetHardwareShadowSupport() const
  1907. - bool GetStreamOffsetSupport() const
  1908. - bool GetSRGBSupport() const
  1909. - bool GetSRGBWriteSupport() const
  1910. - IntVector2 GetDesktopResolution() const
  1911. - unsigned GetRGBFormat()
  1912. Properties:
  1913. - bool initialized (readonly)
  1914. - String windowTitle
  1915. - IntVector2 windowPosition
  1916. - int width (readonly)
  1917. - int height (readonly)
  1918. - int multiSample (readonly)
  1919. - bool fullscreen (readonly)
  1920. - bool resizable (readonly)
  1921. - bool borderless (readonly)
  1922. - bool vSync (readonly)
  1923. - bool tripleBuffer (readonly)
  1924. - bool sRGB
  1925. - bool flushGPU
  1926. - String orientations
  1927. - bool deviceLost (readonly)
  1928. - unsigned numPrimitives (readonly)
  1929. - unsigned numBatches (readonly)
  1930. - unsigned dummyColorFormat (readonly)
  1931. - unsigned shadowMapFormat (readonly)
  1932. - unsigned hiresShadowMapFormat (readonly)
  1933. - bool SM3Support (readonly)
  1934. - bool instancingSupport (readonly)
  1935. - bool lightPrepassSupport (readonly)
  1936. - bool deferredSupport (readonly)
  1937. - bool hardwareShadowSupport (readonly)
  1938. - bool streamOffsetSupport (readonly)
  1939. - bool sRGBSupport (readonly)
  1940. - bool sRGBWriteSupport (readonly)
  1941. - IntVector2 desktopResolution (readonly)
  1942. <a name="Class_HttpRequest"></a>
  1943. ### HttpRequest : Deserializer
  1944. Methods:
  1945. - const String GetURL() const
  1946. - const String GetVerb() const
  1947. - String GetError() const
  1948. - HttpRequestState GetState() const
  1949. - unsigned GetAvailableSize() const
  1950. - bool IsOpen() const
  1951. Properties:
  1952. - String URL (readonly)
  1953. - String verb (readonly)
  1954. - String error (readonly)
  1955. - HttpRequestState state (readonly)
  1956. - unsigned availableSize (readonly)
  1957. - bool open (readonly)
  1958. <a name="Class_Image"></a>
  1959. ### Image : Resource
  1960. Methods:
  1961. - Image() (GC)
  1962. - Image* new()
  1963. - void delete()
  1964. - bool SetSize(int width, int height, unsigned components)
  1965. - bool SetSize(int width, int height, int depth, unsigned components)
  1966. - void SetPixel(int x, int y, const Color& color)
  1967. - void SetPixel(int x, int y, int z, const Color& color)
  1968. - void SetPixelInt(int x, int y, unsigned uintColor)
  1969. - void SetPixelInt(int x, int y, int z, unsigned uintColor)
  1970. - bool LoadColorLUT(Deserializer& source)
  1971. - bool LoadColorLUT(const String fileName)
  1972. - bool FlipHorizontal()
  1973. - bool FlipVertical()
  1974. - bool Resize(int width, int height)
  1975. - void Clear(const Color& color)
  1976. - void ClearInt(unsigned uintColor)
  1977. - bool SaveBMP(const String fileName) const
  1978. - bool SavePNG(const String fileName) const
  1979. - bool SaveTGA(const String fileName) const
  1980. - bool SaveJPG(const String fileName, int quality) const
  1981. - Color GetPixel(int x, int y) const
  1982. - Color GetPixel(int x, int y, int z) const
  1983. - unsigned GetPixelInt(int x, int y) const
  1984. - unsigned GetPixelInt(int x, int y, int z) const
  1985. - Color GetPixelBilinear(float x, float y) const
  1986. - Color GetPixelTrilinear(float x, float y, float z) const
  1987. - int GetWidth() const
  1988. - int GetHeight() const
  1989. - int GetDepth() const
  1990. - unsigned GetComponents() const
  1991. - bool IsCompressed() const
  1992. - CompressedFormat GetCompressedFormat() const
  1993. - unsigned GetNumCompressedLevels() const
  1994. - Image* GetSubimage(const IntRect& rect) const
  1995. Properties:
  1996. - int width (readonly)
  1997. - int height (readonly)
  1998. - int depth (readonly)
  1999. - unsigned components (readonly)
  2000. - bool compressed (readonly)
  2001. - CompressedFormat compressedFormat (readonly)
  2002. - unsigned numCompressedLevels (readonly)
  2003. <a name="Class_Input"></a>
  2004. ### Input : Object
  2005. Methods:
  2006. - void SetToggleFullscreen(bool enable)
  2007. - void SetMouseVisible(bool enable, bool suppressEvent = false)
  2008. - void SetMouseGrabbed(bool grab)
  2009. - void SetMouseMode(MouseMode mode)
  2010. - int AddScreenJoystick(XMLFile* layoutFile = 0, XMLFile* styleFile = 0)
  2011. - bool RemoveScreenJoystick(int id)
  2012. - void SetScreenJoystickVisible(int id, bool enable)
  2013. - void SetScreenKeyboardVisible(bool enable)
  2014. - void SetTouchEmulation(bool enable)
  2015. - bool RecordGesture()
  2016. - bool SaveGestures(File* dest)
  2017. - bool SaveGesture(File* dest, unsigned gestureID)
  2018. - unsigned LoadGestures(File* source)
  2019. - bool SaveGestures(const String fileName)
  2020. - bool SaveGesture(const String fileName, unsigned gestureID)
  2021. - unsigned LoadGestures(const String fileName)
  2022. - bool RemoveGesture(unsigned gestureID)
  2023. - void RemoveAllGestures()
  2024. - int GetKeyFromName(const String name) const
  2025. - int GetKeyFromScancode(int scancode) const
  2026. - String GetKeyName(int key) const
  2027. - int GetScancodeFromKey(int key) const
  2028. - int GetScancodeFromName(const String name) const
  2029. - String GetScancodeName(int scancode) const
  2030. - bool GetKeyDown(int key) const
  2031. - bool GetKeyPress(int key) const
  2032. - bool GetScancodeDown(int scancode) const
  2033. - bool GetScancodePress(int scancode) const
  2034. - bool GetMouseButtonDown(int button) const
  2035. - bool GetMouseButtonPress(int button) const
  2036. - bool GetQualifierDown(int qualifier) const
  2037. - bool GetQualifierPress(int qualifier) const
  2038. - int GetQualifiers() const
  2039. - IntVector2 GetMousePosition() const
  2040. - const IntVector2& GetMouseMove() const
  2041. - int GetMouseMoveX() const
  2042. - int GetMouseMoveY() const
  2043. - int GetMouseMoveWheel() const
  2044. - unsigned GetNumTouches() const
  2045. - TouchState* GetTouch(unsigned index) const
  2046. - unsigned GetNumJoysticks() const
  2047. - JoystickState* GetJoystick(int id)
  2048. - JoystickState* GetJoystickByIndex(unsigned index)
  2049. - bool GetToggleFullscreen() const
  2050. - bool GetScreenKeyboardSupport() const
  2051. - bool IsScreenJoystickVisible(int id) const
  2052. - bool IsScreenKeyboardVisible() const
  2053. - bool GetTouchEmulation() const
  2054. - bool IsMouseVisible() const
  2055. - bool IsMouseGrabbed() const
  2056. - MouseMode GetMouseMode() const
  2057. - bool HasFocus()
  2058. - bool IsMinimized() const
  2059. Properties:
  2060. - int qualifiers (readonly)
  2061. - IntVector2 mousePosition (readonly)
  2062. - IntVector2& mouseMove (readonly)
  2063. - int mouseMoveX (readonly)
  2064. - int mouseMoveY (readonly)
  2065. - int mouseMoveWheel (readonly)
  2066. - unsigned numTouches (readonly)
  2067. - unsigned numJoysticks (readonly)
  2068. - bool toggleFullscreen (readonly)
  2069. - bool screenKeyboardSupport (readonly)
  2070. - MouseMode mouseMode
  2071. - bool screenKeyboardVisible
  2072. - bool touchEmulation
  2073. - bool mouseVisible
  2074. - bool mouseGrabbed
  2075. - bool focus (readonly)
  2076. - bool minimized (readonly)
  2077. <a name="Class_IntRect"></a>
  2078. ### IntRect
  2079. Methods:
  2080. - IntRect() (GC)
  2081. - IntRect* new()
  2082. - IntRect(int left, int top, int right, int bottom) (GC)
  2083. - IntRect* new(int left, int top, int right, int bottom)
  2084. - void delete()
  2085. - bool operator==(const IntRect& rhs) const
  2086. - IntVector2 Size() const
  2087. - int Width() const
  2088. - int Height() const
  2089. - Intersection IsInside(const IntVector2& point) const
  2090. Properties:
  2091. - int left
  2092. - int top
  2093. - int right
  2094. - int bottom
  2095. - const IntRect ZERO
  2096. - IntVector2 size (readonly)
  2097. - int width (readonly)
  2098. - int height (readonly)
  2099. <a name="Class_IntVector2"></a>
  2100. ### IntVector2
  2101. Methods:
  2102. - IntVector2() (GC)
  2103. - IntVector2* new()
  2104. - IntVector2(int x, int y) (GC)
  2105. - IntVector2* new(int x, int y)
  2106. - IntVector2(const IntVector2& rhs) (GC)
  2107. - IntVector2* new(const IntVector2& rhs)
  2108. - void delete()
  2109. - bool operator==(const IntVector2& rhs) const
  2110. - IntVector2 operator+(const IntVector2& rhs) const
  2111. - IntVector2 operator-() const
  2112. - IntVector2 operator-(const IntVector2& rhs) const
  2113. - IntVector2 operator*(int rhs) const
  2114. - IntVector2 operator/(int rhs) const
  2115. - IntVector2 operator/(int rhs) const
  2116. - String ToString() const
  2117. Properties:
  2118. - int x
  2119. - int y
  2120. - const IntVector2 ZERO
  2121. <a name="Class_JSONFile"></a>
  2122. ### JSONFile : Resource
  2123. Methods:
  2124. - JSONFile() (GC)
  2125. - JSONFile* new()
  2126. - void delete()
  2127. - JSONValue CreateRoot(JSONValueType valueType = JSON_OBJECT)
  2128. - JSONValue GetRoot(JSONValueType valueType = JSON_ANY)
  2129. <a name="Class_JSONValue"></a>
  2130. ### JSONValue
  2131. Methods:
  2132. - bool IsNull() const
  2133. - bool NotNull() const
  2134. - bool operatorbool() const
  2135. - JSONValue CreateChild(const String name, JSONValueType valueType = JSON_OBJECT)
  2136. - JSONValue GetChild(const String name, JSONValueType valueType = JSON_ANY) const
  2137. - void SetInt(const String name, int value)
  2138. - void SetBool(const String name, bool value)
  2139. - void SetFloat(const String name, float value)
  2140. - void SetVector2(const String name, const Vector2& value)
  2141. - void SetVector3(const String name, const Vector3& value)
  2142. - void SetVector4(const String name, const Vector4& value)
  2143. - void SetVectorVariant(const String name, const Variant& value)
  2144. - void SetQuaternion(const String name, const Quaternion& value)
  2145. - void SetColor(const String name, const Color& value)
  2146. - void SetString(const String name, const String value)
  2147. - void SetResourceRef(const String name, const ResourceRef& value)
  2148. - void SetResourceRefList(const String name, const ResourceRefList& value)
  2149. - void SetIntRect(const String name, const IntRect& value)
  2150. - void SetIntVector2(const String name, const IntVector2& value)
  2151. - void SetMatrix3(const String name, const Matrix3& value)
  2152. - void SetMatrix3x4(const String name, const Matrix3x4& value)
  2153. - void SetMatrix4(const String name, const Matrix4& value)
  2154. - void SetVariant(const String name, const Variant& value)
  2155. - void SetVariantValue(const String name, const Variant& value)
  2156. - bool IsObject() const
  2157. - Vector<String> GetChildNames() const
  2158. - Vector<String> GetValueNames() const
  2159. - int GetInt(const String name) const
  2160. - bool GetBool(const String name) const
  2161. - float GetFloat(const String name) const
  2162. - Vector2 GetVector2(const String name) const
  2163. - Vector3 GetVector3(const String name) const
  2164. - Vector4 GetVector4(const String name) const
  2165. - Variant GetVectorVariant(const String name) const
  2166. - Quaternion GetQuaternion(const String name) const
  2167. - Color GetColor(const String name) const
  2168. - String GetString(const String name) const
  2169. - const char* GetCString(const String name) const
  2170. - ResourceRef GetResourceRef(const String name) const
  2171. - ResourceRefList GetResourceRefList(const String name) const
  2172. - IntRect GetIntRect(const String name) const
  2173. - IntVector2 GetIntVector2(const String name) const
  2174. - Matrix3 GetMatrix3(const String name) const
  2175. - Matrix3x4 GetMatrix3x4(const String name) const
  2176. - Matrix4 GetMatrix4(const String name) const
  2177. - Variant GetVariant(const String name) const
  2178. - Variant GetVariantValue(const String name, VariantType type) const
  2179. - JSONValue CreateChild(JSONValueType valueType = JSON_OBJECT)
  2180. - JSONValue GetChild(unsigned index, JSONValueType valueType = JSON_ANY) const
  2181. - void AddInt(int value)
  2182. - void AddBool(bool value)
  2183. - void AddFloat(float value)
  2184. - void AddVector2(const Vector2& value)
  2185. - void AddVector3(const Vector3& value)
  2186. - void AddVector4(const Vector4& value)
  2187. - void AddVectorVariant(const Variant& value)
  2188. - void AddQuaternion(const Quaternion& value)
  2189. - void AddColor(const Color& value)
  2190. - void AddString(const String value)
  2191. - void AddResourceRef(const ResourceRef& value)
  2192. - void AddResourceRefList(const ResourceRefList& value)
  2193. - void AddIntRect(const IntRect& value)
  2194. - void AddIntVector2(const IntVector2& value)
  2195. - void AddMatrix3(const Matrix3& value)
  2196. - void AddMatrix3x4(const Matrix3x4& value)
  2197. - void AddMatrix4(const Matrix4& value)
  2198. - void AddVariant(const Variant& value)
  2199. - void AddVariantValue(const Variant& value)
  2200. - bool IsArray() const
  2201. - unsigned GetSize() const
  2202. - int GetInt(unsigned index) const
  2203. - bool GetBool(unsigned index) const
  2204. - float GetFloat(unsigned index) const
  2205. - Vector2 GetVector2(unsigned index) const
  2206. - Vector3 GetVector3(unsigned index) const
  2207. - Vector4 GetVector4(unsigned index) const
  2208. - Variant GetVectorVariant(unsigned index) const
  2209. - Quaternion GetQuaternion(unsigned index) const
  2210. - Color GetColor(unsigned index) const
  2211. - String GetString(unsigned index) const
  2212. - const char* GetCString(unsigned index) const
  2213. - ResourceRef GetResourceRef(unsigned index) const
  2214. - ResourceRefList GetResourceRefList(unsigned index) const
  2215. - IntRect GetIntRect(unsigned index) const
  2216. - IntVector2 GetIntVector2(unsigned index) const
  2217. - Matrix3 GetMatrix3(unsigned index) const
  2218. - Matrix3x4 GetMatrix3x4(unsigned index) const
  2219. - Matrix4 GetMatrix4(unsigned index) const
  2220. - Variant GetVariant(unsigned index) const
  2221. - Variant GetVariantValue(unsigned index, VariantType type) const
  2222. Properties:
  2223. - const JSONValue EMPTY
  2224. - bool null (readonly)
  2225. - bool object (readonly)
  2226. - bool array (readonly)
  2227. <a name="Class_JoystickState"></a>
  2228. ### JoystickState
  2229. Methods:
  2230. - bool IsController() const
  2231. - unsigned GetNumButtons() const
  2232. - unsigned GetNumAxes() const
  2233. - unsigned GetNumHats() const
  2234. - bool GetButtonDown(unsigned index) const
  2235. - bool GetButtonPress(unsigned index) const
  2236. - float GetAxisPosition(unsigned index) const
  2237. - int GetHatPosition(unsigned index) const
  2238. Properties:
  2239. - const String name
  2240. - const int joystickID
  2241. - bool controller (readonly)
  2242. - unsigned numButtons (readonly)
  2243. - unsigned numAxes (readonly)
  2244. - unsigned numHats (readonly)
  2245. <a name="Class_Light"></a>
  2246. ### Light : Drawable
  2247. Methods:
  2248. - void SetLightType(LightType type)
  2249. - void SetPerVertex(bool enable)
  2250. - void SetColor(const Color& color)
  2251. - void SetSpecularIntensity(float intensity)
  2252. - void SetBrightness(float brightness)
  2253. - void SetRange(float range)
  2254. - void SetFov(float fov)
  2255. - void SetAspectRatio(float aspectRatio)
  2256. - void SetFadeDistance(float distance)
  2257. - void SetShadowFadeDistance(float distance)
  2258. - void SetShadowBias(const BiasParameters& parameters)
  2259. - void SetShadowCascade(const CascadeParameters& parameters)
  2260. - void SetShadowFocus(const FocusParameters& parameters)
  2261. - void SetShadowIntensity(float intensity)
  2262. - void SetShadowResolution(float resolution)
  2263. - void SetShadowNearFarRatio(float nearFarRatio)
  2264. - void SetRampTexture(Texture* texture)
  2265. - void SetShapeTexture(Texture* texture)
  2266. - LightType GetLightType() const
  2267. - bool GetPerVertex() const
  2268. - const Color& GetColor() const
  2269. - float GetSpecularIntensity() const
  2270. - float GetBrightness() const
  2271. - Color GetEffectiveColor() const
  2272. - float GetEffectiveSpecularIntensity() const
  2273. - float GetRange() const
  2274. - float GetFov() const
  2275. - float GetAspectRatio() const
  2276. - float GetFadeDistance() const
  2277. - float GetShadowFadeDistance() const
  2278. - const BiasParameters& GetShadowBias() const
  2279. - const CascadeParameters& GetShadowCascade() const
  2280. - const FocusParameters& GetShadowFocus() const
  2281. - float GetShadowIntensity() const
  2282. - float GetShadowResolution() const
  2283. - float GetShadowNearFarRatio() const
  2284. - Texture* GetRampTexture() const
  2285. - Texture* GetShapeTexture() const
  2286. - Frustum GetFrustum() const
  2287. - int GetNumShadowSplits() const
  2288. - bool IsNegative() const
  2289. Properties:
  2290. - LightType lightType
  2291. - bool perVertex
  2292. - Color& color
  2293. - float specularIntensity
  2294. - float brightness
  2295. - float range
  2296. - float fov
  2297. - float aspectRatio
  2298. - float fadeDistance
  2299. - float shadowFadeDistance
  2300. - BiasParameters& shadowBias
  2301. - CascadeParameters& shadowCascade
  2302. - FocusParameters& shadowFocus
  2303. - float shadowIntensity
  2304. - float shadowResolution
  2305. - float shadowNearFarRatio
  2306. - Texture* rampTexture
  2307. - Texture* shapeTexture
  2308. - Frustum frustum (readonly)
  2309. - int numShadowSplits (readonly)
  2310. - bool negative (readonly)
  2311. - Color effectiveColor (readonly)
  2312. - float effectiveSpecularIntensity (readonly)
  2313. <a name="Class_LineEdit"></a>
  2314. ### LineEdit : BorderImage
  2315. Methods:
  2316. - LineEdit() (GC)
  2317. - LineEdit* new()
  2318. - void delete()
  2319. - void SetText(const String text)
  2320. - void SetCursorPosition(unsigned position)
  2321. - void SetCursorBlinkRate(float rate)
  2322. - void SetMaxLength(unsigned length)
  2323. - void SetEchoCharacter(unsigned c)
  2324. - void SetCursorMovable(bool enable)
  2325. - void SetTextSelectable(bool enable)
  2326. - void SetTextCopyable(bool enable)
  2327. - const String GetText() const
  2328. - unsigned GetCursorPosition() const
  2329. - float GetCursorBlinkRate() const
  2330. - unsigned GetMaxLength() const
  2331. - unsigned GetEchoCharacter() const
  2332. - bool IsCursorMovable() const
  2333. - bool IsTextSelectable() const
  2334. - bool IsTextCopyable() const
  2335. - Text* GetTextElement() const
  2336. - BorderImage* GetCursor() const
  2337. Properties:
  2338. - String text
  2339. - unsigned cursorPosition
  2340. - float cursorBlinkRate
  2341. - unsigned maxLength
  2342. - unsigned echoCharacter
  2343. - bool cursorMovable
  2344. - bool textSelectable
  2345. - bool textCopyable
  2346. - Text* textElement (readonly)
  2347. - BorderImage* cursor (readonly)
  2348. <a name="Class_ListView"></a>
  2349. ### ListView : ScrollView
  2350. Methods:
  2351. - ListView() (GC)
  2352. - ListView* new()
  2353. - void delete()
  2354. - void AddItem(UIElement* item)
  2355. - void InsertItem(unsigned index, UIElement* item, UIElement* parentItem = 0)
  2356. - void RemoveItem(UIElement* item, unsigned index = 0)
  2357. - void RemoveItem(unsigned index)
  2358. - void RemoveAllItems()
  2359. - void SetSelection(unsigned index)
  2360. - void SetSelections(const PODVector<unsigned>& indices)
  2361. - void AddSelection(unsigned index)
  2362. - void RemoveSelection(unsigned index)
  2363. - void ToggleSelection(unsigned index)
  2364. - void ChangeSelection(int delta, bool additive = false)
  2365. - void ClearSelection()
  2366. - void SetHighlightMode(HighlightMode mode)
  2367. - void SetMultiselect(bool enable)
  2368. - void SetHierarchyMode(bool enable)
  2369. - void SetBaseIndent(int baseIndent)
  2370. - void SetClearSelectionOnDefocus(bool enable)
  2371. - void SetSelectOnClickEnd(bool enable)
  2372. - void Expand(unsigned index, bool enable, bool recursive = false)
  2373. - void ToggleExpand(unsigned index, bool recursive = false)
  2374. - unsigned GetNumItems() const
  2375. - UIElement* GetItem(unsigned index) const
  2376. - const PODVector<UIElement*>& GetItems() const
  2377. - unsigned FindItem(UIElement* item) const
  2378. - unsigned GetSelection() const
  2379. - const PODVector<unsigned>& GetSelections() const
  2380. - void CopySelectedItemsToClipboard() const
  2381. - UIElement* GetSelectedItem() const
  2382. - const PODVector<UIElement*>& GetSelectedItems() const
  2383. - bool IsSelected(unsigned index) const
  2384. - bool IsExpanded(unsigned index) const
  2385. - HighlightMode GetHighlightMode() const
  2386. - bool GetMultiselect() const
  2387. - bool GetClearSelectionOnDefocus() const
  2388. - bool GetSelectOnClickEnd() const
  2389. - bool GetHierarchyMode() const
  2390. - int GetBaseIndent() const
  2391. Properties:
  2392. - unsigned numItems (readonly)
  2393. - unsigned selection
  2394. - UIElement* selectedItem (readonly)
  2395. - HighlightMode highlightMode
  2396. - bool multiselect
  2397. - bool clearSelectionOnDefocus
  2398. - bool selectOnClickEnd
  2399. - bool hierarchyMode
  2400. - int baseIndent
  2401. <a name="Class_Log"></a>
  2402. ### Log : Object
  2403. Methods:
  2404. - void Open(const String fileName)
  2405. - void Close()
  2406. - void SetLevel(int level)
  2407. - void SetTimeStamp(bool enable)
  2408. - void SetQuiet(bool quiet)
  2409. - int GetLevel() const
  2410. - bool GetTimeStamp() const
  2411. - String GetLastMessage() const
  2412. - bool IsQuiet() const
  2413. - void Write(int level, const String message)
  2414. - void WriteRaw(const String message, bool error = false)
  2415. Properties:
  2416. - int level
  2417. - bool timeStamp
  2418. - bool quiet
  2419. <a name="Class_LuaScriptInstance"></a>
  2420. ### LuaScriptInstance : Component
  2421. Methods:
  2422. - bool CreateObject(const String scriptObjectType)
  2423. - bool CreateObject(LuaFile* scriptFile, const String scriptObjectType)
  2424. - void SetScriptFile(LuaFile* scriptFile)
  2425. - void SetScriptObjectType(const String scriptObjectType)
  2426. - void SubscribeToEvent(const String eventName, void* functionOrFunctionName)
  2427. - void UnsubscribeFromEvent(const String eventName)
  2428. - void UnsubscribeFromAllEvents()
  2429. - void SubscribeToEvent(void* sender, const String eventName, void* functionOrFunctionName)
  2430. - void UnsubscribeFromEvent(void* sender, const String eventName)
  2431. - void UnsubscribeFromEvents(void* sender)
  2432. - LuaFile* GetScriptFile() const
  2433. - const String GetScriptObjectType() const
  2434. Properties:
  2435. - const LuaFile* scriptFile
  2436. - const String scriptObjectType
  2437. <a name="Class_Material"></a>
  2438. ### Material : Resource
  2439. Methods:
  2440. - Material() (GC)
  2441. - Material* new()
  2442. - void delete()
  2443. - void SetNumTechniques(unsigned num)
  2444. - void SetTechnique(unsigned index, Technique* tech, unsigned qualityLevel = 0, float lodDistance = 0.0f)
  2445. - void SetShaderParameter(const String name, const Variant& value)
  2446. - void SetShaderParameterAnimation(const String name, ValueAnimation* animation, WrapMode wrapMode = WM_LOOP, float speed = 1.0f)
  2447. - void SetShaderParameterAnimationWrapMode(const String name, WrapMode wrapMode)
  2448. - void SetShaderParameterAnimationSpeed(const String name, float speed)
  2449. - void SetTexture(TextureUnit unit, Texture* texture)
  2450. - void SetUVTransform(const Vector2& offset, float rotation, const Vector2& repeat)
  2451. - void SetUVTransform(const Vector2& offset, float rotation, float repeat)
  2452. - void SetCullMode(CullMode mode)
  2453. - void SetShadowCullMode(CullMode mode)
  2454. - void SetDepthBias(const BiasParameters& parameters)
  2455. - void SetScene(Scene* scene)
  2456. - void RemoveShaderParameter(const String name)
  2457. - void ReleaseShaders()
  2458. - Material* Clone(const String cloneName = String::EMPTY) const
  2459. - void SortTechniques()
  2460. - void MarkForAuxView(unsigned frameNumber)
  2461. - unsigned GetNumTechniques() const
  2462. - Technique* GetTechnique(unsigned index) const
  2463. - Pass* GetPass(unsigned index, StringHash passType) const
  2464. - Pass* GetPass(unsigned index, const String passType) const
  2465. - Texture* GetTexture(TextureUnit unit) const
  2466. - ValueAnimation* GetShaderParameterAnimation(const String name) const
  2467. - WrapMode GetShaderParameterAnimationWrapMode(const String name) const
  2468. - float GetShaderParameterAnimationSpeed(const String name) const
  2469. - CullMode GetCullMode() const
  2470. - CullMode GetShadowCullMode() const
  2471. - const BiasParameters& GetDepthBias() const
  2472. - unsigned GetAuxViewFrameNumber() const
  2473. - unsigned GetNumUsedTextureUnits() const
  2474. - bool GetOcclusion() const
  2475. - bool GetSpecular() const
  2476. - Scene* GetScene() const
  2477. Properties:
  2478. - CullMode cullMode (readonly)
  2479. - CullMode shadowCullMode (readonly)
  2480. - unsigned auxViewFrameNumber (readonly)
  2481. - unsigned numUsedTextureUnits (readonly)
  2482. - bool occlusion (readonly)
  2483. - bool specular (readonly)
  2484. - Scene* scene
  2485. <a name="Class_Matrix3"></a>
  2486. ### Matrix3
  2487. Methods:
  2488. - Matrix3() (GC)
  2489. - Matrix3* new()
  2490. - Matrix3(const Matrix3& matrix) (GC)
  2491. - Matrix3* new(const Matrix3& matrix)
  2492. - Matrix3(float v00, float v01, float v02, float v10, float v11, float v12, float v20, float v21, float v22) (GC)
  2493. - Matrix3* new(float v00, float v01, float v02, float v10, float v11, float v12, float v20, float v21, float v22)
  2494. - void delete()
  2495. - bool operator==(const Matrix3& rhs) const
  2496. - Vector3 operator*(const Vector3& rhs) const
  2497. - Matrix3 operator+(const Matrix3& rhs) const
  2498. - Matrix3 operator-(const Matrix3& rhs) const
  2499. - Matrix3 operator*(float rhs) const
  2500. - Matrix3 operator*(const Matrix3& rhs) const
  2501. - void SetScale(const Vector3& scale)
  2502. - void SetScale(float scale)
  2503. - Vector3 Scale() const
  2504. - Matrix3 Transpose() const
  2505. - Matrix3 Scaled(const Vector3& scale) const
  2506. - bool Equals(const Matrix3& rhs) const
  2507. - Matrix3 Inverse() const
  2508. - String ToString() const
  2509. Properties:
  2510. - float m00
  2511. - float m01
  2512. - float m02
  2513. - float m10
  2514. - float m11
  2515. - float m12
  2516. - float m20
  2517. - float m21
  2518. - float m22
  2519. - const Matrix3 ZERO
  2520. - const Matrix3 IDENTITY
  2521. <a name="Class_Matrix3x4"></a>
  2522. ### Matrix3x4
  2523. Methods:
  2524. - Matrix3x4() (GC)
  2525. - Matrix3x4* new()
  2526. - Matrix3x4(const Matrix3x4& matrix) (GC)
  2527. - Matrix3x4* new(const Matrix3x4& matrix)
  2528. - Matrix3x4(const Matrix3& matrix) (GC)
  2529. - Matrix3x4* new(const Matrix3& matrix)
  2530. - Matrix3x4(const Matrix4& matrix) (GC)
  2531. - Matrix3x4* new(const Matrix4& matrix)
  2532. - 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)
  2533. - 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)
  2534. - Matrix3x4(const Vector3& translation, const Quaternion& rotation, float scale) (GC)
  2535. - Matrix3x4* new(const Vector3& translation, const Quaternion& rotation, float scale)
  2536. - Matrix3x4(const Vector3& translation, const Quaternion& rotation, const Vector3& scale) (GC)
  2537. - Matrix3x4* new(const Vector3& translation, const Quaternion& rotation, const Vector3& scale)
  2538. - void delete()
  2539. - bool operator==(const Matrix3x4& rhs) const
  2540. - Vector3 operator*(const Vector3& rhs) const
  2541. - Vector3 operator*(const Vector4& rhs) const
  2542. - Matrix3x4 operator+(const Matrix3x4& rhs) const
  2543. - Matrix3x4 operator-(const Matrix3x4& rhs) const
  2544. - Matrix3x4 operator*(float rhs) const
  2545. - Matrix3x4 operator*(const Matrix3x4& rhs) const
  2546. - Matrix4 operator*(const Matrix4& rhs) const
  2547. - void SetTranslation(const Vector3& translation)
  2548. - void SetRotation(const Matrix3& rotation)
  2549. - void SetScale(const Vector3& scale)
  2550. - void SetScale(float scale)
  2551. - Matrix3 ToMatrix3() const
  2552. - Matrix4 ToMatrix4() const
  2553. - Matrix3 RotationMatrix() const
  2554. - Vector3 Translation() const
  2555. - Quaternion Rotation() const
  2556. - Vector3 Scale() const
  2557. - bool Equals(const Matrix3x4& rhs) const
  2558. - void Decompose(Vector3& translation, Quaternion& rotation, Vector3& scale) const
  2559. - Matrix3x4 Inverse() const
  2560. - String ToString() const
  2561. Properties:
  2562. - float m00
  2563. - float m01
  2564. - float m02
  2565. - float m03
  2566. - float m10
  2567. - float m11
  2568. - float m12
  2569. - float m13
  2570. - float m20
  2571. - float m21
  2572. - float m22
  2573. - float m23
  2574. - const Matrix3x4 ZERO
  2575. - const Matrix3x4 IDENTITY
  2576. <a name="Class_Matrix4"></a>
  2577. ### Matrix4
  2578. Methods:
  2579. - Matrix4() (GC)
  2580. - Matrix4* new()
  2581. - Matrix4(const Matrix4& matrix) (GC)
  2582. - Matrix4* new(const Matrix4& matrix)
  2583. - Matrix4(const Matrix3& matrix) (GC)
  2584. - Matrix4* new(const Matrix3& matrix)
  2585. - 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)
  2586. - 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)
  2587. - void delete()
  2588. - bool operator==(const Matrix4& rhs) const
  2589. - Vector3 operator*(const Vector3& rhs) const
  2590. - Vector4 operator*(const Vector4& rhs) const
  2591. - Matrix4 operator+(const Matrix4& rhs) const
  2592. - Matrix4 operator-(const Matrix4& rhs) const
  2593. - Matrix4 operator*(float rhs) const
  2594. - Matrix4 operator*(const Matrix4& rhs) const
  2595. - Matrix4 operator*(const Matrix3x4& rhs) const
  2596. - void SetTranslation(const Vector3& translation)
  2597. - void SetRotation(const Matrix3& rotation)
  2598. - void SetScale(const Vector3& scale)
  2599. - void SetScale(float scale)
  2600. - Matrix3 ToMatrix3() const
  2601. - Matrix3 RotationMatrix() const
  2602. - Vector3 Translation() const
  2603. - Quaternion Rotation() const
  2604. - Vector3 Scale() const
  2605. - Matrix4 Transpose() const
  2606. - bool Equals(const Matrix4& rhs) const
  2607. - void Decompose(Vector3& translation, Quaternion& rotation, Vector3& scale) const
  2608. - Matrix4 Inverse() const
  2609. - String ToString() const
  2610. Properties:
  2611. - float m00
  2612. - float m01
  2613. - float m02
  2614. - float m03
  2615. - float m10
  2616. - float m11
  2617. - float m12
  2618. - float m13
  2619. - float m20
  2620. - float m21
  2621. - float m22
  2622. - float m23
  2623. - float m30
  2624. - float m31
  2625. - float m32
  2626. - float m33
  2627. - const Matrix4 ZERO
  2628. - const Matrix4 IDENTITY
  2629. <a name="Class_Menu"></a>
  2630. ### Menu : Button
  2631. Methods:
  2632. - Menu() (GC)
  2633. - Menu* new()
  2634. - void delete()
  2635. - void SetPopup(UIElement* element)
  2636. - void SetPopupOffset(const IntVector2& offset)
  2637. - void SetPopupOffset(int x, int y)
  2638. - void ShowPopup(bool enable)
  2639. - void SetAccelerator(int key, int qualifiers)
  2640. - UIElement* GetPopup() const
  2641. - const IntVector2& GetPopupOffset() const
  2642. - bool GetShowPopup() const
  2643. - int GetAcceleratorKey() const
  2644. - int GetAcceleratorQualifiers() const
  2645. Properties:
  2646. - UIElement* popup
  2647. - IntVector2& popupOffset
  2648. - bool showPopup
  2649. - int acceleratorKey (readonly)
  2650. - int acceleratorQualifiers (readonly)
  2651. <a name="Class_MessageBox"></a>
  2652. ### MessageBox : Object
  2653. Methods:
  2654. - MessageBox(const String messageString = String::EMPTY, const String titleString = String::EMPTY, XMLFile* layoutFile = 0, XMLFile* styleFile = 0) (GC)
  2655. - MessageBox* new(const String messageString = String::EMPTY, const String titleString = String::EMPTY, XMLFile* layoutFile = 0, XMLFile* styleFile = 0)
  2656. - void delete()
  2657. - void SetTitle(const String text)
  2658. - void SetMessage(const String text)
  2659. - const String GetTitle() const
  2660. - const String GetMessage() const
  2661. - UIElement* GetWindow() const
  2662. Properties:
  2663. - String title
  2664. - String message
  2665. - UIElement* window (readonly)
  2666. <a name="Class_Model"></a>
  2667. ### Model : Resource
  2668. Methods:
  2669. - Model* Clone(const String cloneName = String::EMPTY) const
  2670. - const BoundingBox& GetBoundingBox() const
  2671. - Skeleton& GetSkeleton()
  2672. - unsigned GetNumGeometries() const
  2673. - unsigned GetNumGeometryLodLevels(unsigned index) const
  2674. - Geometry* GetGeometry(unsigned index, unsigned lodLevel) const
  2675. - unsigned GetNumMorphs() const
  2676. - const ModelMorph* GetMorph(const String name) const
  2677. - const ModelMorph* GetMorph(StringHash nameHash) const
  2678. - const ModelMorph* GetMorph(unsigned index) const
  2679. - unsigned GetMorphRangeStart(unsigned bufferIndex) const
  2680. - unsigned GetMorphRangeCount(unsigned bufferIndex) const
  2681. Properties:
  2682. - BoundingBox& boundingBox (readonly)
  2683. - Skeleton skeleton (readonly)
  2684. - unsigned numGeometries (readonly)
  2685. - unsigned numMorphs (readonly)
  2686. <a name="Class_Navigable"></a>
  2687. ### Navigable : Component
  2688. Methods:
  2689. - void SetRecursive(bool enable)
  2690. - bool IsRecursive() const
  2691. Properties:
  2692. - bool recursive
  2693. <a name="Class_NavigationGeometryInfo"></a>
  2694. ### NavigationGeometryInfo
  2695. Properties:
  2696. - Component* component
  2697. - unsigned lodLevel
  2698. - Matrix3x4 transform
  2699. - BoundingBox boundingBox
  2700. <a name="Class_NavigationMesh"></a>
  2701. ### NavigationMesh : Component
  2702. Methods:
  2703. - void SetTileSize(int size)
  2704. - void SetCellSize(float size)
  2705. - void SetCellHeight(float height)
  2706. - void SetAgentHeight(float height)
  2707. - void SetAgentRadius(float radius)
  2708. - void SetAgentMaxClimb(float maxClimb)
  2709. - void SetAgentMaxSlope(float maxSlope)
  2710. - void SetRegionMinSize(float size)
  2711. - void SetRegionMergeSize(float size)
  2712. - void SetEdgeMaxLength(float length)
  2713. - void SetEdgeMaxError(float error)
  2714. - void SetDetailSampleDistance(float distance)
  2715. - void SetDetailSampleMaxError(float error)
  2716. - void SetPadding(const Vector3& padding)
  2717. - bool Build()
  2718. - bool Build(const BoundingBox& boundingBox)
  2719. - Vector3 FindNearestPoint(const Vector3& point)
  2720. - Vector3 FindNearestPoint(const Vector3& point, const Vector3& extents)
  2721. - Vector3 MoveAlongSurface(const Vector3& start, const Vector3& end)
  2722. - Vector3 MoveAlongSurface(const Vector3& start, const Vector3& end, const Vector3& extents, int maxVisited = 3)
  2723. - const PODVector<Vector3>& FindPath(const Vector3& start, const Vector3& end)
  2724. - const PODVector<Vector3>& FindPath(const Vector3& start, const Vector3& end, const Vector3& extents)
  2725. - Vector3 GetRandomPoint()
  2726. - Vector3 GetRandomPointInCircle(const Vector3& center, float radius)
  2727. - Vector3 GetRandomPointInCircle(const Vector3& center, float radius, const Vector3& extents)
  2728. - float GetDistanceToWall(const Vector3& point, float radius)
  2729. - float GetDistanceToWall(const Vector3& point, float radius, const Vector3& extents)
  2730. - Vector3 Raycast(const Vector3& start, const Vector3& end)
  2731. - Vector3 Raycast(const Vector3& start, const Vector3& end, const Vector3& extents)
  2732. - void DrawDebugGeometry(bool depthTest)
  2733. - int GetTileSize() const
  2734. - float GetCellSize() const
  2735. - float GetCellHeight() const
  2736. - float GetAgentHeight() const
  2737. - float GetAgentRadius() const
  2738. - float GetAgentMaxClimb() const
  2739. - float GetAgentMaxSlope() const
  2740. - float GetRegionMinSize() const
  2741. - float GetRegionMergeSize() const
  2742. - float GetEdgeMaxLength() const
  2743. - float GetEdgeMaxError() const
  2744. - float GetDetailSampleDistance() const
  2745. - float GetDetailSampleMaxError() const
  2746. - const Vector3& GetPadding() const
  2747. - bool IsInitialized() const
  2748. - const BoundingBox& GetBoundingBox() const
  2749. - BoundingBox GetWorldBoundingBox() const
  2750. - IntVector2 GetNumTiles() const
  2751. Properties:
  2752. - int tileSize
  2753. - float cellSize
  2754. - float cellHeight
  2755. - float agentHeight
  2756. - float agentRadius
  2757. - float agentMaxClimb
  2758. - float agentMaxSlope
  2759. - float regionMinSize
  2760. - float regionMergeSize
  2761. - float edgeMaxLength
  2762. - float edgeMaxError
  2763. - float detailSampleDistance
  2764. - float detailSampleMaxError
  2765. - Vector3& padding
  2766. - bool initialized (readonly)
  2767. - BoundingBox& boundingBox (readonly)
  2768. - BoundingBox worldBoundingBox (readonly)
  2769. - IntVector2 numTiles (readonly)
  2770. <a name="Class_Network"></a>
  2771. ### Network
  2772. Methods:
  2773. - bool Connect(const String address, short port, Scene* scene)
  2774. - bool Connect(const String address, short port, Scene* scene, const VariantMap& identity)
  2775. - void Disconnect(int waitMSec = 0)
  2776. - bool StartServer(short port)
  2777. - void StopServer()
  2778. - void BroadcastMessage(int msgID, bool reliable, bool inOrder, const VectorBuffer& msg, unsigned contentID = 0)
  2779. - void BroadcastRemoteEvent(StringHash eventType, bool inOrder)
  2780. - void BroadcastRemoteEvent(StringHash eventType, bool inOrder, const VariantMap& eventData)
  2781. - void BroadcastRemoteEvent(const String eventType, bool inOrder)
  2782. - void BroadcastRemoteEvent(const String eventType, bool inOrder, const VariantMap& eventData)
  2783. - void BroadcastRemoteEvent(Scene* scene, StringHash eventType, bool inOrder)
  2784. - void BroadcastRemoteEvent(Scene* scene, StringHash eventType, bool inOrder, const VariantMap& eventData)
  2785. - void BroadcastRemoteEvent(Scene* scene, const String eventType, bool inOrder)
  2786. - void BroadcastRemoteEvent(Scene* scene, const String eventType, bool inOrder, const VariantMap& eventData)
  2787. - void BroadcastRemoteEvent(Node* node, StringHash eventType, bool inOrder)
  2788. - void BroadcastRemoteEvent(Node* node, StringHash eventType, bool inOrder, const VariantMap& eventData)
  2789. - void BroadcastRemoteEvent(Node* node, const String eventType, bool inOrder)
  2790. - void BroadcastRemoteEvent(Node* node, const String eventType, bool inOrder, const VariantMap& eventData)
  2791. - void SetUpdateFps(int fps)
  2792. - void RegisterRemoteEvent(StringHash eventType)
  2793. - void RegisterRemoteEvent(const String eventType)
  2794. - void UnregisterRemoteEvent(StringHash eventType)
  2795. - void UnregisterRemoteEvent(const String eventType)
  2796. - void UnregisterAllRemoteEvents()
  2797. - void SetPackageCacheDir(const String path)
  2798. - void SendPackageToClients(Scene* scene, PackageFile* package)
  2799. - HttpRequest* MakeHttpRequest(const String url, const String verb = String::EMPTY)
  2800. - HttpRequest* MakeHttpRequest(const String url, const String verb, const Vector<String>& headers, const String postData = String::EMPTY)
  2801. - int GetUpdateFps() const
  2802. - Connection* GetServerConnection() const
  2803. - bool IsServerRunning() const
  2804. - bool CheckRemoteEvent(StringHash eventType) const
  2805. - const String GetPackageCacheDir() const
  2806. Properties:
  2807. - int updateFps
  2808. - Connection* serverConnection (readonly)
  2809. - bool serverRunning (readonly)
  2810. - String packageCacheDir
  2811. <a name="Class_NetworkPriority"></a>
  2812. ### NetworkPriority : Component
  2813. Methods:
  2814. - void SetBasePriority(float priority)
  2815. - void SetDistanceFactor(float factor)
  2816. - void SetMinPriority(float priority)
  2817. - void SetAlwaysUpdateOwner(bool enable)
  2818. - float GetBasePriority() const
  2819. - float GetDistanceFactor() const
  2820. - float GetMinPriority() const
  2821. - bool GetAlwaysUpdateOwner() const
  2822. - bool CheckUpdate(float distance, float accumulator)
  2823. Properties:
  2824. - float basePriority
  2825. - float distanceFactor
  2826. - float minPriority
  2827. - bool alwaysUpdateOwner
  2828. <a name="Class_Node"></a>
  2829. ### Node : Animatable
  2830. Methods:
  2831. - Node() (GC)
  2832. - Node* new()
  2833. - void delete()
  2834. - bool SaveXML(File* dest) const
  2835. - void SetName(const String name)
  2836. - void SetPosition(const Vector3& position)
  2837. - void SetPosition2D(const Vector2& position)
  2838. - void SetPosition2D(float x, float y)
  2839. - void SetRotation(const Quaternion& rotation)
  2840. - void SetRotation2D(float rotation)
  2841. - void SetDirection(const Vector3& direction)
  2842. - void SetScale(float scale)
  2843. - void SetScale(const Vector3& scale)
  2844. - void SetScale2D(const Vector2& scale)
  2845. - void SetScale2D(float x, float y)
  2846. - void SetTransform(const Vector3& position, const Quaternion& rotation)
  2847. - void SetTransform(const Vector3& position, const Quaternion& rotation, const Vector3& scale)
  2848. - void SetTransform(const Vector3& position, const Quaternion& rotation, float scale)
  2849. - void SetTransform2D(const Vector2& position, float rotation)
  2850. - void SetTransform2D(const Vector2& position, float rotation, const Vector2& scale)
  2851. - void SetTransform2D(const Vector2& position, float rotation, float scale)
  2852. - void SetWorldPosition(const Vector3& position)
  2853. - void SetWorldPosition2D(const Vector2& position)
  2854. - void SetWorldPosition2D(float x, float y)
  2855. - void SetWorldRotation(const Quaternion& rotation)
  2856. - void SetWorldRotation2D(float rotation)
  2857. - void SetWorldDirection(const Vector3& direction)
  2858. - void SetWorldScale(float scale)
  2859. - void SetWorldScale(const Vector3& scale)
  2860. - void SetWorldScale2D(const Vector2& scale)
  2861. - void SetWorldScale2D(float x, float y)
  2862. - void SetWorldTransform(const Vector3& position, const Quaternion& rotation)
  2863. - void SetWorldTransform(const Vector3& position, const Quaternion& rotation, const Vector3& scale)
  2864. - void SetWorldTransform(const Vector3& position, const Quaternion& rotation, float scale)
  2865. - void SetWorldTransform2D(const Vector2& position, float rotation)
  2866. - void SetWorldTransform2D(const Vector2& position, float rotation, const Vector2& scale)
  2867. - void SetWorldTransform2D(const Vector2& position, float rotation, float scale)
  2868. - void Translate(const Vector3& delta, TransformSpace space = TS_LOCAL)
  2869. - void Translate2D(const Vector2& delta, TransformSpace space = TS_LOCAL)
  2870. - void Rotate(const Quaternion& delta, TransformSpace space = TS_LOCAL)
  2871. - void Rotate2D(float delta, TransformSpace space = TS_LOCAL)
  2872. - void RotateAround(const Vector3& point, const Quaternion& delta, TransformSpace space = TS_LOCAL)
  2873. - void RotateAround2D(const Vector2& point, float delta, TransformSpace space = TS_LOCAL)
  2874. - void Pitch(float angle, TransformSpace space = TS_LOCAL)
  2875. - void Yaw(float angle, TransformSpace space = TS_LOCAL)
  2876. - void Roll(float angle, TransformSpace space = TS_LOCAL)
  2877. - bool LookAt(const Vector3& target)
  2878. - bool LookAt(const Vector3& target, const Vector3& upAxis, TransformSpace space = TS_WORLD)
  2879. - void Scale(float scale)
  2880. - void Scale(const Vector3& scale)
  2881. - void Scale2D(const Vector2& scale)
  2882. - void SetEnabled(bool enable)
  2883. - void SetDeepEnabled(bool enable)
  2884. - void ResetDeepEnabled()
  2885. - void SetEnabledRecursive(bool enable)
  2886. - void SetOwner(Connection* owner)
  2887. - void MarkDirty()
  2888. - Node* CreateChild(const String name = String::EMPTY, CreateMode mode = REPLICATED, unsigned id = 0)
  2889. - void AddChild(Node* node, unsigned index = M_MAX_UNSIGNED)
  2890. - void RemoveChild(Node* node)
  2891. - void RemoveAllChildren()
  2892. - void RemoveChildren(bool removeReplicated, bool removeLocal, bool recursive)
  2893. - void RemoveComponent(Component* component)
  2894. - void RemoveComponent(StringHash type)
  2895. - void RemoveComponent(const String type)
  2896. - void RemoveAllComponents()
  2897. - void RemoveComponents(bool removeReplicated, bool removeLocal)
  2898. - Node* Clone(CreateMode mode = REPLICATED)
  2899. - void Remove()
  2900. - void SetParent(Node* parent)
  2901. - void SetVar(StringHash key, const Variant& value)
  2902. - void AddListener(Component* component)
  2903. - void RemoveListener(Component* component)
  2904. - Component* CreateComponent(const String type, CreateMode mode = REPLICATED, unsigned id = 0)
  2905. - Component* GetOrCreateComponent(const String type, CreateMode mode = REPLICATED, unsigned id = 0)
  2906. - Component* CloneComponent(Component* component, unsigned id = 0)
  2907. - Component* CloneComponent(Component* component, CreateMode mode, unsigned id = 0)
  2908. - int CreateScriptObject(const String scriptObjectType)
  2909. - int CreateScriptObject(const String fileName, const String scriptObjectType)
  2910. - int GetScriptObject() const
  2911. - int GetScriptObject(const String scriptObjectType) const
  2912. - unsigned GetID() const
  2913. - const String GetName() const
  2914. - StringHash GetNameHash() const
  2915. - Node* GetParent() const
  2916. - Scene* GetScene() const
  2917. - bool IsEnabled() const
  2918. - bool IsEnabledSelf() const
  2919. - Connection* GetOwner() const
  2920. - const Vector3& GetPosition() const
  2921. - Vector2 GetPosition2D() const
  2922. - const Quaternion& GetRotation() const
  2923. - float GetRotation2D() const
  2924. - Vector3 GetDirection() const
  2925. - Vector3 GetUp() const
  2926. - Vector3 GetRight() const
  2927. - const Vector3& GetScale() const
  2928. - Vector2 GetScale2D() const
  2929. - Matrix3x4 GetTransform() const
  2930. - Vector3 GetWorldPosition() const
  2931. - Vector2 GetWorldPosition2D() const
  2932. - Quaternion GetWorldRotation() const
  2933. - float GetWorldRotation2D() const
  2934. - Vector3 GetWorldDirection() const
  2935. - Vector3 GetWorldUp() const
  2936. - Vector3 GetWorldRight() const
  2937. - Vector3 GetWorldScale() const
  2938. - Vector2 GetWorldScale2D() const
  2939. - const Matrix3x4& GetWorldTransform() const
  2940. - Vector3 LocalToWorld(const Vector3& position) const
  2941. - Vector3 LocalToWorld(const Vector4& vector) const
  2942. - Vector2 LocalToWorld2D(const Vector2& vector) const
  2943. - Vector3 WorldToLocal(const Vector3& position) const
  2944. - Vector3 WorldToLocal(const Vector4& vector) const
  2945. - Vector2 WorldToLocal2D(const Vector2& vector) const
  2946. - bool IsDirty() const
  2947. - unsigned GetNumChildren(bool recursive = false) const
  2948. - Node* GetChild(const String name, bool recursive = false) const
  2949. - Node* GetChild(StringHash nameHash, bool recursive = false) const
  2950. - Node* GetChild(unsigned index) const
  2951. - unsigned GetNumComponents() const
  2952. - unsigned GetNumNetworkComponents() const
  2953. - bool HasComponent(StringHash type) const
  2954. - bool HasComponent(const String type) const
  2955. - const Variant& GetVar(StringHash key) const
  2956. - const VariantMap& GetVars() const
  2957. - Component* GetComponent(const String type) const
  2958. - void SetID(unsigned id)
  2959. - void SetScene(Scene* scene)
  2960. - void ResetScene()
  2961. - bool Load(Deserializer& source, SceneResolver& resolver, bool loadChildren = true, bool rewriteIDs = false, CreateMode mode = REPLICATED)
  2962. - bool LoadXML(const XMLElement& source, SceneResolver& resolver, bool loadChildren = true, bool rewriteIDs = false, CreateMode mode = REPLICATED)
  2963. - Node* CreateChild(unsigned id, CreateMode mode)
  2964. - void AddComponent(Component* component, unsigned id, CreateMode mode)
  2965. Properties:
  2966. - unsigned ID
  2967. - String name
  2968. - StringHash nameHash (readonly)
  2969. - Node* parent
  2970. - Scene* scene
  2971. - bool enabled
  2972. - bool enabledSelf (readonly)
  2973. - Connection* owner
  2974. - Vector3& position
  2975. - Vector2 position2D
  2976. - Quaternion& rotation
  2977. - float rotation2D
  2978. - Vector3 direction
  2979. - Vector3 up (readonly)
  2980. - Vector3 right (readonly)
  2981. - Vector3& scale
  2982. - Vector2 scale2D
  2983. - Matrix3x4 transform (readonly)
  2984. - Vector3 worldPosition
  2985. - Vector2 worldPosition2D
  2986. - Quaternion worldRotation
  2987. - float worldRotation2D
  2988. - Vector3 worldDirection
  2989. - Vector3 worldUp (readonly)
  2990. - Vector3 worldRight (readonly)
  2991. - Vector3 worldScale
  2992. - Vector2 worldScale2D
  2993. - Matrix3x4& worldTransform (readonly)
  2994. - bool dirty (readonly)
  2995. - unsigned numComponents (readonly)
  2996. - unsigned numNetworkComponents (readonly)
  2997. <a name="Class_Object"></a>
  2998. ### Object : RefCounted
  2999. Methods:
  3000. - StringHash GetType() const
  3001. - StringHash GetBaseType() const
  3002. - const String GetTypeName() const
  3003. - const String GetCategory() const
  3004. - void SendEvent(const String eventName, VariantMap* eventData = 0)
  3005. Properties:
  3006. - StringHash type (readonly)
  3007. - StringHash baseType (readonly)
  3008. - const String typeName (readonly)
  3009. - const String category (readonly)
  3010. <a name="Class_ObjectAnimation"></a>
  3011. ### ObjectAnimation : Resource
  3012. Methods:
  3013. - ObjectAnimation() (GC)
  3014. - ObjectAnimation* new()
  3015. - void delete()
  3016. - void AddAttributeAnimation(const String name, ValueAnimation* attributeAnimation, WrapMode wrapMode = WM_LOOP, float speed = 1.0f)
  3017. - void RemoveAttributeAnimation(const String name)
  3018. - void RemoveAttributeAnimation(ValueAnimation* attributeAnimation)
  3019. - ValueAnimation* GetAttributeAnimation(const String name) const
  3020. - WrapMode GetAttributeAnimationWrapMode(const String name) const
  3021. - float GetAttributeAnimationSpeed(const String name) const
  3022. <a name="Class_Octree"></a>
  3023. ### Octree : Component
  3024. Methods:
  3025. - void SetSize(const BoundingBox& box, unsigned numLevels)
  3026. - void Update(const FrameInfo& frame)
  3027. - void AddManualDrawable(Drawable* drawable)
  3028. - void RemoveManualDrawable(Drawable* drawable)
  3029. - const PODVector<OctreeQueryResult>& GetDrawables(const Vector3& point, char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3030. - const PODVector<OctreeQueryResult>& GetDrawables(const BoundingBox& box, char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3031. - const PODVector<OctreeQueryResult>& GetDrawables(const Frustum& frustum, char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3032. - const PODVector<OctreeQueryResult>& GetDrawables(const Sphere& sphere, char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  3033. - const PODVector<RayQueryResult>& Raycast(const Ray& ray, RayQueryLevel level, float maxDistance, char drawableFlags, unsigned viewMask = DEFAULT_VIEWMASK) const
  3034. - RayQueryResult RaycastSingle(const Ray& ray, RayQueryLevel level, float maxDistance, char drawableFlags, unsigned viewMask = DEFAULT_VIEWMASK) const
  3035. - unsigned GetNumLevels() const
  3036. - void QueueUpdate(Drawable* drawable)
  3037. - void DrawDebugGeometry(bool depthTest)
  3038. Properties:
  3039. - unsigned numLevels (readonly)
  3040. <a name="Class_OctreeQueryResult"></a>
  3041. ### OctreeQueryResult
  3042. Methods:
  3043. - OctreeQueryResult() (GC)
  3044. - OctreeQueryResult* new()
  3045. - void delete()
  3046. Properties:
  3047. - Drawable* drawable
  3048. - Node* node
  3049. <a name="Class_OffMeshConnection"></a>
  3050. ### OffMeshConnection : Component
  3051. Methods:
  3052. - void SetEndPoint(Node* node)
  3053. - void SetRadius(float radius)
  3054. - void SetBidirectional(bool enabled)
  3055. - Node* GetEndPoint() const
  3056. - float GetRadius() const
  3057. - bool IsBidirectional() const
  3058. Properties:
  3059. - Node* endPoint
  3060. - float radius
  3061. - bool bidirectional
  3062. <a name="Class_PackageEntry"></a>
  3063. ### PackageEntry
  3064. Properties:
  3065. - unsigned offset
  3066. - unsigned size
  3067. - unsigned checksum
  3068. <a name="Class_PackageFile"></a>
  3069. ### PackageFile : Object
  3070. Methods:
  3071. - PackageFile() (GC)
  3072. - PackageFile* new()
  3073. - PackageFile(const String fileName, unsigned startOffset = 0) (GC)
  3074. - PackageFile* new(const String fileName, unsigned startOffset = 0)
  3075. - void delete()
  3076. - bool Open(const String fileName, unsigned startOffset = 0)
  3077. - bool Exists(const String fileName) const
  3078. - const PackageEntry* GetEntry(const String fileName) const
  3079. - const HashMap<String,PackageEntry>& GetEntries() const
  3080. - const String GetName() const
  3081. - StringHash GetNameHash() const
  3082. - unsigned GetNumFiles() const
  3083. - unsigned GetTotalSize() const
  3084. - unsigned GetChecksum() const
  3085. - bool IsCompressed() const
  3086. Properties:
  3087. - String name (readonly)
  3088. - StringHash nameHash (readonly)
  3089. - unsigned numFiles (readonly)
  3090. - unsigned totalSize (readonly)
  3091. - unsigned checksum (readonly)
  3092. - bool compressed (readonly)
  3093. <a name="Class_ParticleEffect"></a>
  3094. ### ParticleEffect : Resource
  3095. Methods:
  3096. - void SetMaterial(Material* material)
  3097. - void SetNumParticles(unsigned num)
  3098. - void SetUpdateInvisible(bool enable)
  3099. - void SetRelative(bool enable)
  3100. - void SetScaled(bool enable)
  3101. - void SetSorted(bool enable)
  3102. - void SetAnimationLodBias(float lodBias)
  3103. - void SetEmitterType(EmitterType type)
  3104. - void SetEmitterSize(const Vector3& size)
  3105. - void SetMinDirection(const Vector3& direction)
  3106. - void SetMaxDirection(const Vector3& direction)
  3107. - void SetConstantForce(const Vector3& force)
  3108. - void SetDampingForce(float force)
  3109. - void SetActiveTime(float time)
  3110. - void SetInactiveTime(float time)
  3111. - void SetMinEmissionRate(float rate)
  3112. - void SetMaxEmissionRate(float rate)
  3113. - void SetMinParticleSize(const Vector2& size)
  3114. - void SetMaxParticleSize(const Vector2& size)
  3115. - void SetMinTimeToLive(float time)
  3116. - void SetMaxTimeToLive(float time)
  3117. - void SetMinVelocity(float velocity)
  3118. - void SetMaxVelocity(float velocity)
  3119. - void SetMinRotation(float rotation)
  3120. - void SetMaxRotation(float rotation)
  3121. - void SetMinRotationSpeed(float speed)
  3122. - void SetMaxRotationSpeed(float speed)
  3123. - void SetSizeAdd(float sizeAdd)
  3124. - void SetSizeMul(float sizeMul)
  3125. - void SetColorFrame(unsigned index, const ColorFrame& colorFrame)
  3126. - void SetTextureFrame(unsigned index, const TextureFrame& textureFrame)
  3127. - Material* GetMaterial() const
  3128. - unsigned GetNumParticles() const
  3129. - bool GetUpdateInvisible() const
  3130. - bool IsRelative() const
  3131. - bool IsScaled() const
  3132. - bool IsSorted() const
  3133. - float GetAnimationLodBias() const
  3134. - EmitterType GetEmitterType() const
  3135. - const Vector3& GetEmitterSize() const
  3136. - const Vector3& GetMinDirection() const
  3137. - const Vector3& GetMaxDirection() const
  3138. - const Vector3& GetConstantForce() const
  3139. - float GetDampingForce() const
  3140. - float GetActiveTime() const
  3141. - float GetInactiveTime() const
  3142. - float GetMinEmissionRate() const
  3143. - float GetMaxEmissionRate() const
  3144. - const Vector2& GetMinParticleSize() const
  3145. - const Vector2& GetMaxParticleSize() const
  3146. - float GetMinTimeToLive() const
  3147. - float GetMaxTimeToLive() const
  3148. - float GetMinVelocity() const
  3149. - float GetMaxVelocity() const
  3150. - float GetMinRotation() const
  3151. - float GetMaxRotation() const
  3152. - float GetMinRotationSpeed() const
  3153. - float GetMaxRotationSpeed() const
  3154. - float GetSizeAdd() const
  3155. - float GetSizeMul() const
  3156. - unsigned GetNumColorFrames() const
  3157. - const ColorFrame* GetColorFrame(unsigned index) const
  3158. - unsigned GetNumTextureFrames() const
  3159. - const TextureFrame* GetTextureFrame(unsigned index) const
  3160. Properties:
  3161. - Material* material
  3162. - unsigned numParticles
  3163. - bool updateInvisible
  3164. - bool relative
  3165. - bool scaled
  3166. - bool sorted
  3167. - float animationLodBias
  3168. - EmitterType emitterType
  3169. - const Vector3& emitterSize
  3170. - const Vector3& minDirection
  3171. - const Vector3& maxDirection
  3172. - const Vector3& constantForce
  3173. - float dampingForce
  3174. - float activeTime
  3175. - float inactiveTime
  3176. - float minEmissionRate
  3177. - float maxEmissionRate
  3178. - const Vector2& minParticleSize
  3179. - const Vector2& maxParticleSize
  3180. - float minTimeToLive
  3181. - float maxTimeToLive
  3182. - float minVelocity
  3183. - float maxVelocity
  3184. - float minRotation
  3185. - float maxRotation
  3186. - float minRotationSpeed
  3187. - float maxRotationSpeed
  3188. - float sizeAdd
  3189. - float sizeMul
  3190. - unsigned numColorFrames
  3191. - unsigned numTextureFrames
  3192. <a name="Class_ParticleEffect2D"></a>
  3193. ### ParticleEffect2D : Resource
  3194. <a name="Class_ParticleEmitter"></a>
  3195. ### ParticleEmitter : BillboardSet
  3196. Methods:
  3197. - void SetEffect(ParticleEffect* effect)
  3198. - void SetNumParticles(unsigned num)
  3199. - void SetEmitting(bool enable)
  3200. - void SetSerializeParticles(bool enable)
  3201. - void ResetEmissionTimer()
  3202. - void RemoveAllParticles()
  3203. - void Reset()
  3204. - void ApplyEffect()
  3205. - ParticleEffect* GetEffect() const
  3206. - unsigned GetNumParticles() const
  3207. - bool IsEmitting() const
  3208. - bool GetSerializeParticles() const
  3209. Properties:
  3210. - ParticleEffect* effect
  3211. - unsigned numParticles
  3212. - bool emitting
  3213. - bool serializeParticles
  3214. <a name="Class_ParticleEmitter2D"></a>
  3215. ### ParticleEmitter2D : Drawable2D
  3216. Methods:
  3217. - void SetEffect(ParticleEffect2D* effect)
  3218. - ParticleEffect2D* GetEffect() const
  3219. - void SetSprite(Sprite2D* sprite)
  3220. - Sprite2D* GetSprite() const
  3221. Properties:
  3222. - ParticleEffect2D* effect
  3223. - Sprite2D* sprite
  3224. <a name="Class_Pass"></a>
  3225. ### Pass : RefCounted
  3226. Methods:
  3227. - bool IsSM3() const
  3228. - bool IsDesktop() const
  3229. - const String GetVertexShader() const
  3230. - const String GetPixelShader() const
  3231. Properties:
  3232. - bool SM3 (readonly)
  3233. - bool desktop (readonly)
  3234. - const String vertexShader (readonly)
  3235. - const String pixelShader (readonly)
  3236. <a name="Class_PhysicsRaycastResult"></a>
  3237. ### PhysicsRaycastResult
  3238. Methods:
  3239. - PhysicsRaycastResult() (GC)
  3240. - PhysicsRaycastResult* new()
  3241. - void delete()
  3242. Properties:
  3243. - Vector3 position
  3244. - Vector3 normal
  3245. - float distance
  3246. - RigidBody* body
  3247. <a name="Class_PhysicsRaycastResult2D"></a>
  3248. ### PhysicsRaycastResult2D
  3249. Methods:
  3250. - PhysicsRaycastResult2D() (GC)
  3251. - PhysicsRaycastResult2D* new()
  3252. - void delete()
  3253. Properties:
  3254. - Vector2 position
  3255. - Vector2 normal
  3256. - float distance
  3257. - RigidBody2D* body
  3258. <a name="Class_PhysicsWorld"></a>
  3259. ### PhysicsWorld : Component
  3260. Methods:
  3261. - void Update(float timeStep)
  3262. - void UpdateCollisions()
  3263. - void SetFps(int fps)
  3264. - void SetGravity(const Vector3& gravity)
  3265. - void SetMaxSubSteps(int num)
  3266. - void SetNumIterations(int num)
  3267. - void SetInterpolation(bool enable)
  3268. - void SetInternalEdge(bool enable)
  3269. - void SetSplitImpulse(bool enable)
  3270. - void SetMaxNetworkAngularVelocity(float velocity)
  3271. - const PODVector<PhysicsRaycastResult>& Raycast(const Ray& ray, float maxDistance, unsigned collisionMask = M_MAX_UNSIGNED)
  3272. - PhysicsRaycastResult RaycastSingle(const Ray& ray, float maxDistance, unsigned collisionMask = M_MAX_UNSIGNED)
  3273. - PhysicsRaycastResult SphereCast(const Ray& ray, float radius, float maxDistance, unsigned collisionMask = M_MAX_UNSIGNED)
  3274. - PhysicsRaycastResult ConvexCast(CollisionShape* shape, const Vector3& startPos, const Quaternion& startRot, const Vector3& endPos, const Quaternion& endRot, unsigned collisionMask = M_MAX_UNSIGNED)
  3275. - const PODVector<RigidBody*>& GetRigidBodies(const Sphere& sphere, unsigned collisionMask = M_MAX_UNSIGNED)
  3276. - const PODVector<RigidBody*>& GetRigidBodies(const BoundingBox& box, unsigned collisionMask = M_MAX_UNSIGNED)
  3277. - const PODVector<RigidBody*>& GetRigidBodies(const RigidBody* body)
  3278. - void DrawDebugGeometry(bool depthTest)
  3279. - void RemoveCachedGeometry(Model* model)
  3280. - Vector3 GetGravity() const
  3281. - int GetMaxSubSteps() const
  3282. - int GetNumIterations() const
  3283. - bool GetInterpolation() const
  3284. - bool GetInternalEdge() const
  3285. - bool GetSplitImpulse() const
  3286. - int GetFps() const
  3287. - float GetMaxNetworkAngularVelocity() const
  3288. Properties:
  3289. - Vector3 gravity
  3290. - int maxSubSteps
  3291. - int numIterations
  3292. - bool interpolation
  3293. - bool internalEdge
  3294. - bool splitImpulse
  3295. - int fps
  3296. - float maxNetworkAngularVelocity
  3297. - bool applyingTransforms
  3298. <a name="Class_PhysicsWorld2D"></a>
  3299. ### PhysicsWorld2D : Component
  3300. Methods:
  3301. - void DrawDebugGeometry()
  3302. - void SetDrawShape(bool drawShape)
  3303. - void SetDrawJoint(bool drawJoint)
  3304. - void SetDrawAabb(bool drawAabb)
  3305. - void SetDrawPair(bool drawPair)
  3306. - void SetDrawCenterOfMass(bool drawCenterOfMass)
  3307. - void SetAllowSleeping(bool enable)
  3308. - void SetWarmStarting(bool enable)
  3309. - void SetContinuousPhysics(bool enable)
  3310. - void SetSubStepping(bool enable)
  3311. - void SetGravity(const Vector2& gravity)
  3312. - void SetAutoClearForces(bool enable)
  3313. - void SetVelocityIterations(int velocityIterations)
  3314. - void SetPositionIterations(int positionIterations)
  3315. - const PODVector<PhysicsRaycastResult2D>& Raycast(const Vector2& startPoint, const Vector2& endPoint, unsigned collisionMask = M_MAX_UNSIGNED)
  3316. - PhysicsRaycastResult2D RaycastSingle(const Vector2& startPoint, const Vector2& endPoint, unsigned collisionMask = M_MAX_UNSIGNED)
  3317. - RigidBody2D* GetRigidBody(const Vector2& point, unsigned collisionMask = M_MAX_UNSIGNED)
  3318. - RigidBody2D* GetRigidBody(int screenX, int screenY, unsigned collisionMask = M_MAX_UNSIGNED)
  3319. - const PODVector<RigidBody2D*>& GetRigidBodies(const Rect& aabb, unsigned collisionMask = M_MAX_UNSIGNED)
  3320. - bool GetDrawShape() const
  3321. - bool GetDrawJoint() const
  3322. - bool GetDrawAabb() const
  3323. - bool GetDrawPair() const
  3324. - bool GetDrawCenterOfMass() const
  3325. - bool GetAllowSleeping() const
  3326. - bool GetWarmStarting() const
  3327. - bool GetContinuousPhysics() const
  3328. - bool GetSubStepping() const
  3329. - bool GetAutoClearForces() const
  3330. - const Vector2& GetGravity() const
  3331. - int GetVelocityIterations() const
  3332. - int GetPositionIterations() const
  3333. Properties:
  3334. - bool drawShape
  3335. - bool drawJoint
  3336. - bool drawAabb
  3337. - bool drawPair
  3338. - bool drawCenterOfMass
  3339. - bool allowSleeping
  3340. - bool warmStarting
  3341. - bool continuousPhysics
  3342. - bool subStepping
  3343. - bool autoClearForces
  3344. - Vector2& gravity
  3345. - int velocityIterations
  3346. - int positionIterations
  3347. <a name="Class_Plane"></a>
  3348. ### Plane
  3349. Methods:
  3350. - Plane() (GC)
  3351. - Plane* new()
  3352. - Plane(const Plane& plane) (GC)
  3353. - Plane* new(const Plane& plane)
  3354. - Plane(const Vector3& v0, const Vector3& v1, const Vector3& v2) (GC)
  3355. - Plane* new(const Vector3& v0, const Vector3& v1, const Vector3& v2)
  3356. - Plane(const Vector3& normal, const Vector3& point) (GC)
  3357. - Plane* new(const Vector3& normal, const Vector3& point)
  3358. - Plane(const Vector4& plane) (GC)
  3359. - Plane* new(const Vector4& plane)
  3360. - void delete()
  3361. - void Define(const Vector3& v0, const Vector3& v1, const Vector3& v2)
  3362. - void Define(const Vector3& normal, const Vector3& point)
  3363. - void Define(const Vector4& plane)
  3364. - void Transform(const Matrix3& transform)
  3365. - void Transform(const Matrix3x4& transform)
  3366. - void Transform(const Matrix4& transform)
  3367. - Vector3 Project(const Vector3& point) const
  3368. - float Distance(const Vector3& point) const
  3369. - Vector3 Reflect(const Vector3& direction) const
  3370. - Matrix3x4 ReflectionMatrix() const
  3371. - Plane Transformed(const Matrix3& transform) const
  3372. - Plane Transformed(const Matrix3x4& transform) const
  3373. - Plane Transformed(const Matrix4& transform) const
  3374. - Vector4 ToVector4() const
  3375. Properties:
  3376. - Vector3 normal
  3377. - Vector3 absNormal
  3378. - float d
  3379. - const Plane UP
  3380. <a name="Class_Polyhedron"></a>
  3381. ### Polyhedron
  3382. Methods:
  3383. - Polyhedron() (GC)
  3384. - Polyhedron* new()
  3385. - Polyhedron(const Polyhedron& polyhedron) (GC)
  3386. - Polyhedron* new(const Polyhedron& polyhedron)
  3387. - Polyhedron(const BoundingBox& box) (GC)
  3388. - Polyhedron* new(const BoundingBox& box)
  3389. - Polyhedron(const Frustum& frustum) (GC)
  3390. - Polyhedron* new(const Frustum& frustum)
  3391. - void delete()
  3392. - void Define(const BoundingBox& box)
  3393. - void Define(const Frustum& frustum)
  3394. - void AddFace(const Vector3& v0, const Vector3& v1, const Vector3& v2)
  3395. - void AddFace(const Vector3& v0, const Vector3& v1, const Vector3& v2, const Vector3& v3)
  3396. - void Clip(const Plane& plane)
  3397. - void Clip(const BoundingBox& box)
  3398. - void Clip(const Frustum& box)
  3399. - void Clear()
  3400. - void Transform(const Matrix3& transform)
  3401. - void Transform(const Matrix3x4& transform)
  3402. - Polyhedron Transformed(const Matrix3& transform) const
  3403. - Polyhedron Transformed(const Matrix3x4& transform) const
  3404. - bool Empty() const
  3405. Properties:
  3406. - bool empty (readonly)
  3407. <a name="Class_PropertySet2D"></a>
  3408. ### PropertySet2D
  3409. Methods:
  3410. - bool HasProperty(const String name) const
  3411. - const String GetProperty(const String name) const
  3412. <a name="Class_Quaternion"></a>
  3413. ### Quaternion
  3414. Methods:
  3415. - Quaternion() (GC)
  3416. - Quaternion* new()
  3417. - Quaternion(const Quaternion& quat) (GC)
  3418. - Quaternion* new(const Quaternion& quat)
  3419. - Quaternion(float w, float x, float y, float z) (GC)
  3420. - Quaternion* new(float w, float x, float y, float z)
  3421. - Quaternion(float angle, const Vector3& axis) (GC)
  3422. - Quaternion* new(float angle, const Vector3& axis)
  3423. - Quaternion(float angle) (GC)
  3424. - Quaternion* new(float angle)
  3425. - Quaternion(float x, float y, float z) (GC)
  3426. - Quaternion* new(float x, float y, float z)
  3427. - Quaternion(const Vector3& start, const Vector3& end) (GC)
  3428. - Quaternion* new(const Vector3& start, const Vector3& end)
  3429. - Quaternion(const Vector3& xAxis, const Vector3& yAxis, const Vector3& zAxis) (GC)
  3430. - Quaternion* new(const Vector3& xAxis, const Vector3& yAxis, const Vector3& zAxis)
  3431. - Quaternion(const Matrix3& matrix) (GC)
  3432. - Quaternion* new(const Matrix3& matrix)
  3433. - void delete()
  3434. - bool operator==(const Quaternion& rhs) const
  3435. - Quaternion operator*(float rhs) const
  3436. - Quaternion operator-() const
  3437. - bool operator==(const Quaternion& rhs) const
  3438. - Quaternion operator*(float rhs) const
  3439. - Quaternion operator-() const
  3440. - Quaternion operator+(const Quaternion& rhs) const
  3441. - Quaternion operator-(const Quaternion& rhs) const
  3442. - Quaternion operator*(const Quaternion& rhs) const
  3443. - Vector3 operator*(const Vector3& rhs) const
  3444. - void FromAngleAxis(float angle, const Vector3& axis)
  3445. - void FromEulerAngles(float x, float y, float z)
  3446. - void FromRotationTo(const Vector3& start, const Vector3& end)
  3447. - void FromAxes(const Vector3& xAxis, const Vector3& yAxis, const Vector3& zAxis)
  3448. - void FromRotationMatrix(const Matrix3& matrix)
  3449. - bool FromLookRotation(const Vector3& direction, const Vector3& up)
  3450. - void Normalize()
  3451. - Quaternion Normalized() const
  3452. - Quaternion Inverse() const
  3453. - float LengthSquared() const
  3454. - float DotProduct(const Quaternion& rhs) const
  3455. - bool Equals(const Quaternion& rhs) const
  3456. - bool IsNaN() const
  3457. - Quaternion Conjugate() const
  3458. - Vector3 EulerAngles() const
  3459. - float YawAngle() const
  3460. - float PitchAngle() const
  3461. - float RollAngle() const
  3462. - Matrix3 RotationMatrix() const
  3463. - Quaternion Slerp(Quaternion rhs, float t) const
  3464. - Quaternion Nlerp(Quaternion rhs, float t, bool shortestPath) const
  3465. - String ToString() const
  3466. Properties:
  3467. - float w
  3468. - float x
  3469. - float y
  3470. - float z
  3471. - const Quaternion IDENTITY
  3472. <a name="Class_Ray"></a>
  3473. ### Ray
  3474. Methods:
  3475. - Ray() (GC)
  3476. - Ray* new()
  3477. - Ray(const Vector3& origin, const Vector3& direction) (GC)
  3478. - Ray* new(const Vector3& origin, const Vector3& direction)
  3479. - Ray(const Ray& ray) (GC)
  3480. - Ray* new(const Ray& ray)
  3481. - void delete()
  3482. - bool operator==(const Ray& rhs) const
  3483. - void Define(const Vector3& origin, const Vector3& direction)
  3484. - Vector3 Project(const Vector3& point) const
  3485. - float Distance(const Vector3& point) const
  3486. - Vector3 ClosestPoint(const Ray& ray) const
  3487. - float HitDistance(const Plane& plane) const
  3488. - float HitDistance(const BoundingBox& box) const
  3489. - float HitDistance(const Frustum& frustum, bool solidInside = true) const
  3490. - float HitDistance(const Sphere& sphere) const
  3491. - float HitDistance(const Vector3& v0, const Vector3& v1, const Vector3& v2) const
  3492. - Ray Transformed(const Matrix3x4& transform) const
  3493. Properties:
  3494. - Vector3 origin
  3495. - Vector3 direction
  3496. <a name="Class_RayQueryResult"></a>
  3497. ### RayQueryResult
  3498. Methods:
  3499. - RayQueryResult() (GC)
  3500. - RayQueryResult* new()
  3501. - void delete()
  3502. Properties:
  3503. - Vector3 position
  3504. - Vector3 normal
  3505. - float distance
  3506. - Drawable* drawable
  3507. - Node* node
  3508. - unsigned subObject
  3509. <a name="Class_Rect"></a>
  3510. ### Rect
  3511. Methods:
  3512. - Rect() (GC)
  3513. - Rect* new()
  3514. - Rect(const Rect& rect) (GC)
  3515. - Rect* new(const Rect& rect)
  3516. - Rect(const Vector2& min, const Vector2& max) (GC)
  3517. - Rect* new(const Vector2& min, const Vector2& max)
  3518. - Rect(float left, float top, float right, float bottom) (GC)
  3519. - Rect* new(float left, float top, float right, float bottom)
  3520. - Rect(const Vector4& vector) (GC)
  3521. - Rect* new(const Vector4& vector)
  3522. - void delete()
  3523. - bool operator==(const Rect& rhs) const
  3524. - void Define(const Rect& rect)
  3525. - void Define(const Vector2& min, const Vector2& max)
  3526. - void Define(const Vector2& point)
  3527. - void Merge(const Vector2& point)
  3528. - void Merge(const Rect& rect)
  3529. - void Clear()
  3530. - void Clip(const Rect& rect)
  3531. - Vector2 Center() const
  3532. - Vector2 Size() const
  3533. - Vector2 HalfSize() const
  3534. - bool Equals(const Rect& rhs) const
  3535. - Intersection IsInside(const Vector2& point) const
  3536. - Vector4 ToVector4() const
  3537. - String ToString() const
  3538. Properties:
  3539. - Vector2 min
  3540. - Vector2 max
  3541. - const Rect FULL
  3542. - const Rect POSITIVE
  3543. - const Rect ZERO
  3544. - Vector2 center (readonly)
  3545. - Vector2 size (readonly)
  3546. - Vector2 halfSize (readonly)
  3547. <a name="Class_RemoteEvent"></a>
  3548. ### RemoteEvent
  3549. Properties:
  3550. - unsigned senderID
  3551. - StringHash eventType
  3552. - VariantMap eventData
  3553. - bool inOrder
  3554. <a name="Class_RenderPath"></a>
  3555. ### RenderPath
  3556. Methods:
  3557. - RenderPath* Clone()
  3558. - bool Load(XMLFile* file)
  3559. - bool Append(XMLFile* file)
  3560. - void SetEnabled(const String tag, bool active)
  3561. - void ToggleEnabled(const String tag)
  3562. - void SetRenderTarget(unsigned index, const RenderTargetInfo& info)
  3563. - void AddRenderTarget(const RenderTargetInfo& info)
  3564. - void RemoveRenderTarget(const String name)
  3565. - void RemoveRenderTarget(unsigned index)
  3566. - void RemoveRenderTargets(const String tag)
  3567. - void SetCommand(unsigned index, const RenderPathCommand& command)
  3568. - void AddCommand(const RenderPathCommand& command)
  3569. - void InsertCommand(unsigned index, const RenderPathCommand& command)
  3570. - void RemoveCommand(unsigned index)
  3571. - void RemoveCommands(const String tag)
  3572. - void SetShaderParameter(const String name, const Variant& value)
  3573. - unsigned GetNumRenderTargets() const
  3574. - unsigned GetNumCommands() const
  3575. - const Variant& GetShaderParameter(const String name) const
  3576. <a name="Class_RenderSurface"></a>
  3577. ### RenderSurface
  3578. Methods:
  3579. - RenderSurface(Texture* parentTexture) (GC)
  3580. - RenderSurface* new(Texture* parentTexture)
  3581. - void delete()
  3582. - void SetNumViewports(unsigned num)
  3583. - void SetViewport(unsigned index, Viewport* viewport)
  3584. - void SetUpdateMode(RenderSurfaceUpdateMode mode)
  3585. - void SetLinkedRenderTarget(RenderSurface* renderTarget)
  3586. - void SetLinkedDepthStencil(RenderSurface* depthStencil)
  3587. - void QueueUpdate()
  3588. - void Release()
  3589. - Texture* GetParentTexture() const
  3590. - int GetWidth() const
  3591. - int GetHeight() const
  3592. - TextureUsage GetUsage() const
  3593. - unsigned GetNumViewports() const
  3594. - Viewport* GetViewport(unsigned index) const
  3595. - RenderSurfaceUpdateMode GetUpdateMode() const
  3596. - RenderSurface* GetLinkedRenderTarget() const
  3597. - RenderSurface* GetLinkedDepthStencil() const
  3598. Properties:
  3599. - Texture* parentTexture (readonly)
  3600. - int width (readonly)
  3601. - int height (readonly)
  3602. - TextureUsage usage (readonly)
  3603. - unsigned numViewports
  3604. - RenderSurfaceUpdateMode updateMode
  3605. - RenderSurface* linkedRenderTarget
  3606. - RenderSurface* linkedDepthStencil
  3607. <a name="Class_Renderer"></a>
  3608. ### Renderer
  3609. Methods:
  3610. - void SetNumViewports(unsigned num)
  3611. - void SetViewport(unsigned index, Viewport* viewport)
  3612. - void SetDefaultRenderPath(RenderPath* renderPath)
  3613. - void SetDefaultRenderPath(XMLFile* file)
  3614. - void SetHDRRendering(bool enable)
  3615. - void SetSpecularLighting(bool enable)
  3616. - void SetTextureAnisotropy(int level)
  3617. - void SetTextureFilterMode(TextureFilterMode mode)
  3618. - void SetTextureQuality(int quality)
  3619. - void SetMaterialQuality(int quality)
  3620. - void SetDrawShadows(bool enable)
  3621. - void SetShadowMapSize(int size)
  3622. - void SetShadowQuality(int quality)
  3623. - void SetReuseShadowMaps(bool enable)
  3624. - void SetMaxShadowMaps(int shadowMaps)
  3625. - void SetDynamicInstancing(bool enable)
  3626. - void SetMinInstances(int instances)
  3627. - void SetMaxInstanceTriangles(int triangles)
  3628. - void SetMaxSortedInstances(int instances)
  3629. - void SetMaxOccluderTriangles(int triangles)
  3630. - void SetOcclusionBufferSize(int size)
  3631. - void SetOccluderSizeThreshold(float screenSize)
  3632. - void SetMobileShadowBiasMul(float mul)
  3633. - void SetMobileShadowBiasAdd(float add)
  3634. - void ReloadShaders()
  3635. - unsigned GetNumViewports() const
  3636. - Viewport* GetViewport(unsigned index) const
  3637. - RenderPath* GetDefaultRenderPath() const
  3638. - bool GetHDRRendering() const
  3639. - bool GetSpecularLighting() const
  3640. - bool GetDrawShadows() const
  3641. - int GetTextureAnisotropy() const
  3642. - TextureFilterMode GetTextureFilterMode() const
  3643. - int GetTextureQuality() const
  3644. - int GetMaterialQuality() const
  3645. - int GetShadowMapSize() const
  3646. - int GetShadowQuality() const
  3647. - bool GetReuseShadowMaps() const
  3648. - int GetMaxShadowMaps() const
  3649. - bool GetDynamicInstancing() const
  3650. - int GetMinInstances() const
  3651. - int GetMaxInstanceTriangles() const
  3652. - int GetMaxSortedInstances() const
  3653. - int GetMaxOccluderTriangles() const
  3654. - int GetOcclusionBufferSize() const
  3655. - float GetOccluderSizeThreshold() const
  3656. - float GetMobileShadowBiasMul() const
  3657. - float GetMobileShadowBiasAdd() const
  3658. - unsigned GetNumViews() const
  3659. - unsigned GetNumPrimitives() const
  3660. - unsigned GetNumBatches() const
  3661. - unsigned GetNumGeometries(bool allViews = false) const
  3662. - unsigned GetNumLights(bool allViews = false) const
  3663. - unsigned GetNumShadowMaps(bool allViews = false) const
  3664. - unsigned GetNumOccluders(bool allViews = false) const
  3665. - Zone* GetDefaultZone() const
  3666. - Material* GetDefaultMaterial() const
  3667. - Texture2D* GetDefaultLightRamp() const
  3668. - Texture2D* GetDefaultLightSpot() const
  3669. - void DrawDebugGeometry(bool depthTest)
  3670. Properties:
  3671. - unsigned numViewports
  3672. - RenderPath* defaultRenderPath
  3673. - bool HDRRendering
  3674. - bool specularLighting
  3675. - bool drawShadows
  3676. - int textureAnisotropy
  3677. - TextureFilterMode textureFilterMode
  3678. - int textureQuality
  3679. - int materialQuality
  3680. - int shadowMapSize
  3681. - int shadowQuality
  3682. - bool reuseShadowMaps
  3683. - int maxShadowMaps
  3684. - bool dynamicInstancing
  3685. - int minInstances
  3686. - int maxInstanceTriangles
  3687. - int maxSortedInstances
  3688. - int maxOccluderTriangles
  3689. - int occlusionBufferSize
  3690. - float occluderSizeThreshold
  3691. - float mobileShadowBiasMul
  3692. - float mobileShadowBiasAdd
  3693. - unsigned numViews (readonly)
  3694. - unsigned numPrimitives (readonly)
  3695. - unsigned numBatches (readonly)
  3696. - Zone* defaultZone (readonly)
  3697. - Material* defaultMaterial (readonly)
  3698. - Texture2D* defaultLightRamp (readonly)
  3699. - Texture2D* defaultLightSpot (readonly)
  3700. <a name="Class_Resource"></a>
  3701. ### Resource
  3702. Methods:
  3703. - bool Load(Deserializer& source)
  3704. - bool Save(Serializer& dest) const
  3705. - bool Load(const String fileName)
  3706. - bool Save(const String fileName) const
  3707. - const String GetName() const
  3708. - StringHash GetNameHash() const
  3709. - unsigned GetMemoryUse() const
  3710. Properties:
  3711. - String name (readonly)
  3712. - StringHash nameHash (readonly)
  3713. - unsigned memoryUse (readonly)
  3714. <a name="Class_ResourceCache"></a>
  3715. ### ResourceCache
  3716. Methods:
  3717. - void ReleaseAllResources(bool force = false)
  3718. - bool ReloadResource(Resource* resource)
  3719. - void ReloadResourceWithDependencies(const String fileName)
  3720. - void SetMemoryBudget(StringHash type, unsigned budget)
  3721. - void SetMemoryBudget(const String type, unsigned budget)
  3722. - void SetAutoReloadResources(bool enable)
  3723. - void SetReturnFailedResources(bool enable)
  3724. - void SetSearchPackagesFirst(bool value)
  3725. - void SetFinishBackgroundResourcesMs(int ms)
  3726. - File* GetFile(const String name)
  3727. - Resource* GetResource(const String type, const String name, bool sendEventOnFailure = true)
  3728. - bool BackgroundLoadResource(const String type, const String name, bool sendEventOnFailure = true)
  3729. - unsigned GetNumBackgroundLoadResources() const
  3730. - bool Exists(const String name) const
  3731. - unsigned GetMemoryBudget(StringHash type) const
  3732. - unsigned GetMemoryUse(StringHash type) const
  3733. - unsigned GetTotalMemoryUse() const
  3734. - String GetResourceFileName(const String name) const
  3735. - bool GetAutoReloadResources() const
  3736. - bool GetReturnFailedResources() const
  3737. - bool GetSearchPackagesFirst() const
  3738. - int GetFinishBackgroundResourcesMs() const
  3739. - String GetPreferredResourceDir(const String path) const
  3740. - String SanitateResourceName(const String name) const
  3741. - String SanitateResourceDirName(const String name) const
  3742. Properties:
  3743. - unsigned totalMemoryUse (readonly)
  3744. - bool autoReloadResources
  3745. - bool returnFailedResources
  3746. - bool searchPackagesFirst
  3747. - unsigned numBackgroundLoadResources (readonly)
  3748. - int finishBackgroundResourcesMs
  3749. <a name="Class_ResourceRef"></a>
  3750. ### ResourceRef
  3751. Methods:
  3752. - ResourceRef() (GC)
  3753. - ResourceRef* new()
  3754. - ResourceRef(StringHash type) (GC)
  3755. - ResourceRef* new(StringHash type)
  3756. - ResourceRef(StringHash type, String name) (GC)
  3757. - ResourceRef* new(StringHash type, String name)
  3758. - ResourceRef(const ResourceRef& rhs) (GC)
  3759. - ResourceRef* new(const ResourceRef& rhs)
  3760. - void delete()
  3761. - bool operator==(const ResourceRef& rhs) const
  3762. Properties:
  3763. - StringHash type
  3764. - String name
  3765. <a name="Class_ResourceRefList"></a>
  3766. ### ResourceRefList
  3767. Methods:
  3768. - ResourceRefList() (GC)
  3769. - ResourceRefList* new()
  3770. - ResourceRefList(StringHash type) (GC)
  3771. - ResourceRefList* new(StringHash type)
  3772. - void delete()
  3773. - bool operator==(const ResourceRefList& rhs) const
  3774. Properties:
  3775. - StringHash type
  3776. <a name="Class_RigidBody"></a>
  3777. ### RigidBody : Component
  3778. Methods:
  3779. - void SetMass(float mass)
  3780. - void SetPosition(const Vector3& position)
  3781. - void SetRotation(const Quaternion& rotation)
  3782. - void SetTransform(const Vector3& position, const Quaternion& rotation)
  3783. - void SetLinearVelocity(const Vector3& velocity)
  3784. - void SetLinearFactor(const Vector3& factor)
  3785. - void SetLinearRestThreshold(float threshold)
  3786. - void SetLinearDamping(float damping)
  3787. - void SetAngularVelocity(const Vector3& angularVelocity)
  3788. - void SetAngularFactor(const Vector3& factor)
  3789. - void SetAngularRestThreshold(float threshold)
  3790. - void SetAngularDamping(float factor)
  3791. - void SetFriction(float friction)
  3792. - void SetAnisotropicFriction(const Vector3& friction)
  3793. - void SetRollingFriction(float friction)
  3794. - void SetRestitution(float restitution)
  3795. - void SetContactProcessingThreshold(float threshold)
  3796. - void SetCcdRadius(float radius)
  3797. - void SetCcdMotionThreshold(float threshold)
  3798. - void SetUseGravity(bool enable)
  3799. - void SetGravityOverride(const Vector3& gravity)
  3800. - void SetKinematic(bool enable)
  3801. - void SetTrigger(bool enable)
  3802. - void SetCollisionLayer(unsigned layer)
  3803. - void SetCollisionMask(unsigned mask)
  3804. - void SetCollisionLayerAndMask(unsigned layer, unsigned mask)
  3805. - void SetCollisionEventMode(CollisionEventMode mode)
  3806. - void DisableMassUpdate()
  3807. - void EnableMassUpdate()
  3808. - void ApplyForce(const Vector3& force)
  3809. - void ApplyForce(const Vector3& force, const Vector3& position)
  3810. - void ApplyTorque(const Vector3& torque)
  3811. - void ApplyImpulse(const Vector3& impulse)
  3812. - void ApplyImpulse(const Vector3& impulse, const Vector3& position)
  3813. - void ApplyTorqueImpulse(const Vector3& torque)
  3814. - void ResetForces()
  3815. - void Activate()
  3816. - void ReAddBodyToWorld()
  3817. - PhysicsWorld* GetPhysicsWorld() const
  3818. - float GetMass() const
  3819. - Vector3 GetPosition() const
  3820. - Quaternion GetRotation() const
  3821. - Vector3 GetLinearVelocity() const
  3822. - Vector3 GetLinearFactor() const
  3823. - Vector3 GetVelocityAtPoint(const Vector3& position) const
  3824. - float GetLinearRestThreshold() const
  3825. - float GetLinearDamping() const
  3826. - Vector3 GetAngularVelocity() const
  3827. - Vector3 GetAngularFactor() const
  3828. - float GetAngularRestThreshold() const
  3829. - float GetAngularDamping() const
  3830. - float GetFriction() const
  3831. - Vector3 GetAnisotropicFriction() const
  3832. - float GetRollingFriction() const
  3833. - float GetRestitution() const
  3834. - float GetContactProcessingThreshold() const
  3835. - float GetCcdRadius() const
  3836. - float GetCcdMotionThreshold() const
  3837. - bool GetUseGravity() const
  3838. - const Vector3& GetGravityOverride() const
  3839. - const Vector3& GetCenterOfMass() const
  3840. - bool IsKinematic() const
  3841. - bool IsTrigger() const
  3842. - bool IsActive() const
  3843. - unsigned GetCollisionLayer() const
  3844. - unsigned GetCollisionMask() const
  3845. - CollisionEventMode GetCollisionEventMode() const
  3846. Properties:
  3847. - PhysicsWorld* physicsWorld (readonly)
  3848. - float mass
  3849. - Vector3 position
  3850. - Quaternion rotation
  3851. - Vector3 linearVelocity
  3852. - Vector3 linearFactor
  3853. - float linearRestThreshold
  3854. - float linearDamping
  3855. - Vector3 angularVelocity
  3856. - Vector3 angularFactor
  3857. - float angularRestThreshold
  3858. - float angularDamping
  3859. - float friction
  3860. - Vector3 anisotropicFriction
  3861. - float rollingFriction
  3862. - float restitution
  3863. - float contactProcessingThreshold
  3864. - float ccdRadius
  3865. - float ccdMotionThreshold
  3866. - bool useGravity
  3867. - Vector3& gravityOverride
  3868. - Vector3& centerOfMass (readonly)
  3869. - bool kinematic
  3870. - bool trigger
  3871. - bool active (readonly)
  3872. - unsigned collisionLayer
  3873. - unsigned collisionMask
  3874. - CollisionEventMode collisionEventMode
  3875. <a name="Class_RigidBody2D"></a>
  3876. ### RigidBody2D : Component
  3877. Methods:
  3878. - void SetBodyType(BodyType2D bodyType)
  3879. - void SetMass(float mass)
  3880. - void SetInertia(float inertia)
  3881. - void SetMassCenter(const Vector2& center)
  3882. - void SetUseFixtureMass(bool useFixtureMass)
  3883. - void SetLinearDamping(float linearDamping)
  3884. - void SetAngularDamping(float angularDamping)
  3885. - void SetAllowSleep(bool allowSleep)
  3886. - void SetFixedRotation(bool fixedRotation)
  3887. - void SetBullet(bool bullet)
  3888. - void SetGravityScale(float gravityScale)
  3889. - void SetAwake(bool awake)
  3890. - void SetLinearVelocity(const Vector2& linearVelocity)
  3891. - void SetAngularVelocity(float angularVelocity)
  3892. - void ApplyForce(const Vector2& force, const Vector2& point, bool wake)
  3893. - void ApplyForceToCenter(const Vector2& force, bool wake)
  3894. - void ApplyTorque(float torque, bool wake)
  3895. - void ApplyLinearImpulse(const Vector2& impulse, const Vector2& point, bool wake)
  3896. - void ApplyAngularImpulse(float impulse, bool wake)
  3897. - BodyType2D GetBodyType() const
  3898. - float GetMass() const
  3899. - float GetInertia() const
  3900. - Vector2 GetMassCenter() const
  3901. - bool GetUseFixtureMass() const
  3902. - float GetLinearDamping() const
  3903. - float GetAngularDamping() const
  3904. - bool IsAllowSleep() const
  3905. - bool IsFixedRotation() const
  3906. - bool IsBullet() const
  3907. - float GetGravityScale() const
  3908. - bool IsAwake() const
  3909. - Vector2 GetLinearVelocity() const
  3910. - float GetAngularVelocity() const
  3911. Properties:
  3912. - BodyType2D bodyType
  3913. - float mass
  3914. - float inertia
  3915. - Vector2 massCenter
  3916. - bool useFixtureMass
  3917. - float linearDamping
  3918. - float angularDamping
  3919. - bool allowSleep
  3920. - bool fixedRotation
  3921. - bool bullet
  3922. - float gravityScale
  3923. - bool awake
  3924. - Vector2 linearVelocity
  3925. - float angularVelocity
  3926. <a name="Class_Scene"></a>
  3927. ### Scene : Node
  3928. Methods:
  3929. - Scene() (GC)
  3930. - Scene* new()
  3931. - void delete()
  3932. - bool Load(File* source)
  3933. - bool Save(File* dest) const
  3934. - bool Load(const String fileName)
  3935. - bool Save(const String fileName) const
  3936. - bool LoadXML(File* source)
  3937. - bool SaveXML(File* dest) const
  3938. - bool LoadXML(const String fileName)
  3939. - bool SaveXML(const String fileName) const
  3940. - Node* Instantiate(File* source, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
  3941. - Node* Instantiate(const String fileName, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
  3942. - Node* InstantiateXML(File* source, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
  3943. - Node* InstantiateXML(const String fileName, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
  3944. - bool LoadAsync(File* file, LoadMode mode = LOAD_SCENE_AND_RESOURCES)
  3945. - bool LoadAsyncXML(File* file, LoadMode mode = LOAD_SCENE_AND_RESOURCES)
  3946. - bool LoadAsync(const String fileName, LoadMode mode = LOAD_SCENE_AND_RESOURCES)
  3947. - bool LoadAsyncXML(const String fileName, LoadMode mode = LOAD_SCENE_AND_RESOURCES)
  3948. - void StopAsyncLoading()
  3949. - void Clear(bool clearReplicated = true, bool clearLocal = true)
  3950. - void SetUpdateEnabled(bool enable)
  3951. - void SetTimeScale(float scale)
  3952. - void SetElapsedTime(float time)
  3953. - void SetSmoothingConstant(float constant)
  3954. - void SetSnapThreshold(float threshold)
  3955. - void SetAsyncLoadingMs(int ms)
  3956. - Node* GetNode(unsigned id) const
  3957. - bool IsUpdateEnabled() const
  3958. - bool IsAsyncLoading() const
  3959. - float GetAsyncProgress() const
  3960. - LoadMode GetAsyncLoadMode() const
  3961. - const String GetFileName() const
  3962. - unsigned GetChecksum() const
  3963. - float GetTimeScale() const
  3964. - float GetElapsedTime() const
  3965. - float GetSmoothingConstant() const
  3966. - float GetSnapThreshold() const
  3967. - int GetAsyncLoadingMs() const
  3968. - const String GetVarName(StringHash hash) const
  3969. - void Update(float timeStep)
  3970. - void BeginThreadedUpdate()
  3971. - void EndThreadedUpdate()
  3972. - void DelayedMarkedDirty(Component* component)
  3973. - bool IsThreadedUpdate() const
  3974. - unsigned GetFreeNodeID(CreateMode mode)
  3975. - unsigned GetFreeComponentID(CreateMode mode)
  3976. - void NodeAdded(Node* node)
  3977. - void NodeRemoved(Node* node)
  3978. - void ComponentAdded(Component* component)
  3979. - void ComponentRemoved(Component* component)
  3980. - void SetVarNamesAttr(const String value)
  3981. - String GetVarNamesAttr() const
  3982. - void PrepareNetworkUpdate()
  3983. - void CleanupConnection(Connection* connection)
  3984. - void MarkNetworkUpdate(Node* node)
  3985. - void MarkNetworkUpdate(Component* component)
  3986. - void MarkReplicationDirty(Node* node)
  3987. Properties:
  3988. - bool updateEnabled
  3989. - bool asyncLoading (readonly)
  3990. - float asyncProgress (readonly)
  3991. - LoadMode asyncLoadMode (readonly)
  3992. - const String fileName
  3993. - unsigned checksum (readonly)
  3994. - float timeScale
  3995. - float elapsedTime
  3996. - float smoothingConstant
  3997. - float snapThreshold
  3998. - int asyncLoadingMs
  3999. - bool threadedUpdate (readonly)
  4000. - String varNamesAttr
  4001. <a name="Class_ScrollBar"></a>
  4002. ### ScrollBar : UIElement
  4003. Methods:
  4004. - ScrollBar() (GC)
  4005. - ScrollBar* new()
  4006. - void delete()
  4007. - void SetOrientation(Orientation orientation)
  4008. - void SetRange(float range)
  4009. - void SetValue(float value)
  4010. - void ChangeValue(float delta)
  4011. - void SetScrollStep(float step)
  4012. - void SetStepFactor(float factor)
  4013. - void StepBack()
  4014. - void StepForward()
  4015. - Orientation GetOrientation() const
  4016. - float GetRange() const
  4017. - float GetValue() const
  4018. - float GetScrollStep() const
  4019. - float GetStepFactor() const
  4020. - float GetEffectiveScrollStep() const
  4021. - Button* GetBackButton() const
  4022. - Button* GetForwardButton() const
  4023. - Slider* GetSlider() const
  4024. Properties:
  4025. - Orientation orientation
  4026. - float range
  4027. - float value
  4028. - float scrollStep
  4029. - float stepFactor
  4030. - float effectiveScrollStep (readonly)
  4031. - Button* backButton (readonly)
  4032. - Button* forwardButton (readonly)
  4033. - Slider* slider (readonly)
  4034. <a name="Class_ScrollView"></a>
  4035. ### ScrollView : UIElement
  4036. Methods:
  4037. - ScrollView() (GC)
  4038. - ScrollView* new()
  4039. - void delete()
  4040. - void SetContentElement(UIElement* element)
  4041. - void SetViewPosition(const IntVector2& position)
  4042. - void SetViewPosition(int x, int y)
  4043. - void SetScrollBarsVisible(bool horizontal, bool vertical)
  4044. - void SetScrollBarsAutoVisible(bool enable)
  4045. - void SetScrollStep(float step)
  4046. - void SetPageStep(float step)
  4047. - void SetScrollDeceleration(float deceleration)
  4048. - void SetScrollSnapEpsilon(float snap)
  4049. - void SetAutoDisableChildren(bool disable)
  4050. - void SetAutoDisableThreshold(float amount)
  4051. - const IntVector2& GetViewPosition() const
  4052. - UIElement* GetContentElement() const
  4053. - ScrollBar* GetHorizontalScrollBar() const
  4054. - ScrollBar* GetVerticalScrollBar() const
  4055. - BorderImage* GetScrollPanel() const
  4056. - bool GetScrollBarsAutoVisible() const
  4057. - float GetScrollStep() const
  4058. - float GetPageStep() const
  4059. - float GetScrollDeceleration() const
  4060. - float GetScrollSnapEpsilon() const
  4061. - bool GetAutoDisableChildren() const
  4062. - float GetAutoDisableThreshold() const
  4063. Properties:
  4064. - IntVector2& viewPosition
  4065. - UIElement* contentElement
  4066. - ScrollBar* horizontalScrollBar (readonly)
  4067. - ScrollBar* verticalScrollBar (readonly)
  4068. - BorderImage* scrollPanel (readonly)
  4069. - bool scrollBarsAutoVisible
  4070. - float scrollStep
  4071. - float pageStep
  4072. - float scrollDeceleration
  4073. - float scrollSnapEpsilon
  4074. <a name="Class_Serializable"></a>
  4075. ### Serializable : Object
  4076. Methods:
  4077. - void SetTemporary(bool enable)
  4078. - bool IsTemporary() const
  4079. Properties:
  4080. - bool temporary
  4081. <a name="Class_Serializer"></a>
  4082. ### Serializer
  4083. Methods:
  4084. - unsigned Write(const VectorBuffer& buffer)
  4085. - bool WriteInt(int value)
  4086. - bool WriteShort(short value)
  4087. - bool WriteByte(char value)
  4088. - bool WriteUInt(unsigned value)
  4089. - bool WriteUShort(short value)
  4090. - bool WriteUByte(char value)
  4091. - bool WriteBool(bool value)
  4092. - bool WriteFloat(float value)
  4093. - bool WriteIntRect(const IntRect& value)
  4094. - bool WriteIntVector2(const IntVector2& value)
  4095. - bool WriteRect(const Rect& value)
  4096. - bool WriteVector2(const Vector2& value)
  4097. - bool WriteVector3(const Vector3& value)
  4098. - bool WritePackedVector3(const Vector3& value, float maxAbsCoord)
  4099. - bool WriteVector4(const Vector4& value)
  4100. - bool WriteQuaternion(const Quaternion& value)
  4101. - bool WritePackedQuaternion(const Quaternion& value)
  4102. - bool WriteMatrix3(const Matrix3& value)
  4103. - bool WriteMatrix3x4(const Matrix3x4& value)
  4104. - bool WriteMatrix4(const Matrix4& value)
  4105. - bool WriteColor(const Color& value)
  4106. - bool WriteBoundingBox(const BoundingBox& value)
  4107. - bool WriteString(const String value)
  4108. - bool WriteFileID(const String value)
  4109. - bool WriteStringHash(const StringHash& value)
  4110. - bool WriteBuffer(const VectorBuffer& buffer)
  4111. - bool WriteResourceRef(const ResourceRef& value)
  4112. - bool WriteResourceRefList(const ResourceRefList& value)
  4113. - bool WriteVariant(const Variant& value)
  4114. - bool WriteVariantData(const Variant& value)
  4115. - bool WriteVariantVector(const VariantVector& value)
  4116. - bool WriteVariantMap(const VariantMap& value)
  4117. - bool WriteVLE(unsigned value)
  4118. - bool WriteNetID(unsigned value)
  4119. - bool WriteLine(const String value)
  4120. <a name="Class_Skeleton"></a>
  4121. ### Skeleton
  4122. Methods:
  4123. - unsigned GetNumBones() const
  4124. - Bone* GetRootBone()
  4125. - Bone* GetBone(const String name)
  4126. - Bone* GetBone(unsigned index)
  4127. Properties:
  4128. - unsigned numBones (readonly)
  4129. - Bone* rootBone (readonly)
  4130. <a name="Class_Skybox"></a>
  4131. ### Skybox : StaticModel
  4132. <a name="Class_Slider"></a>
  4133. ### Slider : BorderImage
  4134. Methods:
  4135. - Slider() (GC)
  4136. - Slider* new()
  4137. - void delete()
  4138. - void SetOrientation(Orientation orientation)
  4139. - void SetRange(float range)
  4140. - void SetValue(float value)
  4141. - void ChangeValue(float delta)
  4142. - void SetRepeatRate(float rate)
  4143. - Orientation GetOrientation() const
  4144. - float GetRange() const
  4145. - float GetValue() const
  4146. - BorderImage* GetKnob() const
  4147. - float GetRepeatRate() const
  4148. Properties:
  4149. - Orientation orientation
  4150. - float range
  4151. - float value
  4152. - BorderImage* knob (readonly)
  4153. - float repeatRate
  4154. <a name="Class_Sound"></a>
  4155. ### Sound : Resource
  4156. Methods:
  4157. - Sound() (GC)
  4158. - Sound* new()
  4159. - void delete()
  4160. - bool LoadRaw(Deserializer& source)
  4161. - bool LoadWav(Deserializer& source)
  4162. - bool LoadOggVorbis(Deserializer& source)
  4163. - bool LoadRaw(const String fileName)
  4164. - bool LoadWav(const String fileName)
  4165. - bool LoadOggVorbis(const String fileName)
  4166. - void SetSize(unsigned dataSize)
  4167. - void SetData(const void* data, unsigned dataSize)
  4168. - void SetFormat(unsigned frequency, bool sixteenBit, bool stereo)
  4169. - void SetLooped(bool enable)
  4170. - void SetLoop(unsigned repeatOffset, unsigned endOffset)
  4171. - void FixInterpolation()
  4172. - float GetLength() const
  4173. - unsigned GetDataSize() const
  4174. - unsigned GetSampleSize() const
  4175. - float GetFrequency() const
  4176. - unsigned GetIntFrequency() const
  4177. - bool IsLooped() const
  4178. - bool IsSixteenBit() const
  4179. - bool IsStereo() const
  4180. - bool IsCompressed() const
  4181. Properties:
  4182. - float length (readonly)
  4183. - unsigned dataSize (readonly)
  4184. - unsigned sampleSize (readonly)
  4185. - float frequency (readonly)
  4186. - int intFrequency (readonly)
  4187. - bool looped
  4188. - bool sixteenBit (readonly)
  4189. - bool stereo (readonly)
  4190. - bool compressed (readonly)
  4191. <a name="Class_SoundListener"></a>
  4192. ### SoundListener : Component
  4193. <a name="Class_SoundSource"></a>
  4194. ### SoundSource : Component
  4195. Methods:
  4196. - void Play(Sound* sound)
  4197. - void Play(Sound* sound, float frequency)
  4198. - void Play(Sound* sound, float frequency, float gain)
  4199. - void Play(Sound* sound, float frequency, float gain, float panning)
  4200. - void Stop()
  4201. - void SetSoundType(const String type)
  4202. - void SetFrequency(float frequency)
  4203. - void SetGain(float gain)
  4204. - void SetAttenuation(float attenuation)
  4205. - void SetPanning(float panning)
  4206. - void SetAutoRemove(bool enable)
  4207. - Sound* GetSound() const
  4208. - String GetSoundType() const
  4209. - float GetTimePosition() const
  4210. - float GetFrequency() const
  4211. - float GetGain() const
  4212. - float GetAttenuation() const
  4213. - float GetPanning() const
  4214. - bool GetAutoRemove() const
  4215. - bool IsPlaying() const
  4216. Properties:
  4217. - Sound* sound (readonly)
  4218. - String soundType
  4219. - float timePosition (readonly)
  4220. - float frequency
  4221. - float gain
  4222. - float attenuation
  4223. - float panning
  4224. - bool autoRemove
  4225. - bool playing (readonly)
  4226. <a name="Class_SoundSource3D"></a>
  4227. ### SoundSource3D : SoundSource
  4228. Methods:
  4229. - void SetDistanceAttenuation(float nearDistance, float farDistance, float rolloffFactor)
  4230. - void SetAngleAttenuation(float innerAngle, float outerAngle)
  4231. - void SetNearDistance(float distance)
  4232. - void SetFarDistance(float distance)
  4233. - void SetInnerAngle(float angle)
  4234. - void SetOuterAngle(float angle)
  4235. - void SetRolloffFactor(float factor)
  4236. - void CalculateAttenuation()
  4237. - float GetNearDistance() const
  4238. - float GetFarDistance() const
  4239. - float GetInnerAngle() const
  4240. - float GetOuterAngle() const
  4241. - float RollAngleoffFactor() const
  4242. Properties:
  4243. - float nearDistance
  4244. - float farDistance
  4245. - float innerAngle
  4246. - float outerAngle
  4247. - float rolloffFactor
  4248. <a name="Class_Sphere"></a>
  4249. ### Sphere
  4250. Methods:
  4251. - Sphere() (GC)
  4252. - Sphere* new()
  4253. - Sphere(const Sphere& sphere) (GC)
  4254. - Sphere* new(const Sphere& sphere)
  4255. - Sphere(const Vector3& center, float radius) (GC)
  4256. - Sphere* new(const Vector3& center, float radius)
  4257. - Sphere(const BoundingBox& box) (GC)
  4258. - Sphere* new(const BoundingBox& box)
  4259. - Sphere(const Frustum& frustum) (GC)
  4260. - Sphere* new(const Frustum& frustum)
  4261. - Sphere(const Polyhedron& poly) (GC)
  4262. - Sphere* new(const Polyhedron& poly)
  4263. - void delete()
  4264. - bool operator==(const Sphere& rhs) const
  4265. - void Define(const Sphere& sphere)
  4266. - void Define(const Vector3& center, float radius)
  4267. - void Define(const BoundingBox& box)
  4268. - void Define(const Frustum& frustum)
  4269. - void Define(const Polyhedron& poly)
  4270. - void Merge(const Vector3& point)
  4271. - void Merge(const BoundingBox& box)
  4272. - void Merge(const Frustum& frustum)
  4273. - void Merge(const Polyhedron& poly)
  4274. - void Merge(const Sphere& sphere)
  4275. - void Clear()
  4276. - Intersection IsInside(const Vector3& point) const
  4277. - Intersection IsInside(const Sphere& sphere) const
  4278. - Intersection IsInsideFast(const Sphere& sphere) const
  4279. - Intersection IsInside(const BoundingBox& box) const
  4280. - Intersection IsInsideFast(const BoundingBox& box) const
  4281. - float Distance(const Vector3& point) const
  4282. Properties:
  4283. - Vector3 center
  4284. - float radius
  4285. - bool defined
  4286. <a name="Class_Spline"></a>
  4287. ### Spline
  4288. Methods:
  4289. - Spline() (GC)
  4290. - Spline* new()
  4291. - Spline(InterpolationMode mode) (GC)
  4292. - Spline* new(InterpolationMode mode)
  4293. - Spline(const Spline& rhs) (GC)
  4294. - Spline* new(const Spline& rhs)
  4295. - void delete()
  4296. - bool operator==(const Spline& rhs) const
  4297. - Variant GetPoint(float f) const
  4298. - Variant GetKnot(unsigned index) const
  4299. - void SetKnot(const Variant& knot, unsigned tolua_var_1)
  4300. - void AddKnot(const Variant& knot)
  4301. - void AddKnot(const Variant& knot, unsigned index)
  4302. - void RemoveKnot()
  4303. - void RemoveKnot(unsigned index)
  4304. - void Clear()
  4305. Properties:
  4306. - InterpolationMode interpolationMode
  4307. <a name="Class_SplinePath"></a>
  4308. ### SplinePath : Component
  4309. Methods:
  4310. - void AddControlPoint(Node* point, unsigned index = M_MAX_UNSIGNED)
  4311. - void RemoveControlPoint(Node* point)
  4312. - void ClearControlPoints()
  4313. - Vector3 GetPoint(float factor) const
  4314. - InterpolationMode GetInterpolationMode() const
  4315. - Vector3 GetPosition() const
  4316. - void SetInterpolationMode(InterpolationMode mode)
  4317. - void SetPosition(float factor)
  4318. - void Move(float timeStep)
  4319. - void Reset()
  4320. - bool IsFinished() const
  4321. Properties:
  4322. - float speed
  4323. - Node* controlledNode
  4324. <a name="Class_Sprite"></a>
  4325. ### Sprite : UIElement
  4326. Methods:
  4327. - Sprite() (GC)
  4328. - Sprite* new()
  4329. - void delete()
  4330. - void SetPosition(const Vector2& position)
  4331. - void SetPosition(float x, float y)
  4332. - void SetHotSpot(const IntVector2& hotSpot)
  4333. - void SetHotSpot(int x, int y)
  4334. - void SetScale(const Vector2& scale)
  4335. - void SetScale(float x, float y)
  4336. - void SetScale(float scale)
  4337. - void SetRotation(float angle)
  4338. - void SetTexture(Texture* texture)
  4339. - void SetImageRect(const IntRect& rect)
  4340. - void SetFullImageRect()
  4341. - void SetBlendMode(BlendMode mode)
  4342. - const Vector2& GetPosition() const
  4343. - const IntVector2& GetHotSpot() const
  4344. - const Vector2& GetScale() const
  4345. - float GetRotation() const
  4346. - Texture* GetTexture() const
  4347. - const IntRect& GetImageRect() const
  4348. - BlendMode GetBlendMode() const
  4349. - const Matrix3x4& GetTransform() const
  4350. Properties:
  4351. - Vector2& position
  4352. - IntVector2& hotSpot
  4353. - Vector2& scale
  4354. - float rotation
  4355. - Texture* texture
  4356. - IntRect& imageRect
  4357. - BlendMode blendMode
  4358. - Matrix3x4& transform (readonly)
  4359. <a name="Class_Sprite2D"></a>
  4360. ### Sprite2D : Resource
  4361. Methods:
  4362. - void SetTexture(Texture2D* texture)
  4363. - void SetRectangle(const IntRect& rectangle)
  4364. - void SetHotSpot(const Vector2& hotSpot)
  4365. - void SetOffset(const IntVector2& offset)
  4366. - void SetSpriteSheet(SpriteSheet2D* spriteSheet)
  4367. - Texture2D* GetTexture() const
  4368. - const IntRect& GetRectangle() const
  4369. - const Vector2& GetHotSpot() const
  4370. - const IntVector2& GetOffset() const
  4371. - SpriteSheet2D* GetSpriteSheet() const
  4372. Properties:
  4373. - Texture2D* texture
  4374. - IntRect rectangle
  4375. - Vector2 hotSpot
  4376. - IntVector2 offset
  4377. - SpriteSheet2D* spriteSheet
  4378. <a name="Class_SpriteSheet2D"></a>
  4379. ### SpriteSheet2D : Resource
  4380. Methods:
  4381. - Texture2D* GetTexture() const
  4382. - Sprite2D* GetSprite(const String name) const
  4383. - void DefineSprite(const String name, const IntRect& rectangle)
  4384. - void DefineSprite(const String name, const IntRect& rectangle, const Vector2& hotSpot)
  4385. - void DefineSprite(const String name, const IntRect& rectangle, const Vector2& hotSpot, const IntVector2& originSize)
  4386. <a name="Class_StaticModel"></a>
  4387. ### StaticModel : Drawable
  4388. Methods:
  4389. - void SetModel(Model* model)
  4390. - void SetMaterial(Material* material)
  4391. - bool SetMaterial(unsigned index, Material* material)
  4392. - void SetOcclusionLodLevel(unsigned level)
  4393. - void ApplyMaterialList(const String fileName = String::EMPTY)
  4394. - Model* GetModel() const
  4395. - unsigned GetNumGeometries() const
  4396. - Material* GetMaterial(unsigned index = 0) const
  4397. - unsigned GetOcclusionLodLevel() const
  4398. - bool IsInside(const Vector3& point) const
  4399. - bool IsInsideLocal(const Vector3& point) const
  4400. Properties:
  4401. - Model* model
  4402. - Material* material
  4403. - BoundingBox& boundingBox (readonly)
  4404. - unsigned numGeometries (readonly)
  4405. - unsigned occlusionLodLevel
  4406. <a name="Class_StaticModelGroup"></a>
  4407. ### StaticModelGroup : StaticModel
  4408. Methods:
  4409. - void AddInstanceNode(Node* node)
  4410. - void RemoveInstanceNode(Node* node)
  4411. - void RemoveAllInstanceNodes()
  4412. - unsigned GetNumInstanceNodes() const
  4413. - Node* GetInstanceNode(unsigned index) const
  4414. Properties:
  4415. - unsigned numInstanceNodes (readonly)
  4416. <a name="Class_StaticSprite2D"></a>
  4417. ### StaticSprite2D : Drawable2D
  4418. Methods:
  4419. - void SetSprite(Sprite2D* sprite)
  4420. - void SetFlip(bool flipX, bool flipY)
  4421. - void SetFlipX(bool flipX)
  4422. - void SetFlipY(bool flipY)
  4423. - void SetColor(const Color& color)
  4424. - Sprite2D* GetSprite() const
  4425. - bool GetFlipX() const
  4426. - bool GetFlipY() const
  4427. - const Color& GetColor() const
  4428. Properties:
  4429. - Sprite2D* sprite
  4430. - bool flipX
  4431. - bool flipY
  4432. - Color& color
  4433. <a name="Class_StringHash"></a>
  4434. ### StringHash
  4435. Methods:
  4436. - StringHash() (GC)
  4437. - StringHash* new()
  4438. - StringHash(const StringHash& rhs) (GC)
  4439. - StringHash* new(const StringHash& rhs)
  4440. - StringHash(unsigned value) (GC)
  4441. - StringHash* new(unsigned value)
  4442. - StringHash(const String str) (GC)
  4443. - StringHash* new(const String str)
  4444. - void delete()
  4445. - StringHash operator+(const StringHash& rhs) const
  4446. - bool operator==(const StringHash& rhs) const
  4447. - bool operator<(const StringHash& rhs) const
  4448. - bool operatorbool() const
  4449. - unsigned Value() const
  4450. - String ToString() const
  4451. - unsigned ToHash() const
  4452. - unsigned Calculate(const char* str)
  4453. Properties:
  4454. - const StringHash ZERO
  4455. - unsigned value (readonly)
  4456. <a name="Class_Technique"></a>
  4457. ### Technique : Resource
  4458. Methods:
  4459. - bool HasPass(const StringHash type) const
  4460. - Pass* GetPass(const StringHash type) const
  4461. - Pass* GetSupportedPass(const StringHash type) const
  4462. - bool IsSupported() const
  4463. - bool IsSM3() const
  4464. - bool IsDesktop() const
  4465. - unsigned GetNumPasses() const
  4466. - const Vector<StringHash>& GetPassTypes() const
  4467. - const PODVector<Pass*>& GetPasses() const
  4468. Properties:
  4469. - bool supported (readonly)
  4470. - bool SM3 (readonly)
  4471. - bool desktop (readonly)
  4472. - unsigned numPasses (readonly)
  4473. <a name="Class_Terrain"></a>
  4474. ### Terrain : Component
  4475. Methods:
  4476. - void SetPatchSize(int size)
  4477. - void SetSpacing(const Vector3& spacing)
  4478. - void SetSmoothing(bool enable)
  4479. - bool SetHeightMap(Image* image)
  4480. - void SetMaterial(Material* material)
  4481. - void SetDrawDistance(float distance)
  4482. - void SetShadowDistance(float distance)
  4483. - void SetLodBias(float bias)
  4484. - void SetViewMask(unsigned mask)
  4485. - void SetLightMask(unsigned mask)
  4486. - void SetShadowMask(unsigned mask)
  4487. - void SetZoneMask(unsigned mask)
  4488. - void SetMaxLights(unsigned num)
  4489. - void SetCastShadows(bool enable)
  4490. - void SetOccluder(bool enable)
  4491. - void SetOccludee(bool enable)
  4492. - void ApplyHeightMap()
  4493. - int GetPatchSize() const
  4494. - const Vector3& GetSpacing() const
  4495. - const IntVector2& GetNumVertices() const
  4496. - const IntVector2& GetNumPatches() const
  4497. - bool GetSmoothing() const
  4498. - Image* GetHeightMap() const
  4499. - Material* GetMaterial() const
  4500. - TerrainPatch* GetPatch(unsigned index) const
  4501. - TerrainPatch* GetPatch(int x, int z) const
  4502. - float GetHeight(const Vector3& worldPosition) const
  4503. - Vector3 GetNormal(const Vector3& worldPosition) const
  4504. - IntVector2 WorldToHeightMap(const Vector3& worldPosition) const
  4505. - SharedArrayPtr<float> GetHeightData() const
  4506. - float GetDrawDistance() const
  4507. - float GetShadowDistance() const
  4508. - float GetLodBias() const
  4509. - unsigned GetViewMask() const
  4510. - unsigned GetLightMask() const
  4511. - unsigned GetShadowMask() const
  4512. - unsigned GetZoneMask() const
  4513. - unsigned GetMaxLights() const
  4514. - bool IsVisible() const
  4515. - bool GetCastShadows() const
  4516. - bool IsOccluder() const
  4517. - bool IsOccludee() const
  4518. Properties:
  4519. - int patchSize
  4520. - Vector3& spacing
  4521. - IntVector2& numVertices (readonly)
  4522. - IntVector2& numPatches (readonly)
  4523. - bool smoothing
  4524. - Image* heightMap
  4525. - Material* material
  4526. - float drawDistance
  4527. - float shadowDistance
  4528. - float lodBias
  4529. - unsigned viewMask
  4530. - unsigned lightMask
  4531. - unsigned shadowMask
  4532. - unsigned zoneMask
  4533. - unsigned maxLights
  4534. - bool visible (readonly)
  4535. - bool castShadows
  4536. - bool occluder
  4537. - bool occludee
  4538. <a name="Class_TerrainPatch"></a>
  4539. ### TerrainPatch : Drawable
  4540. Methods:
  4541. - void SetOwner(Terrain* terrain)
  4542. - void SetNeighbors(TerrainPatch* north, TerrainPatch* south, TerrainPatch* west, TerrainPatch* east)
  4543. - void SetMaterial(Material* material)
  4544. - void SetBoundingBox(const BoundingBox& box)
  4545. - void SetCoordinates(const IntVector2& coordinates)
  4546. - void SetOcclusionOffset(float offset)
  4547. - void ResetLod()
  4548. - Geometry* GetGeometry() const
  4549. - Geometry* GetMaxLodGeometry() const
  4550. - Geometry* GetMinLodGeometry() const
  4551. - VertexBuffer* GetVertexBuffer() const
  4552. - Terrain* GetOwner() const
  4553. - TerrainPatch* GetNorthPatch() const
  4554. - TerrainPatch* GetSouthPatch() const
  4555. - TerrainPatch* GetWestPatch() const
  4556. - TerrainPatch* GetEastPatch() const
  4557. - const IntVector2& GetCoordinates() const
  4558. - unsigned GetLodLevel() const
  4559. - float GetOcclusionOffset() const
  4560. Properties:
  4561. - Geometry* geometry (readonly)
  4562. - Geometry* maxLodGeometry (readonly)
  4563. - Geometry* minLodGeometry (readonly)
  4564. - VertexBuffer* vertexBuffer (readonly)
  4565. - Terrain* owner
  4566. - TerrainPatch* northPatch (readonly)
  4567. - TerrainPatch* southPatch (readonly)
  4568. - TerrainPatch* westPatch (readonly)
  4569. - TerrainPatch* eastPatch (readonly)
  4570. - BoundingBox& boundingBox
  4571. - IntVector2& coordinates
  4572. - unsigned lodLevel (readonly)
  4573. - float occlusionOffset
  4574. <a name="Class_Text"></a>
  4575. ### Text : UIElement
  4576. Methods:
  4577. - Text() (GC)
  4578. - Text* new()
  4579. - void delete()
  4580. - bool SetFont(const String fontName, int size = DEFAULT_FONT_SIZE)
  4581. - bool SetFont(Font* font, int size = DEFAULT_FONT_SIZE)
  4582. - void SetText(const String text)
  4583. - void SetTextAlignment(HorizontalAlignment align)
  4584. - void SetRowSpacing(float spacing)
  4585. - void SetWordwrap(bool enable)
  4586. - void SetSelection(unsigned start, unsigned length = M_MAX_UNSIGNED)
  4587. - void ClearSelection()
  4588. - void SetSelectionColor(const Color& color)
  4589. - void SetHoverColor(const Color& color)
  4590. - void SetTextEffect(TextEffect textEffect)
  4591. - void SetEffectColor(const Color& effectColor)
  4592. - Font* GetFont() const
  4593. - int GetFontSize() const
  4594. - const String GetText() const
  4595. - HorizontalAlignment GetTextAlignment() const
  4596. - float GetRowSpacing() const
  4597. - bool GetWordwrap() const
  4598. - unsigned GetSelectionStart() const
  4599. - unsigned GetSelectionLength() const
  4600. - const Color& GetSelectionColor() const
  4601. - const Color& GetHoverColor() const
  4602. - TextEffect GetTextEffect() const
  4603. - const Color& GetEffectColor() const
  4604. - int GetRowHeight() const
  4605. - unsigned GetNumRows() const
  4606. - unsigned GetNumChars() const
  4607. - int GetRowWidth(unsigned index) const
  4608. - IntVector2 GetCharPosition(unsigned index)
  4609. - IntVector2 GetCharSize(unsigned index)
  4610. - void SetEffectDepthBias(float bias)
  4611. - float GetEffectDepthBias() const
  4612. Properties:
  4613. - Font* font
  4614. - int fontSize (readonly)
  4615. - String text
  4616. - HorizontalAlignment textAlignment
  4617. - float rowSpacing
  4618. - bool wordwrap
  4619. - unsigned selectionStart (readonly)
  4620. - unsigned selectionLength (readonly)
  4621. - Color& selectionColor
  4622. - Color& hoverColor
  4623. - TextEffect textEffect
  4624. - Color& effectColor
  4625. - int rowHeight (readonly)
  4626. - unsigned numRows (readonly)
  4627. - unsigned numChars (readonly)
  4628. <a name="Class_Text3D"></a>
  4629. ### Text3D : Drawable
  4630. Methods:
  4631. - Text3D() (GC)
  4632. - Text3D* new()
  4633. - void delete()
  4634. - bool SetFont(const String fontName, int size = DEFAULT_FONT_SIZE)
  4635. - bool SetFont(Font* font, int size = DEFAULT_FONT_SIZE)
  4636. - void SetMaterial(Material* material)
  4637. - void SetText(const String text)
  4638. - void SetAlignment(HorizontalAlignment hAlign, VerticalAlignment vAlign)
  4639. - void SetHorizontalAlignment(HorizontalAlignment align)
  4640. - void SetVerticalAlignment(VerticalAlignment align)
  4641. - void SetTextAlignment(HorizontalAlignment align)
  4642. - void SetRowSpacing(float spacing)
  4643. - void SetWordwrap(bool enable)
  4644. - void SetTextEffect(TextEffect textEffect)
  4645. - void SetEffectColor(const Color& effectColor)
  4646. - void SetEffectDepthBias(float bias)
  4647. - void SetWidth(int width)
  4648. - void SetColor(const Color& color)
  4649. - void SetColor(Corner corner, const Color& color)
  4650. - void SetOpacity(float opacity)
  4651. - void SetFaceCameraMode(FaceCameraMode mode)
  4652. - Font* GetFont() const
  4653. - Material* GetMaterial() const
  4654. - int GetFontSize() const
  4655. - const String GetText() const
  4656. - HorizontalAlignment GetTextAlignment() const
  4657. - HorizontalAlignment GetHorizontalAlignment() const
  4658. - VerticalAlignment GetVerticalAlignment() const
  4659. - float GetRowSpacing() const
  4660. - bool GetWordwrap() const
  4661. - TextEffect GetTextEffect() const
  4662. - const Color& GetEffectColor() const
  4663. - float GetEffectDepthBias() const
  4664. - int GetWidth() const
  4665. - int GetRowHeight() const
  4666. - unsigned GetNumRows() const
  4667. - unsigned GetNumChars() const
  4668. - int GetRowWidth(unsigned index) const
  4669. - IntVector2 GetCharPosition(unsigned index)
  4670. - IntVector2 GetCharSize(unsigned index)
  4671. - const Color& GetColor(Corner corner) const
  4672. - float GetOpacity() const
  4673. - FaceCameraMode GetFaceCameraMode() const
  4674. Properties:
  4675. - Font* font
  4676. - Material* material
  4677. - int fontSize (readonly)
  4678. - String text
  4679. - HorizontalAlignment textAlignment
  4680. - HorizontalAlignment horizontalAlignment
  4681. - VerticalAlignment verticalAlignment
  4682. - float rowSpacing
  4683. - bool wordwrap
  4684. - TextEffect textEffect
  4685. - Color& effectColor
  4686. - float effectDepthBias
  4687. - int width
  4688. - Color& color
  4689. - int rowHeight (readonly)
  4690. - unsigned numRows (readonly)
  4691. - unsigned numChars (readonly)
  4692. - float opacity
  4693. - FaceCameraMode faceCameraMode
  4694. <a name="Class_Texture"></a>
  4695. ### Texture : Resource
  4696. Methods:
  4697. - void SetNumLevels(unsigned levels)
  4698. - void SetFilterMode(TextureFilterMode filter)
  4699. - void SetAddressMode(TextureCoordinate coord, TextureAddressMode address)
  4700. - void SetBorderColor(const Color& color)
  4701. - void SetSRGB(bool enable)
  4702. - void SetBackupTexture(Texture* texture)
  4703. - void SetMipsToSkip(int quality, int mips)
  4704. - unsigned GetFormat() const
  4705. - bool IsCompressed() const
  4706. - unsigned GetLevels() const
  4707. - int GetWidth() const
  4708. - int GetHeight() const
  4709. - TextureFilterMode GetFilterMode() const
  4710. - TextureAddressMode GetAddressMode(TextureCoordinate coord) const
  4711. - const Color& GetBorderColor() const
  4712. - bool GetSRGB() const
  4713. - Texture* GetBackupTexture() const
  4714. - int GetMipsToSkip(int quality) const
  4715. - int GetLevelWidth(unsigned level) const
  4716. - int GetLevelHeight(unsigned level) const
  4717. - TextureUsage GetUsage() const
  4718. - unsigned GetDataSize(int width, int height) const
  4719. - unsigned GetRowDataSize(int width) const
  4720. Properties:
  4721. - unsigned format (readonly)
  4722. - bool compressed (readonly)
  4723. - unsigned levels (readonly)
  4724. - int width (readonly)
  4725. - int height (readonly)
  4726. - TextureFilterMode filterMode
  4727. - Color& borderColor
  4728. - bool sRGB
  4729. - Texture* backupTexture
  4730. - TextureUsage usage (readonly)
  4731. <a name="Class_Texture2D"></a>
  4732. ### Texture2D : Texture
  4733. Methods:
  4734. - Texture2D() (GC)
  4735. - Texture2D* new()
  4736. - void delete()
  4737. - bool SetSize(int width, int height, unsigned format, TextureUsage usage = TEXTURE_STATIC)
  4738. - bool SetData(Image* image, bool useAlpha = false)
  4739. - RenderSurface* GetRenderSurface() const
  4740. Properties:
  4741. - RenderSurface* renderSurface (readonly)
  4742. <a name="Class_TextureCube"></a>
  4743. ### TextureCube : Texture
  4744. Methods:
  4745. - RenderSurface* GetRenderSurface(CubeMapFace face) const
  4746. <a name="Class_TextureFrame"></a>
  4747. ### TextureFrame
  4748. Methods:
  4749. - TextureFrame() (GC)
  4750. - TextureFrame* new()
  4751. - void delete()
  4752. Properties:
  4753. - Rect uv
  4754. - float time
  4755. <a name="Class_Tile2D"></a>
  4756. ### Tile2D
  4757. Methods:
  4758. - int GetGid() const
  4759. - Sprite2D* GetSprite() const
  4760. - bool HasProperty(const String name) const
  4761. - const String GetProperty(const String name) const
  4762. Properties:
  4763. - int gid (readonly)
  4764. - Sprite2D* sprite (readonly)
  4765. <a name="Class_TileMap2D"></a>
  4766. ### TileMap2D : Component
  4767. Methods:
  4768. - void SetTmxFile(TmxFile2D* tmxFile)
  4769. - TmxFile2D* GetTmxFile() const
  4770. - const TileMapInfo2D& GetInfo() const
  4771. - unsigned GetNumLayers() const
  4772. - TileMapLayer2D* GetLayer(unsigned index) const
  4773. - Vector2 TileIndexToPosition(int x, int y) const
  4774. - bool PositionToTileIndex(const Vector2& position, int x = 0, int y = 0) const
  4775. Properties:
  4776. - TmxFile2D* tmxFile
  4777. - TileMapInfo2D& info (readonly)
  4778. - unsigned numLayers (readonly)
  4779. <a name="Class_TileMapInfo2D"></a>
  4780. ### TileMapInfo2D
  4781. Methods:
  4782. - float GetMapWidth() const
  4783. - float GetMapHeight() const
  4784. Properties:
  4785. - Orientation2D orientation
  4786. - int width
  4787. - int height
  4788. - float tileWidth
  4789. - float tileHeight
  4790. - float mapWidth (readonly)
  4791. - float mapHeight (readonly)
  4792. <a name="Class_TileMapLayer2D"></a>
  4793. ### TileMapLayer2D : Component
  4794. Methods:
  4795. - void SetDrawOrder(int drawOrder)
  4796. - void SetVisible(bool visible)
  4797. - int GetDrawOrder() const
  4798. - bool IsVisible() const
  4799. - bool HasProperty(const String name) const
  4800. - const String GetProperty(const String name) const
  4801. - TileMapLayerType2D GetLayerType() const
  4802. - int GetWidth() const
  4803. - int GetHeight() const
  4804. - Node* GetTileNode(int x, int y) const
  4805. - Tile2D* GetTile(int x, int y) const
  4806. - unsigned GetNumObjects() const
  4807. - TileMapObject2D* GetObject(unsigned index) const
  4808. - Node* GetObjectNode(unsigned index) const
  4809. - Node* GetImageNode() const
  4810. Properties:
  4811. - int drawOrder (readonly)
  4812. - bool visible (readonly)
  4813. - TileMapLayerType2D layerType (readonly)
  4814. - int width (readonly)
  4815. - int height (readonly)
  4816. - unsigned numObjects (readonly)
  4817. - Node* imageNode (readonly)
  4818. <a name="Class_TileMapObject2D"></a>
  4819. ### TileMapObject2D
  4820. Methods:
  4821. - TileMapObjectType2D GetObjectType() const
  4822. - const String GetName() const
  4823. - const String GetType() const
  4824. - const Vector2& GetPosition() const
  4825. - const Vector2& GetSize() const
  4826. - unsigned GetNumPoints() const
  4827. - const Vector2& GetPoint(unsigned index) const
  4828. - int GetTileGid() const
  4829. - Sprite2D* GetTileSprite() const
  4830. - bool HasProperty(const String name) const
  4831. - const String GetProperty(const String name) const
  4832. Properties:
  4833. - TileMapObjectType2D objectType (readonly)
  4834. - String name (readonly)
  4835. - String type (readonly)
  4836. - Vector2 position (readonly)
  4837. - Vector2 size (readonly)
  4838. - unsigned numPoints (readonly)
  4839. - int tileGid (readonly)
  4840. - Sprite2D* tileSprite (readonly)
  4841. <a name="Class_Time"></a>
  4842. ### Time : Object
  4843. Methods:
  4844. - unsigned GetFrameNumber() const
  4845. - float GetTimeStep() const
  4846. - unsigned GetTimerPeriod() const
  4847. - float GetElapsedTime()
  4848. - unsigned GetSystemTime()
  4849. - unsigned GetTimeSinceEpoch()
  4850. - String GetTimeStamp()
  4851. - void Sleep(unsigned mSec)
  4852. Properties:
  4853. - unsigned frameNumber (readonly)
  4854. - float timeStep (readonly)
  4855. - unsigned timerPeriod (readonly)
  4856. - float elapsedTime (readonly)
  4857. <a name="Class_TmxFile2D"></a>
  4858. ### TmxFile2D : Resource
  4859. <a name="Class_ToolTip"></a>
  4860. ### ToolTip : UIElement
  4861. Methods:
  4862. - ToolTip() (GC)
  4863. - ToolTip* new()
  4864. - void delete()
  4865. - void SetDelay(float delay)
  4866. - float GetDelay() const
  4867. Properties:
  4868. - float delay
  4869. <a name="Class_TouchState"></a>
  4870. ### TouchState
  4871. Methods:
  4872. - UIElement* GetTouchedElement()
  4873. Properties:
  4874. - int touchID
  4875. - IntVector2 position
  4876. - IntVector2 lastPosition
  4877. - IntVector2 delta
  4878. - float pressure
  4879. - UIElement* touchedElement (readonly)
  4880. <a name="Class_UI"></a>
  4881. ### UI : Object
  4882. Methods:
  4883. - void SetCursor(Cursor* cursor)
  4884. - void SetFocusElement(UIElement* element, bool byKey = false)
  4885. - bool SetModalElement(UIElement* modalElement, bool enable)
  4886. - void Clear()
  4887. - void Update(float timeStep)
  4888. - void RenderUpdate()
  4889. - void Render()
  4890. - void DebugDraw(UIElement* element)
  4891. - UIElement* LoadLayout(File* source, XMLFile* styleFile = 0)
  4892. - UIElement* LoadLayout(const String fileName, XMLFile* styleFile = 0)
  4893. - UIElement* LoadLayout(XMLFile* file, XMLFile* styleFile = 0)
  4894. - bool SaveLayout(Serializer& dest, UIElement* element)
  4895. - void SetClipboardText(const String text)
  4896. - void SetDoubleClickInterval(float interval)
  4897. - void SetDragBeginInterval(float interval)
  4898. - void SetDragBeginDistance(int pixels)
  4899. - void SetDefaultToolTipDelay(float delay)
  4900. - void SetMaxFontTextureSize(int size)
  4901. - void SetNonFocusedMouseWheel(bool nonFocusedMouseWheel)
  4902. - void SetUseSystemClipboard(bool enable)
  4903. - void SetUseScreenKeyboard(bool enable)
  4904. - void SetUseMutableGlyphs(bool enable)
  4905. - void SetForceAutoHint(bool enable)
  4906. - UIElement* GetRoot() const
  4907. - UIElement* GetRootModalElement() const
  4908. - Cursor* GetCursor() const
  4909. - IntVector2 GetCursorPosition() const
  4910. - UIElement* GetElementAt(const IntVector2& position, bool enabledOnly = true)
  4911. - UIElement* GetElementAt(int x, int y, bool enabledOnly = true)
  4912. - UIElement* GetFocusElement() const
  4913. - UIElement* GetFrontElement() const
  4914. - UIElement* GetDragElement(unsigned index)
  4915. - const String GetClipboardText() const
  4916. - float GetDoubleClickInterval() const
  4917. - float GetDragBeginInterval() const
  4918. - int GetDragBeginDistance() const
  4919. - float GetDefaultToolTipDelay() const
  4920. - int GetMaxFontTextureSize() const
  4921. - bool IsNonFocusedMouseWheel() const
  4922. - bool GetUseSystemClipboard() const
  4923. - bool GetUseScreenKeyboard() const
  4924. - bool GetUseMutableGlyphs() const
  4925. - bool GetForceAutoHint() const
  4926. - bool HasModalElement() const
  4927. - bool IsDragging() const
  4928. Properties:
  4929. - UIElement* root (readonly)
  4930. - UIElement* rootModalElement (readonly)
  4931. - Cursor* cursor
  4932. - IntVector2 cursorPosition (readonly)
  4933. - UIElement* focusElement (readonly)
  4934. - UIElement* frontElement (readonly)
  4935. - String clipboardText
  4936. - float doubleClickInterval
  4937. - float dragBeginInterval
  4938. - int dragBeginDistance
  4939. - float defaultToolTipDelay
  4940. - int maxFontTextureSize
  4941. - bool nonFocusedMouseWheel
  4942. - bool useSystemClipboard
  4943. - bool useScreenKeyboard
  4944. - bool useMutableGlyphs
  4945. - bool forceAutoHint
  4946. - bool modalElement (readonly)
  4947. <a name="Class_UIElement"></a>
  4948. ### UIElement : Animatable
  4949. Methods:
  4950. - UIElement() (GC)
  4951. - UIElement* new()
  4952. - void delete()
  4953. - const IntVector2& GetScreenPosition() const
  4954. - bool LoadXML(Deserializer& source)
  4955. - bool SaveXML(Serializer& dest) const
  4956. - bool LoadXML(const String fileName)
  4957. - bool SaveXML(const String fileName) const
  4958. - bool FilterAttributes(XMLElement& dest) const
  4959. - void SetName(const String name)
  4960. - void SetPosition(const IntVector2& position)
  4961. - void SetPosition(int x, int y)
  4962. - void SetSize(const IntVector2& size)
  4963. - void SetSize(int width, int height)
  4964. - void SetWidth(int width)
  4965. - void SetHeight(int height)
  4966. - void SetMinSize(const IntVector2& minSize)
  4967. - void SetMinSize(int width, int height)
  4968. - void SetMinWidth(int width)
  4969. - void SetMinHeight(int height)
  4970. - void SetMaxSize(const IntVector2& maxSize)
  4971. - void SetMaxSize(int width, int height)
  4972. - void SetMaxWidth(int width)
  4973. - void SetMaxHeight(int height)
  4974. - void SetFixedSize(const IntVector2& size)
  4975. - void SetFixedSize(int width, int height)
  4976. - void SetFixedWidth(int width)
  4977. - void SetFixedHeight(int height)
  4978. - void SetAlignment(HorizontalAlignment hAlign, VerticalAlignment vAlign)
  4979. - void SetHorizontalAlignment(HorizontalAlignment align)
  4980. - void SetVerticalAlignment(VerticalAlignment align)
  4981. - void SetClipBorder(const IntRect& rect)
  4982. - void SetColor(const Color& color)
  4983. - void SetColor(Corner corner, const Color& color)
  4984. - void SetPriority(int priority)
  4985. - void SetOpacity(float opacity)
  4986. - void SetBringToFront(bool enable)
  4987. - void SetBringToBack(bool enable)
  4988. - void SetClipChildren(bool enable)
  4989. - void SetSortChildren(bool enable)
  4990. - void SetUseDerivedOpacity(bool enable)
  4991. - void SetEnabled(bool enable)
  4992. - void SetDeepEnabled(bool enable)
  4993. - void ResetDeepEnabled()
  4994. - void SetEnabledRecursive(bool enable)
  4995. - void SetEditable(bool enable)
  4996. - void SetFocus(bool enable)
  4997. - void SetSelected(bool enable)
  4998. - void SetVisible(bool enable)
  4999. - void SetFocusMode(FocusMode mode)
  5000. - void SetDragDropMode(unsigned mode)
  5001. - bool SetStyle(const String styleName, XMLFile* file = 0)
  5002. - bool SetStyle(const XMLElement& element)
  5003. - bool SetStyleAuto(XMLFile* file = 0)
  5004. - void SetDefaultStyle(XMLFile* style)
  5005. - void SetLayout(LayoutMode mode, int spacing = 0)
  5006. - void SetLayout(LayoutMode mode, int spacing, const IntRect& border)
  5007. - void SetLayoutMode(LayoutMode mode)
  5008. - void SetLayoutSpacing(int spacing)
  5009. - void SetLayoutBorder(const IntRect& border)
  5010. - void SetLayoutFlexScale(const Vector2& scale)
  5011. - void SetIndent(int indent)
  5012. - void SetIndentSpacing(int indentSpacing)
  5013. - void UpdateLayout()
  5014. - void DisableLayoutUpdate()
  5015. - void EnableLayoutUpdate()
  5016. - void BringToFront()
  5017. - UIElement* CreateChild(const String type, const String name = String::EMPTY, unsigned index = M_MAX_UNSIGNED)
  5018. - void AddChild(UIElement* element)
  5019. - void InsertChild(unsigned index, UIElement* element)
  5020. - void RemoveChild(UIElement* element, unsigned index = 0)
  5021. - void RemoveChildAtIndex(unsigned index)
  5022. - void RemoveAllChildren()
  5023. - void Remove()
  5024. - unsigned FindChild(UIElement* element) const
  5025. - void SetParent(UIElement* parent, unsigned index = M_MAX_UNSIGNED)
  5026. - void SetVar(StringHash key, const Variant& value)
  5027. - void SetInternal(bool enable)
  5028. - void SetTraversalMode(TraversalMode traversalMode)
  5029. - void SetElementEventSender(bool flag)
  5030. - const String GetName() const
  5031. - const IntVector2& GetPosition() const
  5032. - const IntVector2& GetSize() const
  5033. - int GetWidth() const
  5034. - int GetHeight() const
  5035. - const IntVector2& GetMinSize() const
  5036. - int GetMinWidth() const
  5037. - int GetMinHeight() const
  5038. - const IntVector2& GetMaxSize() const
  5039. - int GetMaxWidth() const
  5040. - int GetMaxHeight() const
  5041. - bool IsFixedSize() const
  5042. - bool IsFixedWidth() const
  5043. - bool IsFixedHeight() const
  5044. - const IntVector2& GetChildOffset() const
  5045. - HorizontalAlignment GetHorizontalAlignment() const
  5046. - VerticalAlignment GetVerticalAlignment() const
  5047. - const IntRect& GetClipBorder() const
  5048. - const Color& GetColor(Corner corner) const
  5049. - int GetPriority() const
  5050. - float GetOpacity() const
  5051. - float GetDerivedOpacity() const
  5052. - bool GetBringToFront() const
  5053. - bool GetBringToBack() const
  5054. - bool GetClipChildren() const
  5055. - bool GetSortChildren() const
  5056. - bool GetUseDerivedOpacity() const
  5057. - bool HasFocus() const
  5058. - bool IsEnabled() const
  5059. - bool IsEnabledSelf() const
  5060. - bool IsEditable() const
  5061. - bool IsSelected() const
  5062. - bool IsVisible() const
  5063. - bool IsHovering() const
  5064. - bool IsInternal() const
  5065. - bool HasColorGradient() const
  5066. - FocusMode GetFocusMode() const
  5067. - unsigned GetDragDropMode() const
  5068. - const String GetAppliedStyle() const
  5069. - XMLFile* GetDefaultStyle(bool recursiveUp = true) const
  5070. - LayoutMode GetLayoutMode() const
  5071. - int GetLayoutSpacing() const
  5072. - const IntRect& GetLayoutBorder() const
  5073. - const Vector2& GetLayoutFlexScale() const
  5074. - unsigned GetNumChildren(bool recursive = false) const
  5075. - int GetDragButtonCombo() const
  5076. - unsigned GetDragButtonCount() const
  5077. - UIElement* GetChild(const String name, bool recursive = false) const
  5078. - UIElement* GetChild(unsigned index) const
  5079. - UIElement* GetParent() const
  5080. - UIElement* GetRoot() const
  5081. - const Color& GetDerivedColor() const
  5082. - const Variant& GetVar(StringHash key) const
  5083. - const VariantMap& GetVars() const
  5084. - IntVector2 ScreenToElement(const IntVector2& screenPosition)
  5085. - IntVector2 ElementToScreen(const IntVector2& position)
  5086. - bool IsInside(IntVector2 position, bool isScreen)
  5087. - bool IsInsideCombined(IntVector2 position, bool isScreen)
  5088. - IntRect GetCombinedScreenRect()
  5089. - void SortChildren()
  5090. - int GetIndent() const
  5091. - int GetIndentSpacing() const
  5092. - int GetIndentWidth() const
  5093. - void SetChildOffset(const IntVector2& offset)
  5094. - void SetHovering(bool enable)
  5095. - const Color& GetColor() const
  5096. - TraversalMode GetTraversalMode() const
  5097. - bool IsElementEventSender() const
  5098. - UIElement* GetElementEventSender() const
  5099. Properties:
  5100. - IntVector2& screenPosition (readonly)
  5101. - String name
  5102. - IntVector2& position
  5103. - IntVector2 size
  5104. - int width
  5105. - int height
  5106. - IntVector2 minSize
  5107. - int minWidth
  5108. - int minHeight
  5109. - IntVector2 maxSize
  5110. - int maxWidth
  5111. - int maxHeight
  5112. - bool fixedSize (readonly)
  5113. - bool fixedWidth (readonly)
  5114. - bool fixedHeight (readonly)
  5115. - IntVector2& childOffset
  5116. - HorizontalAlignment horizontalAlignment
  5117. - VerticalAlignment verticalAlignment
  5118. - IntRect clipBorder
  5119. - Color& color
  5120. - int priority
  5121. - float opacity
  5122. - float derivedOpacity (readonly)
  5123. - bool bringToFront
  5124. - bool bringToBack
  5125. - bool clipChildren
  5126. - bool sortChildren
  5127. - bool useDerivedOpacity
  5128. - bool focus
  5129. - bool enabled
  5130. - bool enabledSelf (readonly)
  5131. - bool editable
  5132. - bool selected
  5133. - bool visible
  5134. - bool hovering
  5135. - bool internal
  5136. - bool colorGradient (readonly)
  5137. - FocusMode focusMode
  5138. - unsigned dragDropMode
  5139. - String style
  5140. - XMLFile* defaultStyle
  5141. - LayoutMode layoutMode
  5142. - int layoutSpacing
  5143. - IntRect& layoutBorder
  5144. - Vector2& layoutFlexScale
  5145. - unsigned numChildren (readonly)
  5146. - UIElement* parent
  5147. - UIElement* root (readonly)
  5148. - Color& derivedColor (readonly)
  5149. - IntRect combinedScreenRect (readonly)
  5150. - int indent
  5151. - int indentSpacing
  5152. - int indentWidth (readonly)
  5153. - TraversalMode traversalMode
  5154. - bool elementEventSender
  5155. <a name="Class_ValueAnimation"></a>
  5156. ### ValueAnimation : Resource
  5157. Methods:
  5158. - ValueAnimation() (GC)
  5159. - ValueAnimation* new()
  5160. - void delete()
  5161. - void SetInterpolationMethod(InterpMethod method)
  5162. - void SetSplineTension(float tension)
  5163. - void SetValueType(VariantType valueType)
  5164. - bool SetKeyFrame(float time, const Variant& value)
  5165. - void SetEventFrame(float time, const StringHash& eventType)
  5166. - void SetEventFrame(float time, const StringHash& eventType, const VariantMap& eventData)
  5167. - InterpMethod GetInterpolationMethod() const
  5168. - float GetSplineTension() const
  5169. - VariantType GetValueType() const
  5170. Properties:
  5171. - InterpMethod interpolationMethod
  5172. - float splineTension
  5173. - VariantType valueType
  5174. <a name="Class_Variant"></a>
  5175. ### Variant
  5176. Methods:
  5177. - Variant() (GC)
  5178. - Variant* new()
  5179. - Variant(int value) (GC)
  5180. - Variant* new(int value)
  5181. - Variant(unsigned value) (GC)
  5182. - Variant* new(unsigned value)
  5183. - Variant(const StringHash& value) (GC)
  5184. - Variant* new(const StringHash& value)
  5185. - Variant(bool value) (GC)
  5186. - Variant* new(bool value)
  5187. - Variant(float value) (GC)
  5188. - Variant* new(float value)
  5189. - Variant(const Vector2& value) (GC)
  5190. - Variant* new(const Vector2& value)
  5191. - Variant(const Vector3& value) (GC)
  5192. - Variant* new(const Vector3& value)
  5193. - Variant(const Vector4& value) (GC)
  5194. - Variant* new(const Vector4& value)
  5195. - Variant(const Quaternion& value) (GC)
  5196. - Variant* new(const Quaternion& value)
  5197. - Variant(const Color& value) (GC)
  5198. - Variant* new(const Color& value)
  5199. - Variant(const String value) (GC)
  5200. - Variant* new(const String value)
  5201. - Variant(const char* value) (GC)
  5202. - Variant* new(const char* value)
  5203. - Variant(const ResourceRef& value) (GC)
  5204. - Variant* new(const ResourceRef& value)
  5205. - Variant(const ResourceRefList& value) (GC)
  5206. - Variant* new(const ResourceRefList& value)
  5207. - Variant(const IntRect& value) (GC)
  5208. - Variant* new(const IntRect& value)
  5209. - Variant(const IntVector2& value) (GC)
  5210. - Variant* new(const IntVector2& value)
  5211. - Variant(const Matrix3& value) (GC)
  5212. - Variant* new(const Matrix3& value)
  5213. - Variant(const Matrix3x4& value) (GC)
  5214. - Variant* new(const Matrix3x4& value)
  5215. - Variant(const Matrix4& value) (GC)
  5216. - Variant* new(const Matrix4& value)
  5217. - Variant(const String type, const String value) (GC)
  5218. - Variant* new(const String type, const String value)
  5219. - Variant(VariantType type, const String value) (GC)
  5220. - Variant* new(VariantType type, const String value)
  5221. - Variant(VariantType type, const char* value) (GC)
  5222. - Variant* new(VariantType type, const char* value)
  5223. - Variant(const Variant& value) (GC)
  5224. - Variant* new(const Variant& value)
  5225. - void delete()
  5226. - void Clear()
  5227. - bool operator==(const Variant& rhs) const
  5228. - bool operator==(int rhs) const
  5229. - bool operator==(unsigned rhs) const
  5230. - bool operator==(bool rhs) const
  5231. - bool operator==(float rhs) const
  5232. - bool operator==(const Vector2& rhs)
  5233. - bool operator==(const Vector3& rhs) const
  5234. - bool operator==(const Vector4& rhs) const
  5235. - bool operator==(const Quaternion& rhs) const
  5236. - bool operator==(const Color& rhs) const
  5237. - bool operator==(const String rhs) const
  5238. - bool operator==(const ResourceRef& rhs) const
  5239. - bool operator==(const ResourceRefList& rhs) const
  5240. - bool operator==(const IntRect& rhs) const
  5241. - bool operator==(const IntVector2& rhs) const
  5242. - bool operator==(const StringHash& rhs) const
  5243. - bool operator==(const Matrix3& rhs) const
  5244. - bool operator==(const Matrix3x4& rhs) const
  5245. - bool operator==(const Matrix4& rhs) const
  5246. - void SetInt(int value)
  5247. - void SetUint(unsigned value)
  5248. - void SetStringHash(const StringHash& value)
  5249. - void SetBool(bool value)
  5250. - void SetFloat(float value)
  5251. - void SetVector2(const Vector2& value)
  5252. - void SetVector3(const Vector3& value)
  5253. - void SetVector4(const Vector4& value)
  5254. - void SetQuaternion(const Quaternion& value)
  5255. - void SetColor(const Color& value)
  5256. - void SetString(const String value)
  5257. - void SetBuffer(const VectorBuffer& value)
  5258. - void SetResourceRef(const ResourceRef& value)
  5259. - void SetResourceRefList(const ResourceRefList& value)
  5260. - void SetIntRect(const IntRect& value)
  5261. - void SetIntVector2(const IntVector2& value)
  5262. - void SetMatrix3(const Matrix3& value)
  5263. - void SetMatrix3x4(const Matrix3x4& value)
  5264. - void SetMatrix4(const Matrix4& value)
  5265. - int GetInt() const
  5266. - int GetUInt() const
  5267. - StringHash GetStringHash()
  5268. - bool GetBool() const
  5269. - float GetFloat() const
  5270. - const Vector2& GetVector2() const
  5271. - const Vector3& GetVector3() const
  5272. - const Vector4& GetVector4() const
  5273. - const Quaternion& GetQuaternion() const
  5274. - const Color& GetColor() const
  5275. - const String GetString() const
  5276. - VectorBuffer GetBuffer() const
  5277. - const ResourceRef& GetResourceRef() const
  5278. - const ResourceRefList& GetResourceRefList() const
  5279. - const IntRect& GetIntRect() const
  5280. - const IntVector2& GetIntVector2() const
  5281. - const Matrix3& GetMatrix3() const
  5282. - const Matrix3x4& GetMatrix3x4() const
  5283. - const Matrix4& GetMatrix4() const
  5284. - VariantType GetType() const
  5285. - String GetTypeName() const
  5286. - String ToString() const
  5287. - bool IsZero() const
  5288. - bool IsEmpty() const
  5289. Properties:
  5290. - VariantType type (readonly)
  5291. - String typeName (readonly)
  5292. - bool zero (readonly)
  5293. - bool empty (readonly)
  5294. <a name="Class_VariantMap"></a>
  5295. ### VariantMap
  5296. Methods:
  5297. - VariantMap() (GC)
  5298. - VariantMap* new()
  5299. - void delete()
  5300. - void SetInt(const String key, int value)
  5301. - void SetUInt(const String key, unsigned value)
  5302. - void SetStringHash(const String key, const StringHash& value)
  5303. - void SetBool(const String key, bool value)
  5304. - void SetFloat(const String key, float value)
  5305. - void SetVector2(const String key, const Vector2 value)
  5306. - void SetVector3(const String key, const Vector3 value)
  5307. - void SetVector4(const String key, const Vector4 value)
  5308. - void SetQuaternion(const String key, const Quaternion value)
  5309. - void SetColor(const String key, const Color value)
  5310. - void SetString(const String key, const String value)
  5311. - void SetBuffer(const String key, const VectorBuffer& value)
  5312. - void SetResourceRef(const String key, const ResourceRef value)
  5313. - void SetResourceRefList(const String key, const ResourceRefList value)
  5314. - void SetIntRect(const String key, const IntRect value)
  5315. - void SetIntVector2(const String key, const IntVector2 value)
  5316. - void SetPtr(const String key, void* value)
  5317. - void SetMatrix3(const String key, const Matrix3 value)
  5318. - void SetMatrix3x4(const String key, const Matrix3x4 value)
  5319. - void SetMatrix4(const String key, const Matrix4 value)
  5320. - int GetInt(const String key)
  5321. - int GetUInt(const String key)
  5322. - StringHash GetStringHash(const String key)
  5323. - bool GetBool(const String key)
  5324. - float GetFloat(const String key)
  5325. - const Vector2& GetVector2(const String key)
  5326. - const Vector3& GetVector3(const String key)
  5327. - const Vector4& GetVector4(const String key)
  5328. - const Quaternion& GetQuaternion(const String key)
  5329. - const Color& GetColor(const String key)
  5330. - const String GetString(const String key)
  5331. - VectorBuffer GetBuffer(const String key)
  5332. - const ResourceRef& GetResourceRef(const String key)
  5333. - const ResourceRefList& GetResourceRefList(const String key)
  5334. - const IntRect& GetIntRect(const String key)
  5335. - const IntVector2& GetIntVector2(const String key)
  5336. - const void* GetPtr(const String type, const String key)
  5337. - const Matrix3& GetMatrix3(const String key)
  5338. - const Matrix3x4& GetMatrix3x4(const String key)
  5339. - const Matrix4& GetMatrix4(const String key)
  5340. <a name="Class_Vector2"></a>
  5341. ### Vector2
  5342. Methods:
  5343. - Vector2() (GC)
  5344. - Vector2* new()
  5345. - Vector2(const Vector2& vector) (GC)
  5346. - Vector2* new(const Vector2& vector)
  5347. - Vector2(float x, float y) (GC)
  5348. - Vector2* new(float x, float y)
  5349. - void delete()
  5350. - bool operator==(const Vector2& rhs) const
  5351. - Vector2 operator+(const Vector2& rhs) const
  5352. - Vector2 operator-() const
  5353. - Vector2 operator-(const Vector2& rhs) const
  5354. - Vector2 operator*(float rhs) const
  5355. - Vector2 operator*(const Vector2& rhs) const
  5356. - Vector2 operator/(float rhs) const
  5357. - Vector2 operator/(const Vector2& rhs) const
  5358. - Vector2 operator/(const Vector2& rhs) const
  5359. - void Normalize()
  5360. - float Length() const
  5361. - float LengthSquared() const
  5362. - float DotProduct(const Vector2& rhs) const
  5363. - float AbsDotProduct(const Vector2& rhs) const
  5364. - Vector2 Abs() const
  5365. - Vector2 Lerp(const Vector2& rhs, float t) const
  5366. - bool Equals(const Vector2& rhs) const
  5367. - bool IsNaN() const
  5368. - Vector2 Normalized() const
  5369. - String ToString() const
  5370. Properties:
  5371. - float x
  5372. - float y
  5373. - const Vector2 ZERO
  5374. - const Vector2 LEFT
  5375. - const Vector2 RIGHT
  5376. - const Vector2 UP
  5377. - const Vector2 DOWN
  5378. - const Vector2 ONE
  5379. <a name="Class_Vector3"></a>
  5380. ### Vector3
  5381. Methods:
  5382. - Vector3() (GC)
  5383. - Vector3* new()
  5384. - Vector3(const Vector3& vector) (GC)
  5385. - Vector3* new(const Vector3& vector)
  5386. - Vector3(const Vector2& vector, float z) (GC)
  5387. - Vector3* new(const Vector2& vector, float z)
  5388. - Vector3(const Vector2& vector) (GC)
  5389. - Vector3* new(const Vector2& vector)
  5390. - Vector3(float x, float y, float z) (GC)
  5391. - Vector3* new(float x, float y, float z)
  5392. - Vector3(float x, float y) (GC)
  5393. - Vector3* new(float x, float y)
  5394. - void delete()
  5395. - bool operator==(const Vector3& rhs) const
  5396. - Vector3 operator+(const Vector3& rhs) const
  5397. - Vector3 operator-() const
  5398. - Vector3 operator-(const Vector3& rhs) const
  5399. - Vector3 operator*(float rhs) const
  5400. - Vector3 operator*(const Vector3& rhs) const
  5401. - Vector3 operator/(float rhs) const
  5402. - Vector3 operator/(const Vector3& rhs) const
  5403. - void Normalize()
  5404. - float Length() const
  5405. - float LengthSquared() const
  5406. - float DotProduct(const Vector3& rhs) const
  5407. - float AbsDotProduct(const Vector3& rhs) const
  5408. - Vector3 CrossProduct(const Vector3& rhs) const
  5409. - Vector3 Abs() const
  5410. - Vector3 Lerp(const Vector3& rhs, float t) const
  5411. - bool Equals(const Vector3& rhs) const
  5412. - bool IsNaN() const
  5413. - float Angle(const Vector3& rhs) const
  5414. - Vector3 Normalized() const
  5415. - String ToString() const
  5416. Properties:
  5417. - float x
  5418. - float y
  5419. - float z
  5420. - const Vector3 ZERO
  5421. - const Vector3 LEFT
  5422. - const Vector3 RIGHT
  5423. - const Vector3 UP
  5424. - const Vector3 DOWN
  5425. - const Vector3 FORWARD
  5426. - const Vector3 BACK
  5427. - const Vector3 ONE
  5428. <a name="Class_Vector4"></a>
  5429. ### Vector4
  5430. Methods:
  5431. - Vector4() (GC)
  5432. - Vector4* new()
  5433. - Vector4(const Vector4& vector) (GC)
  5434. - Vector4* new(const Vector4& vector)
  5435. - Vector4(const Vector3& vector, float w) (GC)
  5436. - Vector4* new(const Vector3& vector, float w)
  5437. - Vector4(float x, float y, float z, float w) (GC)
  5438. - Vector4* new(float x, float y, float z, float w)
  5439. - void delete()
  5440. - bool operator==(const Vector4& rhs) const
  5441. - Vector4 operator+(const Vector4& rhs) const
  5442. - Vector4 operator-() const
  5443. - Vector4 operator-(const Vector4& rhs) const
  5444. - Vector4 operator*(float rhs) const
  5445. - Vector4 operator*(const Vector4& rhs) const
  5446. - Vector4 operator/(float rhs) const
  5447. - Vector4 operator/(const Vector4& rhs) const
  5448. - Vector4 operator/(const Vector4& rhs) const
  5449. - float DotProduct(const Vector4& rhs) const
  5450. - float AbsDotProduct(const Vector4& rhs) const
  5451. - Vector4 Abs() const
  5452. - Vector4 Lerp(const Vector4& rhs, float t) const
  5453. - bool Equals(const Vector4& rhs) const
  5454. - bool IsNaN() const
  5455. - String ToString() const
  5456. Properties:
  5457. - float x
  5458. - float y
  5459. - float z
  5460. - float w
  5461. - const Vector4 ZERO
  5462. - const Vector4 ONE
  5463. <a name="Class_VectorBuffer"></a>
  5464. ### VectorBuffer
  5465. Methods:
  5466. - VectorBuffer() (GC)
  5467. - VectorBuffer* new()
  5468. - VectorBuffer(Deserializer& source, unsigned size) (GC)
  5469. - VectorBuffer* new(Deserializer& source, unsigned size)
  5470. - void delete()
  5471. - void SetData(Deserializer& source, unsigned size)
  5472. - void Clear()
  5473. - void Resize(unsigned size)
  5474. - const void* GetData() const
  5475. - void* GetModifiableData()
  5476. - VectorBuffer Read(unsigned size)
  5477. - unsigned Seek(unsigned position)
  5478. - const String GetName() const
  5479. - unsigned GetChecksum()
  5480. - unsigned GetPosition() const
  5481. - unsigned GetSize() const
  5482. - bool IsEof() const
  5483. - int ReadInt()
  5484. - short ReadShort()
  5485. - char ReadByte()
  5486. - unsigned ReadUInt()
  5487. - short ReadUShort()
  5488. - char ReadUByte()
  5489. - bool ReadBool()
  5490. - float ReadFloat()
  5491. - IntRect ReadIntRect()
  5492. - IntVector2 ReadIntVector2()
  5493. - Rect ReadRect()
  5494. - Vector2 ReadVector2()
  5495. - Vector3 ReadVector3()
  5496. - Vector3 ReadPackedVector3(float maxAbsCoord)
  5497. - Vector4 ReadVector4()
  5498. - Quaternion ReadQuaternion()
  5499. - Quaternion ReadPackedQuaternion()
  5500. - Matrix3 ReadMatrix3()
  5501. - Matrix3x4 ReadMatrix3x4()
  5502. - Matrix4 ReadMatrix4()
  5503. - Color ReadColor()
  5504. - BoundingBox ReadBoundingBox()
  5505. - String ReadString()
  5506. - String ReadFileID()
  5507. - StringHash ReadStringHash()
  5508. - VectorBuffer ReadBuffer()
  5509. - ResourceRef ReadResourceRef()
  5510. - ResourceRefList ReadResourceRefList()
  5511. - Variant ReadVariant()
  5512. - Variant ReadVariant(VariantType type)
  5513. - VariantVector ReadVariantVector()
  5514. - VariantMap ReadVariantMap()
  5515. - unsigned ReadVLE()
  5516. - unsigned ReadNetID()
  5517. - String ReadLine()
  5518. - unsigned Write(const VectorBuffer& buffer)
  5519. - bool WriteInt(int value)
  5520. - bool WriteShort(short value)
  5521. - bool WriteByte(char value)
  5522. - bool WriteUInt(unsigned value)
  5523. - bool WriteUShort(short value)
  5524. - bool WriteUByte(char value)
  5525. - bool WriteBool(bool value)
  5526. - bool WriteFloat(float value)
  5527. - bool WriteIntRect(const IntRect& value)
  5528. - bool WriteIntVector2(const IntVector2& value)
  5529. - bool WriteRect(const Rect& value)
  5530. - bool WriteVector2(const Vector2& value)
  5531. - bool WriteVector3(const Vector3& value)
  5532. - bool WritePackedVector3(const Vector3& value, float maxAbsCoord)
  5533. - bool WriteVector4(const Vector4& value)
  5534. - bool WriteQuaternion(const Quaternion& value)
  5535. - bool WritePackedQuaternion(const Quaternion& value)
  5536. - bool WriteMatrix3(const Matrix3& value)
  5537. - bool WriteMatrix3x4(const Matrix3x4& value)
  5538. - bool WriteMatrix4(const Matrix4& value)
  5539. - bool WriteColor(const Color& value)
  5540. - bool WriteBoundingBox(const BoundingBox& value)
  5541. - bool WriteString(const String value)
  5542. - bool WriteFileID(const String value)
  5543. - bool WriteStringHash(const StringHash& value)
  5544. - bool WriteBuffer(const VectorBuffer& buffer)
  5545. - bool WriteResourceRef(const ResourceRef& value)
  5546. - bool WriteResourceRefList(const ResourceRefList& value)
  5547. - bool WriteVariant(const Variant& value)
  5548. - bool WriteVariantData(const Variant& value)
  5549. - bool WriteVariantVector(const VariantVector& value)
  5550. - bool WriteVariantMap(const VariantMap& value)
  5551. - bool WriteVLE(unsigned value)
  5552. - bool WriteNetID(unsigned value)
  5553. - bool WriteLine(const String value)
  5554. Properties:
  5555. - String name (readonly)
  5556. - unsigned checksum (readonly)
  5557. - unsigned position (readonly)
  5558. - unsigned size (readonly)
  5559. - bool eof (readonly)
  5560. <a name="Class_View3D"></a>
  5561. ### View3D : Window
  5562. Methods:
  5563. - View3D() (GC)
  5564. - View3D* new()
  5565. - void delete()
  5566. - void SetView(Scene* scene, Camera* camera, bool ownScene = true)
  5567. - void SetFormat(unsigned format)
  5568. - void SetAutoUpdate(bool enable)
  5569. - void QueueUpdate()
  5570. - unsigned GetFormat() const
  5571. - bool GetAutoUpdate() const
  5572. - Scene* GetScene() const
  5573. - Node* GetCameraNode() const
  5574. - Texture2D* GetRenderTexture() const
  5575. - Texture2D* GetDepthTexture() const
  5576. - Viewport* GetViewport() const
  5577. Properties:
  5578. - unsigned format
  5579. - bool autoUpdate
  5580. <a name="Class_Viewport"></a>
  5581. ### Viewport
  5582. Methods:
  5583. - Viewport() (GC)
  5584. - Viewport* new()
  5585. - Viewport(Scene* scene, Camera* camera, RenderPath* renderPath = 0) (GC)
  5586. - Viewport* new(Scene* scene, Camera* camera, RenderPath* renderPath = 0)
  5587. - Viewport(Scene* scene, Camera* camera, const IntRect& rect, RenderPath* renderPath = 0) (GC)
  5588. - Viewport* new(Scene* scene, Camera* camera, const IntRect& rect, RenderPath* renderPath = 0)
  5589. - void delete()
  5590. - void SetScene(Scene* scene)
  5591. - void SetCamera(Camera* camera)
  5592. - void SetRect(const IntRect& rect)
  5593. - void SetRenderPath(RenderPath* path)
  5594. - void SetRenderPath(XMLFile* file)
  5595. - void SetDrawDebug(bool enable)
  5596. - Scene* GetScene() const
  5597. - Camera* GetCamera() const
  5598. - const IntRect& GetRect() const
  5599. - RenderPath* GetRenderPath() const
  5600. - bool GetDrawDebug() const
  5601. - Ray GetScreenRay(int x, int y) const
  5602. - IntVector2 WorldToScreenPoint(const Vector3& worldPos) const
  5603. - Vector3 ScreenToWorldPoint(int x, int y, float depth) const
  5604. Properties:
  5605. - Scene* scene
  5606. - Camera* camera
  5607. - IntRect& rect
  5608. - RenderPath* renderPath
  5609. - bool drawDebug
  5610. <a name="Class_Window"></a>
  5611. ### Window : BorderImage
  5612. Methods:
  5613. - Window() (GC)
  5614. - Window* new()
  5615. - void delete()
  5616. - void SetMovable(bool enable)
  5617. - void SetResizable(bool enable)
  5618. - void SetFixedWidthResizing(bool enable)
  5619. - void SetFixedHeightResizing(bool enable)
  5620. - void SetResizeBorder(const IntRect& rect)
  5621. - void SetModal(bool modal)
  5622. - void SetModalShadeColor(const Color& color)
  5623. - void SetModalFrameColor(const Color& color)
  5624. - void SetModalFrameSize(const IntVector2& size)
  5625. - void SetModalAutoDismiss(bool enable)
  5626. - bool IsMovable() const
  5627. - bool IsResizable() const
  5628. - bool GetFixedWidthResizing() const
  5629. - bool GetFixedHeightResizing() const
  5630. - const IntRect& GetResizeBorder() const
  5631. - bool IsModal() const
  5632. - const Color& GetModalShadeColor() const
  5633. - const Color& GetModalFrameColor() const
  5634. - const IntVector2& GetModalFrameSize() const
  5635. - bool GetModalAutoDismiss() const
  5636. Properties:
  5637. - bool movable
  5638. - bool resizable
  5639. - bool fixedWidthResizing
  5640. - bool fixedHeightResizing
  5641. - IntRect& resizeBorder
  5642. - bool modal
  5643. - Color& modalShadeColor
  5644. - Color& modalFrameColor
  5645. - IntVector2& modalFrameSize
  5646. - bool modalAutoDismiss
  5647. <a name="Class_XMLElement"></a>
  5648. ### XMLElement
  5649. Methods:
  5650. - XMLElement CreateChild(const String name)
  5651. - bool RemoveChild(const XMLElement& element)
  5652. - bool RemoveChild(const String name)
  5653. - bool RemoveChildren(const String name = String::EMPTY)
  5654. - bool RemoveAttribute(const String name = String::EMPTY)
  5655. - bool SetValue(const String value)
  5656. - bool SetAttribute(const String name, const String value)
  5657. - bool SetAttribute(const String value)
  5658. - bool SetBool(const String name, bool value)
  5659. - bool SetBoundingBox(const BoundingBox& value)
  5660. - bool SetColor(const String name, const Color& value)
  5661. - bool SetFloat(const String name, float value)
  5662. - bool SetUInt(const String name, unsigned value)
  5663. - bool SetInt(const String name, int value)
  5664. - bool SetIntRect(const String name, const IntRect& value)
  5665. - bool SetIntVector2(const String name, const IntVector2& value)
  5666. - bool SetRect(const String name, const Rect& value)
  5667. - bool SetQuaternion(const String name, const Quaternion& value)
  5668. - bool SetString(const String name, const String value)
  5669. - bool SetVariant(const Variant& value)
  5670. - bool SetVariantValue(const Variant& value)
  5671. - bool SetResourceRef(const ResourceRef& value)
  5672. - bool SetResourceRefList(const ResourceRefList& value)
  5673. - bool SetVector2(const String name, const Vector2& value)
  5674. - bool SetVector3(const String name, const Vector3& value)
  5675. - bool SetVector4(const String name, const Vector4& value)
  5676. - bool SetVectorVariant(const String name, const Variant& value)
  5677. - bool SetMatrix3(const String name, const Matrix3& value)
  5678. - bool SetMatrix3x4(const String name, const Matrix3x4& value)
  5679. - bool SetMatrix4(const String name, const Matrix4& value)
  5680. - bool IsNull() const
  5681. - bool NotNull() const
  5682. - bool operatorbool() const
  5683. - String GetName() const
  5684. - bool HasChild(const String name) const
  5685. - XMLElement GetChild(const String name = String::EMPTY) const
  5686. - XMLElement GetNext(const String name = String::EMPTY) const
  5687. - XMLElement GetParent() const
  5688. - unsigned GetNumAttributes() const
  5689. - bool HasAttribute(const String name) const
  5690. - String GetValue() const
  5691. - String GetAttribute(const String name = String::EMPTY) const
  5692. - String GetAttributeLower(const String name) const
  5693. - String GetAttributeUpper(const String name) const
  5694. - Vector<String> GetAttributeNames() const
  5695. - bool GetBool(const String name) const
  5696. - BoundingBox GetBoundingBox() const
  5697. - Color GetColor(const String name) const
  5698. - float GetFloat(const String name) const
  5699. - unsigned GetUInt(const String name) const
  5700. - int GetInt(const String name) const
  5701. - IntRect GetIntRect(const String name) const
  5702. - IntVector2 GetIntVector2(const String name) const
  5703. - Rect GetRect(const String name) const
  5704. - Quaternion GetQuaternion(const String name) const
  5705. - Variant GetVariant() const
  5706. - Variant GetVariantValue(VariantType type) const
  5707. - ResourceRef GetResourceRef() const
  5708. - ResourceRefList GetResourceRefList() const
  5709. - VariantMap GetVariantMap() const
  5710. - Vector2 GetVector2(const String name) const
  5711. - Vector3 GetVector3(const String name) const
  5712. - Vector4 GetVector4(const String name) const
  5713. - Vector4 GetVector(const String name) const
  5714. - Matrix3 GetMatrix3(const String name) const
  5715. - Matrix3x4 GetMatrix3x4(const String name) const
  5716. - Matrix4 GetMatrix4(const String name) const
  5717. - XMLFile* GetFile() const
  5718. Properties:
  5719. - const XMLElement EMPTY
  5720. - bool null (readonly)
  5721. - String name (readonly)
  5722. - XMLElement parent (readonly)
  5723. - String value (readonly)
  5724. - unsigned numAttributes (readonly)
  5725. - XMLFile* file (readonly)
  5726. <a name="Class_XMLFile"></a>
  5727. ### XMLFile : Resource
  5728. Methods:
  5729. - XMLFile() (GC)
  5730. - XMLFile* new()
  5731. - void delete()
  5732. - bool FromString(const String source)
  5733. - XMLElement CreateRoot(const String name = String::EMPTY)
  5734. - XMLElement GetRoot(const String name = String::EMPTY)
  5735. - String ToString() const
  5736. - void Patch(XMLFile* patchFile)
  5737. - void Patch(XMLElement patchElement)
  5738. <a name="Class_Zone"></a>
  5739. ### Zone : Drawable
  5740. Methods:
  5741. - void SetBoundingBox(const BoundingBox& box)
  5742. - void SetAmbientColor(const Color& color)
  5743. - void SetFogColor(const Color& color)
  5744. - void SetFogStart(float start)
  5745. - void SetFogEnd(float end)
  5746. - void SetFogHeight(float height)
  5747. - void SetFogHeightScale(float scale)
  5748. - void SetPriority(int priority)
  5749. - void SetHeightFog(bool enable)
  5750. - void SetOverride(bool enable)
  5751. - void SetAmbientGradient(bool enable)
  5752. - void SetZoneTexture(Texture* texture)
  5753. - const Matrix3x4& GetInverseWorldTransform() const
  5754. - const Color& GetAmbientColor() const
  5755. - const Color& GetAmbientStartColor()
  5756. - const Color& GetAmbientEndColor()
  5757. - const Color& GetFogColor() const
  5758. - float GetFogStart() const
  5759. - float GetFogEnd() const
  5760. - float GetFogHeight() const
  5761. - float GetFogHeightScale() const
  5762. - int GetPriority() const
  5763. - bool GetHeightFog() const
  5764. - bool GetOverride() const
  5765. - bool GetAmbientGradient() const
  5766. - Texture* GetZoneTexture() const
  5767. - bool IsInside(const Vector3& point) const
  5768. Properties:
  5769. - BoundingBox& boundingBox
  5770. - Matrix3x4& inverseWorldTransform (readonly)
  5771. - Color& ambientColor
  5772. - Color& ambientStartColor (readonly)
  5773. - Color& ambientEndColor (readonly)
  5774. - Color& fogColor
  5775. - float fogStart
  5776. - float fogEnd
  5777. - float fogHeight
  5778. - float fogHeightScale
  5779. - int priority
  5780. - bool heightFog
  5781. - bool override
  5782. - bool ambientGradient
  5783. - Texture* zoneTexture
  5784. \section LuaScriptAPI_Enums Enumerations
  5785. ### BlendMode
  5786. - int BLEND_REPLACE
  5787. - int BLEND_ADD
  5788. - int BLEND_MULTIPLY
  5789. - int BLEND_ALPHA
  5790. - int BLEND_ADDALPHA
  5791. - int BLEND_PREMULALPHA
  5792. - int BLEND_INVDESTALPHA
  5793. - int BLEND_SUBTRACT
  5794. - int BLEND_SUBTRACTALPHA
  5795. - int MAX_BLENDMODES
  5796. ### BodyType2D
  5797. - int BT_STATIC
  5798. - int BT_DYNAMIC
  5799. - int BT_KINEMATIC
  5800. ### CollisionEventMode
  5801. - int COLLISION_NEVER
  5802. - int COLLISION_ACTIVE
  5803. - int COLLISION_ALWAYS
  5804. ### CompareMode
  5805. - int CMP_ALWAYS
  5806. - int CMP_EQUAL
  5807. - int CMP_NOTEQUAL
  5808. - int CMP_LESS
  5809. - int CMP_LESSEQUAL
  5810. - int CMP_GREATER
  5811. - int CMP_GREATEREQUAL
  5812. - int MAX_COMPAREMODES
  5813. ### CompressedFormat
  5814. - int CF_NONE
  5815. - int CF_RGBA
  5816. - int CF_DXT1
  5817. - int CF_DXT3
  5818. - int CF_DXT5
  5819. - int CF_ETC1
  5820. - int CF_PVRTC_RGB_2BPP
  5821. - int CF_PVRTC_RGBA_2BPP
  5822. - int CF_PVRTC_RGB_4BPP
  5823. - int CF_PVRTC_RGBA_4BPP
  5824. ### ConstraintType
  5825. - int CONSTRAINT_POINT
  5826. - int CONSTRAINT_HINGE
  5827. - int CONSTRAINT_SLIDER
  5828. - int CONSTRAINT_CONETWIST
  5829. ### Corner
  5830. - int C_TOPLEFT
  5831. - int C_TOPRIGHT
  5832. - int C_BOTTOMLEFT
  5833. - int C_BOTTOMRIGHT
  5834. - int MAX_UIELEMENT_CORNERS
  5835. ### CreateMode
  5836. - int REPLICATED
  5837. - int LOCAL
  5838. ### CubeMapFace
  5839. - int FACE_POSITIVE_X
  5840. - int FACE_NEGATIVE_X
  5841. - int FACE_POSITIVE_Y
  5842. - int FACE_NEGATIVE_Y
  5843. - int FACE_POSITIVE_Z
  5844. - int FACE_NEGATIVE_Z
  5845. - int MAX_CUBEMAP_FACES
  5846. ### CullMode
  5847. - int CULL_NONE
  5848. - int CULL_CCW
  5849. - int CULL_CW
  5850. - int MAX_CULLMODES
  5851. ### CursorShape
  5852. - int CS_NORMAL
  5853. - int CS_IBEAM
  5854. - int CS_CROSS
  5855. - int CS_RESIZEVERTICAL
  5856. - int CS_RESIZEDIAGONAL_TOPRIGHT
  5857. - int CS_RESIZEHORIZONTAL
  5858. - int CS_RESIZEDIAGONAL_TOPLEFT
  5859. - int CS_RESIZE_ALL
  5860. - int CS_ACCEPTDROP
  5861. - int CS_REJECTDROP
  5862. - int CS_BUSY
  5863. - int CS_BUSY_ARROW
  5864. - int CS_MAX_SHAPES
  5865. ### EmitterType
  5866. - int EMITTER_SPHERE
  5867. - int EMITTER_BOX
  5868. ### EmitterType2D
  5869. - int EMITTER_TYPE_GRAVITY
  5870. - int EMITTER_TYPE_RADIAL
  5871. ### FaceCameraMode
  5872. - int FC_NONE
  5873. - int FC_ROTATE_XYZ
  5874. - int FC_ROTATE_Y
  5875. - int FC_LOOKAT_XYZ
  5876. - int FC_LOOKAT_Y
  5877. ### FaceCameraMode
  5878. - int FC_NONE
  5879. - int FC_ROTATE_XYZ
  5880. - int FC_ROTATE_Y
  5881. - int FC_LOOKAT_XYZ
  5882. - int FC_LOOKAT_Y
  5883. ### FileMode
  5884. - int FILE_READ
  5885. - int FILE_WRITE
  5886. - int FILE_READWRITE
  5887. ### FillMode
  5888. - int FILL_SOLID
  5889. - int FILL_WIREFRAME
  5890. - int FILL_POINT
  5891. ### FocusMode
  5892. - int FM_NOTFOCUSABLE
  5893. - int FM_RESETFOCUS
  5894. - int FM_FOCUSABLE
  5895. - int FM_FOCUSABLE_DEFOCUSABLE
  5896. ### FrustumPlane
  5897. - int PLANE_NEAR
  5898. - int PLANE_LEFT
  5899. - int PLANE_RIGHT
  5900. - int PLANE_UP
  5901. - int PLANE_DOWN
  5902. - int PLANE_FAR
  5903. ### GeometryType
  5904. - int GEOM_STATIC
  5905. - int GEOM_SKINNED
  5906. - int GEOM_INSTANCED
  5907. - int GEOM_BILLBOARD
  5908. - int GEOM_STATIC_NOINSTANCING
  5909. - int MAX_GEOMETRYTYPES
  5910. ### HighlightMode
  5911. - int HM_NEVER
  5912. - int HM_FOCUS
  5913. - int HM_ALWAYS
  5914. ### HorizontalAlignment
  5915. - int HA_LEFT
  5916. - int HA_CENTER
  5917. - int HA_RIGHT
  5918. ### HttpRequestState
  5919. - int HTTP_INITIALIZING
  5920. - int HTTP_ERROR
  5921. - int HTTP_OPEN
  5922. - int HTTP_CLOSED
  5923. ### InterpMethod
  5924. - int IM_LINEAR
  5925. - int IM_SPLINE
  5926. ### InterpolationMode
  5927. - int BEZIER_CURVE
  5928. ### Intersection
  5929. - int OUTSIDE
  5930. - int INTERSECTS
  5931. - int INSIDE
  5932. ### JSONValueType
  5933. - int JSON_ANY
  5934. - int JSON_OBJECT
  5935. - int JSON_ARRAY
  5936. ### LayoutMode
  5937. - int LM_FREE
  5938. - int LM_HORIZONTAL
  5939. - int LM_VERTICAL
  5940. ### LightType
  5941. - int LIGHT_DIRECTIONAL
  5942. - int LIGHT_SPOT
  5943. - int LIGHT_POINT
  5944. ### LoadMode
  5945. - int LOAD_RESOURCES_ONLY
  5946. - int LOAD_SCENE
  5947. - int LOAD_SCENE_AND_RESOURCES
  5948. ### LockState
  5949. - int LOCK_NONE
  5950. - int LOCK_HARDWARE
  5951. - int LOCK_SHADOW
  5952. - int LOCK_SCRATCH
  5953. ### LoopMode2D
  5954. - int LM_DEFAULT
  5955. - int LM_FORCE_LOOPED
  5956. - int LM_FORCE_CLAMPED
  5957. ### MouseMode
  5958. - int MM_ABSOLUTE
  5959. - int MM_RELATIVE
  5960. - int MM_WRAP
  5961. ### Orientation
  5962. - int O_HORIZONTAL
  5963. - int O_VERTICAL
  5964. ### Orientation2D
  5965. - int O_ORTHOGONAL
  5966. - int O_ISOMETRIC
  5967. - int O_STAGGERED
  5968. ### PassLightingMode
  5969. - int LIGHTING_UNLIT
  5970. - int LIGHTING_PERVERTEX
  5971. - int LIGHTING_PERPIXEL
  5972. ### PrimitiveType
  5973. - int TRIANGLE_LIST
  5974. - int LINE_LIST
  5975. - int POINT_LIST
  5976. - int TRIANGLE_STRIP
  5977. - int LINE_STRIP
  5978. - int TRIANGLE_FAN
  5979. ### RayQueryLevel
  5980. - int RAY_AABB
  5981. - int RAY_OBB
  5982. - int RAY_TRIANGLE
  5983. ### RenderSurfaceUpdateMode
  5984. - int SURFACE_MANUALUPDATE
  5985. - int SURFACE_UPDATEVISIBLE
  5986. - int SURFACE_UPDATEALWAYS
  5987. ### ShaderParameterGroup
  5988. - int SP_FRAME
  5989. - int SP_CAMERA
  5990. - int SP_VIEWPORT
  5991. - int SP_ZONE
  5992. - int SP_LIGHT
  5993. - int SP_VERTEXLIGHTS
  5994. - int SP_MATERIAL
  5995. - int SP_OBJECTTRANSFORM
  5996. - int MAX_SHADER_PARAMETER_GROUPS
  5997. ### ShaderType
  5998. - int VS
  5999. - int PS
  6000. ### ShapeType
  6001. - int SHAPE_BOX
  6002. - int SHAPE_SPHERE
  6003. - int SHAPE_STATICPLANE
  6004. - int SHAPE_CYLINDER
  6005. - int SHAPE_CAPSULE
  6006. - int SHAPE_CONE
  6007. - int SHAPE_TRIANGLEMESH
  6008. - int SHAPE_CONVEXHULL
  6009. - int SHAPE_TERRAIN
  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_GEOMETRY2D
  6303. - unsigned DRAWABLE_LIGHT
  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. - String SOUND_AMBIENT
  6713. - String SOUND_EFFECT
  6714. - String SOUND_MASTER
  6715. - String SOUND_MUSIC
  6716. - String SOUND_VOICE
  6717. - unsigned VO_DISABLE_OCCLUSION
  6718. - unsigned VO_DISABLE_SHADOWS
  6719. - unsigned VO_LOW_MATERIAL_QUALITY
  6720. - unsigned VO_NONE
  6721. */
  6722. }