LuaScriptAPI.dox 238 KB

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