LuaScriptAPI.dox 260 KB

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