LuaScriptAPI.dox 232 KB

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