LuaScriptAPI.dox 265 KB

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