LuaScriptAPI.dox 232 KB

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