LuaScriptAPI.dox 253 KB

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