LuaScriptAPI.dox 237 KB

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