LuaScriptAPI.dox 240 KB

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